Java, adds dependentRequired (#363)

spacether · web-flow · commit 7316f8997661 · 2024-01-16T21:41:27.000Z
* 310 regen with partial dependentRequired

* Fixes java 310 tests

* Samples regen
diff --git a/docs/generators/java.md b/docs/generators/java.md
@@ -279,7 +279,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |Const|✓|OAS3
 |Contains|✓|OAS3
 |Default|✓|OAS2,OAS3
-|DependentRequired|✗|OAS3
+|DependentRequired|✓|OAS3
 |DependentSchemas|✗|OAS3
 |Discriminator|✗|OAS2,OAS3
 |Else|✗|OAS3
diff --git a/samples/client/3_0_3_unit_test/java/.openapi-generator/FILES b/samples/client/3_0_3_unit_test/java/.openapi-generator/FILES
@@ -213,6 +213,7 @@ src/main/java/org/openapijsonschematools/client/schemas/validation/ConstValidato
 src/main/java/org/openapijsonschematools/client/schemas/validation/ContainsValidator.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/CustomIsoparser.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/DefaultValueMethod.java
+src/main/java/org/openapijsonschematools/client/schemas/validation/DependentRequiredValidator.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/DoubleEnumValidator.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/DoubleValueMethod.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/EnumValidator.java
diff --git a/samples/client/3_0_3_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/DependentRequiredValidator.java b/samples/client/3_0_3_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/DependentRequiredValidator.java
@@ -0,0 +1,48 @@
+package org.openapijsonschematools.client.schemas.validation;
+
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.openapijsonschematools.client.exceptions.ValidationException;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+public class DependentRequiredValidator implements KeywordValidator {
+    public final Map<String, Set<String>> dependentRequired;
+
+    public DependentRequiredValidator(Map<String, Set<String>> dependentRequired) {
+        this.dependentRequired = dependentRequired;
+    }
+
+    @Override
+    public @Nullable PathToSchemasMap validate(
+        JsonSchema schema,
+        @Nullable Object arg,
+        ValidationMetadata validationMetadata,
+        @Nullable List<PathToSchemasMap> containsPathToSchemas
+    ) {
+        if (!(arg instanceof Map)) {
+            return null;
+        }
+        for (Map.Entry<String, Set<String>> entry: dependentRequired.entrySet()) {
+            if (!((Map<?, ?>) arg).containsKey(entry.getKey())) {
+                continue;
+            }
+            Set<String> missingKeys = new HashSet<>(entry.getValue());
+            for (Object objKey: ((Map<?, ?>) arg).keySet()) {
+                if (objKey instanceof String key) {
+                    missingKeys.remove(key);
+                }
+            }
+            if (missingKeys.isEmpty()) {
+                continue;
+            }
+            throw new ValidationException(
+                    "Validation failed for dependentRequired because these_keys="+missingKeys+" are "+
+                    "missing at pathToItem="+validationMetadata.pathToItem()+" in class "+schema.getClass()
+            );
+        }
+        return null;
+    }
+}
diff --git a/samples/client/3_0_3_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchema.java b/samples/client/3_0_3_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchema.java
@@ -50,6 +50,7 @@ public abstract class JsonSchema {
     public final @Nullable Integer maxContains;
     public final @Nullable Integer minContains;
     public final @Nullable Class<? extends JsonSchema> propertyNames;
+    public @Nullable Map<String, Set<String>> dependentRequired;
     private final LinkedHashMap<String, KeywordValidator> keywordToValidator;
 
     protected JsonSchema(JsonSchemaInfo jsonSchemaInfo) {
@@ -260,6 +261,13 @@ protected JsonSchema(JsonSchemaInfo jsonSchemaInfo) {
                     new PropertyNamesValidator(this.propertyNames)
             );
         }
+        this.dependentRequired = jsonSchemaInfo.dependentRequired;
+        if (this.dependentRequired != null) {
+            keywordToValidator.put(
+                    "dependentRequired",
+                    new DependentRequiredValidator(this.dependentRequired)
+            );
+        }
         this.keywordToValidator = keywordToValidator;
     }
 
diff --git a/samples/client/3_0_3_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchemaInfo.java b/samples/client/3_0_3_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchemaInfo.java
@@ -162,4 +162,9 @@ public JsonSchemaInfo propertyNames(Class<? extends JsonSchema> propertyNames) {
         this.propertyNames = propertyNames;
         return this;
     }
+    public @Nullable Map<String, Set<String>> dependentRequired = null;
+    public JsonSchemaInfo dependentRequired(Map<String, Set<String>> dependentRequired) {
+        this.dependentRequired = dependentRequired;
+        return this;
+    }
 }
