Add metrics for pipeline2atx (#34)

docs/index-all.html

@@ -139,15 +139,21 @@ <h2 class="title">B</h2>
 <h2 class="title">C</h2>
 <dl>
 
+<dt><span class="strong"><a href="vars/pipeline2ATX.html#calculateErrorTime(def)" title="Method in pipeline2ATX">calculateErrorTime(def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
+</dt><dd> <div class="block">Determines the time until an error within the execution phase occurs.</div></dd>
+<dt><span class="strong"><a href="vars/pipeline2ATX.html#calculateTime(def, def)" title="Method in pipeline2ATX">calculateTime(def, def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
+</dt><dd> <div class="block">Calculates the duration metrics and their percentages.</div></dd>
 <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, 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.
+</dt><dd> <div class="block">Generates a test.guide compatible JSON report of a pipeline build including logs, metrics, 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>
 </dt><dd> <div class="block">Process management for Windows (via Powershell) and Linux (via Shell).</div></dd>
 <dt><span class="strong"><a href="vars/cmd.html" title="Script in cmd">cmd</a></span> - Script in <a href="./cmd/package-summary.html">cmd</a>
 </dt><dd><div class="block"></div></dd>
+<dt><span class="strong"><a href="vars/pipeline2ATX.html#convertTimeValueToDouble(def)" title="Method in pipeline2ATX">convertTimeValueToDouble(def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
+</dt><dd> <div class="block">Converts a none null time value to a double with one decimal place.</div></dd>
 <dt><span class="strong"><a href="vars/pipeline2ATX.html#crawlRows(def, def, def)" title="Method in pipeline2ATX">crawlRows(def, def, def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
 </dt><dd> <div class="block">Crawls the current table row for corresponding test execution step items.
  </div></dd>
@@ -186,34 +192,35 @@ <h2 class="title">E</h2>
 <h2 class="title">F</h2>
 <dl>
 
+<dt><span class="strong"><a href="vars/pipeline2ATX.html#findNonPassedVerdict(def, def)" title="Method in pipeline2ATX">findNonPassedVerdict(def, def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
+</dt><dd> <div class="block">Scans the verdicts value while traversing the stages of the pipeline build</div></dd>
 </dl>
 
 
 <a name="_G_"><!-- --></a>
 <h2 class="title">G</h2>
 <dl>
 
-<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><span class="strong"><a href="vars/pipeline2ATX.html#generateJsonReport(def, def, def, def, def, def)" title="Method in pipeline2ATX">generateJsonReport(def, 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, 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)
- - 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)</div></dd>
+</dt><dd> <div class="block">Collects all relevant build information and parameters as a key-value map:
+ <ul>
+   <li><code>PRODUCT_NAME</code>: Content of the env var PRODUCT_NAME, only added if present.</div></dd>
 <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)
- - 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)</div></dd>
+</dt><dd> <div class="block">Collects all relevant build information and parameters as a key-value map:
+ <ul>
+   <li><code>PRODUCT_VERSION</code>: Content of env var PRODUCT_VERSION, only added if present.</div></dd>
+<dt><span class="strong"><a href="vars/pipeline2ATX.html#getBuildMetrics(def, def)" title="Method in pipeline2ATX">getBuildMetrics(def, def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
+</dt><dd> <div class="block">Collects all relevant build metrics information and parameters as a key-value map:
+ <ul>
+   <li><code>TOTAL_EXECUTION_TIME</code>: Full run time of the build in seconds.</div></dd>
 <dt><span class="strong"><a href="vars/log.html#getColorCode(java.lang.String)" title="Method in log">getColorCode(String)</a></span> - Method in <a href="vars/log.html">log</a>
 </dt><dd> <div class="block">Returns the ANSI code for a given color.</div></dd>
 <dt><span class="strong"><a href="vars/pipeline2ATX.html#getConsoleLog(def)" title="Method in pipeline2ATX">getConsoleLog(def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
 </dt><dd> <div class="block">Gets the console log.</div></dd>
+<dt><span class="strong"><a href="vars/pipeline2ATX.html#getCurrentPhase(def, def)" title="Method in pipeline2ATX">getCurrentPhase(def, def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
+</dt><dd> <div class="block">Determines the respective phase of the stage being examined.</div></dd>
 <dt><span class="strong"><a href="vars/pipeline2ATX.html#getCurrentResult(def)" title="Method in pipeline2ATX">getCurrentResult(def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
 </dt><dd> <div class="block">Gets the current build result.</div></dd>
 <dt><span class="strong"><a href="vars/pipeline2ATX.html#getDescription(def)" title="Method in pipeline2ATX">getDescription(def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
@@ -237,6 +244,8 @@ <h2 class="title">G</h2>
 </dt><dd> <div class="block">Returns the ANSI code for a given style.</div></dd>
 <dt><span class="strong"><a href="vars/pipeline2ATX.html#getTestStepName(def)" title="Method in pipeline2ATX">getTestStepName(def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
 </dt><dd> <div class="block">Creates the test step name by combining the row name with its arguments</div></dd>
+<dt><span class="strong"><a href="vars/pipeline2ATX.html#getTimeFromCommitToStart(def)" title="Method in pipeline2ATX">getTimeFromCommitToStart(def)</a></span> - Method in <a href="vars/pipeline2ATX.html">pipeline2ATX</a>
+</dt><dd> <div class="block">Determines the time from commit to start of the build</div></dd>
 </dl>