diff --git a/.github/workflows/bld.yml b/.github/workflows/bld.yml index 7a7639a..947f3c4 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 @@ -25,6 +27,5 @@ jobs: - 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/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 867d049..a203de8 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 6292470..d049d9e 100755 --- a/README.md +++ b/README.md @@ -2,12 +2,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-exec/maven-metadata.xml?color=blue)](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-exec) [![Snapshot](https://flat.badgen.net/maven/v/metadata-url/repo.rife2.com/snapshots/com/uwyn/rife2/bld-exec/maven-metadata.xml?label=snapshot)](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-exec) [![GitHub CI](https://github.com/rife2/bld-exec/actions/workflows/bld.yml/badge.svg)](https://github.com/rife2/bld-exec/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-exec=com.uwyn.rife2:bld-exec +``` + +For more information, please refer to the [extensions](https://github.com/rife2/bld/wiki/Extensions) documentation. + +## Execute a Command To execute a command at the command line, add the following to your build file: @@ -29,7 +37,7 @@ Use the `failOnExit` function to specify whether a command non-zero exit value ( @BuildCommand public void startServer() throws Exception { final List cmds; - if (System.getProperty("os.name").toLowerCase().contains("windows")) { + if (System.getProperty("os.name").toLowerCase().contains("win")) { cmds = List.of("cmd", "/c", "stop.bat"); } else { cmds = List.of("./stop.sh"); 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/lib/bld/bld-wrapper.jar b/lib/bld/bld-wrapper.jar index dad342d..305a313 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 5554ea1..7470756 100644 --- a/lib/bld/bld-wrapper.properties +++ b/lib/bld/bld-wrapper.properties @@ -1,7 +1,7 @@ bld.downloadExtensionJavadoc=false bld.downloadExtensionSources=true bld.downloadLocation= -bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.1.4 +bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.2.2 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/ExecOperationBuild.java b/src/bld/java/rife/bld/extension/ExecOperationBuild.java index 9514143..e759b38 100644 --- a/src/bld/java/rife/bld/extension/ExecOperationBuild.java +++ b/src/bld/java/rife/bld/extension/ExecOperationBuild.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. @@ -33,7 +33,7 @@ public class ExecOperationBuild extends Project { public ExecOperationBuild() { pkg = "rife.bld.extension"; name = "ExecOperation"; - version = version(1, 0, 2); + version = version(1, 0, 5); javaRelease = 17; @@ -41,12 +41,13 @@ public class ExecOperationBuild extends Project { 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("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, 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() @@ -57,28 +58,26 @@ public class ExecOperationBuild extends Project { publishOperation() .repository(version.isSnapshot() ? repository("rife2-snapshot") : repository("rife2")) + .repository(repository("github")) .info() .groupId("com.uwyn.rife2") .artifactId("bld-exec") .description("Command Line Execution Extension for bld") .url("https://github.com/rife2/bld-exec") - .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-exec.git") - .developerConnection("scm:git:git@github.com:rife2/bld-exec.git") - .url("https://github.com/rife2/bld-exec") + .scm(new PublishScm() + .connection("scm:git:https://github.com/rife2/bld-exec.git") + .developerConnection("scm:git:git@github.com:rife2/bld-exec.git") + .url("https://github.com/rife2/bld-exec") ) .signKey(property("sign.key")) .signPassphrase(property("sign.passphrase")); diff --git a/src/main/java/rife/bld/extension/ExecOperation.java b/src/main/java/rife/bld/extension/ExecOperation.java index 94f40ed..d81f484 100644 --- a/src/main/java/rife/bld/extension/ExecOperation.java +++ b/src/main/java/rife/bld/extension/ExecOperation.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. @@ -21,6 +21,7 @@ import rife.bld.operations.AbstractOperation; import rife.bld.operations.exceptions.ExitStatusException; import java.io.File; +import java.nio.file.Path; import java.util.ArrayList; import java.util.Collection; import java.util.List; @@ -57,8 +58,7 @@ public class ExecOperation extends AbstractOperation { * @see #command(Collection) */ public ExecOperation command(String... arg) { - args_.addAll(List.of(arg)); - return this; + return command(List.of(arg)); } /** @@ -199,6 +199,17 @@ public class ExecOperation extends AbstractOperation { return this; } + /** + * Configures the working directory. + * + * @param dir the directory + * @return this operation instance + */ + public ExecOperation workDir(Path dir) { + return workDir(dir.toFile()); + } + + /** * Configures the working directory. * diff --git a/src/test/java/rife/bld/extension/ExecOperationTest.java b/src/test/java/rife/bld/extension/ExecOperationTest.java index a73cd98..be2bd89 100644 --- a/src/test/java/rife/bld/extension/ExecOperationTest.java +++ b/src/test/java/rife/bld/extension/ExecOperationTest.java @@ -1,5 +1,5 @@ /* - * Copyright 2023-2024 the original author or authors. + * Copyright 2023-2025 the original author or authors. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -17,6 +17,8 @@ package rife.bld.extension; 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.Project; import rife.bld.WebProject; @@ -24,13 +26,15 @@ import rife.bld.operations.exceptions.ExitStatusException; import java.io.File; import java.util.List; +import java.util.Locale; import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.assertThatCode; - +@SuppressWarnings("PMD.AvoidDuplicateLiterals") class ExecOperationTest { private static final String FOO = "foo"; + private static final boolean IS_WINDOWS = System.getProperty("os.name").toLowerCase(Locale.US).contains("win"); @Test void testCommand() { @@ -50,18 +54,30 @@ class ExecOperationTest { @Test void testExitValue() { + List cat; + if (IS_WINDOWS) { + cat = List.of("cmd", "/c", "type", FOO); + } else { + cat = List.of("cat", FOO); + } assertThatCode(() -> new ExecOperation() .fromProject(new BaseProject()) - .command(List.of("cat", FOO)) + .command(cat) .execute()).isInstanceOf(ExitStatusException.class); } @Test void testFailOnExit() { + List cat; + if (IS_WINDOWS) { + cat = List.of("cmd", "/c", "type", FOO); + } else { + cat = List.of("cat", FOO); + } var op = new ExecOperation() .fromProject(new BaseProject()) - .command(List.of("cat", FOO)) + .command(cat) .failOnExit(false); assertThat(op.isFailOnExit()).isFalse(); assertThatCode(op::execute).doesNotThrowAnyException(); @@ -72,15 +88,22 @@ class ExecOperationTest { @Test void testTimeout() { + List sleep; + if (IS_WINDOWS) { + sleep = List.of("cmd", "/c", "timeout", "/t", "10"); + } else { + sleep = List.of("sleep", "10"); + } var op = new ExecOperation() .fromProject(new BaseProject()) .timeout(5) - .command(List.of("sleep", "10")); + .command(sleep); assertThat(op.timeout()).isEqualTo(5); assertThatCode(op::execute).isInstanceOf(ExitStatusException.class); } @Test + @EnabledOnOs({OS.LINUX, OS.MAC}) void testTouch() throws Exception { var tmpFile = new File("hello.tmp"); tmpFile.deleteOnExit(); @@ -95,12 +118,27 @@ class ExecOperationTest { @Test void testWorkDir() { + List echo; + if (IS_WINDOWS) { + echo = List.of("cmd", "/c", "echo", FOO); + } else { + echo = List.of("echo", FOO); + } var workDir = new File(System.getProperty("java.io.tmpdir")); var op = new ExecOperation() .fromProject(new BaseProject()) - .command("echo", FOO) + .command(echo) .workDir(workDir); - assertThat(op.workDir()).isEqualTo(workDir); + assertThat(op.workDir()).as("as file").isEqualTo(workDir); + assertThatCode(op::execute).doesNotThrowAnyException(); + + var build = "build"; + op = op.workDir(build); + assertThat(op.workDir()).as("as string").isEqualTo(new File(build)); + assertThatCode(op::execute).doesNotThrowAnyException(); + + op = op.workDir(workDir.toPath()); + assertThat(op.workDir()).as("as path").isEqualTo(workDir); assertThatCode(op::execute).doesNotThrowAnyException(); }