FCREPO-3812: Add failure only reporting option

src/main/java/org/fcrepo/migration/validator/Driver.java

@@ -104,6 +104,10 @@ public class Driver implements Callable<Integer> {
                         description = "Validate objects in the Inactive state as deleted.")
     private boolean deleteInactive;
 
+    @CommandLine.Option(names = {"--failure-only"}, order = 19,
+                        description = "Report only objects which have failed validations.")
+    private boolean failureOnly;
+
     @CommandLine.Option(names = {"--debug"}, order = 30, description = "Enables debug logging")
     private boolean debug;
 
@@ -125,6 +129,7 @@ public Integer call() {
         config.setOcflRepositoryRootDirectory(ocflRootDirectory);
         config.setObjectsToValidate(objectsToValidate);
         config.setDeleteInactive(deleteInactive);
+        config.setFailureOnly(failureOnly);
         LOGGER.info("Configuration created: {}", config);
 
         LOGGER.info("Preparing to execute validation run...");

src/main/java/org/fcrepo/migration/validator/impl/ApplicationConfigurationHelper.java

@@ -64,7 +64,7 @@ public ApplicationConfigurationHelper(final Fedora3ValidationConfig config) {
     }
 
     public ValidationResultWriter validationResultWriter() {
-        return new FileSystemValidationResultWriter(config.getJsonOutputDirectory());
+        return new FileSystemValidationResultWriter(config.getJsonOutputDirectory(), config.isFailureOnly());
     }
 
     public ObjectSource objectSource() {

src/main/java/org/fcrepo/migration/validator/impl/F3ObjectValidationTask.java

@@ -49,7 +49,7 @@ public F3ObjectValidationTask(final FedoraObjectProcessor processor,
 
     @Override
     public void run() {
-        LOGGER.info("starting to process {} ", processor.getObjectInfo().getPid());
+        LOGGER.info("Processing {} ", processor.getObjectInfo().getPid());
         final var validator = new Fedora3ObjectValidator(ocflObjectSessionFactory, objectValidationConfig);
         final var results = validator.validate(processor);
         writer.write(results);

src/main/java/org/fcrepo/migration/validator/impl/Fedora3ValidationConfig.java

@@ -17,6 +17,7 @@
 public class Fedora3ValidationConfig extends ValidationConfig {
 
     private boolean checksum;
+    private boolean failureOnly;
     private boolean deleteInactive;
     private boolean validateHeadOnly;
     private boolean checkNumObjects;
@@ -183,4 +184,16 @@ public Fedora3ValidationConfig setDeleteInactive(final boolean deleteInactive) {
         this.deleteInactive = deleteInactive;
         return this;
     }
+
+    public boolean isFailureOnly() {
+        return failureOnly;
+    }
+
+    /**
+     * @param failureOnly
+     */
+    public Fedora3ValidationConfig setFailureOnly(final boolean failureOnly) {
+        this.failureOnly = failureOnly;
+        return this;
+    }
 }

src/main/java/org/fcrepo/migration/validator/impl/FileSystemValidationResultWriter.java

@@ -14,6 +14,7 @@
 import java.nio.file.Path;
 import java.util.List;
 
+import static org.fcrepo.migration.validator.api.ValidationResult.Status.OK;
 import static org.fcrepo.migration.validator.impl.ValidationResultUtils.resolvePathToJsonResult;
 import static org.slf4j.LoggerFactory.getLogger;
 
@@ -26,24 +27,30 @@ public class FileSystemValidationResultWriter implements ValidationResultWriter
 
     private static final Logger LOGGER = getLogger(FileSystemValidationResultWriter.class);
 
-    private Path validationRoot;
-
+    private final Path validationRoot;
+    private final boolean writeFailureOnly;
 
     /**
      * Constructor
      *
      * @param validationRoot The root of validation report associated with the run
+     * @param writeFailureOnly Flag to indicate if we should write only failed validations or all
      */
-    public FileSystemValidationResultWriter(final Path validationRoot) {
+    public FileSystemValidationResultWriter(final Path validationRoot, final boolean writeFailureOnly) {
         this.validationRoot = validationRoot;
-        this.validationRoot.toFile().mkdirs();
+        this.writeFailureOnly = writeFailureOnly;
+        validationRoot.toFile().mkdirs();
     }
 
     @Override
     public void write(final List<ValidationResult> results) {
         final var objectMapper = new ObjectMapper();
         for (final var result : results) {
-            LOGGER.info("Writing of results here: {}", result);
+            if (result.getStatus() == OK && writeFailureOnly) {
+                continue;
+            }
+
+            LOGGER.debug("Writing of results here: {}", result);
             final var jsonFilePath = this.validationRoot.resolve(resolvePathToJsonResult(result));
             final var file = jsonFilePath.toFile();
             file.getParentFile().mkdirs();

src/main/java/org/fcrepo/migration/validator/impl/ValidatingObjectHandler.java

@@ -289,7 +289,7 @@ private void validateObjectProperty(final ObjectProperty op, final ResourceHeade
         final var property = op.getName();
         final var sourceValue = op.getValue();
 
-        LOGGER.info("PID = {}, object property: name = {}, value = {}", pid, property, sourceValue);
+        LOGGER.debug("PID = {}, object property: name = {}, value = {}", pid, property, sourceValue);
         final var resolver = OCFL_PROPERTY_RESOLVERS.get(property);
         if (resolver != null) {
             final var success = "pid: %s -> properties match: f3 prop name=%s, source=%s, target=%s";
@@ -303,7 +303,7 @@ private void validateObjectProperty(final ObjectProperty op, final ResourceHeade
                         .map(targetVal -> resolver.equals(sourceValue, targetVal) ?
                                  builder.ok(METADATA, format(success, pid, property, sourceValue, targetVal)) :
                                  builder.fail(METADATA, format(error, pid, property, sourceValue, targetVal)))
-                        .orElse(builder.fail(METADATA, format(notFound, pid, property, sourceValue)));
+                        .orElseGet(() -> builder.fail(METADATA, format(notFound, pid, property, sourceValue)));
             validationResults.add(result);
         }
     }
@@ -584,7 +584,7 @@ private void validateSize(final DatastreamVersion dsVersion,
                     return builder.ok(BINARY_SIZE, format(success, version, sourceBytes));
                 }
                 return builder.fail(BINARY_SIZE, format(error, version, sourceBytes, targetBytes));
-            }).orElse(builder.fail(BINARY_SIZE, format(notFound, version, "source")));
+            }).orElseGet(() -> builder.fail(BINARY_SIZE, format(notFound, version, "source")));
             validationResults.add(result);
         }
     }
@@ -636,6 +636,7 @@ public ValidationResult ok(final ValidationType type, final String details) {
         }
 
         public ValidationResult fail(final ValidationType type, final String details) {
+            LOGGER.info("[{}] {} validation failed: {}", sourceObjectId, type, details);
             return new ValidationResult(indexCounter++, FAIL, validationLevel, type, sourceObjectId, targetObjectId,
                                         sourceResource, targetResource, details);
         }

src/main/resources/templates/summary.ftl

@@ -49,7 +49,7 @@
     <h2>Summary</h2>
     <table>
       <tr>
-        <td>Total objects:</td>
+        <td>Total object reports:</td>
         <td>${objectCount}</td>
       </tr>
       <tr>
@@ -70,6 +70,7 @@
   </div>
   </#if>
 
+  <#if objectCount gt 0>
   <div class="container">
     <h2>Object result details</h2>
     <ol>
@@ -78,5 +79,6 @@
       </#list>
     </ol>
   </div>
+  </#if>
 </body>
 </html>

src/test/java/org/fcrepo/migration/validator/ReportGeneratorIT.java

@@ -0,0 +1,125 @@
+/*
+ * The contents of this file are subject to the license and copyright
+ * detailed in the LICENSE and NOTICE files at the root of the source
+ * tree.
+ */
+package org.fcrepo.migration.validator;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.Arrays;
+import java.util.Collection;
+import java.util.List;
+import java.util.function.Predicate;
+import java.util.regex.Pattern;
+import java.util.stream.Collectors;
+
+import edu.wisc.library.ocfl.api.OcflRepository;
+import org.fcrepo.migration.validator.impl.ApplicationConfigurationHelper;
+import org.fcrepo.migration.validator.impl.Fedora3ValidationExecutionManager;
+import org.fcrepo.migration.validator.report.CsvReportHandler;
+import org.fcrepo.migration.validator.report.HtmlReportHandler;
+import org.fcrepo.migration.validator.report.ReportGeneratorImpl;
+import org.fcrepo.migration.validator.report.ReportType;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.Parameterized;
+
+/**
+ *
+ * @author mikejritter
+ */
+@RunWith(Parameterized.class)
+public class ReportGeneratorIT extends AbstractValidationIT {
+
+    @Parameterized.Parameters
+    public static Collection<Object[]> data() {
+        return Arrays.asList(new Object[][] {
+            { ReportType.html }, { ReportType.csv }
+        });
+    }
+
+    /**
+     * Regex to ignore non-object reports
+     */
+    private static final Predicate<String> IGNORE = Pattern.compile("index|repository|migration-validation-summary")
+               .asPredicate()
+               .negate();
+
+    private final ReportType reportType;
+
+    public ReportGeneratorIT(final ReportType reportType) {
+        this.reportType = reportType;
+    }
+
+    @Test
+    public void testAllPass() throws Exception {
+        final var f3ObjectsDir = new File(FIXTURES_BASE_DIR, "valid/f3/objects");
+        final var f3DatastreamsDir = new File(FIXTURES_BASE_DIR, "valid/f3/datastreams");
+        final var f6OcflRootDir = new File(FIXTURES_BASE_DIR, "valid/f6/data/ocfl-root");
+
+        final var config = getConfig(f3DatastreamsDir, f3ObjectsDir, f6OcflRootDir);
+        final var reportDir = config.getReportDirectory(reportType);
+
+        final var configHelper = new ApplicationConfigurationHelper(config);
+        final var executionManager = new Fedora3ValidationExecutionManager(configHelper);
+        executionManager.doValidation();
+
+        final var handler = reportType == ReportType.html ? new HtmlReportHandler(reportDir)
+                                                          : new CsvReportHandler(reportDir, reportType);
+        final var generator = new ReportGeneratorImpl(config.getJsonOutputDirectory(), handler);
+        generator.generate();
+
+        final var ocflRepository = configHelper.ocflRepository();
+        final var objectIds = getExpectedObjectReports(ocflRepository, reportType);
+
+        // get object reports and validate
+        final var objectReports = getObjectReports(reportDir, IGNORE);
+        assertThat(objectReports)
+            .hasSize(objectIds.size())
+            .allMatch(objectIds::contains);
+    }
+
+    @Test
+    public void testOnlyWriteFailureAllPass() throws IOException {
+        final var f3ObjectsDir = new File(FIXTURES_BASE_DIR, "valid/f3/objects");
+        final var f3DatastreamsDir = new File(FIXTURES_BASE_DIR, "valid/f3/datastreams");
+        final var f6OcflRootDir = new File(FIXTURES_BASE_DIR, "valid/f6/data/ocfl-root");
+
+        final var config = getConfig(f3DatastreamsDir, f3ObjectsDir, f6OcflRootDir);
+        config.setFailureOnly(true);
+        final var reportDir = config.getReportDirectory(reportType);
+
+        final var configHelper = new ApplicationConfigurationHelper(config);
+        final var executionManager = new Fedora3ValidationExecutionManager(configHelper);
+        executionManager.doValidation();
+
+        final var handler = reportType == ReportType.html ? new HtmlReportHandler(reportDir)
+                                                          : new CsvReportHandler(reportDir, reportType);
+        final var generator = new ReportGeneratorImpl(config.getJsonOutputDirectory(), handler);
+        generator.generate();
+
+        // filter out non-object reports
+        final var objectReports = getObjectReports(reportDir, IGNORE);
+        assertThat(objectReports).isEmpty();
+    }
+
+    public List<String> getExpectedObjectReports(final OcflRepository repository, final ReportType reportType) {
+        return repository.listObjectIds()
+                         .map(objectId -> objectId.substring("info:fedora/".length()))
+                         .map(objectId -> objectId + reportType.getExtension())
+                         .collect(Collectors.toList());
+    }
+
+    public List<String> getObjectReports(final Path reportDir, final Predicate<String> filter) throws IOException {
+        return Files.list(reportDir)
+                    .map(Path::getFileName)
+                    .map(Path::toString)
+                    .filter(filter)
+                    .collect(Collectors.toList());
+    }
+}