Skip to content

Added ChangedRequestBody #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 27, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 4 additions & 14 deletions src/main/java/com/qdesrame/openapi/diff/compare/OpenApiDiff.java
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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;
Expand Down Expand Up @@ -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);
}

/*
Expand Down Expand Up @@ -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);
Expand Down
Original file line number Diff line number Diff line change
@@ -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;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand Down Expand Up @@ -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() {
Expand All @@ -87,7 +87,7 @@ public boolean isDiff() {
@Override
public boolean isDiffBackwardCompatible() {
return changedParameters.isDiffBackwardCompatible()
&& requestChangedContent.isDiffBackwardCompatible(true)
&& (changedRequestBody == null || changedRequestBody.isDiffBackwardCompatible())
&& changedApiResponse.isDiffBackwardCompatible();
}

Expand All @@ -100,7 +100,7 @@ public boolean isDiffResponse() {
}

public boolean isDiffRequest() {
return requestChangedContent.isDiff();
return changedRequestBody != null && changedRequestBody.isDiff();
}

}
Original file line number Diff line number Diff line change
@@ -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);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -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:")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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()) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down