diff --git a/.github/workflows/bld.yml b/.github/workflows/bld.yml index 947f3c4..c0ba763 100644 --- a/.github/workflows/bld.yml +++ b/.github/workflows/bld.yml @@ -1,16 +1,14 @@ 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, 24 ] - kotlin-version: [ 1.9.25, 2.0.21, 2.1.20 ] - os: [ ubuntu-latest, windows-latest, macos-latest ] - - runs-on: ${{ matrix.os }} + java-version: [17, 21, 22] steps: - name: Checkout source repository @@ -24,8 +22,11 @@ jobs: distribution: "zulu" java-version: ${{ matrix.java-version }} - - name: Download dependencies + - name: Grant execute permission for bld + run: chmod +x bld + + - name: Download the dependencies run: ./bld download - - name: Run tests - run: ./bld compile test \ No newline at end of file + - name: Run tests with bld + run: ./bld compile test diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 88c2cd6..e191f6d 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@v3 + uses: actions/upload-pages-artifact@v1 with: # Upload generated Javadocs repository path: "build/javadoc/" - name: Deploy to GitHub Pages id: deployment - uses: actions/deploy-pages@v4 + uses: actions/deploy-pages@v1 diff --git a/.idea/bld.xml b/.idea/bld.xml deleted file mode 100644 index 6600cee..0000000 --- a/.idea/bld.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/.idea/copyright/Apache_License.xml b/.idea/copyright/Apache_License.xml index 4446c15..ade80da 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 deleted file mode 100644 index 81220b4..0000000 --- a/.idea/icon.svg +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - - - - - - diff --git a/.idea/libraries/bld.xml b/.idea/libraries/bld.xml index a203de8..59ffe59 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 99cc0c0..9bd86aa 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 d4069f2..2ae5c4b 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 57ed5ef..b80486a 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 ba429d0..9e8368e 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.2.1.jar", + "${HOME}/.bld/dist/bld-1.9.0.jar", "lib/**/*.jar" ] } diff --git a/README.md b/README.md index d049d9e..c707871 100755 --- a/README.md +++ b/README.md @@ -2,20 +2,12 @@ [](https://opensource.org/licenses/Apache-2.0) [](https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html) -[](https://rife2.com/bld) +[](https://rife2.com/bld) [](https://repo.rife2.com/#/releases/com/uwyn/rife2/bld-exec) [](https://repo.rife2.com/#/snapshots/com/uwyn/rife2/bld-exec) [](https://github.com/rife2/bld-exec/actions/workflows/bld.yml) -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 install, please refer to the [extensions documentation](https://github.com/rife2/bld/wiki/Extensions). To execute a command at the command line, add the following to your build file: @@ -29,15 +21,15 @@ public void startServer() throws Exception { } ``` -## Exit Value +## Exit Status -Use the `failOnExit` function to specify whether a command non-zero exit value (status) constitutes a failure. +Use the `failOnExit` function to specify whether a command non-zero exit status constitutes a failure. ```java @BuildCommand public void startServer() throws Exception { final List cmds; - if (System.getProperty("os.name").toLowerCase().contains("win")) { + if (System.getProperty("os.name").toLowerCase().contains("windows")) { cmds = List.of("cmd", "/c", "stop.bat"); } else { cmds = List.of("./stop.sh"); diff --git a/config/pmd.xml b/config/pmd.xml index 2641880..3d3203c 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 305a313..82762f1 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 7470756..89f7a72 100644 --- a/lib/bld/bld-wrapper.properties +++ b/lib/bld/bld-wrapper.properties @@ -1,7 +1,8 @@ bld.downloadExtensionJavadoc=false bld.downloadExtensionSources=true -bld.downloadLocation= -bld.extension-pmd=com.uwyn.rife2:bld-pmd:1.2.2 +bld.extension-pmd=com.uwyn.rife2:bld-pmd:0.9.8 +bld.extension-jacoco=com.uwyn.rife2:bld-jacoco-report:0.9.5 bld.repositories=MAVEN_CENTRAL,MAVEN_LOCAL,RIFE2_SNAPSHOTS,RIFE2_RELEASES +bld.downloadLocation= bld.sourceDirectories= -bld.version=2.2.1 +bld.version=1.9.0 diff --git a/src/bld/java/rife/bld/extension/ExecOperationBuild.java b/src/bld/java/rife/bld/extension/ExecOperationBuild.java index e759b38..37db549 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-2025 the original author or authors. + * Copyright 2023-2024 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. @@ -22,9 +22,11 @@ import rife.bld.publish.PublishDeveloper; import rife.bld.publish.PublishLicense; import rife.bld.publish.PublishScm; +import java.io.IOException; import java.util.List; -import static rife.bld.dependencies.Repository.*; +import static rife.bld.dependencies.Repository.MAVEN_CENTRAL; +import static rife.bld.dependencies.Repository.RIFE2_RELEASES; import static rife.bld.dependencies.Scope.compile; import static rife.bld.dependencies.Scope.test; import static rife.bld.operations.JavadocOptions.DocLinkOption.NO_MISSING; @@ -33,21 +35,20 @@ public class ExecOperationBuild extends Project { public ExecOperationBuild() { pkg = "rife.bld.extension"; name = "ExecOperation"; - version = version(1, 0, 5); + version = version(1, 0, 0); javaRelease = 17; downloadSources = true; autoDownloadPurge = true; - repositories = List.of(MAVEN_LOCAL, MAVEN_CENTRAL, RIFE2_RELEASES, RIFE2_SNAPSHOTS); - + repositories = List.of(MAVEN_CENTRAL, RIFE2_RELEASES); scope(compile) - .include(dependency("com.uwyn.rife2", "bld", version(2, 2, 1))); + .include(dependency("com.uwyn.rife2", "bld", version(1, 9, 0))); scope(test) - .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))); + .include(dependency("org.junit.jupiter", "junit-jupiter", version(5, 10, 2))) + .include(dependency("org.junit.platform", "junit-platform-console-standalone", version(1, 10, 2))) + .include(dependency("org.assertj", "assertj-core", version(3, 25, 3))); javadocOperation() .javadocOptions() @@ -58,26 +59,28 @@ 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")); @@ -87,8 +90,15 @@ public class ExecOperationBuild extends Project { new ExecOperationBuild().start(args); } + @BuildCommand(summary = "Generates JaCoCo Reports") + public void jacoco() throws IOException { + new JacocoReportOperation() + .fromProject(this) + .execute(); + } + @BuildCommand(summary = "Runs PMD analysis") - public void pmd() throws Exception { + public void pmd() { new PmdOperation() .fromProject(this) .failOnViolation(true) diff --git a/src/main/java/rife/bld/extension/ExecOperation.java b/src/main/java/rife/bld/extension/ExecOperation.java index d81f484..f07d740 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-2025 the original author or authors. + * Copyright 2023-2024 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. @@ -18,14 +18,12 @@ package rife.bld.extension; import rife.bld.BaseProject; import rife.bld.operations.AbstractOperation; -import rife.bld.operations.exceptions.ExitStatusException; import java.io.File; -import java.nio.file.Path; +import java.io.IOException; import java.util.ArrayList; import java.util.Collection; import java.util.List; -import java.util.Objects; import java.util.concurrent.TimeUnit; import java.util.logging.Level; import java.util.logging.Logger; @@ -38,11 +36,11 @@ import java.util.logging.Logger; */ public class ExecOperation extends AbstractOperation { private static final Logger LOGGER = Logger.getLogger(ExecOperation.class.getName()); - private final Collection args_ = new ArrayList<>(); + private final List args_ = new ArrayList<>(); private boolean failOnExit_ = true; private BaseProject project_; - private int timeout_ = 30; - private File workDir_; + private int timeout = 30; + private String workDir_; /** * Configures the command and arguments to be executed. @@ -58,19 +56,10 @@ public class ExecOperation extends AbstractOperation { * @see #command(Collection) */ public ExecOperation command(String... arg) { - return command(List.of(arg)); + args_.addAll(List.of(arg)); + return this; } - /** - * Returns the command and arguments to be executed. - * - * @return the command and arguments - */ - public Collection command() { - return args_; - } - - /** * Configures the command and arguments to be executed. * @@ -89,54 +78,42 @@ public class ExecOperation extends AbstractOperation { @Override public void execute() throws Exception { if (project_ == null) { - if (LOGGER.isLoggable(Level.SEVERE) && !silent()) { - LOGGER.severe("A project must be specified."); - } - throw new ExitStatusException(ExitStatusException.EXIT_FAILURE); + LOGGER.severe("A project must be specified."); + } + + final File workDir; + if (workDir_ == null || workDir_.isBlank()) { + workDir = new File(project_.workDirectory().getAbsolutePath()); } else { - final File workDir = Objects.requireNonNullElseGet(workDir_, - () -> new File(project_.workDirectory().getAbsolutePath())); + workDir = new File(workDir_); + } + + if (workDir.isDirectory()) { + var pb = new ProcessBuilder(); + pb.inheritIO(); + pb.command(args_); + pb.directory(workDir); if (LOGGER.isLoggable(Level.INFO)) { - LOGGER.info("Working directory: " + workDir.getAbsolutePath()); + LOGGER.info(String.join(" ", args_)); } - if (workDir.isDirectory()) { - var pb = new ProcessBuilder(); - pb.inheritIO(); - pb.command(args_.stream().toList()); - pb.directory(workDir); + var proc = pb.start(); + var err = proc.waitFor(timeout, TimeUnit.SECONDS); - if (LOGGER.isLoggable(Level.INFO) && !silent()) { - LOGGER.info(String.join(" ", args_)); - } - - var proc = pb.start(); - var err = proc.waitFor(timeout_, TimeUnit.SECONDS); - - if (!err) { - proc.destroy(); - if (LOGGER.isLoggable(Level.SEVERE) && !silent()) { - LOGGER.severe("The command timed out."); - } - throw new ExitStatusException(ExitStatusException.EXIT_FAILURE); - } else if (proc.exitValue() != 0 && failOnExit_) { - if (LOGGER.isLoggable(Level.SEVERE) && !silent()) { - LOGGER.severe("The command exit value/status is: " + proc.exitValue()); - } - ExitStatusException.throwOnFailure(proc.exitValue()); - } - } else { - if (LOGGER.isLoggable(Level.SEVERE) && !silent()) { - LOGGER.severe("Invalid working directory: " + workDir); - } - throw new ExitStatusException(ExitStatusException.EXIT_FAILURE); + if (!err) { + proc.destroy(); + throw new IOException("The command timed out."); + } else if (proc.exitValue() != 0 && failOnExit_) { + throw new IOException("The command exit status is: " + proc.exitValue()); } + } else { + throw new IOException("Invalid work directory: " + workDir); } } /** - * Configures whether the operation should fail if the command exit value/status is not 0. + * Configures whether the operation should fail if the command exit status is not 0. * * Default is {@code TRUE} * @@ -159,15 +136,6 @@ public class ExecOperation extends AbstractOperation { return this; } - /** - * Returns whether the operation should fail if the command exit value/status is not 0. - * - * @return {@code true} or {@code false} - */ - public boolean isFailOnExit() { - return failOnExit_; - } - /** * Configure the command timeout. * @@ -175,57 +143,18 @@ public class ExecOperation extends AbstractOperation { * @return this operation instance */ public ExecOperation timeout(int timeout) { - timeout_ = timeout; + this.timeout = timeout; return this; } /** - * Returns the command timeout. - * - * @return the timeout - */ - public int timeout() { - return timeout_; - } - - /** - * Configures the working directory. - * - * @param dir the directory - * @return this operation instance - */ - public ExecOperation workDir(File dir) { - workDir_ = dir; - 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. + * Configures the work directory. * * @param dir the directory path * @return this operation instance */ public ExecOperation workDir(String dir) { - return workDir(new File(dir)); - } - - /** - * Returns the working directory. - * - * @return the directory - */ - public File workDir() { - return workDir_; + workDir_ = dir; + return this; } } diff --git a/src/test/java/rife/bld/extension/ExecOperationTest.java b/src/test/java/rife/bld/extension/ExecOperationTest.java index be2bd89..e0b584c 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-2025 the original author or authors. + * Copyright 2023-2024 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,94 +17,21 @@ 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; -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() { - var op = new ExecOperation().fromProject(new WebProject()) - .command(FOO, "bar"); - assertThat(op.command()).containsExactly(FOO, "bar"); - } - - @Test - void testException() { - assertThatCode(() -> - new ExecOperation() - .fromProject(new BaseProject()) - .command(FOO) - .execute()).message().startsWith("Cannot run program \"" + FOO + '"'); - } - - @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(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(cat) - .failOnExit(false); - assertThat(op.isFailOnExit()).isFalse(); - assertThatCode(op::execute).doesNotThrowAnyException(); - - op.failOnExit(true); - assertThat(op.isFailOnExit()).isTrue(); - } - - @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(sleep); - assertThat(op.timeout()).isEqualTo(5); - assertThatCode(op::execute).isInstanceOf(ExitStatusException.class); - } - - @Test - @EnabledOnOs({OS.LINUX, OS.MAC}) - void testTouch() throws Exception { + void testCat() throws Exception { var tmpFile = new File("hello.tmp"); tmpFile.deleteOnExit(); new ExecOperation() @@ -117,38 +44,50 @@ 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) - .workDir(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(); + void testException() { + assertThatCode(() -> + new ExecOperation() + .fromProject(new BaseProject()) + .command(FOO) + .execute()).message().startsWith("Cannot run program \"" + FOO + '"'); } @Test - void testWorkDirInvalid() { + void testExitStatus() { + assertThatCode(() -> + new ExecOperation() + .fromProject(new BaseProject()) + .command(List.of("cat", FOO)) + .execute()).message().contains("exit status"); + } + + @Test + void testFailOnExit() { + assertThatCode(() -> + new ExecOperation() + .fromProject(new BaseProject()) + .command(List.of("cat", FOO)) + .failOnExit(false) + .execute()).doesNotThrowAnyException(); + } + + @Test + void testTimeout() { + assertThatCode(() -> + new ExecOperation() + .fromProject(new BaseProject()) + .timeout(5) + .command(List.of("sleep", "10")) + .execute()).message().contains("timed out"); + } + + @Test + void testWorkDir() { assertThatCode(() -> new ExecOperation() .fromProject(new BaseProject()) .command("echo") .workDir(FOO) - .execute()).isInstanceOf(ExitStatusException.class); + .execute()).message().startsWith("Invalid work directory: ").endsWith(FOO); } }
* Default is {@code TRUE} * @@ -159,15 +136,6 @@ public class ExecOperation extends AbstractOperation { return this; } - /** - * Returns whether the operation should fail if the command exit value/status is not 0. - * - * @return {@code true} or {@code false} - */ - public boolean isFailOnExit() { - return failOnExit_; - } - /** * Configure the command timeout. * @@ -175,57 +143,18 @@ public class ExecOperation extends AbstractOperation { * @return this operation instance */ public ExecOperation timeout(int timeout) { - timeout_ = timeout; + this.timeout = timeout; return this; } /** - * Returns the command timeout. - * - * @return the timeout - */ - public int timeout() { - return timeout_; - } - - /** - * Configures the working directory. - * - * @param dir the directory - * @return this operation instance - */ - public ExecOperation workDir(File dir) { - workDir_ = dir; - 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. + * Configures the work directory. * * @param dir the directory path * @return this operation instance */ public ExecOperation workDir(String dir) { - return workDir(new File(dir)); - } - - /** - * Returns the working directory. - * - * @return the directory - */ - public File workDir() { - return workDir_; + workDir_ = dir; + return this; } } diff --git a/src/test/java/rife/bld/extension/ExecOperationTest.java b/src/test/java/rife/bld/extension/ExecOperationTest.java index be2bd89..e0b584c 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-2025 the original author or authors. + * Copyright 2023-2024 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,94 +17,21 @@ 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; -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() { - var op = new ExecOperation().fromProject(new WebProject()) - .command(FOO, "bar"); - assertThat(op.command()).containsExactly(FOO, "bar"); - } - - @Test - void testException() { - assertThatCode(() -> - new ExecOperation() - .fromProject(new BaseProject()) - .command(FOO) - .execute()).message().startsWith("Cannot run program \"" + FOO + '"'); - } - - @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(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(cat) - .failOnExit(false); - assertThat(op.isFailOnExit()).isFalse(); - assertThatCode(op::execute).doesNotThrowAnyException(); - - op.failOnExit(true); - assertThat(op.isFailOnExit()).isTrue(); - } - - @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(sleep); - assertThat(op.timeout()).isEqualTo(5); - assertThatCode(op::execute).isInstanceOf(ExitStatusException.class); - } - - @Test - @EnabledOnOs({OS.LINUX, OS.MAC}) - void testTouch() throws Exception { + void testCat() throws Exception { var tmpFile = new File("hello.tmp"); tmpFile.deleteOnExit(); new ExecOperation() @@ -117,38 +44,50 @@ 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) - .workDir(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(); + void testException() { + assertThatCode(() -> + new ExecOperation() + .fromProject(new BaseProject()) + .command(FOO) + .execute()).message().startsWith("Cannot run program \"" + FOO + '"'); } @Test - void testWorkDirInvalid() { + void testExitStatus() { + assertThatCode(() -> + new ExecOperation() + .fromProject(new BaseProject()) + .command(List.of("cat", FOO)) + .execute()).message().contains("exit status"); + } + + @Test + void testFailOnExit() { + assertThatCode(() -> + new ExecOperation() + .fromProject(new BaseProject()) + .command(List.of("cat", FOO)) + .failOnExit(false) + .execute()).doesNotThrowAnyException(); + } + + @Test + void testTimeout() { + assertThatCode(() -> + new ExecOperation() + .fromProject(new BaseProject()) + .timeout(5) + .command(List.of("sleep", "10")) + .execute()).message().contains("timed out"); + } + + @Test + void testWorkDir() { assertThatCode(() -> new ExecOperation() .fromProject(new BaseProject()) .command("echo") .workDir(FOO) - .execute()).isInstanceOf(ExitStatusException.class); + .execute()).message().startsWith("Invalid work directory: ").endsWith(FOO); } }