diff --git a/.github/workflows/bld.yml b/.github/workflows/bld.yml index c0ba763..6dc0235 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,11 +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: Run tests with bld - run: ./bld compile test + - 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 bf43624..508f6a5 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/.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 282ec85..fa7d3b7 100644 --- 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-jacoco-report/maven-metadata.xml?color=blue)](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-jacoco-report) [![Snapshot](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/snapshots/com/uwyn/rife2/bld-jacoco-report/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-jacoco-report) [![GitHub CI](https://github.com/rife2/bld-jacoco-report/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-jacoco-report/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-jacoco=com.uwyn.rife2:bld-jacoco-report +``` + +For more information, please refer to the [extensions](https://github.com/rife2/bld/wiki/Extensions) documentation. + +## Generate Code Coverage Reports To run the tests and generate the code coverage reports, add the floowing to your build file: 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/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 0ba02e9..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 ef3bf27..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.downloadLocation= -bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.6 +bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.10 bld.repositories=MAVEN_LOCAL,MAVEN_CENTRAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES -bld.version=1.9.1 +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 0c4f60a..4dd3a0b 100644 --- a/examples/src/bld/java/com/example/ExamplesBuild.java +++ b/examples/src/bld/java/com/example/ExamplesBuild.java @@ -25,8 +25,8 @@ public class ExamplesBuild extends Project { repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL); 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.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) { diff --git a/lib/bld/bld-wrapper.jar b/lib/bld/bld-wrapper.jar index 0ba02e9..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 0fbcd36..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.downloadLocation= -bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.1.2 +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=1.9.1 +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 47eb461..54a64c4 100644 --- a/src/bld/java/rife/bld/extension/JacocoReportOperationBuild.java +++ b/src/bld/java/rife/bld/extension/JacocoReportOperationBuild.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. @@ -25,31 +25,32 @@ import rife.bld.publish.PublishScm; import java.util.List; -import static rife.bld.dependencies.Repository.MAVEN_CENTRAL; -import static rife.bld.dependencies.Repository.RIFE2_RELEASES; -import static rife.bld.dependencies.Scope.*; +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; public class JacocoReportOperationBuild extends Project { public JacocoReportOperationBuild() { pkg = "rife.bld.extension"; name = "JacocoReportOperation"; - version = version(0, 9, 6); + 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, 12); + var jacocoVersion = new VersionNumber(0, 8, 13); scope(compile) .include(dependency("org.jacoco", "jacoco", jacocoVersion).exclude("*", "org.jacoco.doc")) - .include(dependency("com.uwyn.rife2", "bld", version(1, 9, 1))); + .include(dependency("com.uwyn.rife2", "bld", version(2, 2, 1))); 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, 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() @@ -60,27 +61,25 @@ public class JacocoReportOperationBuild extends Project { 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/") + .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-pmd.git") - .developerConnection("scm:git:git@github.com:rife2/bld-pmd.git") - .url("https://github.com/rife2/bld-pmd") + .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") ) .signKey(property("sign.key")) .signPassphrase(property("sign.passphrase")); @@ -98,4 +97,16 @@ public class JacocoReportOperationBuild extends Project { .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 b055eab..3d8946e 100644 --- a/src/main/java/rife/bld/extension/JacocoReportOperation.java +++ b/src/main/java/rife/bld/extension/JacocoReportOperation.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. @@ -35,7 +35,6 @@ 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; @@ -111,10 +110,10 @@ public class JacocoReportOperation extends AbstractOperation 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 cvs the report location + * @param csv the report location * @return this operation instance */ - public JacocoReportOperation csv(File cvs) { - csv_ = cvs; + public JacocoReportOperation csv(File csv) { + csv_ = csv; return this; } /** * Sets the location of the CSV report. * - * @param cvs the report location + * @param csv the report location * @return this operation instance */ - public JacocoReportOperation csv(String cvs) { - return csv(new File(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. @@ -191,6 +233,16 @@ public class JacocoReportOperation extends AbstractOperation execFiles) { execFiles_.addAll(execFiles); @@ -244,6 +308,28 @@ public class JacocoReportOperation extends AbstractOperation 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. */ @@ -261,7 +347,7 @@ public class JacocoReportOperation extends AbstractOperation sourceFiles) { sourceFiles_.addAll(sourceFiles); @@ -444,6 +552,28 @@ public class JacocoReportOperation extends AbstractOperation 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_); @@ -502,4 +632,14 @@ 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()); @@ -66,9 +92,11 @@ class JacocoReportOperationTest { 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(); @@ -88,4 +116,94 @@ class JacocoReportOperationTest { return op; } + + @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