- Supports 'creates' in the setup_collection section

- Refined template

Author: Alan Christie

src/groovy/PipelineTester.groovy

@@ -49,10 +49,8 @@ class Tester {
     // Controlled by command-line
     boolean verbose = false
 
-    // Controlled by setup sections
-    int testTimeoutSeconds = 30
-
     // Constants?
+    int defaultTimeoutSeconds = 30
     String testExt = '.test'
     String executeAnchorDir = '/src/'
     String testFileSpec = "**/*${testExt}"
@@ -68,6 +66,9 @@ class Tester {
     String testPrefix = 'test_'
     String ignorePrefix = 'ignore_'
 
+    // Controlled by setup sections
+    int testTimeoutSeconds = defaultTimeoutSeconds
+
     // Material accumulated as the tests execute
     int testScriptVersion = 0
     int sectionNumber = 0
@@ -84,6 +85,9 @@ class Tester {
     // i.e. 'arg.volumes' becomes 'volumes' (also contains expanded ranges)
     List<String> optionNames = []
     def optionDefaults = [:]
+    // Files created by the entire test collection.
+    // Defined in the 'setup_collection.creates' block.
+    def collectionCreates = []
 
     /**
      * The run method.
@@ -108,6 +112,7 @@ class Tester {
                 take(currentTestFilename.length() - testExt.length())
             sectionNumber = 0
             testScriptVersion = 0
+            testTimeoutSeconds = 30
 
             // We must not have duplicate test files -
             // this indicates there are pipelines in different projects
@@ -127,7 +132,7 @@ class Tester {
             extractOptionsFromCurrentServiceDescriptor()
 
             // Now run each test found in the test spec
-            // (also checking for a `setup_collection` and `version` sections).
+            // (also checking for `setup_collection` and `version` sections).
             def test_spec = new ConfigSlurper().parse(new File(path).toURI().toURL())
             for (def section : test_spec) {
 
@@ -462,10 +467,18 @@ class Tester {
         info('Processing setup_collection section')
 
         // Extract key setup values, supplying defaults
-        int timeoutSeconds = setupSection.value.get('timeout')
-        if (timeoutSeconds != null) {
-            info("Setup timeout=$timeoutSeconds")
-            testTimeoutSeconds = timeoutSeconds
+        if (setupSection.value.timeout != null) {
+            int timeoutSeconds = setupSection.value.get('timeout')
+            if (timeoutSeconds != null) {
+                info("Setup timeout=$timeoutSeconds")
+                testTimeoutSeconds = timeoutSeconds
+            }
+        }
+
+        // Globally-defined created files?
+        collectionCreates = []
+        if (setupSection.value.creates != null) {
+            collectionCreates = setupSection.value.get('creates')
         }
 
     }
@@ -519,6 +532,8 @@ class Tester {
      *
      * -    creates
      *      An optional list of file names (regular expressions).
+     *      Entries in this list are added to any defined in the creates
+     *      block in the setup_collection section.
      *
      * -    does_not_create
      *      An optional list of file names (regular expressions).
@@ -632,13 +647,17 @@ class Tester {
         boolean validated = true
         if (exitValue == 0) {
 
+            List<String> testCreates = collectionCreates
+            if (createsBlock != null) {
+                testCreates.addAll(createsBlock)
+            }
             // Do we expect output files?
             // Here we look for things like "output*" in the
             // redirected output path.
-            if (testOutputPath != null && createsBlock != null) {
+            if (testOutputPath != null && testCreates.size() > 0) {
                 def createdFiles = new FileNameFinder().
                         getFileNames(testOutputPath.toString(), "*")
-                for (String expectedFile in createsBlock) {
+                for (String expectedFile in testCreates.unique()) {
                     boolean found = false
                     for (String createdFile in createdFiles) {
                         if (createdFile.endsWith(expectedFile)) {

src/groovy/pipeline.test.template

@@ -26,11 +26,16 @@
     // timeout: The time allowed for each pipeline test to complete.
     //          Use this to override the default of 30 seconds.
     //
+    // creates: A list of file names that each test is expected to create.
+    //          Tests can define test-specific files with their own
+    //          'creates' block.
+    //
     // There can only be one setup_collection section and it must be
     // the first section.
 
     setup_collection = [
-        timeout: 10
+        timeout: 10,
+        creates: [ 'output.txt' ]
     ],
 
     // Individual tests.
@@ -67,7 +72,7 @@
 
         command: ```python my_own_command
                  --my-own-param-1 32
-                 --my-own-param-2 18.5```
+                 --my-own-param-2 18.5```,
 
         // Test parameters.
         //
@@ -92,17 +97,16 @@
 
         see: [ 'Computation = 4.5673' ],
 
-        // Files created and not created.
+        // Files created.
         //
-        // If your pipeline creates files you can and should declare
-        // their names in a `creates` block. The test utility will make
-        // sure they exist when your pipeline completes (successfully).
-        // Additionally, if you are not expecting certain files for the test
-        // you can also name them. Here we expect to see the file 'output.png'
-        // but not the file 'output.txt'
-
-        creates: [ 'output.png' ],
-        does_not_create: [ 'output.txt' ]
+        // If your pipeline test creates files you can and should declare
+        // their names in a `creates` block, either here or in the
+        // `setup_collection` section. All files defined in the creates blocks
+        // must exist for the test to pass. Here we expect 'output.png'
+        // but the test also expects 'output.txt' as that's defined in the
+        // 'setup_collection' block above.
+
+        creates: [ 'output.png' ]
 
     ],