feat: Support Jakarta @AssertTrue/@assertfalse annotations (#457)

* feat: Populate enum/const from Jakarta AssertTrue/AssertFalse annotations (#456) * chore(docs): update changelog and bump version number --------- Co-authored-by: Jeffrey D <[email protected]>
victools · Jul 13, 2024 · 91cf55f · 91cf55f
1 parent 9bc8a89
commit 91cf55f
Show file tree

Hide file tree

Showing 19 changed files with 153 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,8 +5,9 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-
--
+### `jsonschema-module-jakarta-validation`
+#### Added
+- populate `const`/`enum` based on `@AssertTrue`/`@AssertFalse`
 
 ## [4.35.0] - 2024-03-29
 ### `jsonschema-generator`

diff --git a/jsonschema-examples/pom.xml b/jsonschema-examples/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.github.victools</groupId>
         <artifactId>jsonschema-generator-parent</artifactId>
-        <version>4.35.1-SNAPSHOT</version>
+        <version>4.36.0-SNAPSHOT</version>
         <relativePath>../jsonschema-generator-parent/pom.xml</relativePath>
     </parent>
     <artifactId>jsonschema-examples</artifactId>

diff --git a/jsonschema-generator-bom/pom.xml b/jsonschema-generator-bom/pom.xml
@@ -8,7 +8,7 @@
 
     <groupId>com.github.victools</groupId>
     <artifactId>jsonschema-generator-bom</artifactId>
-    <version>4.35.1-SNAPSHOT</version>
+    <version>4.36.0-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <properties>

diff --git a/jsonschema-generator-parent/pom.xml b/jsonschema-generator-parent/pom.xml
@@ -4,14 +4,14 @@
     <parent>
         <groupId>com.github.victools</groupId>
         <artifactId>jsonschema-generator-bom</artifactId>
-        <version>4.35.1-SNAPSHOT</version>
+        <version>4.36.0-SNAPSHOT</version>
         <relativePath>../jsonschema-generator-bom/pom.xml</relativePath>
     </parent>
     <artifactId>jsonschema-generator-parent</artifactId>
     <packaging>pom</packaging>
 
     <name>Java JSON Schema Generator (Parent)</name>
-    <description>Java JSON Schema Generator + Modules – creating a JSON Schema from your Java classes</description>
+    <description>Java JSON Schema Generator + Modules - creating a JSON Schema from your Java classes</description>
     <url>https://github.com/victools/jsonschema-generator</url>
 
     <licenses>
@@ -126,6 +126,7 @@
             <url>https://github.com/Nephery</url>
             <roles>
                 <role>Provided PR #435 (fixing Jackson JsonUnwrapped annotation on inherited properties)</role>
+                <role>Provided PR #456 (introducing support for Jakarta @AssertTrue/@AssertFalse)</role>
             </roles>
         </contributor>
     </contributors>

diff --git a/jsonschema-generator/pom.xml b/jsonschema-generator/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.github.victools</groupId>
         <artifactId>jsonschema-generator-parent</artifactId>
-        <version>4.35.1-SNAPSHOT</version>
+        <version>4.36.0-SNAPSHOT</version>
         <relativePath>../jsonschema-generator-parent/pom.xml</relativePath>
     </parent>
     <artifactId>jsonschema-generator</artifactId>

diff --git a/...rator/src/main/java/com/github/victools/jsonschema/generator/impl/AttributeCollector.java b/...rator/src/main/java/com/github/victools/jsonschema/generator/impl/AttributeCollector.java
@@ -435,6 +435,7 @@ private boolean isSupportedEnumValue(Object target) {
         }
         Class<?> targetType = target.getClass();
         return targetType.isPrimitive()
+                || Boolean.class.isAssignableFrom(targetType)
                 || Number.class.isAssignableFrom(targetType)
                 || CharSequence.class.isAssignableFrom(targetType)
                 || Enum.class.isAssignableFrom(targetType);

diff --git a/jsonschema-maven-plugin/pom.xml b/jsonschema-maven-plugin/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>com.github.victools</groupId>
         <artifactId>jsonschema-generator-parent</artifactId>
-        <version>4.35.1-SNAPSHOT</version>
+        <version>4.36.0-SNAPSHOT</version>
         <relativePath>../jsonschema-generator-parent/pom.xml</relativePath>
     </parent>
     <artifactId>jsonschema-maven-plugin</artifactId>

diff --git a/jsonschema-module-jackson/pom.xml b/jsonschema-module-jackson/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.github.victools</groupId>
         <artifactId>jsonschema-generator-parent</artifactId>
-        <version>4.35.1-SNAPSHOT</version>
+        <version>4.36.0-SNAPSHOT</version>
         <relativePath>../jsonschema-generator-parent/pom.xml</relativePath>
     </parent>
     <artifactId>jsonschema-module-jackson</artifactId>

diff --git a/jsonschema-module-jakarta-validation/README.md b/jsonschema-module-jakarta-validation/README.md
@@ -13,6 +13,7 @@ Module for the [jsonschema-generator](../jsonschema-generator) – deriving JSON
 7. Populate "pattern" for strings. Based on `@Pattern`/`@Email`, when corresponding `JakartaValidationOption.INCLUDE_PATTERN_EXPRESSIONS` is being provided in constructor.
 8. Populate "minimum"/"exclusiveMinimum" for numbers. Based on `@Min`/`@DecimalMin`/`@Positive`/`@PositiveOrZero`.
 9. Populate "maximum"/"exclusiveMaximum" for numbers. Based on `@Max`/`@DecimalMax`/`@Negative`/`@NegativeOrZero`.
+10. Populate "enum"/"const" for booleans. Based on `@AssertTrue`/`@AssertFalse`.
 
 Schema attributes derived from validation annotations on fields are also applied to their respective getter methods.  
 Schema attributes derived from validation annotations on getter methods are also applied to their associated fields.

diff --git a/jsonschema-module-jakarta-validation/pom.xml b/jsonschema-module-jakarta-validation/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.github.victools</groupId>
         <artifactId>jsonschema-generator-parent</artifactId>
-        <version>4.35.1-SNAPSHOT</version>
+        <version>4.36.0-SNAPSHOT</version>
         <relativePath>../jsonschema-generator-parent/pom.xml</relativePath>
     </parent>
     <artifactId>jsonschema-module-jakarta-validation</artifactId>

diff --git a/...ava/com/github/victools/jsonschema/module/jakarta/validation/JakartaValidationModule.java b/...ava/com/github/victools/jsonschema/module/jakarta/validation/JakartaValidationModule.java
@@ -28,6 +28,8 @@
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart;
 import com.github.victools.jsonschema.generator.SchemaKeyword;
 import jakarta.validation.Constraint;
+import jakarta.validation.constraints.AssertFalse;
+import jakarta.validation.constraints.AssertTrue;
 import jakarta.validation.constraints.DecimalMax;
 import jakarta.validation.constraints.DecimalMin;
 import jakarta.validation.constraints.Email;
@@ -45,12 +47,13 @@
 import jakarta.validation.constraints.Size;
 import java.lang.annotation.Annotation;
 import java.math.BigDecimal;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
-import java.util.function.BiPredicate;
 import java.util.function.Function;
 import java.util.function.Predicate;
 import java.util.function.ToIntBiFunction;
@@ -116,8 +119,9 @@ public void applyToConfigBuilder(SchemaGeneratorConfigBuilder builder) {
         if (this.options.contains(JakartaValidationOption.NOT_NULLABLE_METHOD_IS_REQUIRED)) {
             methodConfigPart.withRequiredCheck(this::isRequired);
         }
-        Stream.of(DecimalMax.class, DecimalMin.class, Email.class, Max.class, Min.class, Negative.class, NegativeOrZero.class,
-                        NotBlank.class, NotEmpty.class, Null.class, NotNull.class, Pattern.class, Positive.class, PositiveOrZero.class, Size.class)
+        Stream.of(AssertFalse.class, AssertTrue.class, DecimalMax.class, DecimalMin.class, Email.class, Max.class, Min.class,
+                        Negative.class, NegativeOrZero.class, NotBlank.class, NotEmpty.class, Null.class, NotNull.class,
+                        Pattern.class, Positive.class, PositiveOrZero.class, Size.class)
                 .forEach(annotationType -> builder.withAnnotationInclusionOverride(annotationType, AnnotationInclusion.INCLUDE_AND_INHERIT));
     }
 
@@ -137,6 +141,7 @@ private void applyToConfigPart(SchemaGeneratorConfigPart<?> configPart) {
         configPart.withNumberExclusiveMinimumResolver(this::resolveNumberExclusiveMinimum);
         configPart.withNumberInclusiveMaximumResolver(this::resolveNumberInclusiveMaximum);
         configPart.withNumberExclusiveMaximumResolver(this::resolveNumberExclusiveMaximum);
+        configPart.withEnumResolver(this::resolveEnum);
         configPart.withInstanceAttributeOverride(this::overrideInstanceAttributes);
 
         if (this.options.contains(JakartaValidationOption.INCLUDE_PATTERN_EXPRESSIONS)) {
@@ -499,6 +504,28 @@ protected BigDecimal resolveNumberExclusiveMaximum(MemberScope<?, ?> member) {
         return null;
     }
 
+    /**
+     * Look-up the finite list of possible values.
+     *
+     * @param member field/method to determine allowed values for
+     * @return applicable "const"/"enum" values or null
+     *
+     * @since 4.36.0
+     * @see AssertTrue
+     * @see AssertFalse
+     */
+    protected List<Object> resolveEnum(MemberScope<?, ?> member) {
+        List<Object> values;
+        if (this.getAnnotationFromFieldOrGetter(member, AssertTrue.class, AssertTrue::groups) != null) {
+            values = Collections.singletonList(true);
+        } else if (this.getAnnotationFromFieldOrGetter(member, AssertFalse.class, AssertFalse::groups) != null) {
+            values = Collections.singletonList(false);
+        } else {
+            values = null;
+        }
+        return values;
+    }
+
     /**
      * Implementation of the functional {@code InstanceAttributeOverrideV2} interface.
      *

diff --git a/...c/test/java/com/github/victools/jsonschema/module/jakarta/validation/IntegrationTest.java b/...c/test/java/com/github/victools/jsonschema/module/jakarta/validation/IntegrationTest.java
@@ -24,6 +24,8 @@
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
 import com.github.victools.jsonschema.generator.SchemaVersion;
 import jakarta.validation.Constraint;
+import jakarta.validation.constraints.AssertFalse;
+import jakarta.validation.constraints.AssertTrue;
 import jakarta.validation.constraints.DecimalMax;
 import jakarta.validation.constraints.DecimalMin;
 import jakarta.validation.constraints.Email;
@@ -134,6 +136,11 @@ static class TestClass {
         @DecimalMin(value = "0", inclusive = false)
         @DecimalMax(value = "1", inclusive = false)
         public double exclusiveRangeDouble;
+
+        @AssertTrue
+        public boolean trueBoolean;
+        @AssertFalse
+        public boolean falseBoolean;
     }
 
     static class Book implements Publication {

diff --git a/...com/github/victools/jsonschema/module/jakarta/validation/JakartaValidationModuleTest.java b/...com/github/victools/jsonschema/module/jakarta/validation/JakartaValidationModuleTest.java
@@ -23,6 +23,8 @@
 import com.github.victools.jsonschema.generator.MethodScope;
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfigBuilder;
 import com.github.victools.jsonschema.generator.SchemaGeneratorConfigPart;
+import jakarta.validation.constraints.AssertFalse;
+import jakarta.validation.constraints.AssertTrue;
 import jakarta.validation.constraints.DecimalMax;
 import jakarta.validation.constraints.DecimalMin;
 import jakarta.validation.constraints.Email;
@@ -40,6 +42,8 @@
 import jakarta.validation.constraints.Size;
 import java.math.BigDecimal;
 import java.math.BigInteger;
+import java.util.Arrays;
+import java.util.Collection;
 import java.util.List;
 import java.util.Set;
 import java.util.stream.Stream;
@@ -146,6 +150,7 @@ private void verifyCommonConfigurations() {
         Mockito.verify(this.fieldConfigPart).withNumberExclusiveMinimumResolver(Mockito.any());
         Mockito.verify(this.fieldConfigPart).withNumberInclusiveMaximumResolver(Mockito.any());
         Mockito.verify(this.fieldConfigPart).withNumberExclusiveMaximumResolver(Mockito.any());
+        Mockito.verify(this.fieldConfigPart).withEnumResolver(Mockito.any());
         Mockito.verify(this.fieldConfigPart).withInstanceAttributeOverride(Mockito.any(InstanceAttributeOverrideV2.class));
 
         Mockito.verify(this.methodConfigPart).withNullableCheck(Mockito.any());
@@ -158,9 +163,10 @@ private void verifyCommonConfigurations() {
         Mockito.verify(this.methodConfigPart).withNumberExclusiveMinimumResolver(Mockito.any());
         Mockito.verify(this.methodConfigPart).withNumberInclusiveMaximumResolver(Mockito.any());
         Mockito.verify(this.methodConfigPart).withNumberExclusiveMaximumResolver(Mockito.any());
+        Mockito.verify(this.methodConfigPart).withEnumResolver(Mockito.any());
         Mockito.verify(this.methodConfigPart).withInstanceAttributeOverride(Mockito.any(InstanceAttributeOverrideV2.class));
 
-        Mockito.verify(this.configBuilder, Mockito.times(15))
+        Mockito.verify(this.configBuilder, Mockito.times(17))
                 .withAnnotationInclusionOverride(Mockito.any(), Mockito.eq(AnnotationInclusion.INCLUDE_AND_INHERIT));
     }
 
@@ -533,6 +539,58 @@ private void testNumberMinMaxResolvers(String fieldName, BigDecimal expectedMinI
         Assertions.assertEquals(expectedMaxExclusive, maxExclusive);
     }
 
+    static Stream<Arguments> parametersForTestEnumResolvers() {
+        return Stream.of(
+                Arguments.of("unannotatedBoolean", new Object[]{}),
+                Arguments.of("trueBoolean", new Object[]{true}),
+                Arguments.of("trueOnGetterBoolean", new Object[]{true}),
+                Arguments.of("falseBoolean", new Object[]{false}),
+                Arguments.of("falseOnGetterBoolean", new Object[]{false}),
+                // it's deemed invalid to have both @AssertTrue and @AssertFalse simultaneously
+                Arguments.of("trueAndFalseBoolean", new Object[]{true}),
+                Arguments.of("trueAndFalseOnGetterBoolean", new Object[]{true})
+        );
+    }
+
+    @ParameterizedTest
+    @MethodSource("parametersForTestEnumResolvers")
+    public void testEnumResolversNoValidationGroup(String fieldName, Object[] expectedValues) {
+        new JakartaValidationModule().applyToConfigBuilder(this.configBuilder);
+
+        this.testEnumResolvers(fieldName, expectedValues);
+    }
+
+    @ParameterizedTest
+    @MethodSource("parametersForTestEnumResolvers")
+    public void testEnumResolversMatchingValidationGroup(String fieldName, Object[] expectedValues) {
+        new JakartaValidationModule()
+                .forValidationGroups(Test.class)
+                .applyToConfigBuilder(this.configBuilder);
+
+        this.testEnumResolvers(fieldName, expectedValues);
+    }
+
+    @ParameterizedTest
+    @MethodSource("parametersForTestEnumResolvers")
+    public void testEnumResolversDifferentValidationGroup(String fieldName, Object[] ignoredExpectedValues) {
+        new JakartaValidationModule()
+                .forValidationGroups(Object.class)
+                .applyToConfigBuilder(this.configBuilder);
+
+        // none of the annotated values are actually expected to be returned
+        this.testEnumResolvers(fieldName);
+    }
+
+    private void testEnumResolvers(String fieldName, Object... values) {
+        TestType testType = new TestType(TestClassForEnums.class);
+        FieldScope field = testType.getMemberField(fieldName);
+
+        ArgumentCaptor<ConfigFunction<FieldScope, Collection<?>>> enumCaptor = ArgumentCaptor.forClass(ConfigFunction.class);
+        Mockito.verify(this.fieldConfigPart).withEnumResolver(enumCaptor.capture());
+        Collection<?> enumValues = enumCaptor.getValue().apply(field);
+        Assertions.assertEquals(values.length > 0 ? Arrays.asList(values) : null, enumValues);
+    }
+
     static Stream<Arguments> parametersForTestValidationGroupSetting() {
         return Stream.of(
             Arguments.of("skippedConfiguringGroups", "fieldWithoutValidationGroup", Boolean.TRUE, null),
@@ -818,6 +876,36 @@ public Long getNegativeOrZeroOnGetterLong() {
         }
     }
 
+    private static class TestClassForEnums {
+        boolean unannotatedBoolean;
+        @AssertTrue(groups = Test.class)
+        boolean trueBoolean;
+        boolean trueOnGetterBoolean;
+        @AssertFalse(groups = Test.class)
+        boolean falseBoolean;
+        boolean falseOnGetterBoolean;
+        @AssertTrue(groups = Test.class)
+        @AssertFalse(groups = Test.class)
+        boolean trueAndFalseBoolean;
+        boolean trueAndFalseOnGetterBoolean;
+
+        @AssertTrue(groups = Test.class)
+        public boolean isTrueOnGetterBoolean() {
+            return trueOnGetterBoolean;
+        }
+
+        @AssertFalse(groups = Test.class)
+        public boolean isFalseOnGetterBoolean() {
+            return falseOnGetterBoolean;
+        }
+
+        @AssertTrue(groups = Test.class)
+        @AssertFalse(groups = Test.class)
+        public boolean isTrueAndFalseOnGetterBoolean() {
+            return trueAndFalseOnGetterBoolean;
+        }
+    }
+
     private static class TestClassForValidationGroups {
 
         @Null

diff --git a/...ces/com/github/victools/jsonschema/module/jakarta/validation/integration-test-result.json b/...ces/com/github/victools/jsonschema/module/jakarta/validation/integration-test-result.json
@@ -7,6 +7,10 @@
             "exclusiveMinimum": 0,
             "exclusiveMaximum": 1
         },
+        "falseBoolean": {
+            "type": "boolean",
+            "const": false
+        },
         "inclusiveRangeInt": {
             "type": "integer",
             "minimum": 7,
@@ -113,6 +117,10 @@
             "type": "string",
             "minLength": 5,
             "maxLength": 12
+        },
+        "trueBoolean": {
+            "type": "boolean",
+            "const": true
         }
     },
     "required": ["notBlankText", "notEmptyList", "notEmptyMap", "notEmptyPatternText", "notNullEmail", "notNullList"]

diff --git a/jsonschema-module-javax-validation/pom.xml b/jsonschema-module-javax-validation/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.github.victools</groupId>
         <artifactId>jsonschema-generator-parent</artifactId>
-        <version>4.35.1-SNAPSHOT</version>
+        <version>4.36.0-SNAPSHOT</version>
         <relativePath>../jsonschema-generator-parent/pom.xml</relativePath>
     </parent>
     <artifactId>jsonschema-module-javax-validation</artifactId>

diff --git a/jsonschema-module-swagger-1.5/pom.xml b/jsonschema-module-swagger-1.5/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.github.victools</groupId>
         <artifactId>jsonschema-generator-parent</artifactId>
-        <version>4.35.1-SNAPSHOT</version>
+        <version>4.36.0-SNAPSHOT</version>
         <relativePath>../jsonschema-generator-parent/pom.xml</relativePath>
     </parent>
     <artifactId>jsonschema-module-swagger-1.5</artifactId>

diff --git a/jsonschema-module-swagger-2/pom.xml b/jsonschema-module-swagger-2/pom.xml
@@ -5,7 +5,7 @@
     <parent>
         <groupId>com.github.victools</groupId>
         <artifactId>jsonschema-generator-parent</artifactId>
-        <version>4.35.1-SNAPSHOT</version>
+        <version>4.36.0-SNAPSHOT</version>
         <relativePath>../jsonschema-generator-parent/pom.xml</relativePath>
     </parent>
     <artifactId>jsonschema-module-swagger-2</artifactId>

diff --git a/pom.xml b/pom.xml
@@ -3,7 +3,7 @@
 
     <groupId>com.github.victools</groupId>
     <artifactId>jsonschema-generator-reactor</artifactId>
-    <version>4.35.1-SNAPSHOT</version>
+    <version>4.36.0-SNAPSHOT</version>
     <packaging>pom</packaging>
 
     <name>Java JSON Schema Generator (Reactor)</name>