diff --git a/samples/client/3_1_0_unit_test/java/.openapi-generator/FILES b/samples/client/3_1_0_unit_test/java/.openapi-generator/FILES
@@ -265,6 +265,7 @@ src/main/java/org/openapijsonschematools/client/schemas/validation/ConstValidato
 src/main/java/org/openapijsonschematools/client/schemas/validation/ContainsValidator.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/CustomIsoparser.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/DefaultValueMethod.java
+src/main/java/org/openapijsonschematools/client/schemas/validation/DependentRequiredValidator.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/DoubleEnumValidator.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/DoubleValueMethod.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/EnumValidator.java
diff --git a/samples/client/3_1_0_unit_test/java/docs/components/schemas/EmptyDependents.md b/samples/client/3_1_0_unit_test/java/docs/components/schemas/EmptyDependents.md
@@ -19,6 +19,14 @@ A schema class that validates payloads
 ### Field Summary
 | Modifier and Type | Field and Description |
 | ----------------- | ---------------------- |
+| Map<String, Set<String>> | dependentRequired = MapUtils.makeMap(<br>
+&nbsp;&nbsp;&nbsp;&nbsp;new AbstractMap.SimpleEntry<>(<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"bar",<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;SetMaker.makeSet(
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;)
+&nbsp;&nbsp;&nbsp;&nbsp;)<br>
+)
+ |
 
 ### Method Summary
 | Modifier and Type | Method and Description |
diff --git a/samples/client/3_1_0_unit_test/java/src/main/java/org/openapijsonschematools/client/components/schemas/EmptyDependents.java b/samples/client/3_1_0_unit_test/java/src/main/java/org/openapijsonschematools/client/components/schemas/EmptyDependents.java
@@ -1,6 +1,7 @@
 package org.openapijsonschematools.client.components.schemas;
 import java.time.LocalDate;
 import java.time.ZonedDateTime;
+import java.util.AbstractMap;
 import java.util.ArrayList;
 import java.util.HashSet;
 import java.util.LinkedHashMap;
@@ -17,6 +18,7 @@
 import org.openapijsonschematools.client.exceptions.InvalidTypeException;
 import org.openapijsonschematools.client.exceptions.UnsetPropertyException;
 import org.openapijsonschematools.client.exceptions.ValidationException;
+import org.openapijsonschematools.client.schemas.SetMaker;
 import org.openapijsonschematools.client.schemas.UnsetAddPropsSetter;
 import org.openapijsonschematools.client.schemas.validation.BooleanSchemaValidator;
 import org.openapijsonschematools.client.schemas.validation.FrozenList;
@@ -25,6 +27,7 @@
 import org.openapijsonschematools.client.schemas.validation.JsonSchemaInfo;
 import org.openapijsonschematools.client.schemas.validation.ListSchemaValidator;
 import org.openapijsonschematools.client.schemas.validation.MapSchemaValidator;
+import org.openapijsonschematools.client.schemas.validation.MapUtils;
 import org.openapijsonschematools.client.schemas.validation.NullSchemaValidator;
 import org.openapijsonschematools.client.schemas.validation.NumberSchemaValidator;
 import org.openapijsonschematools.client.schemas.validation.PathToSchemasMap;
@@ -46,6 +49,13 @@ public static class EmptyDependents1 extends JsonSchema implements NullSchemaVal
     
         protected EmptyDependents1() {
             super(new JsonSchemaInfo()
+                .dependentRequired(MapUtils.makeMap(
+                    new AbstractMap.SimpleEntry<>(
+                        "bar",
+                        SetMaker.makeSet(
+                        )
+                    )
+                ))
             );
         }
     
