#345: Replace ExitGuard in integration tests

.github/workflows/build.yml

@@ -18,6 +18,8 @@ jobs:
         include:
           - os: ubuntu-latest
             java: 21
+          - os: ubuntu-latest
+            java: 24
 
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}-os-${{ matrix.os }}-java-${{ matrix.java }}

core/src/main/java/org/itsallcode/openfasttrace/core/cli/CliException.java

@@ -30,4 +30,4 @@ public CliException(final String message)
     {
         super(message);
     }
-}
+}

core/src/main/java/org/itsallcode/openfasttrace/core/cli/CliStarter.java

@@ -38,7 +38,7 @@ public static void main(final String[] args)
 
     /**
      * Auxiliary entry point to the command line application that allows
-     * injection of a
+     * injection of a {@link DirectoryService}.
      * 
      * @param args
      *            command line arguments.
@@ -63,6 +63,7 @@ public static void main(final String[] args, final DirectoryService directorySer
         }
     }
 
+    @SuppressWarnings("java:S1166") // Exceptions are reported to the user
     private static CliArguments parseCommandLineArguments(final String[] args,
             final DirectoryService directoryService)
     {

doc/developer_guide.md

@@ -121,13 +121,20 @@ By default, OFT is built with Java 17.
 
 To build and test with a later version, add argument `-Djava.version=17` to the Maven command.
 
-
 #### Speedup Build
 
 By default, Maven builds the OFT modules sequentially.
 
 To speed up the build and build modules in parallel, add argument `-T 1C` to the Maven command.
 
+#### Run Single Integration Test
+
+Specify test class via system property `it.test` and module via command line option `-projects`:
+
+```sh
+mvn -Dit.test=CliStarterIT failsafe:integration-test -projects product
+```
+
 ### Run Requirements Tracing
 
 ```sh

parent/pom.xml

@@ -236,6 +236,18 @@
                 <version>1.4.8</version>
                 <scope>test</scope>
             </dependency>
+            <dependency>
+                <groupId>com.exasol</groupId>
+                <artifactId>maven-project-version-getter</artifactId>
+                <version>1.2.1</version>
+                <scope>test</scope>
+            </dependency>
+            <dependency>
+                <groupId>org.itsallcode</groupId>
+                <artifactId>simple-process</artifactId>
+                <version>0.2.0</version>
+                <scope>test</scope>
+            </dependency>
         </dependencies>
     </dependencyManagement>
     <profiles>

product/pom.xml

@@ -62,6 +62,16 @@
             <artifactId>openfasttrace-testutil</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.exasol</groupId>
+            <artifactId>maven-project-version-getter</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.itsallcode</groupId>
+            <artifactId>simple-process</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
     <build>
         <finalName>openfasttrace-${revision}</finalName>
@@ -117,7 +127,7 @@
                 <configuration>
                     <compilerArgs>
                         <arg>-Xlint:all</arg>
-                        <!-- Suppress warning "bad path element "/Users/chp/private/git/openfasttrace/product/target/classes": no such file or directory" -->
+                        <!-- Suppress warning "bad path element "openfasttrace/product/target/classes": no such file or directory" -->
                         <arg>-Xlint:-path</arg>
                         <arg>-Werror</arg>
                     </compilerArgs>

product/src/test/java/org/itsallcode/openfasttrace/cli/CliExitIT.java

@@ -0,0 +1,112 @@
+package org.itsallcode.openfasttrace.cli;
+
+import static java.util.Collections.emptyList;
+import static org.hamcrest.Matchers.*;
+
+import java.nio.file.Path;
+import java.util.*;
+
+import org.itsallcode.openfasttrace.core.cli.ExitStatus;
+import org.itsallcode.openfasttrace.core.cli.commands.TraceCommand;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.io.TempDir;
+
+class CliExitIT
+{
+    private static final String TEST_RESOURCES_MARKDOWN = "../core/src/test/resources/markdown";
+    private static final String SAMPLE_DESIGN = TEST_RESOURCES_MARKDOWN + "/sample_design.md";
+    private static final String SAMPLE_SYSTEM_REQUIREMENTS = TEST_RESOURCES_MARKDOWN
+            + "/sample_system_requirements.md";
+
+    @Test
+    void testRunWithoutArguments()
+    {
+        jarLauncher()
+                .args(emptyList())
+                .expectedExitCode(ExitStatus.CLI_ERROR.getCode())
+                .expectStdOut(emptyString())
+                .expectStdErr(equalTo("oft: Missing command\nAdd one of 'help','convert','trace'\n\n"))
+                .verify();
+    }
+
+    @Test
+    void testRunWithUnsupportedCommand()
+    {
+        jarLauncher()
+                .args(List.of("unsupported"))
+                .expectedExitCode(ExitStatus.CLI_ERROR.getCode())
+                .expectStdOut(emptyString())
+                .expectStdErr(equalTo(
+                        "oft: 'unsupported' is not an OFT command.\nChoose one of 'help','convert','trace'.\n\n"))
+                .verify();
+    }
+
+    @Test
+    void testRunWithHelpCommand()
+    {
+        jarLauncher()
+                .args(List.of("help"))
+                .expectedExitCode(ExitStatus.OK.getCode())
+                .expectStdOut(startsWith("""
+                        OpenFastTrace
+
+                        Usage:
+                          oft command"""))
+                .expectStdErr(emptyString())
+                .verify();
+    }
+
+    @Test
+    void testRunWithUnsupportedReporter(@TempDir final Path emptyDir)
+    {
+        jarLauncher()
+                .args(List.of("trace", "-o", "unknown", emptyDir.toString()))
+                .expectedExitCode(ExitStatus.FAILURE.getCode())
+                .expectStdOut(emptyString())
+                .expectStdErr(startsWith(
+                        "Exception in thread \"main\" org.itsallcode.openfasttrace.api.exporter.ExporterException: Found no matching reporter for output format 'unknown'"))
+                .verify();
+    }
+
+    @Test
+    void testCliExitCode_Ok()
+    {
+        assertExitStatusForTracedFiles(ExitStatus.OK, SAMPLE_SYSTEM_REQUIREMENTS, SAMPLE_DESIGN);
+    }
+
+    private void assertExitStatusForTracedFiles(final ExitStatus expectedStatus, final String... files)
+    {
+        final List<String> args = new ArrayList<>();
+        args.add(TraceCommand.COMMAND_NAME);
+        args.addAll(Arrays.asList(files));
+        jarLauncher()
+                .args(args)
+                .expectedExitCode(expectedStatus.getCode())
+                .expectStdErr(emptyString())
+                .expectStdOut(not(emptyString()))
+                .verify();
+    }
+
+    private JarLauncher.Builder jarLauncher()
+    {
+        return JarLauncher.builder()
+                .currentWorkingDir();
+    }
+
+    @Test
+    void testCliExitCode_Failure()
+    {
+        assertExitStatusForTracedFiles(ExitStatus.FAILURE, SAMPLE_SYSTEM_REQUIREMENTS);
+    }
+
+    @Test
+    void testCliExitCode_CliError()
+    {
+        jarLauncher()
+                .args(List.of("--zzzz"))
+                .expectedExitCode(ExitStatus.CLI_ERROR.getCode())
+                .expectStdOut(emptyString())
+                .expectStdErr(equalTo("oft: Unexpected parameter '--zzzz' is not allowed\n"))
+                .verify();
+    }
+}