Bug/12 report without name (#13)

* bug/12: Added support for writing a report without name and version

Author: jakobbraun

doc/changes/changelog.md

@@ -1,5 +1,6 @@
 # Changes
 
+* [2.0.1](changes_2.0.1.md)
 * [2.0.0](changes_2.0.0.md)
 * [1.1.1](changes_1.1.1.md)
 * [1.1.0](changes_1.1.0.md)

doc/changes/changes_2.0.1.md

@@ -0,0 +1,9 @@
+# Error Code Model Java 2.0.1, released 2022-03-25
+
+Code name: Writing Report Without Name or Version
+
+## Bug Fixes:
+
+* #12: Added support for writing a report without name and version
+
+## Dependency Updates

pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.exasol</groupId>
     <artifactId>error-code-model-java</artifactId>
-    <version>2.0.0</version>
+    <version>2.0.1</version>
     <name>Error Code Model Java</name>
     <description>Library for describing error message declarations in Java.</description>
     <url>https://github.com/exasol/error-code-model-java</url>

src/main/java/com/exsol/errorcodemodel/ErrorCodeReportWriter.java

@@ -39,8 +39,12 @@ public void writeReport(final ErrorCodeReport report, final Path target) {
     private JsonObject renderReport(final ErrorCodeReport report) {
         final JsonObjectBuilder reportJson = JSON.createObjectBuilder();
         reportJson.add("$schema", SCHEMA);
-        reportJson.add("projectName", report.getProjectName());
-        reportJson.add("projectVersion", report.getProjectVersion());
+        if (report.getProjectName() != null) {
+            reportJson.add("projectName", report.getProjectName());
+        }
+        if (report.getProjectVersion() != null) {
+            reportJson.add("projectVersion", report.getProjectVersion());
+        }
         reportJson.add("errorCodes", renderErrorCodes(report.getErrorMessageDeclarations()));
         return reportJson.build();
     }

src/test/java/com/exsol/errorcodemodel/ErrorCodeReportWriterTest.java

@@ -13,17 +13,27 @@
 
 class ErrorCodeReportWriterTest {
 
+    private static final ErrorMessageDeclaration AN_ERROR_CODE = ErrorMessageDeclaration.builder().identifier(//
+            "E-Test-1")//
+            .prependMessage("My message.")//
+            .addParameter("TEST", "A parameter")//
+            .setPosition("test.java", 2).build();
+
     @Test
     void testWriteReport(@TempDir final Path tempDir) throws IOException {
-        final ErrorCodeReport report = new ErrorCodeReport("my-demo-project", "1.2.3",
-                List.of(ErrorMessageDeclaration.builder().identifier(//
-                        "E-Test-1")//
-                        .prependMessage("My message.")//
-                        .addParameter("TEST", "A parameter")//
-                        .setPosition("test.java", 2).build()));
+        final ErrorCodeReport report = new ErrorCodeReport("my-demo-project", "1.2.3", List.of(AN_ERROR_CODE));
         final Path reportFile = tempDir.resolve("error_code_report.json");
         new ErrorCodeReportWriter().writeReport(report, reportFile);
         assertThat(Files.readString(reportFile), equalTo(
                 "{\"$schema\":\"https://schemas.exasol.com/error_code_report-1.0.0.json\",\"projectName\":\"my-demo-project\",\"projectVersion\":\"1.2.3\",\"errorCodes\":[{\"identifier\":\"E-Test-1\",\"message\":\"My message.\",\"messagePlaceholders\":[{\"placeholder\":\"TEST\",\"description\":\"A parameter\"}],\"sourceFile\":\"test.java\",\"sourceLine\":2,\"mitigations\":[]}]}"));
     }
+
+    @Test
+    void testWriteWithoutNameAndVersion(@TempDir final Path tempDir) throws IOException {
+        final ErrorCodeReport report = new ErrorCodeReport(null, null, List.of(AN_ERROR_CODE));
+        final Path reportFile = tempDir.resolve("error_code_report.json");
+        new ErrorCodeReportWriter().writeReport(report, reportFile);
+        assertThat(Files.readString(reportFile), equalTo(
+                "{\"$schema\":\"https://schemas.exasol.com/error_code_report-1.0.0.json\",\"errorCodes\":[{\"identifier\":\"E-Test-1\",\"message\":\"My message.\",\"messagePlaceholders\":[{\"placeholder\":\"TEST\",\"description\":\"A parameter\"}],\"sourceFile\":\"test.java\",\"sourceLine\":2,\"mitigations\":[]}]}"));
+    }
 }