feat(impl): [#559] write irs-api.actual.yaml if there are differences…

… (to simplify comparison)
eclipse-tractusx · May 11, 2024 · 7e61c02 · 7e61c02
1 parent 183658e
commit 7e61c02
Showing 1 changed file with 20 additions and 14 deletions.
diff --git a/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsApplicationTests.java b/irs-api/src/test/java/org/eclipse/tractusx/irs/IrsApplicationTests.java
@@ -28,6 +28,7 @@
 import java.io.InputStream;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.TimeUnit;
@@ -88,20 +89,25 @@ void generatedOpenApiMatchesContract() throws Exception {
         final Map<String, Object> definedYamlMap = mapper.readerForMapOf(Object.class).readValue(definedYaml);
         final Map<String, Object> generatedYamlMap = mapper.readerForMapOf(Object.class).readValue(generatedYaml);
 
-        // To correctly display both documentations examples - manual and generated by annotations -
-        // we need to remove verification for some "examples", otherwise one or another won't display correctly
-        assertThat(generatedYamlMap)
-
-                .usingRecursiveComparison()
-
-                .ignoringFields("components.schemas.PageResult.example")
-                .ignoringFields("components.schemas.AspectModels.example")
-                .ignoringFields("components.schemas.BatchOrderResponse.example")
-                .ignoringFields("components.schemas.Jobs.example")
-                .ignoringFields("components.schemas.Policy")
-                .ignoringFields("components.schemas.BatchResponse.example")
-
-                .isEqualTo(definedYamlMap);
+        try {
+            // To correctly display both documentations examples - manual and generated by annotations -
+            // we need to remove verification for some "examples", otherwise one or another won't display correctly
+            assertThat(generatedYamlMap)
+
+                    .usingRecursiveComparison()
+
+                    .ignoringFields("components.schemas.PageResult.example")
+                    .ignoringFields("components.schemas.AspectModels.example")
+                    .ignoringFields("components.schemas.BatchOrderResponse.example")
+                    .ignoringFields("components.schemas.Jobs.example")
+                    .ignoringFields("components.schemas.Policy")
+                    .ignoringFields("components.schemas.BatchResponse.example")
+
+                    .isEqualTo(definedYamlMap);
+        } catch (AssertionError e) {
+            // write changed API to file for easier comparison
+            Files.writeString(Paths.get("../docs/src/api/irs-api.actual.yaml"), generatedYaml);
+        }
 
     }