fix: checkstyle and others

Author: mike-d-davydov

.editorconfig

@@ -0,0 +1,7 @@
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true 

.vscode/settings.json

@@ -1,6 +1,6 @@
 {
- "java.checkstyle.configuration": "checkstyle.xml",
- "java.checkstyle.version": "8.41",
+ "java.checkstyle.configuration": "${workspaceFolder}/checkstyle.xml",
+ "java.checkstyle.version": "9.3",
  "editor.formatOnSave": true,
  "editor.formatOnPaste": true,
  "editor.formatOnType": true,
@@ -10,14 +10,13 @@
  },
  "java.configuration.updateBuildConfiguration": "automatic",
  "java.compile.nullAnalysis.mode": "automatic",
- "java.format.enabled": true,
  "java.import.generatesMetadataFilesAtProjectRoot": true,
  "java.sources.organizeImports.starThreshold": 99,
  "java.sources.organizeImports.staticStarThreshold": 99,
  "[java]": {
- "editor.defaultFormatter": "redhat.java",
- "editor.formatOnSave": true,
- "editor.formatOnPaste": true,
- "editor.formatOnType": true
+ "editor.defaultFormatter": null,
+ "editor.formatOnSave": false,
+ "editor.formatOnPaste": false,
+ "editor.formatOnType": false
  }
 }

checkstyle.xml

@@ -17,6 +17,16 @@
  </module>
 
  <module name="TreeWalker">
+ <!-- Indentation -->
+ <module name="Indentation">
+ <property name="basicOffset" value="2" />
+ <property name="braceAdjustment" value="0" />
+ <property name="caseIndent" value="2" />
+ <property name="throwsIndent" value="4" />
+ <property name="lineWrappingIndentation" value="4" />
+ <property name="arrayInitIndent" value="2" />
+ </module>
+
  <!-- Checks for Naming Conventions -->
  <module name="ConstantName" />
  <module name="LocalFinalVariableName" />

pom.xml

@@ -40,6 +40,8 @@
  <java.version>11</java.version>
  <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+ <checkstyle.version>10.12.7</checkstyle.version>
+ <google-formatter-plugin.version>1.7.5</google-formatter-plugin.version>
  </properties>
 
  <dependencies>
@@ -119,6 +121,20 @@
  <scope>provided</scope>
  </dependency>
 
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-simple</artifactId>
+ <version>2.0.9</version>
+ <scope>test</scope>
+ </dependency>
+
+ <dependency>
+ <groupId>org.mockito</groupId>
+ <artifactId>mockito-core</artifactId>
+ <version>5.10.0</version>
+ <scope>test</scope>
+ </dependency>
+
  </dependencies>
 
  <build>
@@ -235,13 +251,38 @@
  </executions>
  </plugin>
 
- <!-- Checkstyle for code style checking -->
+ <!-- Google Java Formatter Plugin (theoryinpractise) -->
+ <plugin>
+ <groupId>com.theoryinpractise</groupId>
+ <artifactId>googleformatter-maven-plugin</artifactId>
+ <version>${google-formatter-plugin.version}</version>
+ <executions>
+ <execution>
+ <id>reformat-sources</id>
+ <goals>
+ <goal>format</goal>
+ </goals>
+ <!-- You can optionally tie this to a phase e.g.
+ <phase>process-sources</phase> -->
+ </execution>
+ </executions>
+ </plugin>
+
+ <!-- Maven Checkstyle Plugin -->
  <plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-checkstyle-plugin</artifactId>
  <version>3.3.1</version>
+ <dependencies>
+ <dependency>
+ <groupId>com.puppycrawl.tools</groupId>
+ <artifactId>checkstyle</artifactId>
+ <version>${checkstyle.version}</version>
+ </dependency>
+ </dependencies>
  <configuration>
- <configLocation>google_checks.xml</configLocation>
+ <configLocation>${basedir}/checkstyle.xml</configLocation>
+ <encoding>UTF-8</encoding>
  <consoleOutput>true</consoleOutput>
  <failsOnError>true</failsOnError>
  <linkXRef>false</linkXRef>

src/main/java/io/github/mikeddavydov/jpwise/JPWise.java

