- PipelineTester now supports validation of metrics

Author: Alan Christie

src/groovy/PipelineTester.groovy

@@ -57,6 +57,7 @@ class Tester {
     String testSearchDir = '../../..'
     String sdExt = '.dsd.json'
     String optionPrefix = 'arg.'
+    String metricsFile = 'output_metrics.txt'
     String outputBasePath = System.getProperty('user.dir') + '/tmp/PipelineTester'
     String outputRegex = '-o (\\S+)'
     String infoPrompt = '->'
@@ -549,7 +550,7 @@ class Tester {
         def paramsBlock = section.value['params']
         def seeBlock = section.value['see']
         def createsBlock = section.value['creates']
-        def doesNotCreateBlock = section.value['does_not_create']
+        def metricsBlock = section.value['metrics']
 
         // Enforce conditions on block combinations...
         if (command != null && paramsBlock != null) {
@@ -696,6 +697,38 @@ class Tester {
 
             }
 
+            // Has the user specified any metrics?
+            // These are located in the `output_metrics.txt` file.
+            if (validated && metricsBlock != null) {
+                // A metrics file must exist.
+                Properties properties = new Properties()
+                String metricsPath = testOutputPath.toString() + File.separator + metricsFile
+                File propertiesFile = new File(metricsPath)
+                if (propertiesFile.exists()) {
+                    propertiesFile.withInputStream {
+                        properties.load(it)
+                    }
+                    metricsBlock.each { metric ->
+                        String fileProperty = properties."$metric.key"
+                        if (fileProperty == null) {
+                            // The Metric is not in the file!
+                            err("Metric for '$metric.key' is not in the metrics file")
+                            validated = false
+                        } else {
+                            def finder = (fileProperty =~ /${metric.value}/)
+                            if (finder.count == 0) {
+                                err("Expected value for metric '$metric.key' ($metric.value)" +
+                                        " does not match file value ($fileProperty)")
+                                validated = false
+                            }
+                        }
+                    }
+                } else {
+                    err("Expected metrics but there was no metrics file ($metricsFile)")
+                    validated = false
+                }
+            }
+
         } else {
             err("Pipeline exitValue=$exitValue. <stderr> follows...")
         }

src/groovy/pipeline.test.template

@@ -109,7 +109,16 @@
         // and 'output.png' but an 'output.txt' is also expected as that's
         // defined in the 'setup_collection' section (above).
 
-        creates: [ 'output.png' ]
+        creates: [ 'output.png' ],
+
+        // Metrics.
+        //
+        // If your pipeline creates standard metrics - a Java properties file
+        // with the name 'output_metrics.txt' you can use the metrics block
+        // here to check the generated values. You can specify a property
+        // (a key) and a regular expression string value.
+
+        metrics: [ __StatusMessage__: 'kel: 0.171, t1/2: 4.06, V: 7.07, CL: 20.1' ]
 
     ],