- You can now write tests that cause the pipeline to exit

Author: Alan Christie

pipeline.test.template

@@ -118,6 +118,11 @@
         stderr: [ 'Computation = 4.5673' ],
         stdout: [ 'Result = SUCCESS' ],
 
+        // If your test causes the pipeline to exit with a non-zero exit code
+        // you need to declare this with an `exit_error` block.
+        // The block defines a string that is expected to be found on stderr.
+        exit_error: 'Command-line error',
+
         // Input files (optional)
         //
         // If your pipeline expects input files you can specify any file in

src/groovy/PipelineTester.groovy

@@ -33,7 +33,7 @@ import org.apache.commons.cli.Option
 
 // Version
 // Update with every change/release
-String version = '2.6.0'
+String version = '2.6.1'
 
 println "+------------------+"
 println "|  PipelineTester  | v$version"

src/groovy/Tester.groovy

@@ -794,6 +794,7 @@ class Tester {
         def paramsBlock = section.value['params']
         def stderrBlock = section.value['stderr']
         def stdoutBlock = section.value['stdout']
+        def exitErrorBlock = section.value['exit_error']
         def inputBlock = section.value['input']
         def createsBlock = section.value['creates']
         def metricsBlock = section.value['metrics']
@@ -923,6 +924,7 @@ class Tester {
         StringBuilder sout
         StringBuilder serr
         int exitValue
+        boolean expectedExit    // If we got a non-zero exit but it was expected
         boolean timeout
         if (imageName && inDocker) {
             Log.info('Docker', 'Yes')
@@ -1057,14 +1059,33 @@ class Tester {
             }
 
         } else {
+
+            expectedExit = false
             if (timeout) {
                 Log.err("Execution was terminated" +
-                    " (taking longer than ${testTimeoutSeconds}S)")
+                        " (taking longer than ${testTimeoutSeconds}S)")
+            } else {
+                // Otherwise, was an 'exit_error' defined for this test?
+                if (exitErrorBlock != null) {
+                    String stderrExpr = escapeString(exitErrorBlock)
+                    def finder = (serr =~ /$stderrExpr/)
+                    if (finder.count == 0) {
+                        Log.err("Test failed." +
+                                " This was expected but did not see '$exitErrorBlock'" +
+                                " in the command's stderr")
+                    } else {
+                        expectedExit = true
+                    }
+                }
+            }
+
+            if (!expectedExit) {
+                Log.err("Pipeline exitValue=$exitValue. <stderr> follows...")
             }
-            Log.err("Pipeline exitValue=$exitValue. <stderr> follows...")
         }
 
-        if (exitValue == 0 && validated) {
+        if (validated &&
+            (exitValue == 0 || (exitValue != 0 && expectedExit) )) {
             testsPassed += 1
             Log.info('Result', 'SUCCESS')
         } else {