Add required info in context

quen2404 · quen2404 · commit 6e156b601294 · 2018-05-03T11:43:11.000+02:00
diff --git a/src/main/java/com/qdesrame/openapi/diff/compare/ContentDiff.java b/src/main/java/com/qdesrame/openapi/diff/compare/ContentDiff.java
@@ -36,7 +36,7 @@ public Optional<ChangedContent> diff(Content left, Content right, DiffContext co
             MediaType oldMediaType = left.get(mediaTypeKey);
             MediaType newMediaType = right.get(mediaTypeKey);
             ChangedMediaType changedMediaType = new ChangedMediaType(oldMediaType.getSchema(), newMediaType.getSchema(), context);
-            openApiDiff.getSchemaDiff().diff(new HashSet<>(), oldMediaType.getSchema(), newMediaType.getSchema(), context).ifPresent(changedMediaType::setChangedSchema);
+            openApiDiff.getSchemaDiff().diff(new HashSet<>(), oldMediaType.getSchema(), newMediaType.getSchema(), context.copyWithRequired(true)).ifPresent(changedMediaType::setChangedSchema);
             if (!isUnchanged(changedMediaType)) {
                 changedMediaTypes.put(mediaTypeKey, changedMediaType);
             }
diff --git a/src/main/java/com/qdesrame/openapi/diff/compare/HeaderDiff.java b/src/main/java/com/qdesrame/openapi/diff/compare/HeaderDiff.java
@@ -44,7 +44,7 @@ protected Optional<ChangedHeader> computeDiff(HashSet<String> refSet, Header lef
         changedHeader.setChangeDeprecated(!Boolean.TRUE.equals(left.getDeprecated()) && Boolean.TRUE.equals(right.getDeprecated()));
         changedHeader.setChangeStyle(!Objects.equals(left.getStyle(), right.getStyle()));
         changedHeader.setChangeExplode(getBooleanDiff(left.getExplode(), right.getExplode()));
-        openApiDiff.getSchemaDiff().diff(new HashSet<>(), left.getSchema(), right.getSchema(), context).ifPresent(changedHeader::setChangedSchema);
+        openApiDiff.getSchemaDiff().diff(new HashSet<>(), left.getSchema(), right.getSchema(), context.copyWithRequired(true)).ifPresent(changedHeader::setChangedSchema);
         openApiDiff.getContentDiff().diff(left.getContent(), right.getContent(), context).ifPresent(changedHeader::setChangedContent);
 
         return isChanged(changedHeader);
diff --git a/src/main/java/com/qdesrame/openapi/diff/compare/ParameterDiff.java b/src/main/java/com/qdesrame/openapi/diff/compare/ParameterDiff.java
@@ -46,7 +46,7 @@ protected Optional<ChangedParameter> computeDiff(HashSet<String> refSet, Paramet
         changedParameter.setChangeAllowEmptyValue(getBooleanDiff(left.getAllowEmptyValue(), right.getAllowEmptyValue()));
         changedParameter.setChangeStyle(!Objects.equals(left.getStyle(), right.getStyle()));
         changedParameter.setChangeExplode(getBooleanDiff(left.getExplode(), right.getExplode()));
-        Optional<ChangedSchema> changedSchema = openApiDiff.getSchemaDiff().diff(refSet, left.getSchema(), right.getSchema(), context);
+        Optional<ChangedSchema> changedSchema = openApiDiff.getSchemaDiff().diff(refSet, left.getSchema(), right.getSchema(), context.copyWithRequired(true));
         if (changedSchema.isPresent()) {
             changedParameter.setChangedSchema(changedSchema.get());
         }
diff --git a/src/main/java/com/qdesrame/openapi/diff/compare/schemadiffresult/ArraySchemaDiffResult.java b/src/main/java/com/qdesrame/openapi/diff/compare/schemadiffresult/ArraySchemaDiffResult.java
@@ -22,6 +22,6 @@ public ArraySchemaDiffResult(OpenApiDiff openApiDiff) {
     public Optional<ChangedSchema> diff(HashSet<String> refSet, Components leftComponents, Components rightComponents, Schema left, Schema right, DiffContext context) {
         ArraySchema leftArraySchema = (ArraySchema) left;
         ArraySchema rightArraySchema = (ArraySchema) right;
-        return openApiDiff.getSchemaDiff().diff(refSet, leftArraySchema.getItems(), rightArraySchema.getItems(), context);
+        return openApiDiff.getSchemaDiff().diff(refSet, leftArraySchema.getItems(), rightArraySchema.getItems(), context.copyWithRequired(true));
     }
 }
diff --git a/src/main/java/com/qdesrame/openapi/diff/compare/schemadiffresult/ComposedSchemaDiffResult.java b/src/main/java/com/qdesrame/openapi/diff/compare/schemadiffresult/ComposedSchemaDiffResult.java
@@ -66,7 +66,7 @@ public Optional<ChangedSchema> diff(HashSet<String> refSet, Components leftCompo
                     leftSchema.set$ref(leftMapping.get(key));
                     Schema rightSchema = new Schema();
                     rightSchema.set$ref(rightMapping.get(key));
-                    Optional<ChangedSchema> changedSchema = openApiDiff.getSchemaDiff().diff(refSet, leftSchema, rightSchema, context);
+                    Optional<ChangedSchema> changedSchema = openApiDiff.getSchemaDiff().diff(refSet, leftSchema, rightSchema, context.copyWithRequired(true));
                     changedSchema.ifPresent(schema -> changedMapping.put(key, schema));
                 }
                 changedSchema.setChangedOneOfSchema(changedOneOfSchema);
diff --git a/src/main/java/com/qdesrame/openapi/diff/compare/schemadiffresult/SchemaDiffResult.java b/src/main/java/com/qdesrame/openapi/diff/compare/schemadiffresult/SchemaDiffResult.java
@@ -12,10 +12,7 @@
 import io.swagger.v3.oas.models.media.Schema;
 import lombok.Getter;
 
-import java.util.HashSet;
-import java.util.Map;
-import java.util.Objects;
-import java.util.Optional;
+import java.util.*;
 
 import static com.qdesrame.openapi.diff.utils.ChangedUtils.isChanged;
 
@@ -58,7 +55,7 @@ public Optional<ChangedSchema> diff(HashSet<String> refSet, Components leftCompo
         Map<String, Schema> missingProp = propertyDiff.getMissing();
 
         for (String key : propertyDiff.getSharedKey()) {
-            Optional<ChangedSchema> resultSchema = openApiDiff.getSchemaDiff().diff(refSet, leftProperties.get(key), rightProperties.get(key), context);
+            Optional<ChangedSchema> resultSchema = openApiDiff.getSchemaDiff().diff(refSet, leftProperties.get(key), rightProperties.get(key), required(context, key, right.getRequired()));
             resultSchema.ifPresent(changedSchema1 -> changedSchema.getChangedProperties().put(key, changedSchema1));
         }
 
@@ -69,6 +66,10 @@ public Optional<ChangedSchema> diff(HashSet<String> refSet, Components leftCompo
         return isChanged(changedSchema);
     }
 
+    private DiffContext required(DiffContext context, String key, List<String> required) {
+        return context.copyWithRequired(required != null && required.contains(key));
+    }
+
     private void compareAdditionalProperties(HashSet<String> refSet, Schema leftSchema, Schema rightSchema, DiffContext context) {
         Object left = leftSchema.getAdditionalProperties();
         Object right = rightSchema.getAdditionalProperties();
@@ -81,7 +82,7 @@ private void compareAdditionalProperties(HashSet<String> refSet, Schema leftSche
             apChangedSchema.setNewSchema(rightAdditionalSchema);
             if (left != null && right != null) {
                 Optional<ChangedSchema> addPropChangedSchemaOP
-                        = openApiDiff.getSchemaDiff().diff(refSet, leftAdditionalSchema, rightAdditionalSchema, context);
+                        = openApiDiff.getSchemaDiff().diff(refSet, leftAdditionalSchema, rightAdditionalSchema, context.copyWithRequired(false));
                 apChangedSchema = addPropChangedSchemaOP.orElse(apChangedSchema);
             }
             isChanged(apChangedSchema).ifPresent(changedSchema::setAddPropChangedSchema);
diff --git a/src/main/java/com/qdesrame/openapi/diff/model/DiffContext.java b/src/main/java/com/qdesrame/openapi/diff/model/DiffContext.java
@@ -17,6 +17,7 @@ public class DiffContext {
     private PathItem.HttpMethod method;
     private boolean response;
     private boolean request;
+    private Boolean required;
 
     public DiffContext() {
         parameters = new HashMap<>();
@@ -28,6 +29,10 @@ public DiffContext copyWithMethod(PathItem.HttpMethod method) {
         return copy().setMethod(method);
     }
 
+    public DiffContext copyWithRequired(boolean required) {
+        return copy().setRequired(required);
+    }
+
     public DiffContext copyAsRequest() {
         return copy().setRequest();
     }
@@ -81,6 +86,7 @@ private DiffContext copy() {
         context.method = this.method;
         context.response = this.response;
         context.request = this.request;
+        context.required = this.required;
         return context;
     }
 
@@ -93,6 +99,15 @@ public DiffContext setParameters(Map<String, String> parameters) {
         return this;
     }
 
+    public Boolean isRequired() {
+        return required;
+    }
+
+    private DiffContext setRequired(boolean required) {
+        this.required = required;
+        return this;
+    }
+
     @Override
     public boolean equals(Object o) {
         if (this == o) return true;
@@ -107,6 +122,7 @@ public boolean equals(Object o) {
                 .append(url, that.url)
                 .append(parameters, that.parameters)
                 .append(method, that.method)
+                .append(required, that.required)
                 .isEquals();
     }
 
@@ -118,6 +134,7 @@ public int hashCode() {
                 .append(method)
                 .append(response)
                 .append(request)
+                .append(required)
                 .toHashCode();
     }
 }
diff --git a/src/main/java/com/qdesrame/openapi/diff/model/schema/ChangedReadOnly.java b/src/main/java/com/qdesrame/openapi/diff/model/schema/ChangedReadOnly.java
@@ -30,9 +30,9 @@ public DiffResult isChanged() {
         }
         if (context.isRequest()) {
             if (Boolean.TRUE.equals(newValue)) {
-                return DiffResult.COMPATIBLE;
-            } else {
                 return DiffResult.INCOMPATIBLE;
+            } else {
+                return context.isRequired() ? DiffResult.INCOMPATIBLE : DiffResult.COMPATIBLE;
             }
         }
         return DiffResult.UNKNOWN;
diff --git a/src/main/java/com/qdesrame/openapi/diff/model/schema/ChangedWriteOnly.java b/src/main/java/com/qdesrame/openapi/diff/model/schema/ChangedWriteOnly.java
@@ -32,7 +32,7 @@ public DiffResult isChanged() {
             if (Boolean.TRUE.equals(newValue)) {
                 return DiffResult.INCOMPATIBLE;
             } else {
-                return DiffResult.COMPATIBLE;
+                return context.isRequired() ? DiffResult.INCOMPATIBLE : DiffResult.COMPATIBLE;
             }
         }
         return DiffResult.UNKNOWN;

Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public Optional<ChangedContent> diff(Content left, Content right, DiffContext co`
`36`	`36`	`MediaType oldMediaType = left.get(mediaTypeKey);`
`37`	`37`	`MediaType newMediaType = right.get(mediaTypeKey);`
`38`	`38`	`ChangedMediaType changedMediaType = new ChangedMediaType(oldMediaType.getSchema(), newMediaType.getSchema(), context);`
`39`		`- openApiDiff.getSchemaDiff().diff(new HashSet<>(), oldMediaType.getSchema(), newMediaType.getSchema(), context).ifPresent(changedMediaType::setChangedSchema);`
	`39`	`+ openApiDiff.getSchemaDiff().diff(new HashSet<>(), oldMediaType.getSchema(), newMediaType.getSchema(), context.copyWithRequired(true)).ifPresent(changedMediaType::setChangedSchema);`
`40`	`40`	`if (!isUnchanged(changedMediaType)) {`
`41`	`41`	`changedMediaTypes.put(mediaTypeKey, changedMediaType);`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,7 +46,7 @@ protected Optional<ChangedParameter> computeDiff(HashSet<String> refSet, Paramet`
`46`	`46`	`changedParameter.setChangeAllowEmptyValue(getBooleanDiff(left.getAllowEmptyValue(), right.getAllowEmptyValue()));`
`47`	`47`	`changedParameter.setChangeStyle(!Objects.equals(left.getStyle(), right.getStyle()));`
`48`	`48`	`changedParameter.setChangeExplode(getBooleanDiff(left.getExplode(), right.getExplode()));`
`49`		`- Optional<ChangedSchema> changedSchema = openApiDiff.getSchemaDiff().diff(refSet, left.getSchema(), right.getSchema(), context);`
	`49`	`+ Optional<ChangedSchema> changedSchema = openApiDiff.getSchemaDiff().diff(refSet, left.getSchema(), right.getSchema(), context.copyWithRequired(true));`
`50`	`50`	`if (changedSchema.isPresent()) {`
`51`	`51`	`changedParameter.setChangedSchema(changedSchema.get());`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,6 @@ public ArraySchemaDiffResult(OpenApiDiff openApiDiff) {`
`22`	`22`	`public Optional<ChangedSchema> diff(HashSet<String> refSet, Components leftComponents, Components rightComponents, Schema left, Schema right, DiffContext context) {`
`23`	`23`	`ArraySchema leftArraySchema = (ArraySchema) left;`
`24`	`24`	`ArraySchema rightArraySchema = (ArraySchema) right;`
`25`		`- return openApiDiff.getSchemaDiff().diff(refSet, leftArraySchema.getItems(), rightArraySchema.getItems(), context);`
	`25`	`+ return openApiDiff.getSchemaDiff().diff(refSet, leftArraySchema.getItems(), rightArraySchema.getItems(), context.copyWithRequired(true));`
`26`	`26`	`}`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -66,7 +66,7 @@ public Optional<ChangedSchema> diff(HashSet<String> refSet, Components leftCompo`
`66`	`66`	`leftSchema.set$ref(leftMapping.get(key));`
`67`	`67`	`Schema rightSchema = new Schema();`
`68`	`68`	`rightSchema.set$ref(rightMapping.get(key));`
`69`		`- Optional<ChangedSchema> changedSchema = openApiDiff.getSchemaDiff().diff(refSet, leftSchema, rightSchema, context);`
	`69`	`+ Optional<ChangedSchema> changedSchema = openApiDiff.getSchemaDiff().diff(refSet, leftSchema, rightSchema, context.copyWithRequired(true));`
`70`	`70`	`changedSchema.ifPresent(schema -> changedMapping.put(key, schema));`
`71`	`71`	`}`
`72`	`72`	`changedSchema.setChangedOneOfSchema(changedOneOfSchema);`
Original file line number	Diff line number	Diff line change
`@@ -30,9 +30,9 @@ public DiffResult isChanged() {`
`30`	`30`	`}`
`31`	`31`	`if (context.isRequest()) {`
`32`	`32`	`if (Boolean.TRUE.equals(newValue)) {`
`33`		`- return DiffResult.COMPATIBLE;`
`34`		`- } else {`
`35`	`33`	`return DiffResult.INCOMPATIBLE;`
	`34`	`+ } else {`
	`35`	`+ return context.isRequired() ? DiffResult.INCOMPATIBLE : DiffResult.COMPATIBLE;`
`36`	`36`	`}`
`37`	`37`	`}`
`38`	`38`	`return DiffResult.UNKNOWN;`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public DiffResult isChanged() {`
`32`	`32`	`if (Boolean.TRUE.equals(newValue)) {`
`33`	`33`	`return DiffResult.INCOMPATIBLE;`
`34`	`34`	`} else {`
`35`		`- return DiffResult.COMPATIBLE;`
	`35`	`+ return context.isRequired() ? DiffResult.INCOMPATIBLE : DiffResult.COMPATIBLE;`
`36`	`36`	`}`
`37`	`37`	`}`
`38`	`38`	`return DiffResult.UNKNOWN;`