This is an automated email from the ASF dual-hosted git repository.
piotr pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/iggy.git
The following commit(s) were added to refs/heads/master by this push:
new e977417e chore(sdk): Add checkstyle support (#1753)
e977417e is described below
commit e977417ecc253d4b985cb2ef8d9ddf4539772eab
Author: Nandakumar Vadivelu <[email protected]>
AuthorDate: Thu May 15 01:47:47 2025 +0530
chore(sdk): Add checkstyle support (#1753)
Fixes #1752
---
.github/workflows/ci-check-java-sdk.yml | 2 +-
foreign/java/dev-support/checkstyle/checkstyle.xml | 213 +++++++++++++++++++++
.../java/examples/simple-consumer/build.gradle.kts | 2 +-
.../java/examples/simple-producer/build.gradle.kts | 2 +-
foreign/java/java-sdk/build.gradle.kts | 6 +
foreign/java/settings.gradle.kts | 15 +-
6 files changed, 232 insertions(+), 8 deletions(-)
diff --git a/.github/workflows/ci-check-java-sdk.yml
b/.github/workflows/ci-check-java-sdk.yml
index 928051ef..a10498f4 100644
--- a/.github/workflows/ci-check-java-sdk.yml
+++ b/.github/workflows/ci-check-java-sdk.yml
@@ -56,7 +56,7 @@ jobs:
uses:
gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0
- name: Build
- run: foreign/java/dev-support/checks/build.sh build -x test
+ run: foreign/java/dev-support/checks/build.sh build -x test -x
checkstyleMain -x checkstyleTest
test:
name: Unit test
diff --git a/foreign/java/dev-support/checkstyle/checkstyle.xml
b/foreign/java/dev-support/checkstyle/checkstyle.xml
new file mode 100644
index 00000000..21a1c7a5
--- /dev/null
+++ b/foreign/java/dev-support/checkstyle/checkstyle.xml
@@ -0,0 +1,213 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<!DOCTYPE module PUBLIC
+ "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+ "https://checkstyle.org/dtds/configuration_1_3.dtd";>
+
+<!--
+
+ Checkstyle configuration for Apache Iggy that is based on the sun_checks.xml
file
+ that checks the coding conventions from:
+
+ - the Java Language Specification at
+ http://java.sun.com/docs/books/jls/second_edition/html/index.html
+
+ - the Sun Code Conventions at http://java.sun.com/docs/codeconv/
+
+ - the Javadoc guidelines at
+ http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
+
+ - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
+
+ - some best practices
+
+ Checkstyle is very configurable. Be sure to read the documentation at
+ http://checkstyle.sf.net (or in your downloaded distribution).
+
+ Most Checks are configurable, be sure to consult the documentation.
+
+ To completely disable a check, just comment it out or delete it from the
file.
+
+ Finally, it is worth reading the documentation.
+
+-->
+
+<module name="Checker">
+ <!--
+ If you set the basedir property below, then all reported file
+ names will be relative to the specified directory. See
+ https://checkstyle.org/5.x/config.html#Checker
+
+ <property name="basedir" value="${basedir}"/>
+ -->
+
+ <property name="fileExtensions" value="java, properties, xml"/>
+
+ <module name="SuppressWarningsFilter"/>
+
+ <!-- Checks that a package-info.java file exists for each package. -->
+ <!-- See http://checkstyle.sf.net/config_javadoc.html#JavadocPackage -->
+ <!-- module name="JavadocPackage"/ -->
+
+ <!-- Checks whether files end with a new line. -->
+ <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
+ <!-- module name="NewlineAtEndOfFile"/ -->
+
+ <!-- Checks that property files contain the same keys. -->
+ <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
+ <module name="Translation"/>
+
+ <!-- Checks for Size Violations. -->
+ <!-- See http://checkstyle.sf.net/config_sizes.html -->
+ <module name="FileLength"/>
+
+ <!-- Checks for whitespace -->
+ <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+ <module name="FileTabCharacter"/>
+
+ <!-- Miscellaneous other checks. -->
+ <!-- See http://checkstyle.sf.net/config_misc.html -->
+ <module name="RegexpSingleline">
+ <property name="format" value="\s+$"/>
+ <property name="minimum" value="0"/>
+ <property name="maximum" value="0"/>
+ <property name="message" value="Line has trailing spaces."/>
+ </module>
+
+ <!-- Checks for Headers -->
+ <!-- See http://checkstyle.sf.net/config_header.html -->
+ <!-- <module name="Header"> -->
+ <!-- <property name="headerFile" value="${checkstyle.header.file}"/> -->
+ <!-- <property name="fileExtensions" value="java"/> -->
+ <!-- </module> -->
+
+ <!-- Checks for Size Violations. -->
+ <!-- See http://checkstyle.sf.net/config_sizes.html#LineLength -->
+ <module name="LineLength">
+ <property name="max" value="120"/>
+ </module>
+
+ <module name="TreeWalker">
+ <module name="SuppressWarningsHolder"/>
+ <module name="SuppressionCommentFilter"/>
+ <module name="SuppressWithNearbyCommentFilter"/>
+
+ <!-- Checks for Javadoc comments. -->
+ <!-- See http://checkstyle.sf.net/config_javadoc.html -->
+ <!--
+ <module name="JavadocMethod"/>
+ <module name="JavadocType">
+ <property name="scope" value="public"/>
+ <property name="allowMissingParamTags" value="true"/>
+ </module>
+ <module name="JavadocVariable"/>
+ <module name="JavadocStyle"/>
+ -->
+
+ <!-- Checks for Naming Conventions. -->
+ <!-- See http://checkstyle.sf.net/config_naming.html -->
+ <module name="ConstantName"/>
+ <module name="LocalFinalVariableName"/>
+ <module name="LocalVariableName"/>
+ <module name="MemberName"/>
+ <module name="MethodName"/>
+ <module name="PackageName"/>
+ <module name="ParameterName"/>
+ <module name="StaticVariableName"/>
+ <module name="TypeName"/>
+
+ <!-- Checks for imports -->
+ <!-- See http://checkstyle.sf.net/config_import.html -->
+ <!-- module name="AvoidStarImport"/ -->
+ <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
+ <module name="RedundantImport"/>
+ <module name="UnusedImports">
+ <property name="processJavadoc" value="false"/>
+ </module>
+
+ <!-- Checks for Size Violations. -->
+ <!-- See http://checkstyle.sf.net/config_sizes.html -->
+ <module name="MethodLength"/>
+ <module name="ParameterNumber">
+ <property name="ignoreOverriddenMethods" value="true"/>
+ </module>
+
+ <!-- Checks for whitespace -->
+ <!-- See http://checkstyle.sf.net/config_whitespace.html -->
+ <!--
+ <module name="EmptyForIteratorPad"/>
+ <module name="GenericWhitespace"/>
+ <module name="MethodParamPad"/>
+ <module name="NoWhitespaceAfter"/>
+ <module name="NoWhitespaceBefore"/>
+ <module name="OperatorWrap"/>
+ <module name="ParenPad"/>
+ <module name="TypecastParenPad"/>
+ <module name="WhitespaceAfter"/>
+ <module name="WhitespaceAround"/>
+ -->
+
+ <!-- Modifier Checks -->
+ <!-- See http://checkstyle.sf.net/config_modifiers.html -->
+ <module name="ModifierOrder"/>
+
+ <!-- Checks for blocks. You know, those {}'s -->
+ <!-- See http://checkstyle.sf.net/config_blocks.html -->
+ <module name="AvoidNestedBlocks"/>
+ <module name="EmptyBlock"/>
+ <module name="LeftCurly"/>
+ <module name="NeedBraces"/>
+ <module name="RightCurly"/>
+
+ <!-- Checks for common coding problems -->
+ <!-- See http://checkstyle.sf.net/config_coding.html -->
+ <!-- module name="AvoidInlineConditionals"/ -->
+ <module name="EmptyStatement"/>
+ <module name="EqualsHashCode"/>
+ <module name="HiddenField">
+ <property name="ignoreConstructorParameter" value="true"/>
+ <property name="ignoreSetter" value="true"/>
+ <property name="setterCanReturnItsClass" value="true"/>
+ </module>
+ <module name="IllegalInstantiation"/>
+ <!-- module name="InnerAssignment"/-->
+ <!-- module name="MagicNumber"/ -->
+ <module name="MissingSwitchDefault"/>
+ <module name="SimplifyBooleanExpression"/>
+ <module name="SimplifyBooleanReturn"/>
+
+ <!-- Checks for class design -->
+ <!-- See http://checkstyle.sf.net/config_design.html -->
+ <!-- module name="DesignForExtension"/ -->
+ <module name="FinalClass"/>
+ <module name="HideUtilityClassConstructor"/>
+ <module name="InterfaceIsType"/>
+ <module name="VisibilityModifier"/>
+
+ <!-- Miscellaneous other checks. -->
+ <!-- See http://checkstyle.sf.net/config_misc.html -->
+ <module name="ArrayTypeStyle"/>
+ <!-- module name="FinalParameters"/ -->
+ <!-- module name="TodoComment"/ -->
+ <module name="UpperEll"/>
+
+ </module>
+
+</module>
diff --git a/foreign/java/examples/simple-consumer/build.gradle.kts
b/foreign/java/examples/simple-consumer/build.gradle.kts
index 08f8a355..dbbecc6d 100644
--- a/foreign/java/examples/simple-consumer/build.gradle.kts
+++ b/foreign/java/examples/simple-consumer/build.gradle.kts
@@ -29,7 +29,7 @@ repositories {
}
dependencies {
- implementation(project(":java-sdk"))
+ implementation(project(":iggy-java-sdk"))
implementation("org.slf4j:slf4j-api:2.0.9")
runtimeOnly("ch.qos.logback:logback-classic:1.4.12")
}
diff --git a/foreign/java/examples/simple-producer/build.gradle.kts
b/foreign/java/examples/simple-producer/build.gradle.kts
index 08f8a355..dbbecc6d 100644
--- a/foreign/java/examples/simple-producer/build.gradle.kts
+++ b/foreign/java/examples/simple-producer/build.gradle.kts
@@ -29,7 +29,7 @@ repositories {
}
dependencies {
- implementation(project(":java-sdk"))
+ implementation(project(":iggy-java-sdk"))
implementation("org.slf4j:slf4j-api:2.0.9")
runtimeOnly("ch.qos.logback:logback-classic:1.4.12")
}
diff --git a/foreign/java/java-sdk/build.gradle.kts
b/foreign/java/java-sdk/build.gradle.kts
index bc799ea9..d217d355 100644
--- a/foreign/java/java-sdk/build.gradle.kts
+++ b/foreign/java/java-sdk/build.gradle.kts
@@ -21,6 +21,7 @@ plugins {
id("java-library")
id("maven-publish")
id("org.jreleaser") version ("1.14.0")
+ id("checkstyle")
}
group = "org.apache.iggy"
@@ -35,6 +36,11 @@ java {
withSourcesJar()
}
+checkstyle {
+ toolVersion = "10.23.1"
+ configFile = file("../dev-support/checkstyle/checkstyle.xml")
+}
+
dependencies {
implementation("org.apache.httpcomponents.client5:httpclient5:5.4")
implementation("com.fasterxml.jackson.core:jackson-databind:2.18.0")
diff --git a/foreign/java/settings.gradle.kts b/foreign/java/settings.gradle.kts
index 2bedb7e2..19745cce 100644
--- a/foreign/java/settings.gradle.kts
+++ b/foreign/java/settings.gradle.kts
@@ -19,9 +19,14 @@
rootProject.name = "iggy-java-client"
-include("java-sdk")
+include("iggy-java-sdk")
+project(":iggy-java-sdk").projectDir = file("java-sdk")
-include("simple-consumer-example")
-project(":simple-consumer-example").projectDir =
file("examples/simple-consumer")
-include("simple-producer-example")
-project(":simple-producer-example").projectDir =
file("examples/simple-producer")
+include("iggy-java-example")
+project(":iggy-java-example").projectDir = file("examples")
+
+include("iggy-java-example:simple-producer")
+project(":iggy-java-example:simple-producer").projectDir =
file("examples/simple-producer")
+
+include("iggy-java-example:simple-consumer")
+project(":iggy-java-example:simple-consumer").projectDir =
file("examples/simple-consumer")
