Fix incorrect usage of JsonIgnoreProperties for discriminator field (issue 601)

boat-scaffold/pom.xml

@@ -21,6 +21,9 @@
         </sonar.coverage.jacoco.xmlReportPaths>
         <sonar.dynamicAnalysis>reuseReports</sonar.dynamicAnalysis>
         <sonar.jacoco.itReportPath>${project.basedir}/target/jacoco-it.exec</sonar.jacoco.itReportPath>
+        <embedded.maven.version>3.9.4</embedded.maven.version>
+        <maven.resolver.version>1.9.15</maven.resolver.version>
+        <maven.wagon.version>3.5.3</maven.wagon.version>
     </properties>
 
     <dependencies>
@@ -108,6 +111,47 @@
             <version>2.6</version>
             <scope>compile</scope>
         </dependency>
+        <dependency>
+            <groupId>org.apache.maven</groupId>
+            <artifactId>maven-embedder</artifactId>
+            <version>${embedded.maven.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.maven</groupId>
+            <artifactId>maven-compat</artifactId>
+            <version>${embedded.maven.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.codehaus.plexus</groupId>
+            <artifactId>plexus-utils</artifactId>
+            <version>3.5.1</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.maven.wagon</groupId>
+            <artifactId>wagon-provider-api</artifactId>
+            <version>${maven.wagon.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.maven.wagon</groupId>
+            <artifactId>wagon-http</artifactId>
+            <version>${maven.wagon.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.maven.resolver</groupId>
+            <artifactId>maven-resolver-connector-basic</artifactId>
+            <version>${maven.resolver.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.maven.resolver</groupId>
+            <artifactId>maven-resolver-transport-http</artifactId>
+            <version>${maven.resolver.version}</version>
+        </dependency>
     </dependencies>
 
     <build>

boat-scaffold/src/main/templates/boat-java/typeInfoAnnotation.mustache

@@ -2,6 +2,7 @@
 
 @JsonIgnoreProperties(
   value = "{{{discriminator.propertyBaseName}}}", // ignore manually set {{{discriminator.propertyBaseName}}}, it will be automatically generated by Jackson during serialization
+  allowGetters = true, // allows the {{{discriminator.propertyBaseName}}} to be set during serialization
   allowSetters = true // allows the {{{discriminator.propertyBaseName}}} to be set during deserialization
 )
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "{{{discriminator.propertyBaseName}}}", visible = true)

boat-scaffold/src/main/templates/boat-spring/typeInfoAnnotation.mustache

@@ -3,6 +3,7 @@
 {{#-first}}
 @JsonIgnoreProperties(
   value = "{{{discriminator.propertyBaseName}}}", // ignore manually set {{{discriminator.propertyBaseName}}}, it will be automatically generated by Jackson during serialization
+  allowGetters = true, // allows the {{{discriminator.propertyBaseName}}} to be set during serialization
   allowSetters = true // allows the {{{discriminator.propertyBaseName}}} to be set during deserialization
 )
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "{{{discriminator.propertyBaseName}}}", visible = true)

boat-scaffold/src/test/java/com/backbase/oss/codegen/java/BoatSpringTemplatesTests.java

@@ -2,40 +2,55 @@
 
 import static java.util.Arrays.asList;
 import static java.util.Arrays.stream;
+import static java.util.stream.Collectors.joining;
+import static java.util.stream.Collectors.toList;
+import static java.util.stream.Stream.concat;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
 import static org.hamcrest.Matchers.hasSize;
 import static org.hamcrest.Matchers.is;
 import static org.hamcrest.Matchers.not;
 import static org.hamcrest.Matchers.nullValue;
-import static org.junit.jupiter.api.DynamicContainer.*;
-import static org.junit.jupiter.api.DynamicTest.*;
-import static java.util.stream.Collectors.joining;
-import static java.util.stream.Collectors.toList;
-import static java.util.stream.Stream.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.DynamicContainer.dynamicContainer;
+import static org.junit.jupiter.api.DynamicTest.dynamicTest;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.type.ArrayType;
+import com.fasterxml.jackson.databind.type.TypeBindings;
+import com.fasterxml.jackson.databind.type.TypeFactory;
+import com.google.common.base.CaseFormat;
 import java.io.File;
 import java.io.IOException;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import java.lang.reflect.Constructor;
 import java.lang.reflect.Method;
+import java.net.URL;
+import java.net.URLClassLoader;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.List;
+import java.util.concurrent.atomic.AtomicReference;
 import java.util.function.Predicate;
 import java.util.regex.Pattern;
 import java.util.stream.IntStream;
 import java.util.stream.Stream;
-
 import lombok.SneakyThrows;
 import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.io.FileUtils;
+import org.apache.maven.cli.MavenCli;
+import org.codehaus.plexus.classworlds.ClassWorld;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.DynamicNode;
 import org.junit.jupiter.api.DynamicTest;
 import org.junit.jupiter.api.TestFactory;
+import org.junit.platform.commons.util.StringUtils;
 import org.openapitools.codegen.ClientOptInput;
 import org.openapitools.codegen.CodegenConstants;
 import org.openapitools.codegen.DefaultGenerator;
@@ -60,6 +75,9 @@
  */
 @Slf4j
 class BoatSpringTemplatesTests {
+    private static final File GH_ACTIONS_M2_SETTINGS_FILE = new File("/home/runner/.m2/settings.xml");
+    private static final File GH_ACTIONS_M2_REPOSITORY_DIR = new File("/home/runner/.m2/repository");
+    private static File M2_REPOSITORY_DIR_IN_USE;
     static final String PROP_BASE = BoatSpringTemplatesTests.class.getSimpleName() + ".";
     static final boolean PROP_FAST = Boolean.parseBoolean(System.getProperty(PROP_BASE + "fast", "true"));
     static final String TEST_OUTPUT = System.getProperty(PROP_BASE + "output", "target/boat-spring-templates-tests");
@@ -68,6 +86,20 @@ class BoatSpringTemplatesTests {
     static public void setUpClass() throws IOException {
         Files.createDirectories(Paths.get(TEST_OUTPUT));
         FileUtils.deleteDirectory(new File(TEST_OUTPUT, "src"));
+
+        File userHome = new File(System.getProperty("user.home"));
+        File userDefaultRepoLocation = new File(userHome, ".m2" + File.separatorChar + "repository");
+        if (GH_ACTIONS_M2_REPOSITORY_DIR.exists()) {
+            M2_REPOSITORY_DIR_IN_USE = GH_ACTIONS_M2_REPOSITORY_DIR;
+        } else if (userDefaultRepoLocation.exists()) {
+            M2_REPOSITORY_DIR_IN_USE = userDefaultRepoLocation;
+        } else {
+            File tempRepo = Files.createTempDirectory(
+                BoatSpringTemplatesTests.class.getSimpleName() + "_mvn_repo").toFile();
+            log.warn("m2 repo not found in paths: {}, {}. Using temp repo in {} which may slow down test execution",
+                GH_ACTIONS_M2_REPOSITORY_DIR, userDefaultRepoLocation, tempRepo);
+            M2_REPOSITORY_DIR_IN_USE = tempRepo;
+        }
     }
 
     static class Combination {
@@ -222,6 +254,116 @@ void useWithModifiers() {
             equalTo(this.param.useWithModifiers));
     }
 
+    @Check
+    void checkCompiles() throws Exception {
+        final var projectDir = new File(TEST_OUTPUT, param.name);
+        assertThat(projectDir + " is not a directory", projectDir.isDirectory());
+        compileGeneratedProject(projectDir);
+        verifyGeneratedClasses(projectDir);
+    }
+
+    private static void compileGeneratedProject(File projectDir) {
+        var mavenCli = new MavenCli(new ClassWorld("myRealm", BoatSpringTemplatesTests.class.getClassLoader()));
+        final String initialDir = System.getProperty(MavenCli.MULTIMODULE_PROJECT_DIRECTORY);
+        try {
+            System.setProperty(MavenCli.MULTIMODULE_PROJECT_DIRECTORY, projectDir.getAbsolutePath());
+            String[] args = generateMavenCliArgs();
+            log.info("mvn cli args: {}", Arrays.toString(args));
+            int compileStatus = mavenCli.doMain(args, projectDir.getAbsolutePath(), System.out, System.out);
+            assertEquals(0, compileStatus, "Could not compile generated project in dir: " + projectDir);
+        } finally {
+            if (StringUtils.isBlank(initialDir)) {
+                System.clearProperty(MavenCli.MULTIMODULE_PROJECT_DIRECTORY);
+            } else {
+                System.setProperty(MavenCli.MULTIMODULE_PROJECT_DIRECTORY, initialDir);
+            }
+        }
+    }
+
+    private static String[] generateMavenCliArgs() {
+        List<String> args = new ArrayList<>();
+        if (GH_ACTIONS_M2_SETTINGS_FILE.exists()) {
+            args.add("--settings");
+            args.add(GH_ACTIONS_M2_SETTINGS_FILE.getAbsolutePath());
+        }
+        args.add("-Dmaven.repo.local=" + M2_REPOSITORY_DIR_IN_USE.getAbsolutePath());
+        args.add("clean");
+        args.add("compile");
+        return args.stream().toArray(String[]::new);
+    }
+
+    private void verifyGeneratedClasses(File projectDir) throws Exception {
+        var classesDir = new File(projectDir, "target/classes");
+        var classLoader = URLClassLoader.newInstance(
+            new URL[]{classesDir.toURI().toURL()},
+            BoatSpringTemplatesTests.class.getClassLoader()
+        );
+        String testedModelClassName = buildTestedModelClassName();
+        verifyModelClassSerializesAndDeserializesFromJson(classLoader, testedModelClassName);
+    }
+
+    private void verifyModelClassSerializesAndDeserializesFromJson(ClassLoader classLoader,
+        String testedModelClassName) throws InterruptedException {
+        var objectMapper = new ObjectMapper();
+        final AtomicReference<Exception> exceptionRef = new AtomicReference<>();
+        Runnable verification = () -> {
+            try {
+                Class<?> modelClass = classLoader.loadClass(testedModelClassName);
+                Constructor<?> constructor = modelClass.getConstructor(String.class, String.class, String.class);
+                Object modelObject1 = constructor.newInstance("OK_status", "ref123", "EUR");
+                Object modelObject2 = constructor.newInstance("BAD_status", "ref456", "USD");
+
+                // serialize and deserialize list
+                List<?> modelObjects = List.of(modelObject1, modelObject2);
+                String serializedObjects = objectMapper.writeValueAsString(modelObjects);
+                Object[] deserializedModelObjects = objectMapper.readValue(
+                    serializedObjects,
+                    ArrayType.construct(
+                        TypeFactory.defaultInstance().constructFromCanonical(modelClass.getName()),
+                        TypeBindings.emptyBindings()
+                    )
+                );
+                assertEquals(modelObjects.size(), deserializedModelObjects.length);
+                assertEquals(modelObject1.getClass(), deserializedModelObjects[0].getClass());
+
+                // serialize and deserialize single object
+                String serializedObject1 = objectMapper.writeValueAsString(modelObject1);
+                Object deserializedObject1 = objectMapper.readValue(serializedObject1, modelClass);
+                assertEquals(modelClass, deserializedObject1.getClass());
+
+            } catch (Exception e) {
+                log.warn("Verification error", e);
+                exceptionRef.set(e);
+            }
+        };
+
+        runVerification(verification, classLoader).join();
+        assertNull(exceptionRef.get(), "Classes verification failed");
+    }
+
+    /**
+     * Build proper class name for `ReceivableRequest`.
+     */
+    private String buildTestedModelClassName() {
+        var modelPackage = param.name.replace('-', '.') + ".model";
+        var classNameSuffix = org.apache.commons.lang3.StringUtils.capitalize(
+            param.name.indexOf('-') > -1
+                ? CaseFormat.LOWER_HYPHEN.to(CaseFormat.LOWER_CAMEL, param.name)
+                : param.name
+        );
+        return modelPackage + ".ReceivableRequest" + classNameSuffix;
+    }
+
+    private Thread runVerification(Runnable verification, ClassLoader classLoader) {
+        var verificationThread = new Thread(verification);
+        verificationThread.setName("verify-classes-" + param.name);
+        verificationThread.setContextClassLoader(classLoader);
+        verificationThread.setUncaughtExceptionHandler(
+            (t1, e) -> log.error("Uncaught exception in classes verifier: ", e));
+        verificationThread.start();
+        return verificationThread;
+    }
+
     private boolean findPattern(String filePattern, String linePattern) {
         final Predicate<String> fileMatch = Pattern.compile(filePattern).asPredicate();
         log.info("Files: {}", files);

boat-scaffold/src/test/resources/boat-spring/openapi.yaml

@@ -69,4 +69,32 @@ components:
           format: date-time
           x-java-type: java.time.OffsetDateTime
       x-java-type: com.backbase.integration.transaction.external.rest.spec.v2.transactions.TransactionsPatchRequestBody
-
+    ReceivableRequest:
+      allOf:
+        - $ref: '#/components/schemas/PaymentRequest'
+        - required:
+            - status
+            - currencyCode
+            - referenceNumber
+          type: object
+          properties:
+            status:
+              type: string
+              description: Status of the request
+            paymentRequestType:
+              type: string
+              default: ReceivableRequest
+    PaymentRequest:
+      required:
+        - currencyCode
+        - referenceNumber
+      type: object
+      discriminator:
+        propertyName: paymentRequestType
+      properties:
+        referenceNumber:
+          type: string
+          description: Reference number
+        currencyCode:
+          type: string
+          description: Currency of the payment request