diff --git a/.github/workflows/bld.yml b/.github/workflows/bld.yml index 55fefbf..6dc0235 100644 --- a/.github/workflows/bld.yml +++ b/.github/workflows/bld.yml @@ -4,29 +4,36 @@ on: [ push, pull_request, workflow_dispatch ] jobs: build-bld-project: - runs-on: ubuntu-latest - strategy: matrix: - java-version: [ 17, 20 ] + 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 - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - name: Set up JDK ${{ matrix.java-version }} - uses: actions/setup-java@v3 + uses: actions/setup-java@v4 with: - distribution: 'zulu' + 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: Run tests with bld + - name: Compile and run JaCoCo [examples] + working-directory: examples + run: ./bld compile jacoco + + - 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 f6122cd..508f6a5 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -30,14 +30,14 @@ jobs: steps: - name: Checkout source repository - uses: actions/checkout@v3 + uses: actions/checkout@v4 with: fetch-depth: 0 - name: Set up JDK 17 - uses: actions/setup-java@v3 + uses: actions/setup-java@v4 with: - distribution: 'zulu' + distribution: "zulu" java-version: 17 - name: Build Javadocs @@ -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/' + path: "build/javadoc/" - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v1 \ No newline at end of file + 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 206aa7d..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/intellij-javadocs-4.0.1.xml b/.idea/intellij-javadocs-4.0.1.xml new file mode 100644 index 0000000..d91c459 --- /dev/null +++ b/.idea/intellij-javadocs-4.0.1.xml @@ -0,0 +1,204 @@ + + + + + UPDATE + false + true + + METHOD + FIELD + TYPE + + + PUBLIC + DEFAULT + PROTECTED + + + + + + ^.*(public|protected|private)*.+interface\s+\w+.* + /**\n + * The interface ${name}.\n +<#if element.typeParameters?has_content> * \n +</#if> +<#list element.typeParameters as typeParameter> + * @param <${typeParameter.name}> the type parameter\n +</#list> + */ + + + ^.*(public|protected|private)*.+enum\s+\w+.* + /**\n + * The enum ${name}.\n + */ + + + ^.*(public|protected|private)*.+class\s+\w+.* + /**\n + * The type ${name}.\n +<#if element.typeParameters?has_content> * \n +</#if> +<#list element.typeParameters as typeParameter> + * @param <${typeParameter.name}> the type parameter\n +</#list> + */ + + + .+ + /**\n + * The type ${name}.\n + */ + + + + + .+ + /**\n + * Instantiates a new ${name}.\n +<#if element.parameterList.parameters?has_content> + *\n +</#if> +<#list element.parameterList.parameters as parameter> + * @param ${parameter.name} the ${paramNames[parameter.name]}\n +</#list> +<#if element.throwsList.referenceElements?has_content> + *\n +</#if> +<#list element.throwsList.referenceElements as exception> + * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n +</#list> + */ + + + + + ^.*(public|protected|private)*\s*.*(\w(\s*<.+>)*)+\s+get\w+\s*\(.*\).+ + /**\n + * Gets ${partName}.\n +<#if element.typeParameters?has_content> * \n +</#if> +<#list element.typeParameters as typeParameter> + * @param <${typeParameter.name}> the type parameter\n +</#list> +<#if element.parameterList.parameters?has_content> + *\n +</#if> +<#list element.parameterList.parameters as parameter> + * @param ${parameter.name} the ${paramNames[parameter.name]}\n +</#list> +<#if isNotVoid> + *\n + * @return the ${partName}\n +</#if> +<#if element.throwsList.referenceElements?has_content> + *\n +</#if> +<#list element.throwsList.referenceElements as exception> + * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n +</#list> + */ + + + ^.*(public|protected|private)*\s*.*(void|\w(\s*<.+>)*)+\s+set\w+\s*\(.*\).+ + /**\n + * Sets ${partName}.\n +<#if element.typeParameters?has_content> * \n +</#if> +<#list element.typeParameters as typeParameter> + * @param <${typeParameter.name}> the type parameter\n +</#list> +<#if element.parameterList.parameters?has_content> + *\n +</#if> +<#list element.parameterList.parameters as parameter> + * @param ${parameter.name} the ${paramNames[parameter.name]}\n +</#list> +<#if isNotVoid> + *\n + * @return the ${partName}\n +</#if> +<#if element.throwsList.referenceElements?has_content> + *\n +</#if> +<#list element.throwsList.referenceElements as exception> + * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n +</#list> + */ + + + ^.*((public\s+static)|(static\s+public))\s+void\s+main\s*\(\s*String\s*(\[\s*\]|\.\.\.)\s+\w+\s*\).+ + /**\n + * The entry point of application.\n + + <#if element.parameterList.parameters?has_content> + *\n +</#if> + * @param ${element.parameterList.parameters[0].name} the input arguments\n +<#if element.throwsList.referenceElements?has_content> + *\n +</#if> +<#list element.throwsList.referenceElements as exception> + * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n +</#list> + */ + + + .+ + /**\n + * ${name}<#if isNotVoid> ${return}</#if>.\n +<#if element.typeParameters?has_content> * \n +</#if> +<#list element.typeParameters as typeParameter> + * @param <${typeParameter.name}> the type parameter\n +</#list> +<#if element.parameterList.parameters?has_content> + *\n +</#if> +<#list element.parameterList.parameters as parameter> + * @param ${parameter.name} the ${paramNames[parameter.name]}\n +</#list> +<#if isNotVoid> + *\n + * @return the ${return}\n +</#if> +<#if element.throwsList.referenceElements?has_content> + *\n +</#if> +<#list element.throwsList.referenceElements as exception> + * @throws ${exception.referenceName} the ${exceptionNames[exception.referenceName]}\n +</#list> + */ + + + + + ^.*(public|protected|private)*.+static.*(\w\s\w)+.+ + /**\n + * The constant ${element.getName()}.\n + */ + + + ^.*(public|protected|private)*.*(\w\s\w)+.+ + /**\n + <#if element.parent.isInterface()> + * The constant ${element.getName()}.\n +<#else> + * The ${name}.\n +</#if> */ + + + .+ + /**\n + <#if element.parent.isEnum()> + *${name} ${typeName}.\n +<#else> + * The ${name}.\n +</#if>*/ + + + + + \ No newline at end of file diff --git a/.idea/libraries/bld.xml b/.idea/libraries/bld.xml index f07cc1c..153a060 100644 --- a/.idea/libraries/bld.xml +++ b/.idea/libraries/bld.xml @@ -2,11 +2,12 @@ - + - + + @@ -14,4 +15,4 @@ - \ No newline at end of file + 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 d2d02c0..b646895 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -29,11 +29,18 @@ + \ No newline at end of file + 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/launch.json b/examples/.vscode/launch.json index 71f6bb3..2d63b46 100644 --- a/examples/.vscode/launch.json +++ b/examples/.vscode/launch.json @@ -5,7 +5,14 @@ "type": "java", "name": "Run Tests", "request": "launch", - "mainClass": "com.example.ExamplesTest" + "mainClass": "org.junit.platform.console.ConsoleLauncher", + "args": [ + "--details=verbose", + "--scan-classpath", + "--disable-banner", + "--disable-ansi-colors", + "--exclude-engine=junit-platform-suite", + "--exclude-engine=junit-vintage"] } ] } diff --git a/examples/.vscode/settings.json b/examples/.vscode/settings.json index 5dd7145..ba429d0 100644 --- a/examples/.vscode/settings.json +++ b/examples/.vscode/settings.json @@ -3,13 +3,13 @@ "src/main/java", "src/main/resources", "src/test/java", - "src/bld/java" + "src/test/resources", + "src/bld/java", + "src/bld/resources" ], "java.configuration.updateBuildConfiguration": "automatic", "java.project.referencedLibraries": [ - "${HOME}bld-1.7.0-SNAPSHOT.jar", - "lib/compile/*.jar", - "lib/runtime/*.jar", - "lib/test/*.jar" + "${HOME}/.bld/dist/bld-2.2.1.jar", + "lib/**/*.jar" ] } diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..e96f91a --- /dev/null +++ b/examples/README.md @@ -0,0 +1,6 @@ +# Compile and Generate JaCoCo Reports + +```console +./bld compile jacoco +``` + diff --git a/examples/lib/bld/bld-wrapper.jar b/examples/lib/bld/bld-wrapper.jar index 0c69eaa..b186992 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 a153829..736e12d 100644 --- a/examples/lib/bld/bld-wrapper.properties +++ b/examples/lib/bld/bld-wrapper.properties @@ -1,6 +1,6 @@ bld.downloadExtensionJavadoc=false bld.downloadExtensionSources=true -bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.0 -bld.repositories=RIFE2_SNAPSHOTS,RIFE2_RELEASES,MAVEN_CENTRAL bld.downloadLocation= -bld.version=1.7.1 +bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.10 +bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES +bld.version=2.2.1 diff --git a/examples/src/bld/java/com/example/ExamplesBuild.java b/examples/src/bld/java/com/example/ExamplesBuild.java index 4c1af5e..4dd3a0b 100644 --- a/examples/src/bld/java/com/example/ExamplesBuild.java +++ b/examples/src/bld/java/com/example/ExamplesBuild.java @@ -17,20 +17,26 @@ public class ExamplesBuild extends Project { name = "Examples"; version = version(0, 1, 0); + javaRelease = 17; + + downloadSources = true; + autoDownloadPurge = true; + repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL); scope(test) - .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 9, 3))) - .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 9, 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))); } public static void main(String[] args) { new ExamplesBuild().start(args); } + @BuildCommand(summary = "Generates Jacoco Reports") - public void jacoco() throws IOException { + public void jacoco() throws Exception { new JacocoReportOperation() .fromProject(this) .execute(); } -} \ No newline at end of file +} diff --git a/lib/bld/bld-wrapper.jar b/lib/bld/bld-wrapper.jar index afa7b0c..cf19588 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 b079455..b8fd71b 100644 --- a/lib/bld/bld-wrapper.properties +++ b/lib/bld/bld-wrapper.properties @@ -1,6 +1,7 @@ bld.downloadExtensionJavadoc=false bld.downloadExtensionSources=true -bld.extension-pmd=com.uwyn.rife2:bld-pmd:0.9.2 -bld.repositories=RIFE2_SNAPSHOTS,RIFE2_RELEASES,MAVEN_CENTRAL bld.downloadLocation= -bld.version=1.7.1 +bld.extension-exec=com.uwyn.rife2:bld-exec:1.0.5 +bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.2.2 +bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES +bld.version=2.2.1 diff --git a/scripts/cliargs.sh b/scripts/cliargs.sh new file mode 100755 index 0000000..a1b7900 --- /dev/null +++ b/scripts/cliargs.sh @@ -0,0 +1,5 @@ +#!/bin/bash + +java -jar lib/compile/org.jacoco.cli-*-nodeps.jar report 2> >(grep "^ [<-]") | + cut -d' ' -f 2 | + sed -e "/help/d" >"src/test/resources/jacoco-args.txt" diff --git a/src/bld/java/rife/bld/extension/JacocoReportOperationBuild.java b/src/bld/java/rife/bld/extension/JacocoReportOperationBuild.java index 342cbd1..54a64c4 100644 --- a/src/bld/java/rife/bld/extension/JacocoReportOperationBuild.java +++ b/src/bld/java/rife/bld/extension/JacocoReportOperationBuild.java @@ -1,17 +1,17 @@ /* - * Copyright 2023 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. - * You may obtain a copy of the License at + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ package rife.bld.extension; @@ -26,52 +26,61 @@ import rife.bld.publish.PublishScm; import java.util.List; import static rife.bld.dependencies.Repository.*; -import static rife.bld.dependencies.Scope.*; +import static rife.bld.dependencies.Scope.compile; +import static rife.bld.dependencies.Scope.test; import static rife.bld.operations.JavadocOptions.DocLinkOption.NO_MISSING; public class JacocoReportOperationBuild extends Project { public JacocoReportOperationBuild() { pkg = "rife.bld.extension"; name = "JacocoReportOperation"; - version = version(0, 9, 0); + version = version(0, 9, 10); javaRelease = 17; + downloadSources = true; autoDownloadPurge = true; - repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES); + + repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES, RIFE2_SNAPSHOTS); - var jacocoVersion = new VersionNumber(0, 8, 10); + var jacocoVersion = new VersionNumber(0, 8, 13); scope(compile) .include(dependency("org.jacoco", "jacoco", jacocoVersion).exclude("*", "org.jacoco.doc")) - .include(dependency("com.uwyn.rife2", "rife2", version(1, 7, 0))) - .include(dependency("com.uwyn.rife2", "bld", version(1, 7, 1))); - scope(runtime) - .include(dependency("org.jacoco", "jacoco", jacocoVersion).exclude("*", "org.jacoco.doc")); + .include(dependency("com.uwyn.rife2", "bld", version(2, 2, 1))); scope(test) - .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 0))) - .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 0))) - .include(dependency("org.assertj:assertj-joda-time:2.2.0")); + .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() .docLint(NO_MISSING) .link("https://rife2.github.io/bld/") .link("https://rife2.github.io/rife2/"); publishOperation() .repository(version.isSnapshot() ? repository("rife2-snapshot") : repository("rife2")) + .repository(repository("github")) .info() .groupId("com.uwyn.rife2") .artifactId("bld-jacoco-report") .description("bld Extension to Generate JaCoCo Code Coverage Reports") .url("https://github.com/rife2/bld-pmd") - .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("http://www.apache.org/licenses/LICENSE-2.0.txt")) + .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") + ) .scm(new PublishScm().connection("scm:git:https://github.com/rife2/bld-pmd.git") .developerConnection("scm:git:git@github.com:rife2/bld-pmd.git") - .url("https://github.com/rife2/bld-pmd")) + .url("https://github.com/rife2/bld-pmd") + ) .signKey(property("sign.key")) .signPassphrase(property("sign.passphrase")); } @@ -81,11 +90,23 @@ public class JacocoReportOperationBuild extends Project { } @BuildCommand(summary = "Runs PMD analysis") - public void pmd() { + public void pmd() throws Exception { new PmdOperation() .fromProject(this) .failOnViolation(true) .ruleSets("config/pmd.xml") .execute(); } + + @Override + public void test() throws Exception { + var os = System.getProperty("os.name"); + if (os != null && os.toLowerCase().contains("linux")) { + new ExecOperation() + .fromProject(this) + .command("scripts/cliargs.sh") + .execute(); + } + super.test(); + } } diff --git a/src/main/java/rife/bld/extension/JacocoReportOperation.java b/src/main/java/rife/bld/extension/JacocoReportOperation.java index 248d07a..3d8946e 100644 --- a/src/main/java/rife/bld/extension/JacocoReportOperation.java +++ b/src/main/java/rife/bld/extension/JacocoReportOperation.java @@ -1,17 +1,17 @@ /* - * Copyright 2023 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. - * You may obtain a copy of the License at + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at * - * https://www.apache.org/licenses/LICENSE-2.0 + * https://www.apache.org/licenses/LICENSE-2.0 * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. */ package rife.bld.extension; @@ -35,7 +35,7 @@ import java.io.IOException; import java.nio.file.Files; 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; import java.util.logging.Logger; @@ -52,195 +52,400 @@ public class JacocoReportOperation extends AbstractOperation classFiles = new ArrayList<>(); + final private Collection classFiles_ = new ArrayList<>(); /** * The location of the exec files. */ - final List execFiles = new ArrayList<>(); + final private Collection execFiles_ = new ArrayList<>(); /** * The location of the source files. */ - final List sourceFiles = new ArrayList<>(); + final private Collection sourceFiles_ = new ArrayList<>(); /** * The location of the CSV report. */ - File csv; + private File csv_; /** * The file to write execution data to. */ - File destFile; + private File destFile_; /** * The source file encoding. */ - String encoding; + private String encoding_; /** * The location of the HTML report. */ - File html; - /** - * The report name. - */ - String name = "JaCoCo Coverage Report"; + private File html_; /** * The project reference. */ - BaseProject project; + private BaseProject project_; /** - * The quiet flag. + * The report name. */ - boolean quiet; + private String reportName_ = "JaCoCo Coverage Report"; /** * THe tab width. */ - int tabWidth = 4; + private int tabWidth_ = 4; /** * THe location of the XML report */ - File xml; + private File xml_; private IBundleCoverage analyze(ExecutionDataStore data) throws IOException { var builder = new CoverageBuilder(); var analyzer = new Analyzer(data, builder); - for (var f : classFiles) { + for (var f : classFiles_) { LOGGER.info(f.getAbsolutePath()); analyzer.analyzeAll(f); } - return builder.getBundle(name); + return builder.getBundle(reportName_); } /** * Sets the locations of Java class files. - **/ + * + * @param classFiles the class files + * @return this operation instance + * @see #classFiles(Collection) + */ public JacocoReportOperation classFiles(File... classFiles) { - this.classFiles.addAll(Arrays.stream(classFiles).toList()); + return classFiles(List.of(classFiles)); + } + + /** + * Sets the locations of Java class files. + * + * @param classFiles the class files + * @return this operation instance + * @see #classFilesStrings(Collection) + */ + public JacocoReportOperation classFiles(String... classFiles) { + return classFilesStrings(List.of(classFiles)); + } + + /** + * Sets the locations of Java class files. + * + * @param classFiles the class files + * @return this operation instance + * @see #classFilesPaths(Collection) + */ + public JacocoReportOperation classFiles(Path... classFiles) { + return classFilesPaths(List.of(classFiles)); + } + + /** + * Returns the locations of Java class files. + * + * @return the class files + */ + public Collection classFiles() { + return classFiles_; + } + + /** + * Sets the locations of Java class files. + * + * @param classFiles the class files + * @return this operation instance + * @see #classFiles(File...) + */ + public JacocoReportOperation classFiles(Collection classFiles) { + classFiles_.addAll(classFiles); + return this; + } + + /** + * Sets the locations of Java class files. + * + * @param classFiles the class files + * @return this operation instance + * @see #classFiles(Path...) + */ + public JacocoReportOperation classFilesPaths(Collection classFiles) { + return classFiles(classFiles.stream().map(Path::toFile).toList()); + } + + /** + * Sets the locations of Java class files. + * + * @param classFiles the class files + * @return this operation instance + * @see #classFiles(String...) + */ + public JacocoReportOperation classFilesStrings(Collection classFiles) { + return classFiles(classFiles.stream().map(File::new).toList()); + } + + /** + * Sets the location of the CSV report. + * + * @param csv the report location + * @return this operation instance + */ + public JacocoReportOperation csv(File csv) { + csv_ = csv; return this; } /** * Sets the location of the CSV report. + * + * @param csv the report location + * @return this operation instance */ - public JacocoReportOperation csv(File cvs) { - this.csv = cvs; + public JacocoReportOperation csv(String csv) { + return csv(new File(csv)); + } + + /** + * Sets the location of the CSV report. + * + * @param csv the report location + * @return this operation instance + */ + public JacocoReportOperation csv(Path csv) { + return csv(csv.toFile()); + } + + /** + * Sets the file to write execution data to. + * + * @param destFile the file + * @return this operation instance + */ + public JacocoReportOperation destFile(File destFile) { + destFile_ = destFile; return this; } /** * Sets the file to write execution data to. + * + * @param destFile the file + * @return this operation instance */ - public JacocoReportOperation destFile(File destFile) { - this.destFile = destFile; - return this; + public JacocoReportOperation destFile(String destFile) { + return destFile(new File(destFile)); + } + + /** + * Sets the file to write execution data to. + * + * @param destFile the file + * @return this operation instance + */ + public JacocoReportOperation destFile(Path destFile) { + return destFile(destFile.toFile()); } /** * Sets the source file encoding. The platform encoding is used by default. + * + * @param encoding the encoding + * @return this operation instance */ public JacocoReportOperation encoding(String encoding) { - this.encoding = encoding; + encoding_ = encoding; return this; } /** * Sets the locations of the JaCoCo *.exec files to read. + * + * @param execFiles the exec files + * @return this operation instance + * @see #execFiles(Collection) */ public JacocoReportOperation execFiles(File... execFiles) { - this.execFiles.addAll(Arrays.stream(execFiles).toList()); + return execFiles(List.of(execFiles)); + } + + /** + * Sets the locations of the JaCoCo *.exec files to read. + * + * @param execFiles the exec files + * @return this operation instance + * @see #execFilesStrings(Collection) + */ + public JacocoReportOperation execFiles(String... execFiles) { + return execFilesStrings(List.of(execFiles)); + } + + /** + * Sets the locations of the JaCoCo *.exec files to read. + * + * @param execFiles the exec files + * @return this operation instance + * @see #execFilesPaths(Collection) + */ + public JacocoReportOperation execFiles(Path... execFiles) { + return execFilesPaths(List.of(execFiles)); + } + + /** + * Sets the locations of the JaCoCo *.exec files to read. + * + * @param execFiles the exec files + * @return this operation instance + * @see #execFiles(File...) + */ + public JacocoReportOperation execFiles(Collection execFiles) { + execFiles_.addAll(execFiles); return this; } + /** + * Returns the locations of the JaCoCo *.exec files to read. + * + * @return the exec files + */ + public Collection execFiles() { + return execFiles_; + } + + /** + * Sets the locations of the JaCoCo *.exec files to read. + * + * @param execFiles the exec files + * @return this operation instance + * @see #execFiles(Path...) + */ + public JacocoReportOperation execFilesPaths(Collection execFiles) { + return execFiles(execFiles.stream().map(Path::toFile).toList()); + } + + /** + * Sets the locations of the JaCoCo *.exec files to read. + * + * @param execFiles the exec files + * @return this operation instance + * @see #execFiles(String...) + */ + public JacocoReportOperation execFilesStrings(Collection execFiles) { + return execFiles(execFiles.stream().map(File::new).toList()); + } + /** * Performs the operation execution that can be wrapped by the {@code #executeOnce} call. */ @Override - public void execute() throws IOException { - if ((project == null) && LOGGER.isLoggable(Level.SEVERE)) { - LOGGER.severe("A project must be specified."); - } else { - var buildJacocoReportsDir = Path.of(project.buildDirectory().getPath(), "reports", "jacoco", "test").toFile(); - var buildJacocoExecDir = Path.of(project.buildDirectory().getPath(), "jacoco").toFile(); - var buildJacocoExec = Path.of(buildJacocoExecDir.getPath(), "jacoco.exec").toFile(); - - if (destFile == null) { - destFile = Path.of(buildJacocoExecDir.getPath(), "jacoco.exec").toFile(); + public void execute() throws Exception { + if ((project_ == null)) { + if (LOGGER.isLoggable(Level.SEVERE) && !silent()) { + LOGGER.severe("A project must be specified."); } - - if (execFiles.isEmpty()) { -// project.testOperation().fromProject(project).javaOptions().javaAgent( -// Path.of(project.libBldDirectory().getPath(), "org.jacoco.agent-" -// + JaCoCo.VERSION.substring(0, JaCoCo.VERSION.lastIndexOf('.')) + "-runtime.jar").toFile(), -// "destfile=" + destFile.getPath()); - project.testOperation().fromProject(project).javaOptions().add("-javaagent:" + - Path.of(project.libBldDirectory().getPath(), "org.jacoco.agent-" - + JaCoCo.VERSION.substring(0, JaCoCo.VERSION.lastIndexOf('.')) + "-runtime.jar") - + "=destfile=" + destFile.getPath()); - try { - project.testOperation().execute(); - } catch (InterruptedException | ExitStatusException e) { - throw new IOException(e); - } - - if (LOGGER.isLoggable(Level.INFO) && !quiet) { - LOGGER.log(Level.INFO, "Execution Data: {0}", destFile); - } - - if (buildJacocoExec.exists()) { - execFiles.add(buildJacocoExec); - } - } - - if (sourceFiles.isEmpty()) { - sourceFiles.add(project.srcMainJavaDirectory()); - } - - if (classFiles.isEmpty()) { - classFiles.add(project.buildMainDirectory()); - } - - if (html == null) { - html = new File(buildJacocoReportsDir, "html"); - } - - if (xml == null) { - xml = new File(buildJacocoReportsDir, "jacocoTestReport.xml"); - } - - if (csv == null) { - csv = new File(buildJacocoReportsDir, "jacocoTestReport.csv"); - } - - //noinspection ResultOfMethodCallIgnored - buildJacocoReportsDir.mkdirs(); - - var loader = loadExecFiles(); - var bundle = analyze(loader.getExecutionDataStore()); - writeReports(bundle, loader); + throw new ExitStatusException(ExitStatusException.EXIT_FAILURE); } + + var buildJacocoReportsDir = Path.of(project_.buildDirectory().getPath(), "reports", "jacoco", "test").toFile(); + var buildJacocoExecDir = Path.of(project_.buildDirectory().getPath(), "jacoco").toFile(); + var buildJacocoExec = Path.of(buildJacocoExecDir.getPath(), "jacoco.exec").toFile(); + + if (destFile_ == null) { + destFile_ = buildJacocoExec; + } + + if (execFiles_.isEmpty()) { + var testOperation = project_.testOperation().fromProject(project_); + testOperation.javaOptions().javaAgent(Path.of(project_.libBldDirectory().getPath(), + "org.jacoco.agent-" + JaCoCo.VERSION.substring(0, JaCoCo.VERSION.lastIndexOf('.')) + + "-runtime.jar").toFile(), "destfile=" + destFile_.getPath()); + + testOperation.execute(); + + if (LOGGER.isLoggable(Level.INFO) && !silent()) { + LOGGER.log(Level.INFO, "Execution Data: {0}", destFile_); + } + + if (buildJacocoExec.exists()) { + execFiles_.add(buildJacocoExec); + } + } + + if (sourceFiles_.isEmpty()) { + sourceFiles_.add(project_.srcMainJavaDirectory()); + } + + if (classFiles_.isEmpty()) { + classFiles_.add(project_.buildMainDirectory()); + } + + if (html_ == null) { + html_ = new File(buildJacocoReportsDir, "html"); + } + + if (xml_ == null) { + xml_ = new File(buildJacocoReportsDir, "jacocoTestReport.xml"); + } + + if (csv_ == null) { + csv_ = new File(buildJacocoReportsDir, "jacocoTestReport.csv"); + } + + //noinspection ResultOfMethodCallIgnored + buildJacocoReportsDir.mkdirs(); + //noinspection ResultOfMethodCallIgnored + buildJacocoExecDir.mkdirs(); + + var loader = loadExecFiles(); + var bundle = analyze(loader.getExecutionDataStore()); + writeReports(bundle, loader); } /** * Configure the operation from a {@link BaseProject}. + * + * @param project the project + * @return this operation instance */ public JacocoReportOperation fromProject(BaseProject project) { - this.project = project; + project_ = project; return this; } /** * Sets the location of the HTML report. + * + * @param html the html + * @return this operation instance */ public JacocoReportOperation html(File html) { - this.html = html; + html_ = html; return this; } + /** + * Sets the location of the HTML report. + * + * @param html the html + * @return this operation instance + */ + public JacocoReportOperation html(String html) { + return html(new File(html)); + } + + /** + * Sets the location of the HTML report. + * + * @param html the html + * @return this operation instance + */ + public JacocoReportOperation html(Path html) { + return html(html.toFile()); + } + private ExecFileLoader loadExecFiles() throws IOException { var loader = new ExecFileLoader(); - if (execFiles.isEmpty() && LOGGER.isLoggable(Level.WARNING) && !quiet) { + if (execFiles_.isEmpty() && LOGGER.isLoggable(Level.WARNING) && !silent()) { LOGGER.warning("No execution data files provided."); } else { - for (var f : execFiles) { - if (LOGGER.isLoggable(Level.INFO) && !quiet) { + for (var f : execFiles_) { + if (LOGGER.isLoggable(Level.INFO) && !silent()) { LOGGER.log(Level.INFO, "Loading execution data: {0}", f.getAbsolutePath()); } @@ -252,36 +457,42 @@ public class JacocoReportOperation extends AbstractOperation visitors = new ArrayList<>(); - if (xml != null) { + if (xml_ != null) { var formatter = new XMLFormatter(); - visitors.add(formatter.createVisitor(Files.newOutputStream(xml.toPath()))); + visitors.add(formatter.createVisitor(Files.newOutputStream(xml_.toPath()))); } - if (csv != null) { + if (csv_ != null) { var formatter = new CSVFormatter(); - visitors.add(formatter.createVisitor(Files.newOutputStream(csv.toPath()))); + visitors.add(formatter.createVisitor(Files.newOutputStream(csv_.toPath()))); } - if (html != null) { + if (html_ != null) { var formatter = new HTMLFormatter(); - visitors.add(formatter.createVisitor(new FileMultiReportOutput(html))); + visitors.add(formatter.createVisitor(new FileMultiReportOutput(html_))); } return new MultiReportVisitor(visitors); @@ -289,32 +500,103 @@ public class JacocoReportOperation extends AbstractOperation sourceFiles) { + sourceFiles_.addAll(sourceFiles); return this; } + /** + * Returns the locations of the source files. + * + * @return the source files + */ + public Collection sourceFiles() { + return sourceFiles_; + } + + /** + * Sets the locations of the source files. (e.g., {@code src/main/java}) + * + * @param sourceFiles the source files + * @return this operation instance + * @see #sourceFiles(Path...) + */ + public JacocoReportOperation sourceFilesPaths(Collection sourceFiles) { + return sourceFiles(sourceFiles.stream().map(Path::toFile).toList()); + } + + /** + * Sets the locations of the source files. (e.g., {@code src/main/java}) + * + * @param sourceFiles the source files + * @return this operation instance + * @see #sourceFiles(String...) + */ + public JacocoReportOperation sourceFilesStrings(Collection sourceFiles) { + return sourceFiles(sourceFiles.stream().map(File::new).toList()); + } + @SuppressWarnings("PMD.AvoidInstantiatingObjectsInLoops") private ISourceFileLocator sourceLocator() { - var multi = new MultiSourceFileLocator(tabWidth); - for (var f : sourceFiles) { - multi.add(new DirectorySourceFileLocator(f, encoding, tabWidth)); + var multi = new MultiSourceFileLocator(tabWidth_); + for (var f : sourceFiles_) { + multi.add(new DirectorySourceFileLocator(f, encoding_, tabWidth_)); } return multi; } /** * Sets the tab stop width for the source pages. Default is {@code 4}. + * + * @param tabWidth the tab width + * @return this operation instance */ public JacocoReportOperation tabWidth(int tabWidth) { - this.tabWidth = tabWidth; + tabWidth_ = tabWidth; return this; } private void writeReports(IBundleCoverage bundle, ExecFileLoader loader) throws IOException { - if (LOGGER.isLoggable(Level.INFO) && !quiet) { + if (LOGGER.isLoggable(Level.INFO) && !silent()) { LOGGER.log(Level.INFO, "Analyzing {0} classes.", bundle.getClassCounter().getTotalCount()); } @@ -323,18 +605,41 @@ public class JacocoReportOperation extends AbstractOperation", + "--classfiles", + "--csv", + "--encoding", + "--html", + "--name", + "--quiet", + "--sourcefiles", + "--tabwith", + "--xml"); + var args = Files.readAllLines(Paths.get("src", "test", "resources", "jacoco-args.txt")); + + assertThat(args).isNotEmpty(); + assertThat(supported).containsAll(args); + + } + + @Test + void executeFailureTest() { + var op = new JacocoReportOperation().fromProject(new Project()); + assertThatCode(op::execute).isInstanceOf(ExitStatusException.class); + } + + @Test + void executeTest() throws Exception { newJacocoReportOperation().execute(); assertThat(csv).exists(); assertThat(html).isDirectory(); assertThat(xml).exists(); - try (var lines = Files.lines(xml.toPath())) { - assertThat(lines.anyMatch(s -> - s.contains(""))).isTrue(); + try (var softly = new AutoCloseableSoftAssertions()) { + try (var lines = Files.lines(xml.toPath())) { + softly.assertThat(lines.anyMatch(s -> + s.contains(""))).isTrue(); + } } assertThat(Path.of(html.getPath(), "com.example", "Examples.java.html")).exists(); - deleteOnExit(tempDir.toFile()); } JacocoReportOperation newJacocoReportOperation() { - var o = new JacocoReportOperation(); - o.fromProject(new Project()); - o.csv(csv); - o.html(html); - o.xml(xml); - o.classFiles(new File("src/test/resources/Examples.class")); - o.sourceFiles(new File("examples/src/main/java")); - o.execFiles(new File("src/test/resources/jacoco.exec")); - return o; + var op = new JacocoReportOperation() + .fromProject(new Project()) + .csv(csv) + .html(html) + .xml(xml) + .classFiles(new File("src/test/resources/Examples.class")) + .sourceFiles(new File("examples/src/main/java")) + .execFiles(new File("src/test/resources/jacoco.exec")); + + deleteOnExit(tempDir.toFile()); + + return op; } -} \ No newline at end of file + + @Test + void testClassFiles() { + var foo = new File("foo"); + var bar = new File("bar"); + + var op = new JacocoReportOperation().classFiles("foo", "bar"); + assertThat(op.classFiles()).as("String...").contains(foo, bar); + op.classFiles().clear(); + + op = op.classFiles(foo, bar); + assertThat(op.classFiles()).as("File...").contains(foo, bar); + op.classFiles().clear(); + + op = op.classFiles(foo.toPath(), bar.toPath()); + assertThat(op.classFiles()).as("Path...").contains(foo, bar); + op.classFiles().clear(); + + op = op.classFilesStrings(List.of("foo", "bar")); + assertThat(op.classFiles()).as("List(String...)").contains(foo, bar); + op.classFiles().clear(); + + op = op.classFiles(List.of(foo, bar)); + assertThat(op.classFiles()).as("File...").contains(foo, bar); + op.classFiles().clear(); + + op = op.classFilesPaths(List.of(foo.toPath(), bar.toPath())); + assertThat(op.classFiles()).as("Path...").contains(foo, bar); + op.classFiles().clear(); + } + + @Test + void testExecFiles() { + var foo = new File("foo"); + var bar = new File("bar"); + + var op = new JacocoReportOperation().execFiles("foo", "bar"); + assertThat(op.execFiles()).as("String...").contains(foo, bar); + op.execFiles().clear(); + + op = op.execFiles(foo, bar); + assertThat(op.execFiles()).as("File...").contains(foo, bar); + op.execFiles().clear(); + + op = op.execFiles(foo.toPath(), bar.toPath()); + assertThat(op.execFiles()).as("Path...").contains(foo, bar); + op.execFiles().clear(); + + op = op.execFilesStrings(List.of("foo", "bar")); + assertThat(op.execFiles()).as("List(String...)").contains(foo, bar); + op.execFiles().clear(); + + op = op.execFiles(List.of(foo, bar)); + assertThat(op.execFiles()).as("File...").contains(foo, bar); + op.execFiles().clear(); + + op = op.execFilesPaths(List.of(foo.toPath(), bar.toPath())); + assertThat(op.execFiles()).as("Path...").contains(foo, bar); + op.execFiles().clear(); + } + + @Test + void testSourceFiles() { + var foo = new File("foo"); + var bar = new File("bar"); + + var op = new JacocoReportOperation().sourceFiles("foo", "bar"); + assertThat(op.sourceFiles()).as("String...").contains(foo, bar); + op.sourceFiles().clear(); + + op = op.sourceFiles(foo, bar); + assertThat(op.sourceFiles()).as("File...").contains(foo, bar); + op.sourceFiles().clear(); + + op = op.sourceFiles(foo.toPath(), bar.toPath()); + assertThat(op.sourceFiles()).as("Path...").contains(foo, bar); + op.sourceFiles().clear(); + + op = op.sourceFilesStrings(List.of("foo", "bar")); + assertThat(op.sourceFiles()).as("List(String...)").contains(foo, bar); + op.sourceFiles().clear(); + + op = op.sourceFiles(List.of(foo, bar)); + assertThat(op.sourceFiles()).as("File...").contains(foo, bar); + op.sourceFiles().clear(); + + op = op.sourceFilesPaths(List.of(foo.toPath(), bar.toPath())); + assertThat(op.sourceFiles()).as("Path...").contains(foo, bar); + op.sourceFiles().clear(); + } +} diff --git a/src/test/resources/jacoco-args.txt b/src/test/resources/jacoco-args.txt new file mode 100644 index 0000000..e883975 --- /dev/null +++ b/src/test/resources/jacoco-args.txt @@ -0,0 +1,10 @@ + +--classfiles +--csv +--encoding +--html +--name +--quiet +--sourcefiles +--tabwith +--xml diff --git a/src/test/resources/jacoco.exec b/src/test/resources/jacoco.exec index fc1f7a2..db0ce81 100644 Binary files a/src/test/resources/jacoco.exec and b/src/test/resources/jacoco.exec differ