Merge pull request #42 from entur/same-as

Implement sameAs method to check if the outcome of two validation events are the same

Author: testower

src/main/java/org/entur/gbfs/validation/model/FileValidationError.java

@@ -18,7 +18,9 @@
 
 package org.entur.gbfs.validation.model;
 
-public class FileValidationError {
+import java.util.Objects;
+
+public class FileValidationError implements ValidationResultComponentIdentity<FileValidationError> {
     private String schemaPath;
     private String violationPath;
     private String message;
@@ -55,4 +57,13 @@ public String toString() {
                 ", message='" + message + '\'' +
                 '}';
     }
+
+    @Override
+    public boolean sameAs(FileValidationError other) {
+        if (other == null) return false;
+        if (!Objects.equals(schemaPath, other.schemaPath)) return false;
+        if (!Objects.equals(violationPath, other.violationPath))
+            return false;
+        return Objects.equals(message, other.message);
+    }
 }

src/main/java/org/entur/gbfs/validation/model/FileValidationResult.java

@@ -19,8 +19,10 @@
 package org.entur.gbfs.validation.model;
 
 import java.util.List;
+import java.util.Objects;
+import java.util.stream.IntStream;
 
-public class FileValidationResult {
+public class FileValidationResult implements ValidationResultComponentIdentity<FileValidationResult> {
     private String file;
     private boolean required;
     private boolean exists;
@@ -107,4 +109,19 @@ public String toString() {
                 ", errors=" + errors +
                 '}';
     }
+
+    @Override
+    public boolean sameAs(FileValidationResult other) {
+        if (other == null) return false;
+        if (required != other.required) return false;
+        if (exists != other.exists) return false;
+        if (errorsCount != other.errorsCount) return false;
+        if (!Objects.equals(file, other.file)) return false;
+        if (!Objects.equals(schema, other.schema)) return false;
+        if (!Objects.equals(fileContents, other.fileContents)) return false;
+        if (!Objects.equals(version, other.version)) return false;
+        return IntStream
+                .range(0, errors.size())
+                .allMatch(i -> errors.get(i).sameAs(other.errors.get(i)));
+    }
 }

src/main/java/org/entur/gbfs/validation/model/ValidationResult.java

@@ -21,7 +21,7 @@
 import java.util.HashMap;
 import java.util.Map;
 
-public class ValidationResult {
+public class ValidationResult implements ValidationResultComponentIdentity<ValidationResult> {
     private ValidationSummary summary = new ValidationSummary();
     private Map<String, FileValidationResult> files = new HashMap<>();
 
@@ -48,4 +48,11 @@ public String toString() {
                 ", files=" + files +
                 '}';
     }
+
+    @Override
+    public boolean sameAs(ValidationResult other) {
+        if (other == null) return false;
+        if (!summary.sameAs(other.getSummary())) return false;
+        return files.entrySet().stream().allMatch(entry -> other.files.get(entry.getKey()).sameAs(entry.getValue()));
+    }
 }

src/main/java/org/entur/gbfs/validation/model/ValidationResultComponentIdentity.java

@@ -0,0 +1,30 @@
+/*
+ *
+ *  *
+ *  *
+ *  *  * Licensed under the EUPL, Version 1.2 or – as soon they will be approved by
+ *  *  * the European Commission - subsequent versions of the EUPL (the "Licence");
+ *  *  * You may not use this work except in compliance with the Licence.
+ *  *  * You may obtain a copy of the Licence at:
+ *  *  *
+ *  *  *   https://joinup.ec.europa.eu/software/page/eupl
+ *  *  *
+ *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  * distributed under the Licence is distributed on an "AS IS" basis,
+ *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  * See the Licence for the specific language governing permissions and
+ *  *  * limitations under the Licence.
+ *  *
+ *
+ */
+
+package org.entur.gbfs.validation.model;
+
+public interface ValidationResultComponentIdentity<T> {
+
+    /**
+     * Check if the (part of) a validation result is the same as another one. Should return true for two validation
+     * events at different times with the same outcome
+     */
+    boolean sameAs(T other);
+}

src/main/java/org/entur/gbfs/validation/model/ValidationSummary.java

@@ -18,7 +18,9 @@
 
 package org.entur.gbfs.validation.model;
 
-public class ValidationSummary {
+import java.util.Objects;
+
+public class ValidationSummary implements ValidationResultComponentIdentity<ValidationSummary> {
     private String version;
     private long timestamp;
     private int errorsCount;
@@ -55,4 +57,11 @@ public String toString() {
                 ", errorsCount=" + errorsCount +
                 '}';
     }
+
+    @Override
+    public boolean sameAs(ValidationSummary other) {
+        if (other == null) return false;
+        if (errorsCount != other.errorsCount) return false;
+        return Objects.equals(version, other.version);
+    }
 }

src/test/java/org/entur/gbfs/validation/model/ValidationResultTest.java

@@ -0,0 +1,97 @@
+/*
+ *
+ *  *
+ *  *
+ *  *  * Licensed under the EUPL, Version 1.2 or – as soon they will be approved by
+ *  *  * the European Commission - subsequent versions of the EUPL (the "Licence");
+ *  *  * You may not use this work except in compliance with the Licence.
+ *  *  * You may obtain a copy of the Licence at:
+ *  *  *
+ *  *  *   https://joinup.ec.europa.eu/software/page/eupl
+ *  *  *
+ *  *  * Unless required by applicable law or agreed to in writing, software
+ *  *  * distributed under the Licence is distributed on an "AS IS" basis,
+ *  *  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  *  * See the Licence for the specific language governing permissions and
+ *  *  * limitations under the Licence.
+ *  *
+ *
+ */
+
+package org.entur.gbfs.validation.model;
+
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
+import java.util.List;
+import java.util.Map;
+
+class ValidationResultTest {
+
+    @Test
+    void testSameAsSucceeds() {
+        Assertions.assertTrue(generateValidationResult(
+                "message-1",
+                "message-2"
+        ).sameAs(generateValidationResult(
+                "message-1",
+                "message-2"
+        )));
+    }
+
+    @Test
+    void testSameAsFails() {
+        Assertions.assertFalse(generateValidationResult(
+                "message-1",
+                "message-2"
+        ).sameAs(generateValidationResult(
+                "message-1",
+                "message-3"
+        )));
+    }
+
+    private ValidationResult generateValidationResult(String message1, String message2) {
+        var validationResult = new ValidationResult();
+
+        validationResult.setFiles(
+                Map.of(
+                        "gbfs", generateFileValidationResult(message1, message2)
+                )
+        );
+
+        return validationResult;
+    }
+
+    private ValidationSummary generateValidationSummary() {
+        var validationSummary = new ValidationSummary();
+        validationSummary.setVersion("2.2");
+        validationSummary.setTimestamp(System.currentTimeMillis());
+        validationSummary.setErrorsCount(2);
+        return validationSummary;
+    }
+
+    private FileValidationResult generateFileValidationResult(String message1, String message2) {
+        var fileValidationResult = new FileValidationResult();
+
+        fileValidationResult.setFile("gbfs");
+        fileValidationResult.setExists(true);
+        fileValidationResult.setRequired(true);
+        fileValidationResult.setErrorsCount(2);
+        fileValidationResult.setErrors(List.of(
+                generateFileValidationError(message1),
+                generateFileValidationError(message2)
+        ));
+
+        return fileValidationResult;
+    }
+
+    private FileValidationError generateFileValidationError(String message) {
+        var fileValidationError = new FileValidationError();
+
+        fileValidationError.setMessage(message);
+        fileValidationError.setSchemaPath("schema/path");
+        fileValidationError.setViolationPath("violation/path");
+
+        return fileValidationError;
+    }
+}