diff --git a/samples/client/3_1_0_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/DependentRequiredValidator.java b/samples/client/3_1_0_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/DependentRequiredValidator.java
@@ -0,0 +1,48 @@
+package org.openapijsonschematools.client.schemas.validation;
+
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.openapijsonschematools.client.exceptions.ValidationException;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+public class DependentRequiredValidator implements KeywordValidator {
+    public final Map<String, Set<String>> dependentRequired;
+
+    public DependentRequiredValidator(Map<String, Set<String>> dependentRequired) {
+        this.dependentRequired = dependentRequired;
+    }
+
+    @Override
+    public @Nullable PathToSchemasMap validate(
+        JsonSchema schema,
+        @Nullable Object arg,
+        ValidationMetadata validationMetadata,
+        @Nullable List<PathToSchemasMap> containsPathToSchemas
+    ) {
+        if (!(arg instanceof Map)) {
+            return null;
+        }
+        for (Map.Entry<String, Set<String>> entry: dependentRequired.entrySet()) {
+            if (!((Map<?, ?>) arg).containsKey(entry.getKey())) {
+                continue;
+            }
+            Set<String> missingKeys = new HashSet<>(entry.getValue());
+            for (Object objKey: ((Map<?, ?>) arg).keySet()) {
+                if (objKey instanceof String key) {
+                    missingKeys.remove(key);
+                }
+            }
+            if (missingKeys.isEmpty()) {
+                continue;
+            }
+            throw new ValidationException(
+                    "Validation failed for dependentRequired because these_keys="+missingKeys+" are "+
+                    "missing at pathToItem="+validationMetadata.pathToItem()+" in class "+schema.getClass()
+            );
+        }
+        return null;
+    }
+}
diff --git a/samples/client/3_1_0_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchema.java b/samples/client/3_1_0_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchema.java
@@ -50,6 +50,7 @@ public abstract class JsonSchema {
     public final @Nullable Integer maxContains;
     public final @Nullable Integer minContains;
     public final @Nullable Class<? extends JsonSchema> propertyNames;
+    public @Nullable Map<String, Set<String>> dependentRequired;
     private final LinkedHashMap<String, KeywordValidator> keywordToValidator;
 
     protected JsonSchema(JsonSchemaInfo jsonSchemaInfo) {
@@ -260,6 +261,13 @@ protected JsonSchema(JsonSchemaInfo jsonSchemaInfo) {
                     new PropertyNamesValidator(this.propertyNames)
             );
         }
+        this.dependentRequired = jsonSchemaInfo.dependentRequired;
+        if (this.dependentRequired != null) {
+            keywordToValidator.put(
+                    "dependentRequired",
+                    new DependentRequiredValidator(this.dependentRequired)
+            );
+        }
         this.keywordToValidator = keywordToValidator;
     }
 
diff --git a/samples/client/3_1_0_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchemaInfo.java b/samples/client/3_1_0_unit_test/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchemaInfo.java
@@ -162,4 +162,9 @@ public JsonSchemaInfo propertyNames(Class<? extends JsonSchema> propertyNames) {
         this.propertyNames = propertyNames;
         return this;
     }
+    public @Nullable Map<String, Set<String>> dependentRequired = null;
+    public JsonSchemaInfo dependentRequired(Map<String, Set<String>> dependentRequired) {
+        this.dependentRequired = dependentRequired;
+        return this;
+    }
 }
diff --git a/samples/client/petstore/java/.openapi-generator/FILES b/samples/client/petstore/java/.openapi-generator/FILES
@@ -691,6 +691,7 @@ src/main/java/org/openapijsonschematools/client/schemas/validation/ConstValidato
 src/main/java/org/openapijsonschematools/client/schemas/validation/ContainsValidator.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/CustomIsoparser.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/DefaultValueMethod.java
+src/main/java/org/openapijsonschematools/client/schemas/validation/DependentRequiredValidator.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/DoubleEnumValidator.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/DoubleValueMethod.java
 src/main/java/org/openapijsonschematools/client/schemas/validation/EnumValidator.java
