From 08574ffb14dd959493d1ff241b3e84a232311d7e Mon Sep 17 00:00:00 2001
From: maxe <Max.Ehrlich@tracetronic.de>
Date: Tue, 20 Feb 2024 11:23:14 +0100
Subject: [PATCH 1/4] add custom constants and attributes (#32)

---
 vars/pipeline2ATX.groovy | 36 +++++++++++++-----------------------
 vars/pipeline2ATX.txt    |  4 ++++
 2 files changed, 17 insertions(+), 23 deletions(-)

diff --git a/vars/pipeline2ATX.groovy b/vars/pipeline2ATX.groovy
index 9971ab8..6ac737b 100644
--- a/vars/pipeline2ATX.groovy
+++ b/vars/pipeline2ATX.groovy
@@ -52,7 +52,7 @@ import org.jenkinsci.plugins.workflow.support.visualization.table.FlowGraphTable
  * @param buildNumber
  *      the number of the pipeline build (optional)
  */
-def call(log = false, jobName = '', int buildNumber = 0) {
+def call(log = false, jobName = '', int buildNumber = 0, def customAttributes = [:], def customConstants = [:]) {
     def build
     def logFile = ''
 
@@ -62,8 +62,8 @@ def call(log = false, jobName = '', int buildNumber = 0) {
     }
 
     def filename = "${build.getParent().getDisplayName()}_${build.getNumber()}"
-    def attributes = getBuildAttributes(build)
-    def constants = getBuildConstants(build)
+    def attributes = getBuildAttributes(build, customAttributes)
+    def constants = getBuildConstants(build, customConstants)
     def executionSteps = getExecutionSteps(build, log)
 
     if (log) {
@@ -107,24 +107,19 @@ def getRawBuild(String jobName, int buildNumber) {
  * - JENKINS_WORKSPACE (path to the Jenkins pipeline workspace)
  * - TEST_LEVEL (content of env var TEST_LEVEL, only added if present)
  * 
+ *  customAttributes overrides build attributes (when adding maps the second map will override values present in both)
  * @param build
  *      the pipeline raw build
  * @return the collected build information and parameters in ATX attribute format 
  */
-def getBuildAttributes(build) {
-    def attributes = []
-    def buildAttributes = [PRODUCT_NAME: env.PRODUCT_NAME,
+def getBuildAttributes(build, customAttributes) {
+    def attributes = [PRODUCT_NAME: env.PRODUCT_NAME,
                            GIT_URL: env.GIT_URL, 
                            JENKINS_PIPELINE: build.getDisplayName(), 
                            JENKINS_URL: build.getAbsoluteUrl(),
                            JENKINS_WORKSPACE: env.WORKSPACE,
-                           TEST_LEVEL: env.TEST_LEVEL]
-    buildAttributes.each { k, v ->
-        if (v) {
-            attributes.add([key: k, value: v.toString()])
-        }
-    }
-    return attributes
+                           TEST_LEVEL: env.TEST_LEVEL] + customAttributes
+    return attributes.findAll{k,v -> v}.collect{ k, v -> [key: k, value: v.toString()]}
 }
 
 /**
@@ -135,23 +130,18 @@ def getBuildAttributes(build) {
  * - JENKINS_EXECUTOR_NUMBER (number of currecnt Jenkins executor)
  * - JENKINS_NODE_NAME (name of current node the current build is running on)
  *
+ * customConstants overrides build constants (when adding maps the second map will override values present in both)
  * @param build
  *      the pipeline raw build
  * @return the collected build information and parameters in ATX constants format 
  */
-def getBuildConstants(build) {
-    def constants = []
-    def buildConstants = [PRODUCT_VERSION: env.PRODUCT_VERSION,
+def getBuildConstants(build, customConstants) {
+    def constants = [PRODUCT_VERSION: env.PRODUCT_VERSION,
                           GIT_COMMIT: env.GIT_COMMIT,
                           JENKINS_BUILD_ID: build.id,
                           JENKINS_EXECUTOR_NUMBER: env.EXECUTOR_NUMBER,
-                          JENKINS_NODE_NAME: env.NODE_NAME]
-    buildConstants.each { k, v ->
-        if (v) {
-            constants.add([key: k, value: v.toString()])
-        }
-    }
-    return constants
+                          JENKINS_NODE_NAME: env.NODE_NAME] + customConstants
+    return constants.findAll{k,v -> v}.collect{ k, v -> [key: k, value: v.toString()]}
 }
 
 /**
diff --git a/vars/pipeline2ATX.txt b/vars/pipeline2ATX.txt
index 84a3b7c..9932b84 100644
--- a/vars/pipeline2ATX.txt
+++ b/vars/pipeline2ATX.txt
@@ -33,6 +33,10 @@ The report is compressed as a zip file within the build workspace and can be upl
             <dd>the name of the pipeline job (optional)</dd>
             <dt>buildNumber</dt>
             <dd>the number of the pipeline build (optional)</dd>
+            <dt> customAttributes</dt>
+            <dd> customAttribues to add to testcase (will override buildAttributes)</dd>
+            <dt> customConstants</dt>
+            <dd> customConstants to add to testcase (will override buildConstants)</dd>
         </dl>
     </dd>
 </dl>

From 98d015837e098435daafcac2cfa1915ed984650c Mon Sep 17 00:00:00 2001
From: maxe <Max.Ehrlich@tracetronic.de>
Date: Tue, 20 Feb 2024 11:34:13 +0100
Subject: [PATCH 2/4] adjust tests (#32)

---
 test/vars/Pipeline2ATXTest.groovy | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/test/vars/Pipeline2ATXTest.groovy b/test/vars/Pipeline2ATXTest.groovy
index 97d45c1..fac9e2e 100644
--- a/test/vars/Pipeline2ATXTest.groovy
+++ b/test/vars/Pipeline2ATXTest.groovy
@@ -42,7 +42,7 @@ class Pipeline2ATXTest extends PipelineSpockTestBase {
             addEnvVar('TEST_LEVEL', 'Unit Test')
 
         when: 'collect the build attributes'       
-            List attributes = pipeline2ATX.getBuildAttributes(build)
+            List attributes = pipeline2ATX.getBuildAttributes(build,['GIT_URL':'https://mycustomgit/blub'])
                        
 
         then: 'expect a attributes list with build information'
@@ -50,7 +50,7 @@ class Pipeline2ATXTest extends PipelineSpockTestBase {
 
         where:
             result = [['key':'PRODUCT_NAME', 'value':'testProd'],
-                      ['key':'GIT_URL', 'value':'https://mygit/blub'],
+                      ['key':'GIT_URL', 'value':'https://mycustomgit/blub'],
                       ['key':'JENKINS_PIPELINE', 'value':'TestBuild'],
                       ['key':'JENKINS_URL', 'value':'https://testurl'],
                       ['key':'JENKINS_WORKSPACE', 'value':'C:/ws/TestBuild/build42'],
@@ -63,7 +63,7 @@ class Pipeline2ATXTest extends PipelineSpockTestBase {
             build.getDisplayName() >> 'TestBuild'
             build.getAbsoluteUrl() >> 'https://testurl'
         when: 'collect the build attributes'
-            List attributes = pipeline2ATX.getBuildAttributes(build)
+            List attributes = pipeline2ATX.getBuildAttributes(build,[:])
 
         then: 'expect a attributes list with build information'
             result == attributes
@@ -85,14 +85,14 @@ class Pipeline2ATXTest extends PipelineSpockTestBase {
 
 
         when: 'collect the build constants'
-            List constants = pipeline2ATX.getBuildConstants(build)
+            List constants = pipeline2ATX.getBuildConstants(build,['GIT_COMMIT':'customGitCommit'])
 
         then: 'expect a attributes list with build information'
             result == constants
 
         where:
             result = [['key':'PRODUCT_VERSION', 'value':'1.2.3'],
-                      ['key':'GIT_COMMIT', 'value':'gitCommit'],
+                      ['key':'GIT_COMMIT', 'value':'customGitCommit'],
                       ['key':'JENKINS_BUILD_ID', 'value':'42'],
                       ['key':'JENKINS_EXECUTOR_NUMBER', 'value':'0815'],
                       ['key':'JENKINS_NODE_NAME', 'value':'Runner0815']]
@@ -104,7 +104,7 @@ class Pipeline2ATXTest extends PipelineSpockTestBase {
             build.id >> 42
 
         when: 'collect the build constants'
-            List constants = pipeline2ATX.getBuildConstants(build)
+            List constants = pipeline2ATX.getBuildConstants(build,[:])
 
         then: 'expect a attributes list with build information'
             result == constants

From 401a139ed5ae657b0fbf40548a04f322d85bc675 Mon Sep 17 00:00:00 2001
From: MxEh-TT <MxEh-TT@users.noreply.github.com>
Date: Tue, 20 Feb 2024 10:35:21 +0000
Subject: [PATCH 3/4] Sync documentation

Signed-off-by: MxEh-TT <MxEh-TT@users.noreply.github.com>
---
 docs/index-all.html         |  6 +++---
 docs/vars/cmd.html          |  4 ++--
 docs/vars/log.html          |  4 ++--
 docs/vars/maven.html        |  4 ++--
 docs/vars/pipeline2ATX.html | 30 +++++++++++++++++-------------
 docs/vars/task.html         |  4 ++--
 6 files changed, 28 insertions(+), 24 deletions(-)

diff --git a/docs/index-all.html b/docs/index-all.html
index 6f526f4..f434f61 100644
--- a/docs/index-all.html
+++ b/docs/index-all.html
@@ -141,7 +141,7 @@ <h2 class="title">C</h2>
 
 <dt><span class="strong"><a href="vars/cmd.html#call(java.lang.String)" title="Method in cmd">call(String)</a></span> - Method in <a href="vars/cmd.html">cmd</a>
 </dt><dd> <div class="block">Executes a passed command on Linux Shell or Windows Batch depending on the node.</div></dd>
-<dt><span class="strong"><a href="vars/pipeline2ATX.html#call(def, def, int)" title="Method in pipeline2ATX">call(def, def, int)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
+<dt><span class="strong"><a href="vars/pipeline2ATX.html#call(def, def, int, def, def)" title="Method in pipeline2ATX">call(def, def, int, def, def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
 </dt><dd> <div class="block">Generates a test.guide compatible JSON report of a pipeline build including logs and stage meta data.
  </div></dd>
 <dt><span class="strong"><a href="vars/task.html#call(java.lang.String, List, java.lang.String, boolean, boolean)" title="Method in task">call(String, List, String, boolean, boolean)</a></span> - Method in <a href="vars/task.html">task</a>
@@ -195,7 +195,7 @@ <h2 class="title">G</h2>
 
 <dt><span class="strong"><a href="vars/pipeline2ATX.html#generateJsonReport(def, def, def, def, def)" title="Method in pipeline2ATX">generateJsonReport(def, def, def, def, def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
 </dt><dd> <div class="block">Generates a test.guide compatible JSON report of the pipeline build.</div></dd>
-<dt><span class="strong"><a href="vars/pipeline2ATX.html#getBuildAttributes(def)" title="Method in pipeline2ATX">getBuildAttributes(def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
+<dt><span class="strong"><a href="vars/pipeline2ATX.html#getBuildAttributes(def, def)" title="Method in pipeline2ATX">getBuildAttributes(def, def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
 </dt><dd> <div class="block">Collects all relevant build information and parameter as a key-value-map:
  - PRODUCT_NAME (content of the env var PRODUCT_NAME, only added if present)
  - GIT_URL (content of env var GIT_URL, only added if present)
@@ -203,7 +203,7 @@ <h2 class="title">G</h2>
  - JENKINS_URL (url to the current Jenkins build job)
  - JENKINS_WORKSPACE (path to the Jenkins pipeline workspace)
  - TEST_LEVEL (content of env var TEST_LEVEL, only added if present)</div></dd>
-<dt><span class="strong"><a href="vars/pipeline2ATX.html#getBuildConstants(def)" title="Method in pipeline2ATX">getBuildConstants(def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
+<dt><span class="strong"><a href="vars/pipeline2ATX.html#getBuildConstants(def, def)" title="Method in pipeline2ATX">getBuildConstants(def, def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
 </dt><dd> <div class="block">Collects all relevant build information and parameter as a key-value-map:
  - PRODUCT_VERSION (content of env var PRODUCT_VERSION, only added if present)
  - GIT_COMMIT (content of env var GIT_COMMIT, only added if present)
diff --git a/docs/vars/cmd.html b/docs/vars/cmd.html
index b3eaa25..99e42fc 100644
--- a/docs/vars/cmd.html
+++ b/docs/vars/cmd.html
@@ -163,11 +163,11 @@ <h3>Inherited Methods Summary</h3>
                         
                         <tr class="altColor">
                             <td class="colFirst"><code>class groovy.lang.Script</code></td>
-                            <td class="colLast"><code>groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#println(), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()</code></td>
+                            <td class="colLast"><code>groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#println(), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()</code></td>
                         </tr>
                         <tr class="altColor">
                             <td class="colFirst"><code>class groovy.lang.GroovyObjectSupport</code></td>
-                            <td class="colLast"><code>groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()</code></td>
+                            <td class="colLast"><code>groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()</code></td>
                         </tr>
                     </table>
                    </ul>
diff --git a/docs/vars/log.html b/docs/vars/log.html
index a83fb54..864246f 100644
--- a/docs/vars/log.html
+++ b/docs/vars/log.html
@@ -205,11 +205,11 @@ <h3>Inherited Methods Summary</h3>
                         
                         <tr class="altColor">
                             <td class="colFirst"><code>class groovy.lang.Script</code></td>
-                            <td class="colLast"><code>groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#println(), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()</code></td>
+                            <td class="colLast"><code>groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#println(), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()</code></td>
                         </tr>
                         <tr class="altColor">
                             <td class="colFirst"><code>class groovy.lang.GroovyObjectSupport</code></td>
-                            <td class="colLast"><code>groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()</code></td>
+                            <td class="colLast"><code>groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()</code></td>
                         </tr>
                     </table>
                    </ul>
diff --git a/docs/vars/maven.html b/docs/vars/maven.html
index 899f617..a042e32 100644
--- a/docs/vars/maven.html
+++ b/docs/vars/maven.html
@@ -205,11 +205,11 @@ <h3>Inherited Methods Summary</h3>
                         
                         <tr class="altColor">
                             <td class="colFirst"><code>class groovy.lang.Script</code></td>
-                            <td class="colLast"><code>groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#println(), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()</code></td>
+                            <td class="colLast"><code>groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#println(), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()</code></td>
                         </tr>
                         <tr class="altColor">
                             <td class="colFirst"><code>class groovy.lang.GroovyObjectSupport</code></td>
-                            <td class="colLast"><code>groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()</code></td>
+                            <td class="colLast"><code>groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()</code></td>
                         </tr>
                     </table>
                    </ul>
diff --git a/docs/vars/pipeline2ATX.html b/docs/vars/pipeline2ATX.html
index ae20bef..c53a02e 100644
--- a/docs/vars/pipeline2ATX.html
+++ b/docs/vars/pipeline2ATX.html
@@ -138,7 +138,7 @@ <h3>Methods Summary</h3>
                         <tr class="altColor">
                             <td class="colFirst"><code></code></td>
                             <td class="colLast"><code>java.lang.Object</code></td>
-                            <td class="colLast"><code><strong><a href="#call(def, def, int)">call</a></strong>(java.lang.Object log = false, java.lang.Object jobName = '', int buildNumber = 0)</code><br>Generates a test.guide compatible JSON report of a pipeline build including logs and stage meta data.
+                            <td class="colLast"><code><strong><a href="#call(def, def, int, def, def)">call</a></strong>(java.lang.Object log = false, java.lang.Object jobName = '', int buildNumber = 0, java.lang.Object customAttributes = [:], java.lang.Object customConstants = [:])</code><br>Generates a test.guide compatible JSON report of a pipeline build including logs and stage meta data.
  </td>
                         </tr>
                         
@@ -170,7 +170,7 @@ <h3>Methods Summary</h3>
                         <tr class="rowColor">
                             <td class="colFirst"><code></code></td>
                             <td class="colLast"><code>java.lang.Object</code></td>
-                            <td class="colLast"><code><strong><a href="#getBuildAttributes(def)">getBuildAttributes</a></strong>(java.lang.Object build)</code><br>Collects all relevant build information and parameter as a key-value-map:
+                            <td class="colLast"><code><strong><a href="#getBuildAttributes(def, def)">getBuildAttributes</a></strong>(java.lang.Object build, java.lang.Object customAttributes)</code><br>Collects all relevant build information and parameter as a key-value-map:
  - PRODUCT_NAME (content of the env var PRODUCT_NAME, only added if present)
  - GIT_URL (content of env var GIT_URL, only added if present)
  - JENKINS_PIPELINE (name of the current Jenkins build job)
@@ -182,7 +182,7 @@ <h3>Methods Summary</h3>
                         <tr class="altColor">
                             <td class="colFirst"><code></code></td>
                             <td class="colLast"><code>java.lang.Object</code></td>
-                            <td class="colLast"><code><strong><a href="#getBuildConstants(def)">getBuildConstants</a></strong>(java.lang.Object build)</code><br>Collects all relevant build information and parameter as a key-value-map:
+                            <td class="colLast"><code><strong><a href="#getBuildConstants(def, def)">getBuildConstants</a></strong>(java.lang.Object build, java.lang.Object customConstants)</code><br>Collects all relevant build information and parameter as a key-value-map:
  - PRODUCT_VERSION (content of env var PRODUCT_VERSION, only added if present)
  - GIT_COMMIT (content of env var GIT_COMMIT, only added if present)
  - JENKINS_BUILD_ID (number of current Jenkins build)
@@ -261,11 +261,11 @@ <h3>Inherited Methods Summary</h3>
                         
                         <tr class="altColor">
                             <td class="colFirst"><code>class groovy.lang.Script</code></td>
-                            <td class="colLast"><code>groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#println(), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()</code></td>
+                            <td class="colLast"><code>groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#println(), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()</code></td>
                         </tr>
                         <tr class="altColor">
                             <td class="colFirst"><code>class groovy.lang.GroovyObjectSupport</code></td>
-                            <td class="colLast"><code>groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()</code></td>
+                            <td class="colLast"><code>groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()</code></td>
                         </tr>
                     </table>
                    </ul>
@@ -299,10 +299,10 @@ <h3>Inherited Methods Summary</h3>
                 </a>
                     <h3>Method Detail</h3>
                     
-                        <a name="call(def, def, int)"><!-- --></a>
+                        <a name="call(def, def, int, def, def)"><!-- --></a>
                         <ul class="blockListLast">
                             <li class="blockList">
-                                <h4>java.lang.Object <strong>call</strong>(java.lang.Object log = false, java.lang.Object jobName = '', int buildNumber = 0)</h4>
+                                <h4>java.lang.Object <strong>call</strong>(java.lang.Object log = false, java.lang.Object jobName = '', int buildNumber = 0, java.lang.Object customAttributes = [:], java.lang.Object customConstants = [:])</h4>
                                 <p> Generates a test.guide compatible JSON report of a pipeline build including logs and stage meta data.
  The report is compressed as a zip file within the build workspace and can be uploaded using the JSON2ATX converter.
 
@@ -390,32 +390,36 @@ <h4>java.lang.Object <strong>generateJsonReport</strong>(java.lang.Object build,
                             </li>
                         </ul>
                     
-                        <a name="getBuildAttributes(def)"><!-- --></a>
+                        <a name="getBuildAttributes(def, def)"><!-- --></a>
                         <ul class="blockListLast">
                             <li class="blockList">
-                                <h4>java.lang.Object <strong>getBuildAttributes</strong>(java.lang.Object build)</h4>
+                                <h4>java.lang.Object <strong>getBuildAttributes</strong>(java.lang.Object build, java.lang.Object customAttributes)</h4>
                                 <p> Collects all relevant build information and parameter as a key-value-map:
  - PRODUCT_NAME (content of the env var PRODUCT_NAME, only added if present)
  - GIT_URL (content of env var GIT_URL, only added if present)
  - JENKINS_PIPELINE (name of the current Jenkins build job)
  - JENKINS_URL (url to the current Jenkins build job)
  - JENKINS_WORKSPACE (path to the Jenkins pipeline workspace)
- - TEST_LEVEL (content of env var TEST_LEVEL, only added if present) 
+ - TEST_LEVEL (content of env var TEST_LEVEL, only added if present)
+ 
+  customAttributes overrides build attributes (when adding maps the second map will override values present in both) 
  <DL><DT><B>Parameters:</B></DT><DD><code>build
 </code> -       the pipeline raw build</DD></DL><DL><DT><B>Returns:</B></DT><DD>the collected build information and parameters in ATX attribute format</DD></DL></p>
                             </li>
                         </ul>
                     
-                        <a name="getBuildConstants(def)"><!-- --></a>
+                        <a name="getBuildConstants(def, def)"><!-- --></a>
                         <ul class="blockListLast">
                             <li class="blockList">
-                                <h4>java.lang.Object <strong>getBuildConstants</strong>(java.lang.Object build)</h4>
+                                <h4>java.lang.Object <strong>getBuildConstants</strong>(java.lang.Object build, java.lang.Object customConstants)</h4>
                                 <p> Collects all relevant build information and parameter as a key-value-map:
  - PRODUCT_VERSION (content of env var PRODUCT_VERSION, only added if present)
  - GIT_COMMIT (content of env var GIT_COMMIT, only added if present)
  - JENKINS_BUILD_ID (number of current Jenkins build)
  - JENKINS_EXECUTOR_NUMBER (number of currecnt Jenkins executor)
- - JENKINS_NODE_NAME (name of current node the current build is running on) 
+ - JENKINS_NODE_NAME (name of current node the current build is running on)
+
+ customConstants overrides build constants (when adding maps the second map will override values present in both) 
  <DL><DT><B>Parameters:</B></DT><DD><code>build
 </code> -       the pipeline raw build</DD></DL><DL><DT><B>Returns:</B></DT><DD>the collected build information and parameters in ATX constants format</DD></DL></p>
                             </li>
diff --git a/docs/vars/task.html b/docs/vars/task.html
index 3ec54d7..6efbfde 100644
--- a/docs/vars/task.html
+++ b/docs/vars/task.html
@@ -193,11 +193,11 @@ <h3>Inherited Methods Summary</h3>
                         
                         <tr class="altColor">
                             <td class="colFirst"><code>class groovy.lang.Script</code></td>
-                            <td class="colLast"><code>groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#println(), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()</code></td>
+                            <td class="colLast"><code>groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#println(), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#run(), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()</code></td>
                         </tr>
                         <tr class="altColor">
                             <td class="colFirst"><code>class groovy.lang.GroovyObjectSupport</code></td>
-                            <td class="colLast"><code>groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()</code></td>
+                            <td class="colLast"><code>groovy.lang.GroovyObjectSupport#getProperty(java.lang.String), groovy.lang.GroovyObjectSupport#setProperty(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.GroovyObjectSupport#getMetaClass(), groovy.lang.GroovyObjectSupport#setMetaClass(groovy.lang.MetaClass), groovy.lang.GroovyObjectSupport#wait(long), groovy.lang.GroovyObjectSupport#wait(long, int), groovy.lang.GroovyObjectSupport#wait(), groovy.lang.GroovyObjectSupport#equals(java.lang.Object), groovy.lang.GroovyObjectSupport#toString(), groovy.lang.GroovyObjectSupport#hashCode(), groovy.lang.GroovyObjectSupport#getClass(), groovy.lang.GroovyObjectSupport#notify(), groovy.lang.GroovyObjectSupport#notifyAll()</code></td>
                         </tr>
                     </table>
                    </ul>

From 12ed5fa7e3fe472d02859447c6fef48a6a5f77e3 Mon Sep 17 00:00:00 2001
From: maxe <Max.Ehrlich@tracetronic.de>
Date: Thu, 22 Feb 2024 10:31:49 +0100
Subject: [PATCH 4/4] add non env custom var (#32)

---
 test/vars/Pipeline2ATXTest.groovy | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/test/vars/Pipeline2ATXTest.groovy b/test/vars/Pipeline2ATXTest.groovy
index fac9e2e..07c50dd 100644
--- a/test/vars/Pipeline2ATXTest.groovy
+++ b/test/vars/Pipeline2ATXTest.groovy
@@ -42,7 +42,7 @@ class Pipeline2ATXTest extends PipelineSpockTestBase {
             addEnvVar('TEST_LEVEL', 'Unit Test')
 
         when: 'collect the build attributes'       
-            List attributes = pipeline2ATX.getBuildAttributes(build,['GIT_URL':'https://mycustomgit/blub'])
+            List attributes = pipeline2ATX.getBuildAttributes(build,['GIT_URL':'https://mycustomgit/blub','TOOL_NAME':'test.tool'])
                        
 
         then: 'expect a attributes list with build information'
@@ -54,7 +54,8 @@ class Pipeline2ATXTest extends PipelineSpockTestBase {
                       ['key':'JENKINS_PIPELINE', 'value':'TestBuild'],
                       ['key':'JENKINS_URL', 'value':'https://testurl'],
                       ['key':'JENKINS_WORKSPACE', 'value':'C:/ws/TestBuild/build42'],
-                      ['key':'TEST_LEVEL', 'value':'Unit Test']]
+                      ['key':'TEST_LEVEL', 'value':'Unit Test'],
+                      ['key':'TOOL_NAME', 'value':'test.tool']]
     }
 
     def 'Collect build attributes - missing env vars'() {
@@ -85,7 +86,7 @@ class Pipeline2ATXTest extends PipelineSpockTestBase {
 
 
         when: 'collect the build constants'
-            List constants = pipeline2ATX.getBuildConstants(build,['GIT_COMMIT':'customGitCommit'])
+            List constants = pipeline2ATX.getBuildConstants(build,['GIT_COMMIT':'customGitCommit','TOOL_NAME':'test.tool'])
 
         then: 'expect a attributes list with build information'
             result == constants
@@ -95,7 +96,8 @@ class Pipeline2ATXTest extends PipelineSpockTestBase {
                       ['key':'GIT_COMMIT', 'value':'customGitCommit'],
                       ['key':'JENKINS_BUILD_ID', 'value':'42'],
                       ['key':'JENKINS_EXECUTOR_NUMBER', 'value':'0815'],
-                      ['key':'JENKINS_NODE_NAME', 'value':'Runner0815']]
+                      ['key':'JENKINS_NODE_NAME', 'value':'Runner0815'],
+                      ['key':'TOOL_NAME', 'value':'test.tool']]
     }
     
     def 'Collect build constants - missing env vars'() {