diff --git a/.github/workflows/bld.yml b/.github/workflows/bld.yml index 3c9d30a..bacdbae 100644 --- a/.github/workflows/bld.yml +++ b/.github/workflows/bld.yml @@ -1,14 +1,16 @@ name: bld-ci -on: [push, pull_request, workflow_dispatch] +on: [ push, pull_request, workflow_dispatch ] jobs: build-bld-project: - runs-on: ubuntu-latest - strategy: matrix: - java-version: [17, 21, 22] + java-version: [ 17, 21, 24 ] + kotlin-version: [ 1.9.25, 2.0.21, 2.1.20 ] + os: [ ubuntu-latest, windows-latest, macos-latest ] + + runs-on: ${{ matrix.os }} steps: - name: Checkout source repository @@ -22,17 +24,16 @@ jobs: distribution: "zulu" java-version: ${{ matrix.java-version }} - - name: Grant execute permission for bld - run: chmod +x bld - - - name: Download the dependencies + - name: Download dependencies [examples] + working-directory: examples run: ./bld download - - name: Download the examples dependencies - run: | - cd examples - chmod +x bld - ./bld download + - name: Run Detekt [examples] + working-directory: examples + run: ./bld compile test-ci - - name: Run tests with bld - run: ./bld compile test + - name: Download dependencies + run: ./bld download + + - name: Run tests + run: ./bld compile test \ No newline at end of file diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index e191f6d..88c2cd6 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -47,11 +47,11 @@ jobs: uses: actions/configure-pages@v3 - name: Upload artifact - uses: actions/upload-pages-artifact@v1 + uses: actions/upload-pages-artifact@v3 with: # Upload generated Javadocs repository path: "build/javadoc/" - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v1 + uses: actions/deploy-pages@v4 diff --git a/.idea/bld.xml b/.idea/bld.xml new file mode 100644 index 0000000..6600cee --- /dev/null +++ b/.idea/bld.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/copyright/Apache_License.xml b/.idea/copyright/Apache_License.xml index ade80da..4446c15 100644 --- a/.idea/copyright/Apache_License.xml +++ b/.idea/copyright/Apache_License.xml @@ -1,6 +1,6 @@ - - + \ No newline at end of file diff --git a/.idea/icon.svg b/.idea/icon.svg new file mode 100644 index 0000000..81220b4 --- /dev/null +++ b/.idea/icon.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/.idea/libraries/bld.xml b/.idea/libraries/bld.xml index a2969be..153a060 100644 --- a/.idea/libraries/bld.xml +++ b/.idea/libraries/bld.xml @@ -2,12 +2,12 @@ - + - + diff --git a/.idea/libraries/compile.xml b/.idea/libraries/compile.xml index 9bd86aa..99cc0c0 100644 --- a/.idea/libraries/compile.xml +++ b/.idea/libraries/compile.xml @@ -7,7 +7,7 @@ - - + + \ No newline at end of file diff --git a/.idea/libraries/runtime.xml b/.idea/libraries/runtime.xml index 2ae5c4b..d4069f2 100644 --- a/.idea/libraries/runtime.xml +++ b/.idea/libraries/runtime.xml @@ -8,7 +8,7 @@ - - + + \ No newline at end of file diff --git a/.idea/libraries/test.xml b/.idea/libraries/test.xml index b80486a..57ed5ef 100644 --- a/.idea/libraries/test.xml +++ b/.idea/libraries/test.xml @@ -8,7 +8,7 @@ - - + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml index 22c7683..cf8a3be 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -3,20 +3,6 @@ - - - diff --git a/.vscode/settings.json b/.vscode/settings.json index d136e4d..ba429d0 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -9,7 +9,7 @@ ], "java.configuration.updateBuildConfiguration": "automatic", "java.project.referencedLibraries": [ - "${HOME}/.bld/dist/bld-1.9.1.jar", + "${HOME}/.bld/dist/bld-2.2.1.jar", "lib/**/*.jar" ] } diff --git a/README.md b/README.md index c983fff..cdcb0a0 100755 --- a/README.md +++ b/README.md @@ -3,12 +3,20 @@ [![License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Java](https://img.shields.io/badge/java-17%2B-blue)](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) -[![bld](https://img.shields.io/badge/1.9.1-FA9052?label=bld&labelColor=2392FF)](https://rife2.com/bld) +[![bld](https://img.shields.io/badge/2.2.1-FA9052?label=bld&labelColor=2392FF)](https://rife2.com/bld) [![Release](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/releases/com/uwyn/rife2/bld-detekt/maven-metadata.xml?color=blue)](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-detekt) [![Snapshot](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/snapshots/com/uwyn/rife2/bld-detekt/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-detekt) [![GitHub CI](https://github.com/rife2/bld-detekt/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-detekt/actions/workflows/bld.yml) -To install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions). +To install the latest version, add the following to the `lib/bld/bld-wrapper.properties` file: + +```properties +bld.extension-detekt=com.uwyn.rife2:bld-detekt +``` + +For more information, please refer to the [extensions](https://github.com/rife2/bld/wiki/Extensions) documentation. + +## Check Source Code with Detekt To check all Kotlin source code located in the project, add the following to your build file: ```java @@ -45,3 +53,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/checkcliargs.sh b/checkcliargs.sh deleted file mode 100755 index 9f49d61..0000000 --- a/checkcliargs.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/bin/bash - -MAIN="io.gitlab.arturbosch.detekt.cli.Main" -TMPNEW=/tmp/checkcliargs-new -TMPOLD=/tmp/checkcliargs-old - -java -cp "lib/compile/*:examples/lib/bld/*" $MAIN --help >$TMPNEW -java -cp "examples/lib/bld/*" $MAIN --help >$TMPOLD - -diff $TMPOLD $TMPNEW - -rm -rf $TMPNEW $TMPOLD diff --git a/config/pmd.xml b/config/pmd.xml index 3d3203c..2641880 100644 --- a/config/pmd.xml +++ b/config/pmd.xml @@ -7,9 +7,9 @@ - - + + diff --git a/examples/.idea/bld.xml b/examples/.idea/bld.xml new file mode 100644 index 0000000..6600cee --- /dev/null +++ b/examples/.idea/bld.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/examples/.idea/libraries/bld.xml b/examples/.idea/libraries/bld.xml index a2969be..153a060 100644 --- a/examples/.idea/libraries/bld.xml +++ b/examples/.idea/libraries/bld.xml @@ -2,12 +2,12 @@ - + - + diff --git a/examples/.idea/libraries/compile.xml b/examples/.idea/libraries/compile.xml index 9bd86aa..99cc0c0 100644 --- a/examples/.idea/libraries/compile.xml +++ b/examples/.idea/libraries/compile.xml @@ -7,7 +7,7 @@ - - + + \ No newline at end of file diff --git a/examples/.idea/libraries/runtime.xml b/examples/.idea/libraries/runtime.xml index 2ae5c4b..d4069f2 100644 --- a/examples/.idea/libraries/runtime.xml +++ b/examples/.idea/libraries/runtime.xml @@ -8,7 +8,7 @@ - - + + \ No newline at end of file diff --git a/examples/.idea/libraries/test.xml b/examples/.idea/libraries/test.xml index b80486a..57ed5ef 100644 --- a/examples/.idea/libraries/test.xml +++ b/examples/.idea/libraries/test.xml @@ -8,7 +8,7 @@ - - + + \ No newline at end of file diff --git a/examples/.vscode/settings.json b/examples/.vscode/settings.json index d136e4d..ba429d0 100644 --- a/examples/.vscode/settings.json +++ b/examples/.vscode/settings.json @@ -9,7 +9,7 @@ ], "java.configuration.updateBuildConfiguration": "automatic", "java.project.referencedLibraries": [ - "${HOME}/.bld/dist/bld-1.9.1.jar", + "${HOME}/.bld/dist/bld-2.2.1.jar", "lib/**/*.jar" ] } diff --git a/examples/lib/bld/bld-wrapper.jar b/examples/lib/bld/bld-wrapper.jar index e188fc7..20412e6 100644 Binary files a/examples/lib/bld/bld-wrapper.jar and b/examples/lib/bld/bld-wrapper.jar differ diff --git a/examples/lib/bld/bld-wrapper.properties b/examples/lib/bld/bld-wrapper.properties index dfa1d5b..67eaf60 100644 --- a/examples/lib/bld/bld-wrapper.properties +++ b/examples/lib/bld/bld-wrapper.properties @@ -1,8 +1,8 @@ bld.downloadExtensionJavadoc=false bld.downloadExtensionSources=true -bld.extensions=com.uwyn.rife2:bld-kotlin:0.9.4 -bld.extension-detekt=com.uwyn.rife2:bld-detekt:0.9.4 -bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES bld.downloadLocation= +bld.extension-detekt=com.uwyn.rife2:bld-detekt:0.9.10-SNAPSHOT +bld.extension-kotlin=com.uwyn.rife2:bld-kotlin:1.1.0-SNAPSHOT +bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES bld.sourceDirectories= -bld.version=1.9.1 +bld.version=2.2.1 diff --git a/examples/src/bld/java/com/example/ExampleBuild.java b/examples/src/bld/java/com/example/ExampleBuild.java index 9c02b47..9a9a49c 100644 --- a/examples/src/bld/java/com/example/ExampleBuild.java +++ b/examples/src/bld/java/com/example/ExampleBuild.java @@ -31,13 +31,14 @@ public class ExampleBuild extends Project { repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES); - final var kotlin = version(1, 9, 24); + final var kotlin = version(2, 1, 20); scope(compile) .include(dependency("org.jetbrains.kotlin", "kotlin-stdlib", kotlin)); scope(test) .include(dependency("org.jetbrains.kotlin", "kotlin-test-junit5", kotlin)) - .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 2))) - .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 2))); + .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 12, 1))) + .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 12, 1))) + .include(dependency("org.junit.platform", "junit-platform-launcher", version(1, 12, 1))); // Include the Kotlin source directory when creating or publishing sources Java Archives jarSourcesOperation().sourceDirectories(new File(srcMainDirectory(), "kotlin")); @@ -45,21 +46,21 @@ public class ExampleBuild extends Project { public static void main(String[] args) { // Enable detailed logging - // var level = Level.ALL; - // var logger = Logger.getLogger("rife.bld.extension"); - // var consoleHandler = new ConsoleHandler(); + var level = Level.ALL; + var logger = Logger.getLogger("rife.bld.extension"); + var consoleHandler = new ConsoleHandler(); - // consoleHandler.setLevel(level); - // logger.addHandler(consoleHandler); - // logger.setLevel(level); - // logger.setUseParentHandlers(false); + consoleHandler.setLevel(level); + logger.addHandler(consoleHandler); + logger.setLevel(level); + logger.setUseParentHandlers(false); new ExampleBuild().start(args); } @BuildCommand(summary = "Compiles the Kotlin project") @Override - public void compile() throws IOException { + public void compile() throws Exception { new CompileKotlinOperation() .fromProject(this) .execute(); @@ -100,4 +101,13 @@ public class ExampleBuild extends Project { .input("src/test/kotlin") .execute(); } + + @BuildCommand(value = "test-ci", summary = "Run detek with a test baseline") + public void testCi() throws ExitStatusException, IOException, InterruptedException { + // Run detek with the test basline (for CI testing) + new DetektOperation() + .fromProject(this) + .baseline("src/test/resources/detekt-baseline.xml") + .execute(); + } } diff --git a/examples/src/test/resources/detekt-baseline.xml b/examples/src/test/resources/detekt-baseline.xml new file mode 100644 index 0000000..1bf5c16 --- /dev/null +++ b/examples/src/test/resources/detekt-baseline.xml @@ -0,0 +1,12 @@ + + + + + EmptyIfBlock:Example.kt$Example.Companion${ } + MagicNumber:Example.kt$Example$5 + NewLineAtEndOfFile:ExampleTest.kt$com.example.ExampleTest.kt + ThrowingExceptionsWithoutMessageOrCause:Example.kt$Example.Companion$IllegalStateException() + UseCheckOrError:Example.kt$Example.Companion$throw IllegalStateException() + VariableNaming:Example.kt$Example$// https://detekt.dev/docs/rules/naming#variablenaming val Message: String get() = "Hello World!" + + diff --git a/lib/bld/bld-wrapper.jar b/lib/bld/bld-wrapper.jar index ee7a945..ab362ae 100644 Binary files a/lib/bld/bld-wrapper.jar and b/lib/bld/bld-wrapper.jar differ diff --git a/lib/bld/bld-wrapper.properties b/lib/bld/bld-wrapper.properties index 56cd8a5..c5da09f 100644 --- a/lib/bld/bld-wrapper.properties +++ b/lib/bld/bld-wrapper.properties @@ -1,7 +1,8 @@ bld.downloadExtensionJavadoc=false bld.downloadExtensionSources=true -bld.extension-pmd=com.uwyn.rife2:bld-pmd:0.9.9 -bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES bld.downloadLocation= +bld.extension-exec=com.uwyn.rife2:bld-exec:1.0.4 +bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.2.1 +bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES bld.sourceDirectories= -bld.version=1.9.1 +bld.version=2.2.1 diff --git a/scripts/checkcliargs.sh b/scripts/checkcliargs.sh new file mode 100755 index 0000000..44517ee --- /dev/null +++ b/scripts/checkcliargs.sh @@ -0,0 +1,12 @@ +#!/bin/bash + +main=io.gitlab.arturbosch.detekt.cli.Main +new=/tmp/checkcliargs-new +old=/tmp/checkcliargs-old + +java -cp "lib/compile/*:examples/lib/bld/*" $main --help >$new +java -cp "examples/lib/bld/*" $main --help >$old + +diff $old $new + +rm -rf $new $old diff --git a/scripts/cliargs.sh b/scripts/cliargs.sh new file mode 100755 index 0000000..c8b56e2 --- /dev/null +++ b/scripts/cliargs.sh @@ -0,0 +1,8 @@ +#!/bin/bash + +java -cp "lib/compile/*:examples/lib/bld/*" io.gitlab.arturbosch.detekt.cli.Main --help |\ +grep "^ --.*" |\ +sed -e "s/ //" -e "s/, .*//" -e '/version/d' -e '/help/d' |\ +sort |\ +sed -e '$s/,//' > "src/test/resources/detekt-args.txt" + diff --git a/src/bld/java/rife/bld/extension/DetektOperationBuild.java b/src/bld/java/rife/bld/extension/DetektOperationBuild.java index 6c87b41..78f1a3e 100644 --- a/src/bld/java/rife/bld/extension/DetektOperationBuild.java +++ b/src/bld/java/rife/bld/extension/DetektOperationBuild.java @@ -1,5 +1,5 @@ /* - * Copyright 2023-2024 the original author or authors. + * Copyright 2023-2025 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -23,9 +23,9 @@ import rife.bld.publish.PublishLicense; import rife.bld.publish.PublishScm; import java.util.List; +import java.util.Locale; -import static rife.bld.dependencies.Repository.MAVEN_CENTRAL; -import static rife.bld.dependencies.Repository.RIFE2_RELEASES; +import static rife.bld.dependencies.Repository.*; import static rife.bld.dependencies.Scope.compile; import static rife.bld.dependencies.Scope.test; import static rife.bld.operations.JavadocOptions.DocLinkOption.NO_MISSING; @@ -34,20 +34,22 @@ public class DetektOperationBuild extends Project { public DetektOperationBuild() { pkg = "rife.bld.extension"; name = "DetektOperation"; - version = version(0, 9, 4); + version = version(0, 9, 10, "SNAPSHOT"); javaRelease = 17; + downloadSources = true; autoDownloadPurge = true; - repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES); + + repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES, RIFE2_SNAPSHOTS); scope(compile) - .include(dependency("com.uwyn.rife2", "bld", version(1, 9, 1))) - .include(dependency("io.gitlab.arturbosch.detekt", "detekt-cli", version(1, 23, 6))); + .include(dependency("com.uwyn.rife2", "bld", version(2, 2, 1))) + .include(dependency("io.gitlab.arturbosch.detekt", "detekt-cli", version(1, 23, 8))); scope(test) - .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 2))) - .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 2))) - .include(dependency("org.assertj", "assertj-core", version(3, 25, 3))); + .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 12, 1))) + .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 12, 1))) + .include(dependency("org.assertj", "assertj-core", version(3, 27, 3))); javadocOperation() .javadocOptions() .author() @@ -57,28 +59,26 @@ public class DetektOperationBuild extends Project { publishOperation() .repository(version.isSnapshot() ? repository("rife2-snapshot") : repository("rife2")) + .repository(repository("github")) .info() .groupId("com.uwyn.rife2") .artifactId("bld-detekt") .description("bld Detekt Extension") .url("https://github.com/rife2/bld-detekt") - .developer( - new PublishDeveloper() - .id("ethauvin") - .name("Erik C. Thauvin") - .email("erik@thauvin.net") - .url("https://erik.thauvin.net/") + .developer(new PublishDeveloper() + .id("ethauvin") + .name("Erik C. Thauvin") + .email("erik@thauvin.net") + .url("https://erik.thauvin.net/") ) - .license( - new PublishLicense() - .name("The Apache License, Version 2.0") - .url("https://www.apache.org/licenses/LICENSE-2.0.txt") + .license(new PublishLicense() + .name("The Apache License, Version 2.0") + .url("https://www.apache.org/licenses/LICENSE-2.0.txt") ) - .scm( - new PublishScm() - .connection("scm:git:https://github.com/rife2/bld-detekt.git") - .developerConnection("scm:git:git@github.com:rife2/bld-detekt.git") - .url("https://github.com/rife2/bld-detekt") + .scm(new PublishScm() + .connection("scm:git:https://github.com/rife2/bld-detekt.git") + .developerConnection("scm:git:git@github.com:rife2/bld-detekt.git") + .url("https://github.com/rife2/bld-detekt") ) .signKey(property("sign.key")) .signPassphrase(property("sign.passphrase")); @@ -89,10 +89,24 @@ public class DetektOperationBuild extends Project { } @BuildCommand(summary = "Checks source code with PMD") - public void pmd() { + public void pmd() throws Exception { new PmdOperation() .fromProject(this) .ruleSets("config/pmd.xml") .execute(); } + + @Override + public void test() throws Exception { + var os = System.getProperty("os.name"); + if (os != null && os.toLowerCase(Locale.US).contains("linux")) { + new ExecOperation() + .fromProject(this) + .command("scripts/cliargs.sh") + .execute(); + } + super.test(); + } + + } diff --git a/src/main/java/rife/bld/extension/DetektOperation.java b/src/main/java/rife/bld/extension/DetektOperation.java index 7541107..2bb17a1 100644 --- a/src/main/java/rife/bld/extension/DetektOperation.java +++ b/src/main/java/rife/bld/extension/DetektOperation.java @@ -1,5 +1,5 @@ /* - * Copyright 2023-2024 the original author or authors. + * Copyright 2023-2025 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,12 +17,14 @@ package rife.bld.extension; import rife.bld.BaseProject; +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; +import java.nio.file.Path; import java.util.ArrayList; import java.util.Collection; import java.util.List; @@ -46,19 +48,21 @@ public class DetektOperation extends AbstractProcessOperation { "kotlin-reflect-", "kotlin-script-runtime-", "kotlin-stdlib-", - "kotlin-stdlib-jdk7-", - "kotlin-stdlib-jdk8-", + "kotlinx-coroutines-", "kotlinx-html-jvm-", "kotlinx-serialization-", + "poko-annotations-jvm-", "sarif4k-jvm-", "snakeyaml-engine-", "trove4j-"); - private static final Logger LOGGER = Logger.getLogger(DetektReport.class.getName()); - private final Collection classpath_ = new ArrayList<>(); - private final Collection config_ = new ArrayList<>(); - private final Collection input_ = new ArrayList<>(); - private final Collection plugins_ = new ArrayList<>(); - private final Collection report_ = new ArrayList<>(); + private static final Logger LOGGER = Logger.getLogger(DetektOperation.class.getName()); + 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<>(); private boolean allRules_; private boolean autoCorrect_; private String basePath_; @@ -68,9 +72,7 @@ public class DetektOperation extends AbstractProcessOperation { private boolean createBaseline_; private boolean debug_; private boolean disableDefaultRuleSets_; - private String excludes_; private boolean generateConfig_; - private String includes_; private String jdkHome_; private String jvmTarget_; private String languageVersion_; @@ -117,6 +119,39 @@ public class DetektOperation extends AbstractProcessOperation { return this; } + /** + * Specifies a directory as the base path. Currently, it impacts all file + * paths in the formatted reports. File paths in console output and txt + * report are not affected and remain as absolute paths. + * + * @param path the directory path + * @return this operation instance + */ + public DetektOperation basePath(File path) { + return basePath(path.getAbsolutePath()); + } + + /** + * Retrieves the base path. + * + * @return the directory path + */ + public String basePath() { + return basePath_; + } + + /** + * Specifies a directory as the base path. Currently, it impacts all file + * paths in the formatted reports. File paths in console output and txt + * report are not affected and remain as absolute paths. + * + * @param path the directory path + * @return this operation instance + */ + public DetektOperation basePath(Path path) { + return basePath(path.toFile().getAbsolutePath()); + } + /** * If a baseline xml file is passed in, only new code smells not in the * baseline are printed in the console. @@ -129,6 +164,37 @@ public class DetektOperation extends AbstractProcessOperation { return this; } + /** + * If a baseline xml file is passed in, only new code smells not in the + * baseline are printed in the console. + * + * @param baseline the baseline xml file + * @return this operation instance + */ + public DetektOperation baseline(File baseline) { + return baseline(baseline.getAbsolutePath()); + } + + /** + * If a baseline xml file is passed in, only new code smells not in the + * baseline are printed in the console. + * + * @param baseline the baseline xml file + * @return this operation instance + */ + public DetektOperation baseline(Path baseline) { + return baseline(baseline.toFile().getAbsolutePath()); + } + + /** + * Retrieves the baseline xml file. + * + * @return the baseline xml file + */ + public String baseline() { + return baseline_; + } + /** * Preconfigures detekt with a bunch of rules and some opinionated defaults * for you. Allows additional provided configurations to override the @@ -143,49 +209,151 @@ public class DetektOperation extends AbstractProcessOperation { } /** - * EXPERIMENTAL: Paths where to find user class files and depending jar files. + * EXPERIMENTAL: Paths where to find user class files and jar dependencies. * Used for type resolution. * * @param paths one or more files * @return this operation instance + * @see #classPath(Collection) */ - public DetektOperation classPath(String... paths) { - classpath_.addAll(List.of(paths)); - return this; + public DetektOperation classPath(File... paths) { + return classPath(List.of(paths)); } /** - * EXPERIMENTAL: Paths where to find user class files and depending jar files. + * EXPERIMENTAL: Paths where to find user class files and jar dependencies. * Used for type resolution. * - * @param paths the list of files + * @param paths one or more files * @return this operation instance + * @see #classPathPaths(Collection) */ - public DetektOperation classPath(Collection paths) { + public DetektOperation classPath(Path... paths) { + return classPathPaths(List.of(paths)); + } + + /** + * EXPERIMENTAL: Paths where to find user class files and jar dependencies. + * Used for type resolution. + * + * @param paths one or more files + * @return this operation instance + * @see #classPathStrings(Collection) + */ + public DetektOperation classPath(String... paths) { + return classPathStrings(List.of(paths)); + } + + + /** + * EXPERIMENTAL: Paths where to find user class files and jar dependencies. + * Used for type resolution. + * + * @param paths the paths + * @return this operation instance + * @see #classPath(File...) + */ + public DetektOperation classPath(Collection paths) { classpath_.addAll(paths); return this; } /** - * Path to the config file ({@code path/to/config.yml}). + * Paths where to find user class files and jar dependencies. + * + * @return the paths + */ + public Collection classPath() { + return classpath_; + } + + /** + * EXPERIMENTAL: Paths where to find user class files and jar dependencies. + * Used for type resolution. + * + * @param paths the paths + * @return this operation instance + * @see #classPath(Path...) + */ + public DetektOperation classPathPaths(Collection paths) { + return classPath(paths.stream().map(Path::toFile).toList()); + } + + /** + * EXPERIMENTAL: Paths where to find user class files and jar dependencies. + * Used for type resolution. + * + * @param paths the paths + * @return this operation instance + * @see #classPath(String...) + */ + public DetektOperation classPathStrings(Collection paths) { + return classPath(paths.stream().map(File::new).toList()); + } + + /** + * Paths to the config files ({@code path/to/config.yml}). * * @param configs one or more config files * @return this operation instance + * @see #config(Collection) + */ + public DetektOperation config(File... configs) { + return config(List.of(configs)); + } + + /** + * Paths to the config files ({@code path/to/config.yml}). + * + * @param configs one or more config files + * @return this operation instance + * @see #configPaths(Collection) + */ + public DetektOperation config(Path... configs) { + return configPaths(List.of(configs)); + } + + /** + * Paths to the config files ({@code path/to/config.yml}). + * + * @param configs one or more config files + * @return this operation instance + * @see #configStrings(Collection) */ public DetektOperation config(String... configs) { - config_.addAll(List.of(configs)); + return configStrings(List.of(configs)); + } + + /** + * Paths to the config files ({@code path/to/config.yml}). + * + * @param configs the config files + * @return this operation instance + * @see #config(File...) + */ + public DetektOperation config(Collection configs) { + config_.addAll(configs); return this; } /** - * Path to the config file ({@code path/to/config.yml}). + * Paths to config files. * - * @param configs the list pf config files - * @return this operation instance + * @return the config files paths. */ - public DetektOperation config(Collection configs) { - config_.addAll(configs); - return this; + public Collection config() { + return config_; + } + + /** + * Paths to the config files ({@code path/to/config.yml}). + * + * @param configs the config files + * @return this operation instance + * @see #config(Path...) + */ + public DetektOperation configPaths(Collection configs) { + return config(configs.stream().map(Path::toFile).toList()); } /** @@ -199,6 +367,47 @@ public class DetektOperation extends AbstractProcessOperation { return this; } + /** + * Path to the config resource on detekt's classpath ({@code path/to/config.yml}). + * + * @param resource the config resource path + * @return this operation instance + */ + public DetektOperation configResource(File resource) { + return configResource(resource.getAbsolutePath()); + } + + /** + * Path to the config resource on detekt's classpath ({@code path/to/config.yml}). + * + * @param resource the config resource path + * @return this operation instance + */ + public DetektOperation configResource(Path resource) { + return configResource(resource.toFile().getAbsolutePath()); + } + + /** + * Retrieves the path of the config resource. + * + * @return the config resource path + */ + public String configResource() { + return configResource_; + } + + /** + * Paths to the config files ({@code path/to/config.yml}). + * + * @param configs the config files + * @return this operation instance + * @see #config(String...) + */ + public DetektOperation configStrings(Collection configs) { + config_.addAll(configs.stream().map(File::new).toList()); + return this; + } + /** * Treats current analysis findings as a smell baseline for future detekt * runs. @@ -236,31 +445,56 @@ public class DetektOperation extends AbstractProcessOperation { /** * Globbing patterns describing paths to exclude from the analysis. * - * @param patterns the patterns + * @param patterns one or more pattern * @return this operation instance */ - public DetektOperation excludes(String patterns) { - excludes_ = patterns; + public DetektOperation excludes(String... patterns) { + return excludes(List.of(patterns)); + } + + /** + * Globbing patterns describing paths to exclude from the analysis. + * + * @param patterns a collection of patterns + * @return this operation instance + */ + public DetektOperation excludes(Collection patterns) { + excludes_.addAll(patterns); return this; } + /** + * Returns the globbing patterns describing paths to exclude from the analysis. + * + * @return the globbing patterns + */ + public Collection excludes() { + return excludes_; + } + /** * 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 successfully generated: " - + "file://" + new File(baseline_).toURI().getPath()); - } else { - LOGGER.info("Detekt executed 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."); + } } } } @@ -271,144 +505,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().filter(this::isNotBlank).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().filter(this::isNotBlank).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 (isNotBlank(excludes_)) { - args.add("--excludes"); - args.add(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 (isNotBlank(includes_)) { - args.add("--includes"); - args.add(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().filter(this::isNotBlank).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().filter(this::isNotBlank).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("-r"); - 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; @@ -433,7 +665,7 @@ public class DetektOperation extends AbstractProcessOperation { if (baseline.exists()) { baseline_ = baseline.getAbsolutePath(); } - excludes(".*/build/.*,.*/resources/.*"); + excludes(".*/build/.*", ".*/resources/.*"); return this; } @@ -450,9 +682,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(); @@ -471,28 +701,49 @@ public class DetektOperation extends AbstractProcessOperation { } } } - return String.join(":", jars); + return String.join(File.pathSeparator, jars); } /** * Globbing patterns describing paths to include in the analysis. Useful in - * combination with {@link #excludes(String) excludes} patterns. + * combination with {@link #excludes() excludes} patterns. * - * @param patterns the patterns + * @param patterns one or more patterns * @return this operation instance */ - public DetektOperation includes(String patterns) { - includes_ = patterns; + public DetektOperation includes(String... patterns) { + return includes(List.of(patterns)); + } + + /** + * Globbing patterns describing paths to include in the analysis. Useful in + * combination with {@link #excludes() excludes} patterns. + * + * @param patterns a collection of patterns + * @return this operation instance + */ + public DetektOperation includes(Collection patterns) { + includes_.addAll(patterns); return this; } + /** + * Returns the globbing patterns describing paths to include in the analysis. + * + * @return the globbing patterns + */ + public Collection includes() { + return includes_; + } + /** * Input paths to analyze. If not specified the current working directory is used. * - * @param paths the list of paths + * @param paths the paths * @return this operation instance + * @see #input(Collection) */ - public DetektOperation input(Collection paths) { + public DetektOperation input(Collection paths) { input_.addAll(paths); return this; } @@ -502,10 +753,32 @@ public class DetektOperation extends AbstractProcessOperation { * * @param paths one or more paths * @return this operation instance + * @see #inputStrings(Collection) */ public DetektOperation input(String... paths) { - input_.addAll(List.of(paths)); - return this; + return inputStrings(List.of(paths)); + } + + /** + * Input paths to analyze. If not specified the current working directory is used. + * + * @param paths one or more paths + * @return this operation instance + * @see #input(Collection) + */ + public DetektOperation input(File... paths) { + return input(List.of(paths)); + } + + /** + * Input paths to analyze. If not specified the current working directory is used. + * + * @param paths one or more paths + * @return this operation instance + * @see #inputPaths(Collection) + */ + public DetektOperation input(Path... paths) { + return inputPaths(List.of(paths)); } /** @@ -513,10 +786,32 @@ public class DetektOperation extends AbstractProcessOperation { * * @return the input paths */ - public Collection input() { + public Collection input() { return input_; } + /** + * Input paths to analyze. If not specified the current working directory is used. + * + * @param paths the paths + * @return this operation instance + * @see #input(Path...) + */ + public DetektOperation inputPaths(Collection paths) { + return input(paths.stream().map(Path::toFile).toList()); + } + + /** + * Input paths to analyze. If not specified the current working directory is used. + * + * @param paths the paths + * @return this operation instance + * @see #input(String...) + */ + public DetektOperation inputStrings(Collection paths) { + return input(paths.stream().map(File::new).toList()); + } + /* * Determines if a string is not blank. */ @@ -594,30 +889,84 @@ public class DetektOperation extends AbstractProcessOperation { * * @param jars one or more jars * @return this operation instance + * @see #pluginsStrings(Collection) */ public DetektOperation plugins(String... jars) { - plugins_.addAll(List.of(jars)); - return this; + return pluginsStrings(List.of(jars)); } /** * Extra paths to plugin jars. * - * @param jars the list of jars + * @param jars one or more jars * @return this operation instance + * @see #plugins(Collection) */ - public DetektOperation plugins(Collection jars) { + public DetektOperation plugins(File... jars) { + return plugins(List.of(jars)); + } + + /** + * Extra paths to plugin jars. + * + * @param jars one or more jars + * @return this operation instance + * @see #pluginsPaths(Collection) + */ + public DetektOperation plugins(Path... jars) { + return pluginsPaths(List.of(jars)); + } + + /** + * Extra paths to plugin jars. + * + * @param jars the jars paths + * @return this operation instance + * @see #input(File...) + */ + public DetektOperation plugins(Collection jars) { plugins_.addAll(jars); return this; } /** - * Generates a report for given {@link DetektReportId report-id} and stores it on given 'path'. + * Extra path to plugins jars. + * + * @return the jars paths + */ + public Collection plugins() { + return plugins_; + } + + /** + * Extra paths to plugin jars. + * + * @param jars the jars paths + * @return this operation instance + * @see #plugins(Path...) + */ + public DetektOperation pluginsPaths(Collection jars) { + return plugins(jars.stream().map(Path::toFile).toList()); + } + + /** + * Extra paths to plugin jars. + * + * @param jars the jars paths + * @return this operation instance + * @see #plugins(String...) + */ + public DetektOperation pluginsStrings(Collection jars) { + return plugins(jars.stream().map(File::new).toList()); + } + + /** + * Generates a report for given {@link ReportId report-id} and stores it on given 'path'. * * @param reports one or more reports * @return this operation instance */ - public DetektOperation report(DetektReport... reports) { + public DetektOperation report(Report... reports) { report_.addAll(List.of(reports)); return this; } diff --git a/src/main/java/rife/bld/extension/DetektReport.java b/src/main/java/rife/bld/extension/detekt/Report.java similarity index 84% rename from src/main/java/rife/bld/extension/DetektReport.java rename to src/main/java/rife/bld/extension/detekt/Report.java index 0560f3d..ffa4a45 100644 --- a/src/main/java/rife/bld/extension/DetektReport.java +++ b/src/main/java/rife/bld/extension/detekt/Report.java @@ -1,5 +1,5 @@ /* - * Copyright 2023-2024 the original author or authors. + * Copyright 2023-2025 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -14,7 +14,7 @@ * limitations under the License. */ -package rife.bld.extension; +package rife.bld.extension.detekt; /** * Defines a report for the given report-id to be stored on the given path. @@ -24,5 +24,5 @@ package rife.bld.extension; * @author Erik C. Thauvin * @since 1.0 */ -public record DetektReport(DetektReportId id, String path) { +public record Report(ReportId id, String path) { } diff --git a/src/main/java/rife/bld/extension/DetektReportId.java b/src/main/java/rife/bld/extension/detekt/ReportId.java similarity index 86% rename from src/main/java/rife/bld/extension/DetektReportId.java rename to src/main/java/rife/bld/extension/detekt/ReportId.java index ab398eb..c087243 100644 --- a/src/main/java/rife/bld/extension/DetektReportId.java +++ b/src/main/java/rife/bld/extension/detekt/ReportId.java @@ -1,5 +1,5 @@ /* - * Copyright 2023-2024 the original author or authors. + * Copyright 2023-2025 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -14,7 +14,7 @@ * limitations under the License. */ -package rife.bld.extension; +package rife.bld.extension.detekt; /** * The report-id values. @@ -22,6 +22,6 @@ package rife.bld.extension; * @author Erik C. Thauvin * @since 1.0 */ -public enum DetektReportId { +public enum ReportId { TXT, XML, HTML, MD, SARIF } diff --git a/src/test/java/rife/bld/extension/DetektOperationTest.java b/src/test/java/rife/bld/extension/DetektOperationTest.java index dd3e4f4..04db107 100644 --- a/src/test/java/rife/bld/extension/DetektOperationTest.java +++ b/src/test/java/rife/bld/extension/DetektOperationTest.java @@ -1,5 +1,5 @@ /* - * Copyright 2023-2024 the original author or authors. + * Copyright 2023-2025 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -16,14 +16,21 @@ package rife.bld.extension; +import org.assertj.core.api.AutoCloseableSoftAssertions; import org.junit.jupiter.api.BeforeAll; import org.junit.jupiter.api.Test; +import org.junit.jupiter.api.condition.EnabledOnOs; +import org.junit.jupiter.api.condition.OS; +import rife.bld.BaseProject; import rife.bld.blueprints.BaseProjectBlueprint; +import rife.bld.extension.detekt.Report; +import rife.bld.extension.detekt.ReportId; import rife.bld.operations.exceptions.ExitStatusException; import java.io.File; import java.io.IOException; import java.nio.file.Files; +import java.nio.file.Paths; import java.util.List; import java.util.Objects; import java.util.logging.ConsoleHandler; @@ -32,7 +39,6 @@ import java.util.logging.Logger; import static org.assertj.core.api.Assertions.*; - @SuppressWarnings("PMD.AvoidDuplicateLiterals") class DetektOperationTest { @BeforeAll @@ -57,16 +63,193 @@ class DetektOperationTest { } } + @Test + void testBasePath() { + var foo = new File("foo"); + var bar = new File("bar"); + + var op = new DetektOperation().basePath(foo); + assertThat(op.basePath()).as("as file").isEqualTo(foo.getAbsolutePath()); + + op = op.basePath(bar.toPath()); + assertThat(op.basePath()).as("as path").isEqualTo(bar.getAbsolutePath()); + + op = op.basePath("foo"); + assertThat(op.basePath()).as("as string").isEqualTo("foo"); + } + + @Test + void testBaseline() { + var foo = new File("foo"); + var bar = new File("bar"); + + var op = new DetektOperation().baseline(foo); + assertThat(op.baseline()).as("as file").isEqualTo(foo.getAbsolutePath()); + + op = op.baseline(bar.toPath()); + assertThat(op.baseline()).as("as path").isEqualTo(bar.getAbsolutePath()); + + op = op.baseline("foo"); + assertThat(op.baseline()).as("as string").isEqualTo("foo"); + } + + @Test + @EnabledOnOs(OS.LINUX) + @SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops") + void testCheckAllParameters() throws IOException { + var args = Files.readAllLines(Paths.get("src", "test", "resources", "detekt-args.txt")); + + assertThat(args).isNotEmpty(); + + var op = new DetektOperation() + .fromProject(new BaseProject()) + .allRules(true) + .autoCorrect(true) + .basePath("basePath") + .basePath(new File("basePath")) + .baseline("baseline") + .buildUponDefaultConfig(true) + .classPath(new File("path1")) + .classPath("path2", "path3") + .classPath(List.of(new File("path4"), new File("path5"))) + .config(new File("config1")) + .config("config2", "config3") + .config(List.of(new File("config4"), new File("config5"))) + .configResource("configResource") + .configResource(new File("configResource")) + .createBaseline(true) + .debug(true) + .disableDefaultRuleSets(true) + .excludes(List.of("excludes1", "excludes2")) + .excludes("excludes3", "excludes4") + .generateConfig(true) + .includes(List.of("includes1", "includes2")) + .includes("includes3", "includes4", "includes5") + .input(new File("input1")) + .input("input2", "input3") + .input(List.of(new File("input4"), new File("input5"))) + .jdkHome("jdkHome") + .jvmTarget("jvmTarget") + .languageVersion("languageVersion") + .maxIssues(10) + .parallel(true) + .plugins(new File("jar1")) + .plugins("jar2", "jar3") + .plugins(List.of(new File("jar4"), new File("jar5"))) + .report(new Report(ReportId.HTML, "reports")); + + assertThat(op.excludes()).as("excludes[]").containsExactly(".*/build/.*", ".*/resources/.*", + "excludes1", "excludes2", "excludes3", "excludes4"); + + 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)); + } + + var params = op.executeConstructProcessCommandList(); + + try (var softly = new AutoCloseableSoftAssertions()) { + for (var p : args) { + var found = false; + for (var a : params) { + if (a.startsWith(p)) { + found = true; + break; + } + } + softly.assertThat(found).as(p + " not found.").isTrue(); + } + } + } + + @Test + void testClassPath() { + var foo = new File("foo"); + var bar = new File("bar"); + + var op = new DetektOperation().classPath("foo", "bar"); + assertThat(op.classPath()).as("String...").contains(foo, bar); + op.classPath().clear(); + + op = op.classPath(foo, bar); + assertThat(op.classPath()).as("File...").contains(foo, bar); + op.classPath().clear(); + + op = op.classPath(foo.toPath(), bar.toPath()); + assertThat(op.classPath()).as("Path...").contains(foo, bar); + op.classPath().clear(); + + op = op.classPathStrings(List.of("foo", "bar")); + assertThat(op.classPath()).as("List(String...)").contains(foo, bar); + op.classPath().clear(); + + op = op.classPath(List.of(foo, bar)); + assertThat(op.classPath()).as("File...").contains(foo, bar); + op.classPath().clear(); + + op = op.classPathPaths(List.of(foo.toPath(), bar.toPath())); + assertThat(op.classPath()).as("Path...").contains(foo, bar); + op.classPath().clear(); + } + + @Test + void testConfig() { + var foo = new File("foo"); + var bar = new File("bar"); + + var op = new DetektOperation().config("foo", "bar"); + assertThat(op.config()).as("String...").contains(foo, bar); + op.config().clear(); + + op = op.config(foo, bar); + assertThat(op.config()).as("File...").contains(foo, bar); + op.config().clear(); + + op = op.config(foo.toPath(), bar.toPath()); + assertThat(op.config()).as("Path...").contains(foo, bar); + op.config().clear(); + + op = op.configStrings(List.of("foo", "bar")); + assertThat(op.config()).as("List(String...)").contains(foo, bar); + op.config().clear(); + + op = op.config(List.of(foo, bar)); + assertThat(op.config()).as("File...").contains(foo, bar); + op.config().clear(); + + op = op.configPaths(List.of(foo.toPath(), bar.toPath())); + assertThat(op.config()).as("Path...").contains(foo, bar); + op.config().clear(); + } + + @Test + void testConfigResource() { + var foo = new File("foo"); + var bar = new File("bar"); + + var op = new DetektOperation().configResource(foo); + assertThat(op.configResource()).as("as file").isEqualTo(foo.getAbsolutePath()); + + op = op.configResource(bar.toPath()); + assertThat(op.configResource()).as("as path").isEqualTo(bar.getAbsolutePath()); + + op = new DetektOperation().configResource("foo"); + assertThat(op.configResource()).as("as string").isEqualTo("foo"); + } + @Test void testExampleBaseline() throws IOException, ExitStatusException, InterruptedException { var tmpDir = Files.createTempDirectory("bld-detekt-").toFile(); - var baseline = new File(tmpDir, "detekt-baseline.xml"); + var baseline = new File(tmpDir, "examples/src/test/resources/detekt-baseline.xml"); var op = new DetektOperation() .fromProject(new BaseProjectBlueprint(new File("examples"), "com.example", - "Example")) - .baseline(baseline.getAbsolutePath()) + "example", "Example")) + .baseline(baseline) .createBaseline(true); op.execute(); @@ -80,7 +263,7 @@ class DetektOperationTest { void testExampleMaxIssues() { var op = new DetektOperation() .fromProject(new BaseProjectBlueprint(new File("examples"), "com.example", - "Example")) + "example", "Example")) .maxIssues(8); assertThatNoException().isThrownBy(op::execute); } @@ -97,12 +280,12 @@ class DetektOperationTest { var op = new DetektOperation() .fromProject(new BaseProjectBlueprint(new File("examples"), "com.example", - "Example")) - .report(new DetektReport(DetektReportId.HTML, html.getAbsolutePath())) - .report(new DetektReport(DetektReportId.XML, xml.getAbsolutePath())) - .report(new DetektReport(DetektReportId.TXT, txt.getAbsolutePath())) - .report(new DetektReport(DetektReportId.MD, md.getAbsolutePath())) - .report(new DetektReport(DetektReportId.SARIF, sarif.getAbsolutePath())); + "example", "Example")) + .report(new Report(ReportId.HTML, html.getAbsolutePath())) + .report(new Report(ReportId.XML, xml.getAbsolutePath())) + .report(new Report(ReportId.TXT, txt.getAbsolutePath())) + .report(new Report(ReportId.MD, md.getAbsolutePath())) + .report(new Report(ReportId.SARIF, sarif.getAbsolutePath())); assertThatThrownBy(op::execute).isInstanceOf(ExitStatusException.class); @@ -115,8 +298,74 @@ class DetektOperationTest { void testExamplesExecute() { var op = new DetektOperation() .fromProject(new BaseProjectBlueprint(new File("examples"), "com.example", - "Example")) + "example", "Example")) .debug(true); assertThatThrownBy(op::execute).isInstanceOf(ExitStatusException.class); } + + @Test + void testExecuteNoProject() { + var op = new DetektOperation(); + assertThatCode(op::execute).isInstanceOf(ExitStatusException.class); + } + + @Test + void testInput() { + var foo = new File("foo"); + var bar = new File("bar"); + + var op = new DetektOperation().input("foo", "bar"); + assertThat(op.input()).as("String...").contains(foo, bar); + op.input().clear(); + + op = op.input(foo, bar); + assertThat(op.input()).as("File...").contains(foo, bar); + op.input().clear(); + + op = op.input(foo.toPath(), bar.toPath()); + assertThat(op.input()).as("Path...").contains(foo, bar); + op.input().clear(); + + op = op.inputStrings(List.of("foo", "bar")); + assertThat(op.input()).as("List(String...)").contains(foo, bar); + op.input().clear(); + + op = op.input(List.of(foo, bar)); + assertThat(op.input()).as("File...").contains(foo, bar); + op.input().clear(); + + op = op.inputPaths(List.of(foo.toPath(), bar.toPath())); + assertThat(op.input()).as("Path...").contains(foo, bar); + op.input().clear(); + } + + @Test + void testPlugins() { + var foo = new File("foo"); + var bar = new File("bar"); + + var op = new DetektOperation().plugins("foo", "bar"); + assertThat(op.plugins()).as("String...").contains(foo, bar); + op.plugins().clear(); + + op = op.plugins(foo, bar); + assertThat(op.plugins()).as("File...").contains(foo, bar); + op.plugins().clear(); + + op = op.plugins(foo.toPath(), bar.toPath()); + assertThat(op.plugins()).as("Path...").contains(foo, bar); + op.plugins().clear(); + + op = op.pluginsStrings(List.of("foo", "bar")); + assertThat(op.plugins()).as("List(String...)").contains(foo, bar); + op.plugins().clear(); + + op = op.plugins(List.of(foo, bar)); + assertThat(op.plugins()).as("File...").contains(foo, bar); + op.plugins().clear(); + + op = op.pluginsPaths(List.of(foo.toPath(), bar.toPath())); + assertThat(op.plugins()).as("Path...").contains(foo, bar); + op.plugins().clear(); + } } diff --git a/src/test/resources/detekt-args.txt b/src/test/resources/detekt-args.txt new file mode 100644 index 0000000..b804831 --- /dev/null +++ b/src/test/resources/detekt-args.txt @@ -0,0 +1,21 @@ +--all-rules +--auto-correct +--baseline +--base-path +--build-upon-default-config +--classpath +--config +--config-resource +--create-baseline +--debug +--disable-default-rulesets +--excludes +--generate-config +--includes +--input +--jdk-home +--jvm-target +--max-issues +--parallel +--plugins +--report