diff --git a/samples/client/petstore/java/src/main/java/org/openapijsonschematools/client/schemas/validation/DependentRequiredValidator.java b/samples/client/petstore/java/src/main/java/org/openapijsonschematools/client/schemas/validation/DependentRequiredValidator.java
@@ -0,0 +1,48 @@
+package org.openapijsonschematools.client.schemas.validation;
+
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.openapijsonschematools.client.exceptions.ValidationException;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+public class DependentRequiredValidator implements KeywordValidator {
+    public final Map<String, Set<String>> dependentRequired;
+
+    public DependentRequiredValidator(Map<String, Set<String>> dependentRequired) {
+        this.dependentRequired = dependentRequired;
+    }
+
+    @Override
+    public @Nullable PathToSchemasMap validate(
+        JsonSchema schema,
+        @Nullable Object arg,
+        ValidationMetadata validationMetadata,
+        @Nullable List<PathToSchemasMap> containsPathToSchemas
+    ) {
+        if (!(arg instanceof Map)) {
+            return null;
+        }
+        for (Map.Entry<String, Set<String>> entry: dependentRequired.entrySet()) {
+            if (!((Map<?, ?>) arg).containsKey(entry.getKey())) {
+                continue;
+            }
+            Set<String> missingKeys = new HashSet<>(entry.getValue());
+            for (Object objKey: ((Map<?, ?>) arg).keySet()) {
+                if (objKey instanceof String key) {
+                    missingKeys.remove(key);
+                }
+            }
+            if (missingKeys.isEmpty()) {
+                continue;
+            }
+            throw new ValidationException(
+                    "Validation failed for dependentRequired because these_keys="+missingKeys+" are "+
+                    "missing at pathToItem="+validationMetadata.pathToItem()+" in class "+schema.getClass()
+            );
+        }
+        return null;
+    }
+}
diff --git a/samples/client/petstore/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchema.java b/samples/client/petstore/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchema.java
@@ -50,6 +50,7 @@ public abstract class JsonSchema {
     public final @Nullable Integer maxContains;
     public final @Nullable Integer minContains;
     public final @Nullable Class<? extends JsonSchema> propertyNames;
+    public @Nullable Map<String, Set<String>> dependentRequired;
     private final LinkedHashMap<String, KeywordValidator> keywordToValidator;
 
     protected JsonSchema(JsonSchemaInfo jsonSchemaInfo) {
@@ -260,6 +261,13 @@ protected JsonSchema(JsonSchemaInfo jsonSchemaInfo) {
                     new PropertyNamesValidator(this.propertyNames)
             );
         }
+        this.dependentRequired = jsonSchemaInfo.dependentRequired;
+        if (this.dependentRequired != null) {
+            keywordToValidator.put(
+                    "dependentRequired",
+                    new DependentRequiredValidator(this.dependentRequired)
+            );
+        }
         this.keywordToValidator = keywordToValidator;
     }
 
diff --git a/samples/client/petstore/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchemaInfo.java b/samples/client/petstore/java/src/main/java/org/openapijsonschematools/client/schemas/validation/JsonSchemaInfo.java
@@ -162,4 +162,9 @@ public JsonSchemaInfo propertyNames(Class<? extends JsonSchema> propertyNames) {
         this.propertyNames = propertyNames;
         return this;
     }
+    public @Nullable Map<String, Set<String>> dependentRequired = null;
+    public JsonSchemaInfo dependentRequired(Map<String, Set<String>> dependentRequired) {
+        this.dependentRequired = dependentRequired;
+        return this;
+    }
 }
