* Default is {@code TRUE} * @@ -136,6 +159,15 @@ 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. * @@ -143,18 +175,57 @@ public class ExecOperation extends AbstractOperation { * @return this operation instance */ public ExecOperation timeout(int timeout) { - this.timeout = timeout; + timeout_ = timeout; return this; } /** - * Configures the work directory. + * 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. * * @param dir the directory path * @return this operation instance */ public ExecOperation workDir(String dir) { - workDir_ = dir; - return this; + return workDir(new File(dir)); + } + + /** + * Returns the working directory. + * + * @return the directory + */ + public File workDir() { + return workDir_; } } diff --git a/src/test/java/rife/bld/extension/ExecOperationTest.java b/src/test/java/rife/bld/extension/ExecOperationTest.java index e0b584c..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,30 +17,30 @@ 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 testCat() throws Exception { - var tmpFile = new File("hello.tmp"); - tmpFile.deleteOnExit(); - new ExecOperation() - .fromProject(new Project()) - .timeout(10) - .command("touch", tmpFile.getName()) - .execute(); - - assertThat(tmpFile).exists(); + void testCommand() { + var op = new ExecOperation().fromProject(new WebProject()) + .command(FOO, "bar"); + assertThat(op.command()).containsExactly(FOO, "bar"); } @Test @@ -53,41 +53,102 @@ class ExecOperationTest { } @Test - void testExitStatus() { + 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)) - .execute()).message().contains("exit status"); + .command(cat) + .execute()).isInstanceOf(ExitStatusException.class); } @Test void testFailOnExit() { - assertThatCode(() -> - new ExecOperation() - .fromProject(new BaseProject()) - .command(List.of("cat", FOO)) - .failOnExit(false) - .execute()).doesNotThrowAnyException(); + 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() { - assertThatCode(() -> - new ExecOperation() - .fromProject(new BaseProject()) - .timeout(5) - .command(List.of("sleep", "10")) - .execute()).message().contains("timed out"); + 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 { + var tmpFile = new File("hello.tmp"); + tmpFile.deleteOnExit(); + new ExecOperation() + .fromProject(new Project()) + .timeout(10) + .command("touch", tmpFile.getName()) + .execute(); + + assertThat(tmpFile).exists(); } @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(); + } + + @Test + void testWorkDirInvalid() { assertThatCode(() -> new ExecOperation() .fromProject(new BaseProject()) .command("echo") .workDir(FOO) - .execute()).message().startsWith("Invalid work directory: ").endsWith(FOO); + .execute()).isInstanceOf(ExitStatusException.class); } }