changed equal validation for changed example to properly validate arrays of primitive types

changed equal validation for changed example to properly validate arrays of primitive types

Author: wexom

core/src/main/java/org/openapitools/openapidiff/core/model/ChangedExample.java

@@ -1,5 +1,6 @@
 package org.openapitools.openapidiff.core.model;
 
+import java.lang.reflect.Array;
 import java.util.Objects;
 
 public class ChangedExample implements Changed {
@@ -30,9 +31,35 @@ public void setRightExample(Object rightExample) {
 
   @Override
   public DiffResult isChanged() {
-    if (!Objects.equals(leftExample, rightExample)) {
+    DiffResult arrayDiff = compareArrays();
+    if (arrayDiff != null) {
+      return arrayDiff;
+    }
+
+    return Objects.equals(leftExample, rightExample) ? DiffResult.NO_CHANGES : DiffResult.METADATA;
+  }
+
+  private DiffResult compareArrays() {
+    if (leftExample == null || rightExample == null) {
+      return null;
+    }
+
+    if (!leftExample.getClass().isArray() || !rightExample.getClass().isArray()) {
+      return null;
+    }
+
+    int leftLength = Array.getLength(leftExample);
+
+    if (leftLength != Array.getLength(rightExample)) {
       return DiffResult.METADATA;
     }
+
+    for (int i = 0; i < leftLength; i++) {
+      if (!Objects.deepEquals(Array.get(leftExample, i), Array.get(rightExample, i))) {
+        return DiffResult.METADATA;
+      }
+    }
+
     return DiffResult.NO_CHANGES;
   }
 

core/src/test/java/org/openapitools/openapidiff/core/output/ConsoleRenderTest.java

@@ -4,6 +4,7 @@
 
 import java.io.ByteArrayOutputStream;
 import java.io.OutputStreamWriter;
+import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.Test;
 import org.openapitools.openapidiff.core.OpenApiCompare;
 import org.openapitools.openapidiff.core.model.ChangedOpenApi;
@@ -76,4 +77,19 @@ public void renderShowsWhatsChangedSectionWithCorrectFormattingWhenEndpointIsCha
         .contains("What's Changed")
         .containsSubsequence("- GET    /widgets", "Parameter:", "- Changed query-param-1 in query");
   }
+
+  @Test
+  void renderShowsNoDifferencesWhenCSVMediaTypeResponseExampleIsByteArray() {
+    ConsoleRender render = new ConsoleRender();
+    ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+    OutputStreamWriter outputStreamWriter = new OutputStreamWriter(outputStream);
+    ChangedOpenApi diff =
+        OpenApiCompare.fromLocations(
+            "issue-828-binary-example-for-csv-media-type.yaml",
+            "issue-828-binary-example-for-csv-media-type.yaml");
+    render.render(diff, outputStreamWriter);
+    Assertions.assertThat(outputStream.toString()).isNotBlank();
+    Assertions.assertThat(outputStream.toString())
+        .hasToString("No differences. Specifications are equivalents");
+  }
 }

core/src/test/resources/issue-828-binary-example-for-csv-media-type.yaml

@@ -0,0 +1,26 @@
+openapi: 3.0.1
+info:
+  title: My API
+  version: 1.0.0
+paths:
+  /api/v1/csv:
+    get:
+      operationId: someCsvEndpoint
+      responses:
+        "200":
+          content:
+            text/csv:
+              schema:
+                type: string
+                format: binary
+                example: Example
+          description: Successful operation
+      security:
+        - Bearer: []
+      summary: Download a CSV or something
+components:
+  securitySchemes:
+    Bearer:
+      bearerFormat: JWT
+      scheme: bearer
+      type: http