Add support for changes in summary / description

.circleci/config.yml

@@ -5,7 +5,7 @@ jobs:
     working_directory: ~/openapi-diff
 
     docker:
-      - image: circleci/openjdk:8-jdk-browsers
+      - image: circleci/openjdk:8-jdk-node-browsers
 
     steps:
 
@@ -21,7 +21,7 @@ jobs:
             - ~/.m2
           key: openapi-diff-{{ checksum "pom.xml" }}
 
-      - run: mvn package
+      - run: mvn package -X
 
       - store_test_results:
           path: target/surefire-reports

pom.xml

@@ -53,23 +53,51 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.scm.id>github</project.scm.id>
+        <maven-surefire-plugin.version>2.19.1</maven-surefire-plugin.version>
+        <junit.jupiter.version>5.1.0</junit.jupiter.version>
+        <junit.platform.version>1.1.0</junit.platform.version>
+        <assertj-core.version>3.10.0</assertj-core.version>
     </properties>
 
     <dependencies>
         <dependency>
             <groupId>io.swagger.parser.v3</groupId>
             <artifactId>swagger-parser-v3</artifactId>
-            <version>2.0.4</version>
+            <version>2.0.5</version>
         </dependency>
         <dependency>
             <groupId>com.j2html</groupId>
             <artifactId>j2html</artifactId>
             <version>1.2.0</version>
         </dependency>
         <dependency>
