Merge pull request #8 from adarshsharma/adarsh_master

quen2404 · web-flow · commit aacfa8091e8f · 2017-12-27T21:42:51.000+01:00
Added ChangedRequestBody
diff --git a/src/main/java/com/qdesrame/openapi/diff/compare/OpenApiDiff.java b/src/main/java/com/qdesrame/openapi/diff/compare/OpenApiDiff.java
@@ -6,8 +6,6 @@
 import io.swagger.v3.oas.models.OpenAPI;
 import io.swagger.v3.oas.models.Operation;
 import io.swagger.v3.oas.models.PathItem;
-import io.swagger.v3.oas.models.media.Content;
-import io.swagger.v3.oas.models.parameters.RequestBody;
 import io.swagger.v3.oas.models.responses.ApiResponse;
 import io.swagger.v3.parser.OpenAPIV3Parser;
 import io.swagger.v3.parser.core.models.AuthorizationValue;
@@ -31,6 +29,7 @@ public class OpenApiDiff {
     private ContentDiff contentDiff;
     private ParametersDiff parametersDiff;
     private ParameterDiff parameterDiff;
+    private RequestBodyDiff requestBodyDiff;
 
     private OpenAPI oldSpecOpenApi;
     private OpenAPI newSpecOpenApi;
@@ -87,6 +86,7 @@ private void initializeFields() {
         this.contentDiff = new ContentDiff(this);
         this.parametersDiff = new ParametersDiff(this);
         this.parameterDiff = new ParameterDiff(this);
+        this.requestBodyDiff = new RequestBodyDiff(this);
     }
 
     /*
@@ -138,19 +138,9 @@ private ChangedOpenApi compare() {
                 changedOperation.setSummary(newOperation.getSummary());
                 changedOperation.setDeprecated(!Boolean.TRUE.equals(oldOperation.getDeprecated()) && Boolean.TRUE.equals(newOperation.getDeprecated()));
 
-                Content oldRequestContent = new Content();
-                Content newRequestContent = new Content();
-                if (oldOperation.getRequestBody() != null) {
-                    RequestBody oldRequestBody = RefPointer.Replace.requestBody(oldSpecOpenApi.getComponents(), oldOperation.getRequestBody());
-                    if (oldRequestBody.getContent() != null) {
-                        oldRequestContent = oldRequestBody.getContent();
-                    }
-                }
-                if (newOperation.getRequestBody() != null) {
-                    RequestBody newRequestBody = RefPointer.Replace.requestBody(oldSpecOpenApi.getComponents(), newOperation.getRequestBody());
-                    newRequestContent = newRequestBody.getContent();
+                if (oldOperation.getRequestBody() != null || newOperation.getRequestBody() != null) {
+                    changedOperation.setChangedRequestBody(requestBodyDiff.diff(oldOperation.getRequestBody(), newOperation.getRequestBody()));
                 }
-                changedOperation.setRequestChangedContent(contentDiff.diff(oldRequestContent, newRequestContent));
 
                 ChangedParameters changedParameters = parametersDiff.diff(oldOperation.getParameters(), newOperation.getParameters());
                 changedOperation.setChangedParameters(changedParameters);
diff --git a/src/main/java/com/qdesrame/openapi/diff/compare/RequestBodyDiff.java b/src/main/java/com/qdesrame/openapi/diff/compare/RequestBodyDiff.java
@@ -0,0 +1,51 @@
+package com.qdesrame.openapi.diff.compare;
+
+import com.qdesrame.openapi.diff.model.ChangedRequestBody;
+import com.qdesrame.openapi.diff.utils.RefPointer;
+import io.swagger.v3.oas.models.media.Content;
+import io.swagger.v3.oas.models.parameters.RequestBody;
+
+import java.util.Objects;
+
+/**
+ * Created by adarsh.sharma on 28/12/17.
+ */
+public class RequestBodyDiff {
+    private OpenApiDiff openApiDiff;
+
+    public RequestBodyDiff(OpenApiDiff openApiDiff) {
+        this.openApiDiff = openApiDiff;
+    }
+
+    public ChangedRequestBody diff(RequestBody left, RequestBody right) {
+        Content oldRequestContent = new Content();
+        Content newRequestContent = new Content();
+        RequestBody oldRequestBody = null;
+        RequestBody newRequestBody = null;
+        if (left != null) {
+            oldRequestBody = RefPointer.Replace.requestBody(openApiDiff.getOldSpecOpenApi().getComponents(), left);
+            if (oldRequestBody.getContent() != null) {
+                oldRequestContent = oldRequestBody.getContent();
+            }
+        }
+        if (right != null) {
+            newRequestBody = RefPointer.Replace.requestBody(openApiDiff.getOldSpecOpenApi().getComponents(), right);
+            if (newRequestBody.getContent() != null) {
+                newRequestContent = newRequestBody.getContent();
+            }
+        }
+
+        ChangedRequestBody changedRequestBody = new ChangedRequestBody(left, right);
+
+        boolean leftRequired = oldRequestBody != null ? Boolean.TRUE.equals(oldRequestBody.getRequired()) : false;
+        boolean rightRequired = newRequestBody != null ? Boolean.TRUE.equals(newRequestBody.getRequired()) : false;
+        changedRequestBody.setChangeRequired(leftRequired != rightRequired);
+
+        String leftDescription = oldRequestBody != null ? oldRequestBody.getDescription() : null;
+        String rightDescription = newRequestBody != null ? newRequestBody.getDescription() : null;
+        changedRequestBody.setChangeDescription(!Objects.equals(leftDescription, rightDescription));
+
+        changedRequestBody.setChangedContent(openApiDiff.getContentDiff().diff(oldRequestContent, newRequestContent));
+        return changedRequestBody;
+    }
+}
diff --git a/src/main/java/com/qdesrame/openapi/diff/model/ChangedOperation.java b/src/main/java/com/qdesrame/openapi/diff/model/ChangedOperation.java
@@ -13,7 +13,7 @@ public class ChangedOperation implements Changed {
     private String summary;
     private boolean deprecated;
     private ChangedParameters changedParameters;
-    private ChangedContent requestChangedContent;
+    private ChangedRequestBody changedRequestBody;
     private ChangedApiResponse changedApiResponse;
 
     public ChangedOperation(String pathUrl, PathItem.HttpMethod httpMethod, Operation oldOperation, Operation newOperation) {
@@ -63,12 +63,12 @@ public void setChangedParameters(ChangedParameters changedParameters) {
         this.changedParameters = changedParameters;
     }
 
-    public ChangedContent getRequestChangedContent() {
-        return requestChangedContent;
+    public ChangedRequestBody getChangedRequestBody() {
+        return changedRequestBody;
     }
 
-    public void setRequestChangedContent(ChangedContent requestChangedContent) {
-        this.requestChangedContent = requestChangedContent;
+    public void setChangedRequestBody(ChangedRequestBody changedRequestBody) {
+        this.changedRequestBody = changedRequestBody;
     }
 
     public ChangedApiResponse getChangedApiResponse() {
@@ -87,7 +87,7 @@ public boolean isDiff() {
     @Override
     public boolean isDiffBackwardCompatible() {
         return changedParameters.isDiffBackwardCompatible()
-                && requestChangedContent.isDiffBackwardCompatible(true)
+                && (changedRequestBody == null || changedRequestBody.isDiffBackwardCompatible())
                 && changedApiResponse.isDiffBackwardCompatible();
     }
 
@@ -100,7 +100,7 @@ public boolean isDiffResponse() {
     }
 
     public boolean isDiffRequest() {
-        return requestChangedContent.isDiff();
+        return changedRequestBody != null && changedRequestBody.isDiff();
     }
 
 }
diff --git a/src/main/java/com/qdesrame/openapi/diff/model/ChangedRequestBody.java b/src/main/java/com/qdesrame/openapi/diff/model/ChangedRequestBody.java
@@ -0,0 +1,69 @@
+package com.qdesrame.openapi.diff.model;
+
+import io.swagger.v3.oas.models.parameters.RequestBody;
+
+/**
+ * Created by adarsh.sharma on 27/12/17.
+ */
+public class ChangedRequestBody implements Changed {
+    private RequestBody oldRequestBody;
+    private RequestBody newRequestBody;
+    private boolean changeDescription;
+    private boolean changeRequired;
+    private ChangedContent changedContent;
+
+    public ChangedRequestBody(RequestBody oldRequestBody, RequestBody newRequestBody) {
+        this.oldRequestBody = oldRequestBody;
+        this.newRequestBody = newRequestBody;
+    }
+
+    public RequestBody getOldRequestBody() {
+        return oldRequestBody;
+    }
+
+    public void setOldRequestBody(RequestBody oldRequestBody) {
+        this.oldRequestBody = oldRequestBody;
+    }
+
+    public RequestBody getNewRequestBody() {
+        return newRequestBody;
+    }
+
+    public void setNewRequestBody(RequestBody newRequestBody) {
+        this.newRequestBody = newRequestBody;
+    }
+
+    public boolean isChangeDescription() {
+        return changeDescription;
+    }
+
+    public void setChangeDescription(boolean changeDescription) {
+        this.changeDescription = changeDescription;
+    }
+
+    public boolean isChangeRequired() {
+        return changeRequired;
+    }
+
+    public void setChangeRequired(boolean changeRequired) {
+        this.changeRequired = changeRequired;
+    }
+
+    public ChangedContent getChangedContent() {
+        return changedContent;
+    }
+
+    public void setChangedContent(ChangedContent changedContent) {
+        this.changedContent = changedContent;
+    }
+
+    @Override
+    public boolean isDiff() {
+        return changeDescription || changeRequired || changedContent.isDiff();
+    }
+
+    @Override
+    public boolean isDiffBackwardCompatible() {
+        return !changeRequired && changedContent.isDiffBackwardCompatible(true);
+    }
+}
diff --git a/src/main/java/com/qdesrame/openapi/diff/output/ConsoleRender.java b/src/main/java/com/qdesrame/openapi/diff/output/ConsoleRender.java
@@ -65,7 +65,7 @@ private String ol_changed(List<ChangedOperation> operations) {
             if (operation.isDiffRequest()) {
                 ul_detail.append(StringUtils.repeat(' ', 2)).append("Request:")
                         .append(System.lineSeparator())
-                        .append(ul_content(operation.getRequestChangedContent(), true));
+                        .append(ul_content(operation.getChangedRequestBody().getChangedContent(), true));
             }
             if (operation.isDiffResponse()) {
                 ul_detail.append(StringUtils.repeat(' ', 2)).append("Return Type:")
diff --git a/src/main/java/com/qdesrame/openapi/diff/output/HtmlRender.java b/src/main/java/com/qdesrame/openapi/diff/output/HtmlRender.java
@@ -125,7 +125,7 @@ private ContainerTag ol_changed(List<ChangedOperation> changedOperations) {
                 ul_detail.with(li().with(h3("Parameters")).with(ul_param(changedOperation.getChangedParameters())));
             }
             if (changedOperation.isDiffRequest()) {
-                ul_detail.with(li().with(h3("Request")).with(ul_request(changedOperation.getRequestChangedContent())));
+                ul_detail.with(li().with(h3("Request")).with(ul_request(changedOperation.getChangedRequestBody().getChangedContent())));
             } else {
             }
             if (changedOperation.isDiffResponse()) {
diff --git a/src/main/java/com/qdesrame/openapi/diff/output/MarkdownRender.java b/src/main/java/com/qdesrame/openapi/diff/output/MarkdownRender.java
@@ -103,7 +103,7 @@ private String ol_changed(List<ChangedOperation> changedOperations) {
             }
             if (changedOperation.isDiffRequest()) {
                 ul_detail.append(PRE_LI).append("Request")
-                        .append(ul_request(changedOperation.getRequestChangedContent()));
+                        .append(ul_request(changedOperation.getChangedRequestBody().getChangedContent()));
             }
             if (changedOperation.isDiffResponse()) {
                 ul_detail.append(PRE_LI).append("Return Type")

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public class ChangedOperation implements Changed {`
`13`	`13`	`private String summary;`
`14`	`14`	`private boolean deprecated;`
`15`	`15`	`private ChangedParameters changedParameters;`
`16`		`- private ChangedContent requestChangedContent;`
	`16`	`+ private ChangedRequestBody changedRequestBody;`
`17`	`17`	`private ChangedApiResponse changedApiResponse;`
`18`	`18`
`19`	`19`	`public ChangedOperation(String pathUrl, PathItem.HttpMethod httpMethod, Operation oldOperation, Operation newOperation) {`
`@@ -63,12 +63,12 @@ public void setChangedParameters(ChangedParameters changedParameters) {`
`63`	`63`	`this.changedParameters = changedParameters;`
`64`	`64`	`}`
`65`	`65`
`66`		`- public ChangedContent getRequestChangedContent() {`
`67`		`- return requestChangedContent;`
	`66`	`+ public ChangedRequestBody getChangedRequestBody() {`
	`67`	`+ return changedRequestBody;`
`68`	`68`	`}`
`69`	`69`
`70`		`- public void setRequestChangedContent(ChangedContent requestChangedContent) {`
`71`		`- this.requestChangedContent = requestChangedContent;`
	`70`	`+ public void setChangedRequestBody(ChangedRequestBody changedRequestBody) {`
	`71`	`+ this.changedRequestBody = changedRequestBody;`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`public ChangedApiResponse getChangedApiResponse() {`
`@@ -87,7 +87,7 @@ public boolean isDiff() {`
`87`	`87`	`@Override`
`88`	`88`	`public boolean isDiffBackwardCompatible() {`
`89`	`89`	`return changedParameters.isDiffBackwardCompatible()`
`90`		`- && requestChangedContent.isDiffBackwardCompatible(true)`
	`90`	`+ && (changedRequestBody == null \|\| changedRequestBody.isDiffBackwardCompatible())`
`91`	`91`	`&& changedApiResponse.isDiffBackwardCompatible();`
`92`	`92`	`}`
`93`	`93`
`@@ -100,7 +100,7 @@ public boolean isDiffResponse() {`
`100`	`100`	`}`
`101`	`101`
`102`	`102`	`public boolean isDiffRequest() {`
`103`		`- return requestChangedContent.isDiff();`
	`103`	`+ return changedRequestBody != null && changedRequestBody.isDiff();`
`104`	`104`	`}`
`105`	`105`
`106`	`106`	`}`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ private String ol_changed(List<ChangedOperation> operations) {`
`65`	`65`	`if (operation.isDiffRequest()) {`
`66`	`66`	`ul_detail.append(StringUtils.repeat(' ', 2)).append("Request:")`
`67`	`67`	`.append(System.lineSeparator())`
`68`		`- .append(ul_content(operation.getRequestChangedContent(), true));`
	`68`	`+ .append(ul_content(operation.getChangedRequestBody().getChangedContent(), true));`
`69`	`69`	`}`
`70`	`70`	`if (operation.isDiffResponse()) {`
`71`	`71`	`ul_detail.append(StringUtils.repeat(' ', 2)).append("Return Type:")`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ private ContainerTag ol_changed(List<ChangedOperation> changedOperations) {`
`125`	`125`	`ul_detail.with(li().with(h3("Parameters")).with(ul_param(changedOperation.getChangedParameters())));`
`126`	`126`	`}`
`127`	`127`	`if (changedOperation.isDiffRequest()) {`
`128`		`- ul_detail.with(li().with(h3("Request")).with(ul_request(changedOperation.getRequestChangedContent())));`
	`128`	`+ ul_detail.with(li().with(h3("Request")).with(ul_request(changedOperation.getChangedRequestBody().getChangedContent())));`
`129`	`129`	`} else {`
`130`	`130`	`}`
`131`	`131`	`if (changedOperation.isDiffResponse()) {`
Original file line number	Diff line number	Diff line change
`@@ -103,7 +103,7 @@ private String ol_changed(List<ChangedOperation> changedOperations) {`
`103`	`103`	`}`
`104`	`104`	`if (changedOperation.isDiffRequest()) {`
`105`	`105`	`ul_detail.append(PRE_LI).append("Request")`
`106`		`- .append(ul_request(changedOperation.getRequestChangedContent()));`
	`106`	`+ .append(ul_request(changedOperation.getChangedRequestBody().getChangedContent()));`
`107`	`107`	`}`
`108`	`108`	`if (changedOperation.isDiffResponse()) {`
`109`	`109`	`ul_detail.append(PRE_LI).append("Return Type")`