diff --git a/src/main/java/org/openapijsonschematools/codegen/generators/JavaClientGenerator.java b/src/main/java/org/openapijsonschematools/codegen/generators/JavaClientGenerator.java
@@ -258,7 +258,7 @@ public JavaClientGenerator() {
                         SchemaFeature.Const,
                         SchemaFeature.Contains,
                         SchemaFeature.Default,
-                        // SchemaFeature.DependentRequired,
+                        SchemaFeature.DependentRequired,
                         // SchemaFeature.DependentSchemas,
                         // SchemaFeature.Discriminator,
                         // SchemaFeature.Else,
@@ -567,6 +567,7 @@ public void processOpts() {
         keywordValidatorFiles.add("BigDecimalValidator");
         keywordValidatorFiles.add("CustomIsoparser");
         keywordValidatorFiles.add("DefaultValueMethod");
+        keywordValidatorFiles.add("DependentRequiredValidator");
         keywordValidatorFiles.add("DoubleEnumValidator");
         keywordValidatorFiles.add("DoubleValueMethod");
         keywordValidatorFiles.add("EnumValidator");
@@ -1347,6 +1348,7 @@ public Set<String> getImports(String sourceJsonPath, CodegenSchema schema, Featu
                 addMultipleOfValidator(schema, imports);
                 addAdditionalPropertiesImports(schema, imports);
                 addDefaultValueImport(schema, imports);
+                addDependentRequiredImports(schema, imports);
                 if (schema.mapValueSchema != null) {
                     imports.addAll(getDeeperImports(sourceJsonPath, schema.mapValueSchema));
                 }
@@ -1460,6 +1462,14 @@ private void addPropertiesValidator(CodegenSchema schema, Set<String> imports) {
         }
     }
 
+    private void addDependentRequiredImports(CodegenSchema schema, Set<String> imports) {
+        if (schema.dependentRequired != null) {
+            imports.add("import "+packageName + ".schemas.validation.MapUtils;");
+            imports.add("import java.util.AbstractMap;");
+            imports.add("import "+packageName + ".schemas.SetMaker;");
+        }
+    }
+
     private void addAllOfValidator(CodegenSchema schema, Set<String> imports) {
         if (schema.allOf != null) {
             imports.add("import java.util.List;");
@@ -1554,6 +1564,7 @@ private void addMapSchemaImports(Set<String> imports, CodegenSchema schema) {
         addAnyOfValidator(schema, imports);
         addOneOfValidator(schema, imports);
         addAdditionalPropertiesImports(schema, imports);
+        addDependentRequiredImports(schema, imports);
     }
 
     private void addListSchemaImports(Set<String> imports, CodegenSchema schema) {
diff --git a/src/main/resources/java/src/main/java/packagename/components/schemas/SchemaClass/_Schema_anytypeOrMultitype.hbs b/src/main/resources/java/src/main/java/packagename/components/schemas/SchemaClass/_Schema_anytypeOrMultitype.hbs
@@ -111,6 +111,9 @@ public static class {{jsonPathPiece.pascalCase}} extends JsonSchema implements {
         {{#if propertyNames}}
             {{> src/main/java/packagename/components/schemas/SchemaClass/_propertyNames }}
         {{/if}}
+        {{#if dependentRequired}}
+            {{> src/main/java/packagename/components/schemas/SchemaClass/_dependentRequired }}
+        {{/if}}
         );
     }
 
@@ -135,9 +138,6 @@ public static class {{jsonPathPiece.pascalCase}} extends JsonSchema implements {
 {{#if else_}}
     {{!> components/schemas/schema_cls/_else }}
 {{/if}}
-{{#if dependentRequired}}
-    {{!> components/schemas/schema_cls/_dependent_required }}
-{{/if}}
 {{#if dependentSchemas}}
     {{!> components/schemas/schema_cls/_dependent_schemas }}
 {{/if}}
diff --git a/src/main/resources/java/src/main/java/packagename/components/schemas/SchemaClass/_Schema_map.hbs b/src/main/resources/java/src/main/java/packagename/components/schemas/SchemaClass/_Schema_map.hbs
diff --git a/src/main/resources/java/src/main/java/packagename/components/schemas/SchemaClass/_dependentRequired.hbs b/src/main/resources/java/src/main/java/packagename/components/schemas/SchemaClass/_dependentRequired.hbs
diff --git a/src/main/resources/java/src/main/java/packagename/components/schemas/docschema_fields_field.hbs b/src/main/resources/java/src/main/java/packagename/components/schemas/docschema_fields_field.hbs
diff --git a/src/main/resources/java/src/main/java/packagename/schemas/validation/DependentRequiredValidator.hbs b/src/main/resources/java/src/main/java/packagename/schemas/validation/DependentRequiredValidator.hbs
diff --git a/src/main/resources/java/src/main/java/packagename/schemas/validation/JsonSchema.hbs b/src/main/resources/java/src/main/java/packagename/schemas/validation/JsonSchema.hbs
diff --git a/src/main/resources/java/src/main/java/packagename/schemas/validation/JsonSchemaInfo.hbs b/src/main/resources/java/src/main/java/packagename/schemas/validation/JsonSchemaInfo.hbs
diff --git a/src/test/resources/3_1/unit_test_spec/spec_writer.py b/src/test/resources/3_1/unit_test_spec/spec_writer.py

Original file line number	Diff line number	Diff line change
`@@ -162,4 +162,9 @@ public JsonSchemaInfo propertyNames(Class<? extends JsonSchema> propertyNames) {`
`162`	`162`	`this.propertyNames = propertyNames;`
`163`	`163`	`return this;`
`164`	`164`	`}`
	`165`	`+ public @Nullable Map<String, Set<String>> dependentRequired = null;`
	`166`	`+ public JsonSchemaInfo dependentRequired(Map<String, Set<String>> dependentRequired) {`
	`167`	`+ this.dependentRequired = dependentRequired;`
	`168`	`+ return this;`
	`169`	`+ }`
`165`	`170`	`}`