diff --git a/.github/workflows/bld.yml b/.github/workflows/bld.yml index 2d50ee7..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,12 +24,16 @@ jobs: distribution: "zulu" java-version: ${{ matrix.java-version }} - - name: Download dependencies - run: ./bld download - - name: Download dependencies [examples] working-directory: examples run: ./bld download + - name: Run Detekt [examples] + working-directory: examples + run: ./bld compile test-ci + + - name: Download dependencies + run: ./bld download + - name: Run tests - run: ./bld compile test + 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/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 4dd96bf..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/.vscode/settings.json b/.vscode/settings.json index 5b2667b..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-2.0.1.jar", + "${HOME}/.bld/dist/bld-2.2.1.jar", "lib/**/*.jar" ] } diff --git a/README.md b/README.md index 46e298b..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/2.0.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 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 4dd96bf..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 5b2667b..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-2.0.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 32bac6a..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 765309b..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.downloadLocation= -bld.extension-detekt=com.uwyn.rife2:bld-detekt:0.9.5 -bld.extension-kotlin=com.uwyn.rife2:bld-kotlin:1.0.0 +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=2.0.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 b877e17..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(2, 0, 0); + 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, 3))) - .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 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.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,14 +46,14 @@ 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(); -// -// consoleHandler.setLevel(level); -// logger.addHandler(consoleHandler); -// logger.setLevel(level); -// logger.setUseParentHandlers(false); + 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); new ExampleBuild().start(args); } @@ -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 f836770..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 79b2f59..c5da09f 100644 --- a/lib/bld/bld-wrapper.properties +++ b/lib/bld/bld-wrapper.properties @@ -1,8 +1,8 @@ bld.downloadExtensionJavadoc=false bld.downloadExtensionSources=true bld.downloadLocation= -bld.extension-exec=com.uwyn.rife2:bld-exec:1.0.2 -bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.1.4 +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=2.0.1 +bld.version=2.2.1 diff --git a/src/bld/java/rife/bld/extension/DetektOperationBuild.java b/src/bld/java/rife/bld/extension/DetektOperationBuild.java index e4e17fb..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,6 +23,7 @@ import rife.bld.publish.PublishLicense; import rife.bld.publish.PublishScm; import java.util.List; +import java.util.Locale; import static rife.bld.dependencies.Repository.*; import static rife.bld.dependencies.Scope.compile; @@ -33,20 +34,22 @@ public class DetektOperationBuild extends Project { public DetektOperationBuild() { pkg = "rife.bld.extension"; name = "DetektOperation"; - version = version(0, 9, 5); + version = version(0, 9, 10, "SNAPSHOT"); javaRelease = 17; + downloadSources = true; autoDownloadPurge = true; + repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES, RIFE2_SNAPSHOTS); scope(compile) - .include(dependency("com.uwyn.rife2", "bld", version(2, 0, 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, 3))) - .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 3))) - .include(dependency("org.assertj", "assertj-core", version(3, 26, 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() @@ -56,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")); @@ -97,10 +98,13 @@ public class DetektOperationBuild extends Project { @Override public void test() throws Exception { - new ExecOperation() - .fromProject(this) - .command("scripts/cliargs.sh") - .execute(); + 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 97aecc5..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. @@ -24,8 +24,8 @@ import rife.bld.operations.exceptions.ExitStatusException; import java.io.File; import java.io.IOException; +import java.nio.file.Path; import java.util.ArrayList; -import java.util.Arrays; import java.util.Collection; import java.util.List; import java.util.logging.Level; @@ -48,14 +48,14 @@ 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(Report.class.getName()); + 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<>(); @@ -128,8 +128,28 @@ public class DetektOperation extends AbstractProcessOperation { * @return this operation instance */ public DetektOperation basePath(File path) { - basePath_ = path.getAbsolutePath(); - return this; + 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()); } /** @@ -152,8 +172,27 @@ public class DetektOperation extends AbstractProcessOperation { * @return this operation instance */ public DetektOperation baseline(File baseline) { - baseline_ = baseline.getAbsolutePath(); - return this; + 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_; } /** @@ -175,10 +214,10 @@ public class DetektOperation extends AbstractProcessOperation { * * @param paths one or more files * @return this operation instance + * @see #classPath(Collection) */ public DetektOperation classPath(File... paths) { - classpath_.addAll(List.of(paths)); - return this; + return classPath(List.of(paths)); } /** @@ -187,10 +226,22 @@ public class DetektOperation extends AbstractProcessOperation { * * @param paths one or more files * @return this operation instance + * @see #classPathPaths(Collection) + */ + 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) { - classpath_.addAll(Arrays.stream(paths).map(File::new).toList()); - return this; + return classPathStrings(List.of(paths)); } @@ -200,6 +251,7 @@ public class DetektOperation extends AbstractProcessOperation { * * @param paths the paths * @return this operation instance + * @see #classPath(File...) */ public DetektOperation classPath(Collection paths) { classpath_.addAll(paths); @@ -216,14 +268,27 @@ public class DetektOperation extends AbstractProcessOperation { } /** - * Paths to the config files ({@code path/to/config.yml}). + * EXPERIMENTAL: Paths where to find user class files and jar dependencies. + * Used for type resolution. * - * @param configs one or more config files + * @param paths the paths * @return this operation instance + * @see #classPath(Path...) */ - public DetektOperation config(File... configs) { - config_.addAll(List.of(configs)); - return this; + 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()); } /** @@ -231,10 +296,32 @@ public class DetektOperation extends AbstractProcessOperation { * * @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(Arrays.stream(configs).map(File::new).toList()); - return this; + return configStrings(List.of(configs)); } /** @@ -242,6 +329,7 @@ public class DetektOperation extends AbstractProcessOperation { * * @param configs the config files * @return this operation instance + * @see #config(File...) */ public DetektOperation config(Collection configs) { config_.addAll(configs); @@ -257,6 +345,17 @@ public class DetektOperation extends AbstractProcessOperation { 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()); + } + /** * Path to the config resource on detekt's classpath ({@code path/to/config.yml}). * @@ -275,7 +374,37 @@ public class DetektOperation extends AbstractProcessOperation { * @return this operation instance */ public DetektOperation configResource(File resource) { - configResource_ = resource.getAbsolutePath(); + 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; } @@ -320,8 +449,7 @@ public class DetektOperation extends AbstractProcessOperation { * @return this operation instance */ public DetektOperation excludes(String... patterns) { - excludes_.addAll(List.of(patterns)); - return this; + return excludes(List.of(patterns)); } /** @@ -360,7 +488,7 @@ public class DetektOperation extends AbstractProcessOperation { throw new ExitStatusException(ExitStatusException.EXIT_FAILURE); } else { super.execute(); - if (successful_ && LOGGER.isLoggable(Level.INFO) && !silent()){ + if (successful_ && LOGGER.isLoggable(Level.INFO) && !silent()) { if (createBaseline_) { LOGGER.info("Detekt baseline generated successfully: " + "file://" + new File(baseline_).toURI().getPath()); @@ -573,7 +701,7 @@ public class DetektOperation extends AbstractProcessOperation { } } } - return String.join(":", jars); + return String.join(File.pathSeparator, jars); } /** @@ -584,8 +712,7 @@ public class DetektOperation extends AbstractProcessOperation { * @return this operation instance */ public DetektOperation includes(String... patterns) { - includes_.addAll(List.of(patterns)); - return this; + return includes(List.of(patterns)); } /** @@ -614,6 +741,7 @@ public class DetektOperation extends AbstractProcessOperation { * * @param paths the paths * @return this operation instance + * @see #input(Collection) */ public DetektOperation input(Collection paths) { input_.addAll(paths); @@ -625,10 +753,10 @@ 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(Arrays.stream(paths).map(File::new).toList()); - return this; + return inputStrings(List.of(paths)); } /** @@ -636,12 +764,22 @@ public class DetektOperation extends AbstractProcessOperation { * * @param paths one or more paths * @return this operation instance + * @see #input(Collection) */ public DetektOperation input(File... paths) { - input_.addAll(List.of(paths)); - return this; + 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)); + } /** * Returns the input paths to analyze. @@ -652,6 +790,28 @@ public class DetektOperation extends AbstractProcessOperation { 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. */ @@ -729,10 +889,10 @@ 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(Arrays.stream(jars).map(File::new).toList()); - return this; + return pluginsStrings(List.of(jars)); } /** @@ -740,10 +900,21 @@ public class DetektOperation extends AbstractProcessOperation { * * @param jars one or more jars * @return this operation instance + * @see #plugins(Collection) */ public DetektOperation plugins(File... jars) { - plugins_.addAll(List.of(jars)); - return this; + 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)); } /** @@ -751,6 +922,7 @@ public class DetektOperation extends AbstractProcessOperation { * * @param jars the jars paths * @return this operation instance + * @see #input(File...) */ public DetektOperation plugins(Collection jars) { plugins_.addAll(jars); @@ -766,6 +938,28 @@ public class DetektOperation extends AbstractProcessOperation { 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'. * diff --git a/src/main/java/rife/bld/extension/detekt/Report.java b/src/main/java/rife/bld/extension/detekt/Report.java index 32dcc60..ffa4a45 100644 --- a/src/main/java/rife/bld/extension/detekt/Report.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. diff --git a/src/main/java/rife/bld/extension/detekt/ReportId.java b/src/main/java/rife/bld/extension/detekt/ReportId.java index ef53bc9..c087243 100644 --- a/src/main/java/rife/bld/extension/detekt/ReportId.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. diff --git a/src/test/java/rife/bld/extension/DetektOperationTest.java b/src/test/java/rife/bld/extension/DetektOperationTest.java index c45b3fa..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,8 +16,11 @@ 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; @@ -61,6 +64,37 @@ 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")); @@ -117,27 +151,104 @@ class DetektOperationTest { var params = op.executeConstructProcessCommandList(); - for (var p : args) { - var found = false; - for (var a : params) { - if (a.startsWith(p)) { - found = true; - break; + 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(); } - 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")) + "example", "Example")) .baseline(baseline) .createBaseline(true); op.execute(); @@ -152,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); } @@ -169,7 +280,7 @@ class DetektOperationTest { var op = new DetektOperation() .fromProject(new BaseProjectBlueprint(new File("examples"), "com.example", - "Example")) + "example", "Example")) .report(new Report(ReportId.HTML, html.getAbsolutePath())) .report(new Report(ReportId.XML, xml.getAbsolutePath())) .report(new Report(ReportId.TXT, txt.getAbsolutePath())) @@ -187,7 +298,7 @@ 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); } @@ -197,4 +308,64 @@ class DetektOperationTest { 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(); + } }