From 9c71528c836bca174eec4c8d086b9dbfe54fa947 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ant=C3=B3nio=20Lindo?= Date: Fri, 10 Nov 2023 16:51:47 +0000 Subject: [PATCH] added flag to not generate validation-report file --- .../model/reporters/ValidationReporter.java | 2 +- .../modules/siard/SIARDValidateFactory.java | 34 +++++++++++++------ .../siard/validate/SIARDValidateModule.java | 7 ++-- 3 files changed, 30 insertions(+), 13 deletions(-) diff --git a/dbptk-model/src/main/java/com/databasepreservation/model/reporters/ValidationReporter.java b/dbptk-model/src/main/java/com/databasepreservation/model/reporters/ValidationReporter.java index c9c17e13e..b6511792f 100644 --- a/dbptk-model/src/main/java/com/databasepreservation/model/reporters/ValidationReporter.java +++ b/dbptk-model/src/main/java/com/databasepreservation/model/reporters/ValidationReporter.java @@ -56,7 +56,7 @@ public ValidationReporter(Path path, Path siardPackagePath) { private void init(Path path, Path siardPackagePath) { this.outputFile = path; - if (outputFile.toFile().exists()) { + if (outputFile != null && outputFile.toFile().exists()) { try { Files.createFile(outputFile); } catch (IOException e) { diff --git a/dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/SIARDValidateFactory.java b/dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/SIARDValidateFactory.java index c421c7938..9d2b03b01 100644 --- a/dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/SIARDValidateFactory.java +++ b/dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/SIARDValidateFactory.java @@ -35,6 +35,7 @@ public class SIARDValidateFactory implements ValidateModuleFactory { public static final String PARAMETER_ALLOWED = "allowed"; public static final String PARAMETER_REPORT = "report"; public static final String PARAMETER_SKIP_ADDITIONAL_CHECKS = "skip-additional-checks"; + public static final String PARAMETER_NO_REPORT_FILE = "no-report-file"; private static final Parameter file = new Parameter().shortName("f").longName(PARAMETER_FILE) .description("Path to SIARD2 archive file.").hasArgument(true).setOptionalArgument(false).required(true); @@ -55,6 +56,11 @@ public class SIARDValidateFactory implements ValidateModuleFactory { + " The additional checks can be found at: https://github.com/keeps/db-preservation-toolkit/wiki/Validation#additional-checks ") .hasArgument(false).valueIfSet("true").valueIfNotSet("false").required(false); + private static final Parameter noReportFile = new Parameter().shortName("nrf") + .longName(PARAMETER_NO_REPORT_FILE) + .description("The validation report file will not be generated.") + .hasArgument(false).valueIfSet("true").valueIfNotSet("false").required(false); + @Override public String getModuleName() { return "validate-siard"; @@ -72,7 +78,7 @@ public Parameters getImportParameters() { @Override public Parameters getSingleParameters() { - return new Parameters(Arrays.asList(allowed, report, skipAdditionalChecks), null); + return new Parameters(Arrays.asList(allowed, report, skipAdditionalChecks, noReportFile), null); } @Override @@ -82,6 +88,7 @@ public Map getAllParameters() { parameterHashMap.put(report.longName(), report); parameterHashMap.put(allowed.longName(), allowed); parameterHashMap.put(skipAdditionalChecks.longName(), skipAdditionalChecks); + parameterHashMap.put(noReportFile.longName(), noReportFile); return parameterHashMap; } @@ -92,13 +99,19 @@ public ValidateModule buildModule(Map parameters, Reporter re Path pReport; Path pAllowUDTs = null; - if (parameters.get(report) != null) { - pReport = Paths.get(parameters.get(report)); + boolean pNoReportFile = Boolean.parseBoolean(parameters.get(noReportFile)); + + if (!pNoReportFile) { + if (parameters.get(report) != null) { + pReport = Paths.get(parameters.get(report)); + } else { + String name = Constants.DBPTK_VALIDATION_REPORTER_PREFIX + "-" + + pFile.getFileName().toString().replaceFirst("[.][^.]+$", "") + "-" + + new SimpleDateFormat("yyyyMMddHHmmssSSS").format(new Date()) + ".txt"; + pReport = ConfigUtils.getReportsDirectory().resolve(name); + } } else { - String name = Constants.DBPTK_VALIDATION_REPORTER_PREFIX + "-" - + pFile.getFileName().toString().replaceFirst("[.][^.]+$", "") + "-" - + new SimpleDateFormat("yyyyMMddHHmmssSSS").format(new Date()) + ".txt"; - pReport = ConfigUtils.getReportsDirectory().resolve(name); + pReport = null; } if (parameters.get(allowed) != null) { @@ -113,13 +126,14 @@ public ValidateModule buildModule(Map parameters, Reporter re } if (pAllowUDTs != null) { + String reportParam = pReport != null ? pReport.normalize().toAbsolutePath().toString() : null; reporter.importModuleParameters(getModuleName(), PARAMETER_FILE, pFile.normalize().toAbsolutePath().toString(), - PARAMETER_ALLOWED, pAllowUDTs.normalize().toAbsolutePath().toString(), PARAMETER_REPORT, - pReport.normalize().toAbsolutePath().toString()); + PARAMETER_ALLOWED, pAllowUDTs.normalize().toAbsolutePath().toString(), PARAMETER_REPORT, reportParam); return new SIARDValidateModule(pFile, pReport, pAllowUDTs, pSkipAdditionalChecks); } else { + String reportParam = pReport != null ? pReport.normalize().toAbsolutePath().toString() : null; reporter.importModuleParameters(getModuleName(), PARAMETER_FILE, pFile.normalize().toAbsolutePath().toString(), - PARAMETER_REPORT, pReport.normalize().toAbsolutePath().toString()); + PARAMETER_REPORT, reportParam); return new SIARDValidateModule(pFile, pReport, pSkipAdditionalChecks); } } diff --git a/dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/validate/SIARDValidateModule.java b/dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/validate/SIARDValidateModule.java index b05a3b95b..f7396f90a 100644 --- a/dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/validate/SIARDValidateModule.java +++ b/dbptk-modules/dbptk-module-siard/src/main/java/com/databasepreservation/modules/siard/validate/SIARDValidateModule.java @@ -61,8 +61,11 @@ public class SIARDValidateModule implements ValidateModule { */ public SIARDValidateModule(Path SIARDPackagePath, Path validationReporterPath, boolean skipAdditionalChecks) { siardPackageNormalizedPath = SIARDPackagePath.toAbsolutePath().normalize(); - validationReporter = new ValidationReporter(validationReporterPath.toAbsolutePath().normalize(), - siardPackageNormalizedPath); + + validationReporter = new ValidationReporter( + validationReporterPath != null ? validationReporterPath.toAbsolutePath().normalize() : null, + siardPackageNormalizedPath + ); allowedUDTs = Collections.emptyList(); validatorPathStrategy = new ValidatorPathStrategyImpl(); zipFileManager = new ZipFileManager();