Parameterize tests of Generated classes and fields (#139)

* Refactor class deprecation to GeneratedClass-enum

* Refactor more attributes to GenerateClass-enum

* Refactor testing of generated Enum-classes

* Minor refactoring

* Minor refactoring

* Refactor into `GeneratedEnum.java`

* Encapsulate test properties to `GeneratedSource.java`

* Set expected generated fields in runtime

* Add boolean 'isEnum' to `GeneratedClass`

* Parameterize generated fields

* Assert generated fields dynamically

* Migrate field-"nullability" from class to field level

* Minor refactor

* Type-Parameterize `GeneratedField` and remove uses of rawtypes

* Minor refactoring

* Set expected defaultValue in `GeneratedField`

* Add testing of `default`-values for fields

* Minor refactoring

* Assert record-fields are set to constructor-arguments

* Add testing values for all field types

* Refactor `TestSuite`-class

* Fix unsafe type-casting and remove redundant use of Optionals

* Fix unsafe cast in Enum-tests

Author: Chrimle

src/test/java/com/chrimle/example/GeneratedClass.java

@@ -1,22 +1,33 @@
 package com.chrimle.example;
 
 public enum GeneratedClass {
-  DEPRECATED_EXAMPLE_ENUM("DeprecatedExampleEnum"),
-  DEPRECATED_EXAMPLE_RECORD("DeprecatedExampleRecord"),
-  EXAMPLE_ENUM("ExampleEnum"),
-  EXAMPLE_RECORD("ExampleRecord"),
-  EXAMPLE_RECORD_WITH_DEFAULT_FIELDS("ExampleRecordWithDefaultFields"),
-  EXAMPLE_RECORD_WITH_REQUIRED_FIELDS_OF_EACH_TYPE("ExampleRecordWithRequiredFieldsOfEachType"),
-  EXAMPLE_RECORD_WITH_NULLABLE_FIELDS_OF_EACH_TYPE("ExampleRecordWithNullableFieldsOfEachType");
+  DEPRECATED_EXAMPLE_ENUM("DeprecatedExampleEnum", true, true),
+  DEPRECATED_EXAMPLE_RECORD("DeprecatedExampleRecord", true, false),
+  EXAMPLE_ENUM("ExampleEnum", false, true),
+  EXAMPLE_RECORD("ExampleRecord", false, false),
+  EXAMPLE_RECORD_WITH_DEFAULT_FIELDS("ExampleRecordWithDefaultFields", false, false),
+  EXAMPLE_RECORD_WITH_REQUIRED_FIELDS_OF_EACH_TYPE(
+      "ExampleRecordWithRequiredFieldsOfEachType", false, false),
+  EXAMPLE_RECORD_WITH_NULLABLE_FIELDS_OF_EACH_TYPE(
+      "ExampleRecordWithNullableFieldsOfEachType", false, false);
 
   public static final String PACKAGE_NAME = "io.github.chrimle.example";
-  private final String simpleClassName;
+  public final String simpleClassName;
+  public final boolean isDeprecated;
+  public final boolean isEnum;
 
-  GeneratedClass(final String simpleClassName) {
+  GeneratedClass(final String simpleClassName, final boolean isDeprecated, final boolean isEnum) {
     this.simpleClassName = simpleClassName;
+    this.isDeprecated = isDeprecated;
+    this.isEnum = isEnum;
   }
 
-  public String getCanonicalClassName(final String moduleName) {
-    return String.format("%s.%s.%s", PACKAGE_NAME, moduleName, simpleClassName);
+  public String getCanonicalClassName(final PluginExecution pluginExecution) {
+    return getCanonicalClassName(pluginExecution.packageName, this);
+  }
+
+  public static String getCanonicalClassName(
+      final String moduleName, final GeneratedClass generatedClass) {
+    return String.join(".", PACKAGE_NAME, moduleName, generatedClass.simpleClassName);
   }
 }

src/test/java/com/chrimle/example/GeneratedField.java

@@ -0,0 +1,32 @@
+package com.chrimle.example;
+
+import java.util.Optional;
+
+public record GeneratedField<T>(
+    String name, Class<T> type, boolean isNullable, Optional<T> defaultValue) {
+
+  public GeneratedField(String name, Class<T> type, boolean isNullable, T defaultValue) {
+    this(name, type, isNullable, Optional.ofNullable(defaultValue));
+  }
+
+  public GeneratedField(String name, Class<T> type, boolean isNullable) {
+    this(name, type, isNullable, Optional.empty());
+  }
+
+  public GeneratedField(String name, Class<T> type) {
+    this(name, type, false);
+  }
+
+  public static <T> GeneratedField<T> of(String name, Class<T> type) {
+    return new GeneratedField<>(name, type);
+  }
+
+  public static <T> GeneratedField<T> of(String name, Class<T> type, boolean isNullable) {
+    return new GeneratedField<>(name, type, isNullable);
+  }
+
+  public static <T> GeneratedField<T> of(
+      String name, Class<T> type, boolean isNullable, T defaultValue) {
+    return new GeneratedField<>(name, type, isNullable, defaultValue);
+  }
+}

src/test/java/com/chrimle/example/GeneratedSource.java

@@ -0,0 +1,67 @@
+package com.chrimle.example;
+
+import com.chrimle.example.utils.AssertionUtils;
+import java.util.Arrays;
+
+public class GeneratedSource {
+
+  private final Class<?> classUnderTest;
+  private final GeneratedField<?>[] generatedFields;
+  private final PluginExecution pluginExecution;
+  private final GeneratedClass generatedClass;
+
+  public GeneratedSource(
+      final PluginExecution pluginExecution,
+      final GeneratedClass generatedClass,
+      final GeneratedField<?>... generatedFields) {
+    this.pluginExecution = pluginExecution;
+    this.generatedClass = generatedClass;
+    this.generatedFields = generatedFields;
+    classUnderTest =
+        AssertionUtils.assertClassExists(generatedClass.getCanonicalClassName(pluginExecution));
+  }
+
+  public boolean generateBuilders() {
+    return pluginExecution.generateBuilders;
+  }
+
+  public boolean hasAdditionalEnumTypeAnnotations() {
+    return pluginExecution.hasAdditionalEnumTypeAnnotations;
+  }
+
+  public boolean hasAdditionalModelTypeAnnotations() {
+    return pluginExecution.hasAdditionalModelTypeAnnotations;
+  }
+
+  public boolean serializableModel() {
+    return pluginExecution.serializableModel;
+  }
+
+  public boolean useEnumCaseInsensitive() {
+    return pluginExecution.useEnumCaseInsensitive;
+  }
+
+  public boolean useJakartaEe() {
+    return pluginExecution.useJakartaEe;
+  }
+
+  public boolean isDeprecated() {
+    return generatedClass.isDeprecated;
+  }
+
+  public boolean isEnum() {
+    return generatedClass.isEnum;
+  }
+
+  public Class<?>[] fieldClasses() {
+    return Arrays.stream(generatedFields).map(GeneratedField::type).toArray(Class<?>[]::new);
+  }
+
+  public GeneratedField<?>[] generatedFields() {
+    return generatedFields;
+  }
+
+  public Class<?> getClassUnderTest() {
+    return classUnderTest;
+  }
+}

src/test/java/com/chrimle/example/PluginExecution.java

@@ -11,13 +11,13 @@ public enum PluginExecution {
   USE_ENUM_CASE_INSENSITIVE("useEnumCaseInsensitive", false, false, false, false, true, false),
   USE_JAKARTA_EE("useJakartaEe", false, false, false, false, false, true);
 
-  private final String packageName;
-  private final boolean generateBuilders;
-  private final boolean hasAdditionalEnumTypeAnnotations;
-  private final boolean hasAdditionalModelTypeAnnotations;
-  private final boolean serializableModel;
-  private final boolean useEnumCaseInsensitive;
-  private final boolean useJakartaEe;
+  public final String packageName;
+  public final boolean generateBuilders;
+  public final boolean hasAdditionalEnumTypeAnnotations;
+  public final boolean hasAdditionalModelTypeAnnotations;
+  public final boolean serializableModel;
+  public final boolean useEnumCaseInsensitive;
+  public final boolean useJakartaEe;
 
   PluginExecution(
       final String packageName,
@@ -26,7 +26,7 @@ public enum PluginExecution {
       final boolean hasAdditionalModelTypeAnnotations,
       final boolean serializableModel,
       final boolean useEnumCaseInsensitive,
-      boolean useJakartaEe) {
+      final boolean useJakartaEe) {
     this.packageName = packageName;
     this.hasAdditionalEnumTypeAnnotations = hasAdditionalEnumTypeAnnotations;
     this.hasAdditionalModelTypeAnnotations = hasAdditionalModelTypeAnnotations;
@@ -35,32 +35,4 @@ public enum PluginExecution {
     this.useEnumCaseInsensitive = useEnumCaseInsensitive;
     this.useJakartaEe = useJakartaEe;
   }
-
-  public String getPackageName() {
-    return packageName;
-  }
-
-  public boolean generateBuilders() {
-    return generateBuilders;
-  }
-
-  public boolean hasAdditionalEnumTypeAnnotations() {
-    return hasAdditionalEnumTypeAnnotations;
-  }
-
-  public boolean hasAdditionalModelTypeAnnotations() {
-    return hasAdditionalModelTypeAnnotations;
-  }
-
-  public boolean serializableModel() {
-    return serializableModel;
-  }
-
-  public boolean useEnumCaseInsensitive() {
-    return useEnumCaseInsensitive;
-  }
-
-  public boolean useJakartaEe() {
-    return useJakartaEe;
-  }
 }

src/test/java/com/chrimle/example/TestSuite.java

@@ -3,6 +3,9 @@
 import com.chrimle.example.utils.AssertionUtils;
 import com.chrimle.example.utils.GeneratedEnumTestUtils;
 import com.chrimle.example.utils.GeneratedRecordTestUtils;
+import java.math.BigDecimal;
+import java.util.List;
+import java.util.Set;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.EnumSource;
@@ -14,44 +17,63 @@ public class TestSuite {
   @DisplayName("Testing Plugin Executions...")
   public void testAll(final PluginExecution pluginExecution) {
     for (final GeneratedClass generatedClass : GeneratedClass.values()) {
-      assertModel(generatedClass, pluginExecution);
+
+      final GeneratedSource generatedSource =
+          getGeneratedSourceForGeneratedClass(generatedClass, pluginExecution);
+
+      if (generatedSource.isEnum()) {
+        GeneratedEnumTestUtils.assertEnumClass(generatedSource);
+      } else {
+        GeneratedRecordTestUtils.assertRecord(generatedSource);
+      }
     }
   }
 
-  private void assertModel(
+  private static GeneratedSource getGeneratedSourceForGeneratedClass(
       final GeneratedClass generatedClass, final PluginExecution pluginExecution) {
-
-    final Class<?> classUnderTest =
-        AssertionUtils.assertClassExists(getCanonicalClassName(pluginExecution, generatedClass));
-
-    switch (generatedClass) {
-      case EXAMPLE_ENUM ->
-          GeneratedEnumTestUtils.assertExampleEnum(pluginExecution, classUnderTest);
-      case EXAMPLE_RECORD ->
-          GeneratedRecordTestUtils.assertExampleRecord(pluginExecution, classUnderTest);
-      case DEPRECATED_EXAMPLE_ENUM ->
-          GeneratedEnumTestUtils.assertDeprecatedExampleEnum(pluginExecution, classUnderTest);
-      case DEPRECATED_EXAMPLE_RECORD ->
-          GeneratedRecordTestUtils.assertDeprecatedExampleRecord(pluginExecution, classUnderTest);
+    return switch (generatedClass) {
+      case DEPRECATED_EXAMPLE_ENUM, EXAMPLE_ENUM ->
+          new GeneratedSource(pluginExecution, generatedClass);
+      case DEPRECATED_EXAMPLE_RECORD, EXAMPLE_RECORD ->
+          new GeneratedSource(
+              pluginExecution, generatedClass, GeneratedField.of("field1", Boolean.class));
       case EXAMPLE_RECORD_WITH_DEFAULT_FIELDS ->
-          GeneratedRecordTestUtils.assertExampleRecordWithDefaultFields(
-              pluginExecution, classUnderTest);
-      case EXAMPLE_RECORD_WITH_REQUIRED_FIELDS_OF_EACH_TYPE ->
-          GeneratedRecordTestUtils.assertExampleRecordWithRequiredFieldsOfEachType(
+          new GeneratedSource(
               pluginExecution,
-              classUnderTest,
-              AssertionUtils.assertClassExists(
-                  getCanonicalClassName(pluginExecution, GeneratedClass.EXAMPLE_RECORD)),
-              AssertionUtils.assertClassExists(
-                  getCanonicalClassName(pluginExecution, GeneratedClass.EXAMPLE_ENUM)));
+              generatedClass,
+              GeneratedField.of("field1", String.class, false, "someDefaultValue"));
       case EXAMPLE_RECORD_WITH_NULLABLE_FIELDS_OF_EACH_TYPE ->
-          GeneratedRecordTestUtils.assertExampleRecordWithNullableFieldsOfEachType(
-              pluginExecution, classUnderTest);
-    }
+          new GeneratedSource(
+              pluginExecution,
+              generatedClass,
+              GeneratedField.of("field1", Boolean.class, true),
+              GeneratedField.of("field2", String.class, true),
+              GeneratedField.of("field3", Integer.class, true),
+              GeneratedField.of("field4", BigDecimal.class, true),
+              GeneratedField.of("field5", List.class, true),
+              GeneratedField.of("field6", Set.class, true));
+      case EXAMPLE_RECORD_WITH_REQUIRED_FIELDS_OF_EACH_TYPE ->
+          new GeneratedSource(
+              pluginExecution,
+              generatedClass,
+              GeneratedField.of("field1", Boolean.class),
+              GeneratedField.of("field2", String.class),
+              GeneratedField.of("field3", Integer.class),
+              GeneratedField.of("field4", BigDecimal.class),
+              GeneratedField.of("field5", List.class),
+              GeneratedField.of("field6", Set.class),
+              GeneratedField.of("field7", getExampleRecordClass(pluginExecution)),
+              GeneratedField.of("field8", getExampleEnumClass(pluginExecution)));
+    };
+  }
+
+  private static Class<?> getExampleEnumClass(PluginExecution pluginExecution) {
+    return AssertionUtils.assertClassExists(
+        GeneratedClass.EXAMPLE_ENUM.getCanonicalClassName(pluginExecution));
   }
 
-  private String getCanonicalClassName(
-      final PluginExecution pluginExecution, final GeneratedClass generatedClass) {
-    return generatedClass.getCanonicalClassName(pluginExecution.getPackageName());
+  private static Class<?> getExampleRecordClass(PluginExecution pluginExecution) {
+    return AssertionUtils.assertClassExists(
+        GeneratedClass.EXAMPLE_RECORD.getCanonicalClassName(pluginExecution));
   }
 }