@@ -19,14 +19,11 @@
 import io.github.mikeddavydov.jpwise.core.TestParameter;
 
 /**
- * A facade class providing a simplified API for the JPWise test generation
- * framework. This class
- * offers static methods for building test inputs and generating test
- * combinations using either
+ * A facade class providing a simplified API for the JPWise test generation framework. This class
+ * offers static methods for building test inputs and generating test combinations using either
  * pairwise or combinatorial algorithms.
  *
- * <p>
- * Example usage:
+ * <p>Example usage:
  *
  * <pre>
  * // Direct generation
@@ -54,8 +51,7 @@ private JPWise() {
  }
 
  /**
- * Creates a new InputBuilder for fluently constructing test inputs. This is an
- * alias for {@link
+ * Creates a new InputBuilder for fluently constructing test inputs. This is an alias for {@link
  * #builder()}.
  *
  * @return A new InputBuilder instance
@@ -96,8 +92,7 @@ public static InputBuilder withParameters(Collection<TestParameter> parameters)
  }
 
  /**
- * Generates test combinations using the pairwise algorithm with default
- * settings.
+ * Generates test combinations using the pairwise algorithm with default settings.
  *
  * @param parameters The test parameters
  * @return A table of generated test combinations
@@ -108,8 +103,7 @@ public static CombinationTable generatePairwise(TestParameter... parameters) {
  }
 
  /**
- * Generates test combinations using the pairwise algorithm with default
- * settings.
+ * Generates test combinations using the pairwise algorithm with default settings.
  *
  * @param parameters The test parameters
  * @return A table of generated test combinations
@@ -122,11 +116,10 @@ public static CombinationTable generatePairwise(Collection<TestParameter> parame
  /**
  * Generates test combinations using a configured pairwise algorithm.
  *
- * @param algorithm  The configured pairwise algorithm instance
+ * @param algorithm The configured pairwise algorithm instance
  * @param parameters The test parameters
  * @return A table of generated test combinations
- * @throws NullPointerException if algorithm, parameters array, or any parameter
- * is null
+ * @throws NullPointerException if algorithm, parameters array, or any parameter is null
  */
  public static CombinationTable generatePairwise(
  PairwiseAlgorithm algorithm, TestParameter... parameters) {
@@ -137,11 +130,10 @@ public static CombinationTable generatePairwise(
  /**
  * Generates test combinations using a configured pairwise algorithm.
  *
- * @param algorithm  The configured pairwise algorithm instance
+ * @param algorithm The configured pairwise algorithm instance
  * @param parameters The test parameters
  * @return A table of generated test combinations
- * @throws NullPointerException if algorithm, parameters collection, or any
- * parameter is null
+ * @throws NullPointerException if algorithm, parameters collection, or any parameter is null
  */
  public static CombinationTable generatePairwise(
  PairwiseAlgorithm algorithm, Collection<TestParameter> parameters) {
@@ -150,8 +142,7 @@ public static CombinationTable generatePairwise(
  }
 
  /**
- * Generates test combinations using the pairwise algorithm with default
- * settings.
+ * Generates test combinations using the pairwise algorithm with default settings.
  *
  * @param input The test input configuration
  * @return A table of generated test combinations
@@ -164,7 +155,7 @@ public static CombinationTable generatePairwise(TestInput input) {
  /**
  * Generates test combinations using a configured pairwise algorithm.
  *
- * @param input  The test input configuration
+ * @param input The test input configuration
  * @param algorithm The configured pairwise algorithm instance
  * @return A table of generated test combinations
  * @throws NullPointerException if input or algorithm is null
@@ -176,8 +167,7 @@ public static CombinationTable generatePairwise(TestInput input, PairwiseAlgorit
  }
 
  /**
- * Generates test combinations using the combinatorial algorithm with default
- * settings.
+ * Generates test combinations using the combinatorial algorithm with default settings.
  *
  * @param parameters The test parameters
  * @return A table of generated test combinations
@@ -188,14 +178,12 @@ public static CombinationTable generateCombinatorial(TestParameter... parameters
  }
 
  /**
- * Generates test combinations using the combinatorial algorithm with default
- * settings.
+ * Generates test combinations using the combinatorial algorithm with default settings.
  *
  * @param parameters The test parameters
- * @param limit  The maximum number of combinations to generate
+ * @param limit The maximum number of combinations to generate
  * @return A table of generated test combinations
- * @throws NullPointerException if parameters collection or any element is
- * null
+ * @throws NullPointerException if parameters collection or any element is null
  * @throws IllegalArgumentException if limit is less than 1
  */
  public static CombinationTable generateCombinatorial(
@@ -206,12 +194,11 @@ public static CombinationTable generateCombinatorial(
  /**
  * Generates test combinations using a configured combinatorial algorithm.
  *
- * @param algorithm  The configured combinatorial algorithm instance
- * @param limit  The maximum number of combinations to generate
+ * @param algorithm The configured combinatorial algorithm instance
+ * @param limit The maximum number of combinations to generate
  * @param parameters The test parameters
  * @return A table of generated test combinations
- * @throws NullPointerException if algorithm, parameters array, or any
- * parameter is null
+ * @throws NullPointerException if algorithm, parameters array, or any parameter is null
  * @throws IllegalArgumentException if limit is less than 1
  */
  public static CombinationTable generateCombinatorial(
@@ -221,8 +208,7 @@ public static CombinationTable generateCombinatorial(
  }
 
  /**
- * Generates test combinations using the combinatorial algorithm with default
- * settings.
+ * Generates test combinations using the combinatorial algorithm with default settings.
  *
  * @param input The test input configuration
  * @return A table of generated test combinations
@@ -235,7 +221,7 @@ public static CombinationTable generateCombinatorial(TestInput input) {
  /**
  * Generates test combinations using a configured combinatorial algorithm.
  *
- * @param input  The test input configuration
+ * @param input The test input configuration
  * @param algorithm The configured combinatorial algorithm instance
  * @return A table of generated test combinations
  * @throws NullPointerException if input or algorithm is null
@@ -246,14 +232,13 @@ public static CombinationTable generateCombinatorial(
  }
 
  /**
- * Generates test combinations using a configured combinatorial algorithm with a
- * limit.
+ * Generates test combinations using a configured combinatorial algorithm with a limit.
  *
- * @param input  The test input configuration
+ * @param input The test input configuration
  * @param algorithm The configured combinatorial algorithm instance
- * @param limit  The maximum number of combinations to generate
+ * @param limit The maximum number of combinations to generate
  * @return A table of generated test combinations
- * @throws NullPointerException  if input or algorithm is null
+ * @throws NullPointerException if input or algorithm is null
  * @throws IllegalArgumentException if limit is less than 1
  */
  public static CombinationTable generateCombinatorial(
@@ -268,19 +253,22 @@ public static CombinationTable generateCombinatorial(
  }
 
  private static CombinationTable executeGeneration(
- TestInput input, GenerationAlgorithm algorithm, int nWiseOrLimit) {
- logger.debug("JPWise.executeGeneration called with algorithm: {}, nWiseOrLimit: {}",
- algorithm.getClass().getSimpleName(), nWiseOrLimit);
- Objects.requireNonNull(input, "input must not be null");
- Objects.requireNonNull(algorithm, "algorithm must not be null");
- if (nWiseOrLimit < 1) {
- throw new IllegalArgumentException("nWiseOrLimit must generally be positive.");
- }
-
+ TestInput input, GenerationAlgorithm algorithm, Integer nWiseOrLimit) {
+ logger.info(
+ "Executing generation with algorithm: {} for TestInput with {} parameters. NWise/Limit: {}",
+  algorithm.getClass().getSimpleName(),
+  input.getTestParameters().size(),
+  nWiseOrLimit == null ? "default" : nWiseOrLimit);
+
+ // Create the generator and run the algorithm.
+ // The nWiseOrLimit is now handled by the algorithm's constructor if needed.
  TestGenerator generator = new TestGenerator(input);
- logger.debug("JPWise.executeGeneration: TestGenerator created. Calling TestGenerator.generate()...");
- CombinationTable result = generator.generate(algorithm, nWiseOrLimit);
- logger.info("Generated {} test combinations", result.size());
+ logger.debug(
+ "JPWise.executeGeneration: TestGenerator created. Calling TestGenerator.generate()...");
+ CombinationTable result = generator.generate(algorithm);
+ logger.debug(
+ "JPWise.executeGeneration: TestGenerator.generate() returned. Result size: {}",
+ result.size());
  return result;
  }
 
@@ -310,7 +298,7 @@ public InputBuilder parameter(TestParameter parameter) {
  /**
  * Creates and adds a parameter with the given name and partitions.
  *
- * @param name  The parameter name
+ * @param name The parameter name
  * @param partitions The parameter's partitions
  * @return This builder instance
  * @throws NullPointerException if name or partitions array is null
@@ -322,12 +310,11 @@ public InputBuilder parameter(String name, EquivalencePartition... partitions) {
  }
 
  /**
- * Creates and adds a parameter with the given name, partitions, and
- * compatibility rules.
+ * Creates and adds a parameter with the given name, partitions, and compatibility rules.
  *
- * @param name  The parameter name
+ * @param name The parameter name
  * @param partitions The parameter's partitions
- * @param rules  The parameter's compatibility rules
+ * @param rules The parameter's compatibility rules
  * @return This builder instance
  * @throws NullPointerException if any argument is null
  */
@@ -382,8 +369,7 @@ public TestInput build() {
  }
 
  /**
- * Convenience method to generate test combinations using the pairwise algorithm
- * with default
+ * Convenience method to generate test combinations using the pairwise algorithm with default
  * settings.
  *
  * @return A table of generated test combinations
@@ -394,8 +380,7 @@ public CombinationTable generatePairwise() {
  }
 
  /**
- * Convenience method to generate test combinations using the combinatorial
- * algorithm with
+ * Convenience method to generate test combinations using the combinatorial algorithm with
  * default settings.
  *
  * @return A table of generated test combinations
@@ -405,8 +390,7 @@ public CombinationTable generateCombinatorial() {
  }
 
  /**
- * Convenience method to generate test combinations using the combinatorial
- * algorithm with a
+ * Convenience method to generate test combinations using the combinatorial algorithm with a
  * limit.
  *
  * @param limit The maximum number of combinations to generate