From 8b02e1e45a264b04273af5d294fc446314d2b936 Mon Sep 17 00:00:00 2001 From: "Erik C. Thauvin" Date: Mon, 22 Jul 2024 16:30:11 -0700 Subject: [PATCH] Ensured exit status is set on failure --- README.md | 4 + .../rife/bld/extension/DetektOperation.java | 263 +++++++++--------- .../bld/extension/DetektOperationTest.java | 15 +- 3 files changed, 147 insertions(+), 135 deletions(-) diff --git a/README.md b/README.md index c983fff..3798237 100755 --- a/README.md +++ b/README.md @@ -45,3 +45,7 @@ public void detektBaseline() throws ExitStatusException, IOException, Interrupte - [View Examples Project](https://github.com/rife2/bld-detekt/tree/main/examples) Please check the [DetektOperation documentation](https://rife2.github.io/bld-detekt/rife/bld/extension/DetektOperation.html#method-summary) for all available configuration options. + +## Template Project + +There is also a [Kotlin Template Project](https://github.com/rife2/kotlin-bld-example) with support for [Dokka](https://github.com/rife2/bld-dokka) and the Detekt extensions. diff --git a/src/main/java/rife/bld/extension/DetektOperation.java b/src/main/java/rife/bld/extension/DetektOperation.java index b1d1bf1..97aecc5 100644 --- a/src/main/java/rife/bld/extension/DetektOperation.java +++ b/src/main/java/rife/bld/extension/DetektOperation.java @@ -21,7 +21,6 @@ import rife.bld.extension.detekt.Report; import rife.bld.extension.detekt.ReportId; import rife.bld.operations.AbstractProcessOperation; import rife.bld.operations.exceptions.ExitStatusException; -import rife.tools.exceptions.FileUtilsErrorException; import java.io.File; import java.io.IOException; @@ -60,6 +59,7 @@ public class DetektOperation extends AbstractProcessOperation { private final Collection classpath_ = new ArrayList<>(); private final Collection config_ = new ArrayList<>(); private final Collection excludes_ = new ArrayList<>(); + private final Collection includes_ = new ArrayList<>(); private final Collection input_ = new ArrayList<>(); private final Collection plugins_ = new ArrayList<>(); private final Collection report_ = new ArrayList<>(); @@ -73,7 +73,6 @@ public class DetektOperation extends AbstractProcessOperation { private boolean debug_; private boolean disableDefaultRuleSets_; private boolean generateConfig_; - private final Collection includes_ = new ArrayList<>(); private String jdkHome_; private String jvmTarget_; private String languageVersion_; @@ -348,20 +347,26 @@ public class DetektOperation extends AbstractProcessOperation { /** * Performs the operation. * - * @throws InterruptedException when the operation was interrupted - * @throws IOException when an exception occurred during the execution of the process - * @throws FileUtilsErrorException when an exception occurred during the retrieval of the operation output - * @throws ExitStatusException when the exit status was changed during the operation + * @throws InterruptedException when the operation was interrupted + * @throws IOException when an exception occurred during the execution of the process + * @throws ExitStatusException when the exit status was changed during the operation */ @Override - public void execute() throws IOException, FileUtilsErrorException, InterruptedException, ExitStatusException { - super.execute(); - if (successful_ && LOGGER.isLoggable(Level.INFO)) { - if (createBaseline_) { - LOGGER.info("Detekt baseline generated successfully: " - + "file://" + new File(baseline_).toURI().getPath()); - } else { - LOGGER.info("Detekt operation finished successfully."); + public void execute() throws IOException, InterruptedException, ExitStatusException { + if (project_ == null) { + if (LOGGER.isLoggable(Level.SEVERE) && !silent()) { + LOGGER.severe("A project must be specified."); + } + throw new ExitStatusException(ExitStatusException.EXIT_FAILURE); + } else { + super.execute(); + if (successful_ && LOGGER.isLoggable(Level.INFO) && !silent()){ + if (createBaseline_) { + LOGGER.info("Detekt baseline generated successfully: " + + "file://" + new File(baseline_).toURI().getPath()); + } else { + LOGGER.info("Detekt operation finished successfully."); + } } } } @@ -372,144 +377,142 @@ public class DetektOperation extends AbstractProcessOperation { */ @Override protected List executeConstructProcessCommandList() { - if (project_ == null) { - LOGGER.severe("A project must be specified."); - } - final List args = new ArrayList<>(); - args.add(javaTool()); - args.add("-cp"); - args.add(getDetektJarList(project_.libBldDirectory())); - args.add("io.gitlab.arturbosch.detekt.cli.Main"); + if (project_ != null) { + args.add(javaTool()); + args.add("-cp"); + args.add(getDetektJarList(project_.libBldDirectory())); + args.add("io.gitlab.arturbosch.detekt.cli.Main"); - // all-rules - if (allRules_) { - args.add("--all-rules"); - } + // all-rules + if (allRules_) { + args.add("--all-rules"); + } - // auto-correct - if (autoCorrect_) { - args.add("--auto-correct"); - } + // auto-correct + if (autoCorrect_) { + args.add("--auto-correct"); + } - // base-path - if (isNotBlank(basePath_)) { - args.add("--base-path"); - args.add(basePath_); - } + // base-path + if (isNotBlank(basePath_)) { + args.add("--base-path"); + args.add(basePath_); + } - // baseline - if (isNotBlank(baseline_)) { - args.add("--baseline"); - args.add(baseline_); - } + // baseline + if (isNotBlank(baseline_)) { + args.add("--baseline"); + args.add(baseline_); + } - // build-upon-default-config - if (buildUponDefaultConfig_) { - args.add("--build-upon-default-config"); - } + // build-upon-default-config + if (buildUponDefaultConfig_) { + args.add("--build-upon-default-config"); + } - // classpath - if (!classpath_.isEmpty()) { - args.add("--classpath"); - args.add(String.join(File.pathSeparator, classpath_.stream().map(File::getAbsolutePath).toList())); - } + // classpath + if (!classpath_.isEmpty()) { + args.add("--classpath"); + args.add(String.join(File.pathSeparator, classpath_.stream().map(File::getAbsolutePath).toList())); + } - // config - if (!config_.isEmpty()) { - args.add("-config"); - args.add(String.join(";", config_.stream().map(File::getAbsolutePath).toList())); - } + // config + if (!config_.isEmpty()) { + args.add("-config"); + args.add(String.join(";", config_.stream().map(File::getAbsolutePath).toList())); + } - // config-resource - if (isNotBlank(configResource_)) { - args.add("--config-resource"); - args.add(configResource_); - } + // config-resource + if (isNotBlank(configResource_)) { + args.add("--config-resource"); + args.add(configResource_); + } - // create-baseline - if (createBaseline_) { - args.add("--create-baseline"); - } + // create-baseline + if (createBaseline_) { + args.add("--create-baseline"); + } - // debug - if (debug_) { - args.add("--debug"); - } + // debug + if (debug_) { + args.add("--debug"); + } - // disable-default-rulesets - if (disableDefaultRuleSets_) { - args.add("--disable-default-rulesets"); - } + // disable-default-rulesets + if (disableDefaultRuleSets_) { + args.add("--disable-default-rulesets"); + } - // excludes - if (!excludes_.isEmpty()) { - args.add("--excludes"); - args.add(String.join(",", excludes_)); - } + // excludes + if (!excludes_.isEmpty()) { + args.add("--excludes"); + args.add(String.join(",", excludes_)); + } - // generate-config - if (generateConfig_) { - args.add("--generate-config"); - } + // generate-config + if (generateConfig_) { + args.add("--generate-config"); + } - // includes - if (!includes_.isEmpty()) { - args.add("--includes"); - args.add(String.join(",", includes_)); - } + // includes + if (!includes_.isEmpty()) { + args.add("--includes"); + args.add(String.join(",", includes_)); + } - // input - if (!input_.isEmpty()) { - args.add("--input"); - args.add(String.join(",", input_.stream().map(File::getAbsolutePath).toList())); - } + // input + if (!input_.isEmpty()) { + args.add("--input"); + args.add(String.join(",", input_.stream().map(File::getAbsolutePath).toList())); + } - // jdk-home - if (isNotBlank(jdkHome_)) { - args.add("--jdk-home"); - args.add(jdkHome_); - } + // jdk-home + if (isNotBlank(jdkHome_)) { + args.add("--jdk-home"); + args.add(jdkHome_); + } - // jvm-target - if (isNotBlank(jvmTarget_)) { - args.add("--jvm-target"); - args.add(jvmTarget_); - } + // jvm-target + if (isNotBlank(jvmTarget_)) { + args.add("--jvm-target"); + args.add(jvmTarget_); + } - // language-version - if (isNotBlank(languageVersion_)) { - args.add("--language-version"); - args.add(languageVersion_); - } + // language-version + if (isNotBlank(languageVersion_)) { + args.add("--language-version"); + args.add(languageVersion_); + } - // max-issues - if (maxIssues_ > 0) { - args.add("--max-issues"); - args.add(String.valueOf(maxIssues_)); - } + // max-issues + if (maxIssues_ > 0) { + args.add("--max-issues"); + args.add(String.valueOf(maxIssues_)); + } - // parallel - if (parallel_) { - args.add("--parallel"); - } + // parallel + if (parallel_) { + args.add("--parallel"); + } - // plugins - if (!plugins_.isEmpty()) { - args.add("--plugins"); - args.add(String.join(",", plugins_.stream().map(File::getAbsolutePath).toList())); - } + // plugins + if (!plugins_.isEmpty()) { + args.add("--plugins"); + args.add(String.join(",", plugins_.stream().map(File::getAbsolutePath).toList())); + } - // report - if (!report_.isEmpty()) { - report_.forEach(it -> { - args.add("--report"); - args.add(it.id().name().toLowerCase() + ":" + it.path()); - }); - } + // report + if (!report_.isEmpty()) { + report_.forEach(it -> { + args.add("--report"); + args.add(it.id().name().toLowerCase() + ":" + it.path()); + }); + } - if (LOGGER.isLoggable(Level.FINE)) { - LOGGER.fine(String.join(" ", args.stream().filter(this::isNotBlank).toList())); + if (LOGGER.isLoggable(Level.FINE) && !silent()) { + LOGGER.fine(String.join(" ", args.stream().filter(this::isNotBlank).toList())); + } } return args; @@ -551,9 +554,7 @@ public class DetektOperation extends AbstractProcessOperation { return this; } - /* - * Retrieves the matching JARs files from the given directory. - */ + // Retrieves the matching JARs files from the given directory. private String getDetektJarList(File directory) { var jars = new ArrayList(); diff --git a/src/test/java/rife/bld/extension/DetektOperationTest.java b/src/test/java/rife/bld/extension/DetektOperationTest.java index 760d824..c45b3fa 100644 --- a/src/test/java/rife/bld/extension/DetektOperationTest.java +++ b/src/test/java/rife/bld/extension/DetektOperationTest.java @@ -61,6 +61,7 @@ class DetektOperationTest { } @Test + @SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops") void testCheckAllParameters() throws IOException { var args = Files.readAllLines(Paths.get("src", "test", "resources", "detekt-args.txt")); @@ -108,10 +109,10 @@ class DetektOperationTest { for (var i = 1; i < 6; i++) { assertThat(op.classPath()).as("classPath[" + i + ']').hasSize(5).contains(new File("path" + i)); - assertThat(op.config()).as("config[" + i + ']').hasSize(5).contains(new File("config" + i)); - assertThat(op.includes()).as("includes[" + i + ']').hasSize(5).contains("includes" + i); - assertThat(op.input()).as("input[" + i + ']').hasSize(5).contains(new File("input" + i)); - assertThat(op.plugins()).as("plugins[" + i + ']').hasSize(5).contains(new File("jar" + i)); + assertThat(op.config()).as("config[" + i + ']').hasSize(5).contains(new File("config" + i)); + assertThat(op.includes()).as("includes[" + i + ']').hasSize(5).contains("includes" + i); + assertThat(op.input()).as("input[" + i + ']').hasSize(5).contains(new File("input" + i)); + assertThat(op.plugins()).as("plugins[" + i + ']').hasSize(5).contains(new File("jar" + i)); } var params = op.executeConstructProcessCommandList(); @@ -190,4 +191,10 @@ class DetektOperationTest { .debug(true); assertThatThrownBy(op::execute).isInstanceOf(ExitStatusException.class); } + + @Test + void testExecuteNoProject() { + var op = new DetektOperation(); + assertThatCode(op::execute).isInstanceOf(ExitStatusException.class); + } }