-            <groupId>junit</groupId>
-            <artifactId>junit</artifactId>
-            <version>4.8.2</version>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <version>${junit.jupiter.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-api</artifactId>
+            <version>${junit.jupiter.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.platform</groupId>
+            <artifactId>junit-platform-runner</artifactId>
+            <version>${junit.platform.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.junit.platform</groupId>
+            <artifactId>junit-platform-launcher</artifactId>
+            <version>${junit.platform.version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>${assertj-core.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
@@ -221,6 +249,32 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>${maven-surefire-plugin.version}</version>
+                <configuration>
+                    <includes>
+                        <include>**/Test*.java</include>
+                        <include>**/*Test.java</include>
+                        <include>**/*Tests.java</include>
+                        <include>**/*TestCase.java</include>
+                    </includes>
+                    <useSystemClassLoader>false</useSystemClassLoader>
+                </configuration>
+                <dependencies>
+                    <dependency>
+                        <groupId>org.junit.platform</groupId>
+                        <artifactId>junit-platform-surefire-provider</artifactId>
+                        <version>${junit.platform.version}</version>
+                    </dependency>
+                    <dependency>
+                        <groupId>org.junit.jupiter</groupId>
+                        <artifactId>junit-jupiter-engine</artifactId>
+                        <version>${junit.jupiter.version}</version>
+                    </dependency>
+                </dependencies>
+            </plugin>
             <plugin>
                 <groupId>com.coveo</groupId>
                 <artifactId>fmt-maven-plugin</artifactId>

src/main/java/com/qdesrame/openapi/diff/compare/ApiResponseDiff.java

@@ -23,9 +23,6 @@ public ApiResponseDiff(OpenApiDiff openApiDiff) {
   public Optional<ChangedApiResponse> diff(
       ApiResponses left, ApiResponses right, DiffContext context) {
     MapKeyDiff<String, ApiResponse> responseMapKeyDiff = MapKeyDiff.diff(left, right);
-    ChangedApiResponse changedApiResponse = new ChangedApiResponse(left, right, context);
-    changedApiResponse.setAddResponses(responseMapKeyDiff.getIncreased());
-    changedApiResponse.setMissingResponses(responseMapKeyDiff.getMissing());
     List<String> sharedResponseCodes = responseMapKeyDiff.getSharedKey();
     Map<String, ChangedResponse> resps = new LinkedHashMap<>();
     for (String responseCode : sharedResponseCodes) {
@@ -34,11 +31,15 @@ public Optional<ChangedApiResponse> diff(
           .diff(left.get(responseCode), right.get(responseCode), context)
           .ifPresent(changedResponse -> resps.put(responseCode, changedResponse));
     }
-    changedApiResponse.setChangedResponses(resps);
+    ChangedApiResponse changedApiResponse =
+        new ChangedApiResponse(left, right, context)
+            .setIncreased(responseMapKeyDiff.getIncreased())
+            .setMissing(responseMapKeyDiff.getMissing())
+            .setChanged(resps);
     openApiDiff
         .getExtensionsDiff()
         .diff(left.getExtensions(), right.getExtensions(), context)
-        .ifPresent(changedApiResponse::setChangedExtensions);
+        .ifPresent(changedApiResponse::setExtensions);
     return isChanged(changedApiResponse);
   }
 }

src/main/java/com/qdesrame/openapi/diff/compare/ContentDiff.java

@@ -24,11 +24,8 @@ public boolean compare(Content left, Content right) {
   }
 
   public Optional<ChangedContent> diff(Content left, Content right, DiffContext context) {
-    ChangedContent changedContent = new ChangedContent(left, right, context);
 
     MapKeyDiff<String, MediaType> mediaTypeDiff = MapKeyDiff.diff(left, right);
-    changedContent.setIncreased(mediaTypeDiff.getIncreased());
-    changedContent.setMissing(mediaTypeDiff.getMissing());
     List<String> sharedMediaTypes = mediaTypeDiff.getSharedKey();
     Map<String, ChangedMediaType> changedMediaTypes = new LinkedHashMap<>();
     for (String mediaTypeKey : sharedMediaTypes) {
@@ -43,12 +40,15 @@ public Optional<ChangedContent> diff(Content left, Content right, DiffContext co
               oldMediaType.getSchema(),
               newMediaType.getSchema(),
               context.copyWithRequired(true))
-          .ifPresent(changedMediaType::setChangedSchema);
+          .ifPresent(changedMediaType::setSchema);
       if (!isUnchanged(changedMediaType)) {
         changedMediaTypes.put(mediaTypeKey, changedMediaType);
       }
     }
-    changedContent.setChanged(changedMediaTypes);
-    return isChanged(changedContent);
+    return isChanged(
+        new ChangedContent(left, right, context)
+            .setIncreased(mediaTypeDiff.getIncreased())
+            .setMissing(mediaTypeDiff.getMissing())
+            .setChanged(changedMediaTypes));
   }
 }

src/main/java/com/qdesrame/openapi/diff/compare/HeaderDiff.java

@@ -14,10 +14,10 @@
 
 /** Created by adarsh.sharma on 28/12/17. */
 public class HeaderDiff extends ReferenceDiffCache<Header, ChangedHeader> {
+  private static RefPointer<Header> refPointer = new RefPointer<>(RefType.HEADERS);
   private OpenApiDiff openApiDiff;
   private Components leftComponents;
   private Components rightComponents;
-  private static RefPointer<Header> refPointer = new RefPointer<>(RefType.HEADERS);
 
   public HeaderDiff(OpenApiDiff openApiDiff) {
     this.openApiDiff = openApiDiff;
@@ -41,27 +41,30 @@ protected Optional<ChangedHeader> computeDiff(
     left = refPointer.resolveRef(leftComponents, left, left.get$ref());
     right = refPointer.resolveRef(rightComponents, right, right.get$ref());
 
-    ChangedHeader changedHeader = new ChangedHeader(left, right, context);
-
-    changedHeader.setChangeDescription(
-        !Objects.equals(left.getDescription(), right.getDescription()));
-    changedHeader.setChangeRequired(getBooleanDiff(left.getRequired(), right.getRequired()));
-    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()));
+    ChangedHeader changedHeader =
+        new ChangedHeader(left, right, context)
+            .setRequired(getBooleanDiff(left.getRequired(), right.getRequired()))
+            .setDeprecated(
+                !Boolean.TRUE.equals(left.getDeprecated())
+                    && Boolean.TRUE.equals(right.getDeprecated()))
+            .setStyle(!Objects.equals(left.getStyle(), right.getStyle()))
+            .setExplode(getBooleanDiff(left.getExplode(), right.getExplode()));
+    openApiDiff
+        .getMetadataDiff()
+        .diff(left.getDescription(), right.getDescription(), context)
+        .ifPresent(changedHeader::setDescription);
     openApiDiff
         .getSchemaDiff()
         .diff(new HashSet<>(), left.getSchema(), right.getSchema(), context.copyWithRequired(true))
-        .ifPresent(changedHeader::setChangedSchema);
+        .ifPresent(changedHeader::setSchema);
     openApiDiff
         .getContentDiff()
         .diff(left.getContent(), right.getContent(), context)
-        .ifPresent(changedHeader::setChangedContent);
+        .ifPresent(changedHeader::setContent);
     openApiDiff
         .getExtensionsDiff()
         .diff(left.getExtensions(), right.getExtensions(), context)
-        .ifPresent(changedHeader::setChangedExtensions);
+        .ifPresent(changedHeader::setExtensions);
     return isChanged(changedHeader);
   }
 

src/main/java/com/qdesrame/openapi/diff/compare/HeadersDiff.java

@@ -21,10 +21,7 @@ public HeadersDiff(OpenApiDiff openApiDiff) {
 
   public Optional<ChangedHeaders> diff(
       Map<String, Header> left, Map<String, Header> right, DiffContext context) {
-    ChangedHeaders changedHeaders = new ChangedHeaders(left, right, context);
     MapKeyDiff<String, Header> headerMapDiff = MapKeyDiff.diff(left, right);
-    changedHeaders.setIncreased(headerMapDiff.getIncreased());
-    changedHeaders.setMissing(headerMapDiff.getMissing());
     List<String> sharedHeaderKeys = headerMapDiff.getSharedKey();
 
     Map<String, ChangedHeader> changed = new LinkedHashMap<>();
@@ -36,8 +33,10 @@ public Optional<ChangedHeaders> diff(
           .diff(oldHeader, newHeader, context)
           .ifPresent(changedHeader -> changed.put(headerKey, changedHeader));
     }
-    changedHeaders.setChanged(changed);
-
-    return isChanged(changedHeaders);
+    return isChanged(
+        new ChangedHeaders(left, right, context)
+            .setIncreased(headerMapDiff.getIncreased())
+            .setMissing(headerMapDiff.getMissing())
+            .setChanged(changed));
   }
 }

src/main/java/com/qdesrame/openapi/diff/compare/MetadataDiff.java

@@ -0,0 +1,31 @@
+package com.qdesrame.openapi.diff.compare;
+
+import static com.qdesrame.openapi.diff.utils.ChangedUtils.isChanged;
+
+import com.qdesrame.openapi.diff.model.ChangedMetadata;
+import com.qdesrame.openapi.diff.model.DiffContext;
+import io.swagger.v3.oas.models.Components;
+import java.util.Optional;
+
+public class MetadataDiff {
+
+  private Components leftComponents;
+  private Components rightComponents;
+  private OpenApiDiff openApiDiff;
+
+  public MetadataDiff(OpenApiDiff openApiDiff) {
+    this.openApiDiff = openApiDiff;
+    this.leftComponents =
+        openApiDiff.getOldSpecOpenApi() != null
+            ? openApiDiff.getOldSpecOpenApi().getComponents()
+            : null;
+    this.rightComponents =
+        openApiDiff.getNewSpecOpenApi() != null
+            ? openApiDiff.getNewSpecOpenApi().getComponents()
+            : null;
+  }
+
+  public Optional<ChangedMetadata> diff(String left, String right, DiffContext context) {
+    return isChanged(new ChangedMetadata().setLeft(left).setRight(right));
+  }
+}

src/main/java/com/qdesrame/openapi/diff/compare/OAuthFlowDiff.java

@@ -24,16 +24,16 @@ private static Map<String, Object> getExtensions(OAuthFlow oAuthFlow) {
   public Optional<ChangedOAuthFlow> diff(OAuthFlow left, OAuthFlow right) {
     ChangedOAuthFlow changedOAuthFlow = new ChangedOAuthFlow(left, right);
     if (left != null && right != null) {
-      changedOAuthFlow.setChangedAuthorizationUrl(
-          !Objects.equals(left.getAuthorizationUrl(), right.getAuthorizationUrl()));
-      changedOAuthFlow.setChangedTokenUrl(!Objects.equals(left.getTokenUrl(), right.getTokenUrl()));
-      changedOAuthFlow.setChangedRefreshUrl(
-          !Objects.equals(left.getRefreshUrl(), right.getRefreshUrl()));
+      changedOAuthFlow
+          .setAuthorizationUrl(
+              !Objects.equals(left.getAuthorizationUrl(), right.getAuthorizationUrl()))
+          .setTokenUrl(!Objects.equals(left.getTokenUrl(), right.getTokenUrl()))
+          .setRefreshUrl(!Objects.equals(left.getRefreshUrl(), right.getRefreshUrl()));
     }
     openApiDiff
         .getExtensionsDiff()
         .diff(getExtensions(left), getExtensions(right))
-        .ifPresent(changedOAuthFlow::setChangedExtensions);
+        .ifPresent(changedOAuthFlow::setExtensions);
     return isChanged(changedOAuthFlow);
   }
 }

src/main/java/com/qdesrame/openapi/diff/compare/OAuthFlowsDiff.java

@@ -26,24 +26,24 @@ public Optional<ChangedOAuthFlows> diff(OAuthFlows left, OAuthFlows right) {
       openApiDiff
           .getOAuthFlowDiff()
           .diff(left.getImplicit(), right.getImplicit())
-          .ifPresent(changedOAuthFlows::setChangedImplicitOAuthFlow);
+          .ifPresent(changedOAuthFlows::setImplicitOAuthFlow);
       openApiDiff
           .getOAuthFlowDiff()
           .diff(left.getPassword(), right.getPassword())
-          .ifPresent(changedOAuthFlows::setChangedPasswordOAuthFlow);
+          .ifPresent(changedOAuthFlows::setPasswordOAuthFlow);
       openApiDiff
           .getOAuthFlowDiff()
           .diff(left.getClientCredentials(), right.getClientCredentials())
-          .ifPresent(changedOAuthFlows::setChangedClientCredentialOAuthFlow);
+          .ifPresent(changedOAuthFlows::setClientCredentialOAuthFlow);
       openApiDiff
           .getOAuthFlowDiff()
           .diff(left.getAuthorizationCode(), right.getAuthorizationCode())
-          .ifPresent(changedOAuthFlows::setChangedAuthorizationCodeOAuthFlow);
+          .ifPresent(changedOAuthFlows::setAuthorizationCodeOAuthFlow);
     }
     openApiDiff
         .getExtensionsDiff()
         .diff(getExtensions(left), getExtensions(right))
-        .ifPresent(changedOAuthFlows::setChangedExtensions);
+        .ifPresent(changedOAuthFlows::setExtensions);
     return isChanged(changedOAuthFlows);
   }
 }

src/main/java/com/qdesrame/openapi/diff/compare/OpenApiDiff.java

@@ -24,7 +24,6 @@ public class OpenApiDiff {
 
   private static Logger logger = LoggerFactory.getLogger(OpenApiDiff.class);
 
-  private ChangedOpenApi changedOpenApi;
   private PathsDiff pathsDiff;
   private PathDiff pathDiff;
   private SchemaDiff schemaDiff;
@@ -43,6 +42,7 @@ public class OpenApiDiff {
   private OAuthFlowsDiff oAuthFlowsDiff;
   private OAuthFlowDiff oAuthFlowDiff;
   private ExtensionsDiff extensionsDiff;
+  private MetadataDiff metadataDiff;
 
   private OpenAPI oldSpecOpenApi;
   private OpenAPI newSpecOpenApi;
@@ -56,7 +56,6 @@ public class OpenApiDiff {
    * @param newSpecOpenApi
    */
   private OpenApiDiff(OpenAPI oldSpecOpenApi, OpenAPI newSpecOpenApi) {
-    this.changedOpenApi = new ChangedOpenApi();
     this.oldSpecOpenApi = oldSpecOpenApi;
     this.newSpecOpenApi = newSpecOpenApi;
     if (null == oldSpecOpenApi || null == newSpecOpenApi) {
@@ -88,6 +87,7 @@ private void initializeFields() {
     this.oAuthFlowsDiff = new OAuthFlowsDiff(this);
     this.oAuthFlowDiff = new OAuthFlowDiff(this);
     this.extensionsDiff = new ExtensionsDiff(this);
+    this.metadataDiff = new MetadataDiff(this);
   }
 
   private ChangedOpenApi compare() {
@@ -167,12 +167,12 @@ private void preProcess(OpenAPI openApi) {
   }
 
   private ChangedOpenApi getChangedOpenApi() {
-    changedOpenApi.setMissingEndpoints(missingEndpoints);
-    changedOpenApi.setNewEndpoints(newEndpoints);
-    changedOpenApi.setNewSpecOpenApi(newSpecOpenApi);
-    changedOpenApi.setOldSpecOpenApi(oldSpecOpenApi);
-    changedOpenApi.setChangedOperations(changedOperations);
-    changedOpenApi.setChangedExtensions(changedExtensions);
-    return changedOpenApi;
+    return new ChangedOpenApi()
+        .setMissingEndpoints(missingEndpoints)
+        .setNewEndpoints(newEndpoints)
+        .setNewSpecOpenApi(newSpecOpenApi)
+        .setOldSpecOpenApi(oldSpecOpenApi)
+        .setChangedOperations(changedOperations)
+        .setChangedExtensions(changedExtensions);
   }
 }