add summary for trend ave

src/comment.js

@@ -272,20 +272,6 @@ module.exports.createBodyForComparisonWithTrendDetMovAverage = function(evaluati
   )
   lines.push('|-|-|-|-|-|-|')
 
-  /**
-   *   return module.exports.createEvaluationObject({
-   *     "evaluation_method": "trend_detection_moving_ave",
-   *     "metric_names": metricNames,
-   *     "metric_units": metricUnits,
-   *     "is": percentageIncreases,
-   *     "should_be": should_be,
-   *     "result": evaluationResults,
-   *     "reference_benchmarks": {
-   *         "previous": previousBenchmarkDataArray,
-   *         "current": currentBenchmarkData
-   *     }
-   *   });
-   */
 
   const evaluationResults = evaluationResult.results.result
   const evaluationParameters = evaluationResult.evalParameters
@@ -304,9 +290,6 @@ module.exports.createBodyForComparisonWithTrendDetMovAverage = function(evaluati
     const shouldBe = evaluationParameters.shouldBe[i];
     const ratio = evaluationParameters.is[i];
 
-    //const numberOfConsideredBuilds = evaluationConfiguration.numberOfConsideredBuilds[i];
-
-
     let line
 
 // Max.Jump | Was | No builds | Res
@@ -892,7 +875,8 @@ module.exports.summaryForMethodNotSupported = function (evaluationResult, linkTo
 //////////
 /// Helpers
 //////////
-module.exports.addSummary = function (evaluationMethod, headers, rows, summaryMessage, linkToGraph, eventName) {
+module.exports.addSummary = function (evaluationMethod, headers, rows, summaryMessage, linkToGraph, eventName,
+                                      isMovingAve = false, movingAveWindowSize = null) {
 
   const methodSpecificDescription = module.exports.getEvaluationMethodSpecificDescriptionOfEvalMethod(evaluationMethod);
   const methodDescriptionFullText = `<b>Method description:</b> ${methodSpecificDescription}`;
@@ -906,6 +890,11 @@ module.exports.addSummary = function (evaluationMethod, headers, rows, summaryMe
     core.summary.addRaw(scheduledEventExtraInfo)
     .addSeparator();
   }
+  if (isMovingAve) {
+    const movingAveExtraInfo = `The chosen moving average window size is ${movingAveWindowSize}.`;
+    core.summary.addRaw(movingAveExtraInfo)
+        .addSeparator();
+  }
   core.summary
       .addHeading(`The chosen evaluation method: ${evaluationMethod}`, 4)
       .addRaw(methodDescriptionFullText)
@@ -1016,6 +1005,90 @@ module.exports.createWorkflowSummaryForJumpDetection = function (evaluationResul
       completeConfig.eventName);
 }
 
+module.exports.createWorkflowSummaryForTrendDetAve = function (evaluationResult, completeConfig) {
+  const currentBenchmark = evaluationResult.referenceBenchmarks.current;
+  const previousBenchmark = evaluationResult.referenceBenchmarks.previous;
+
+  const currentCommitId = completeConfig.eventName === 'schedule' ? currentBenchmark.commitInfo.id : currentBenchmark.commitInfo.id.substring(0, 7);
+  const previousCommitId = previousBenchmark.commitInfo.eventName === 'schedule' ? previousBenchmark.commitInfo.id : previousBenchmark.commitInfo.id.substring(0, 7);
+
+  const headers = [
+    {
+      data: 'Metric',
+      header: true,
+    },
+    {
+      data: `Current: "${currentCommitId}"`,
+      header: true,
+    },
+
+
+    {
+      data: 'Jump',
+      header: true,
+    },
+    {
+      data: 'Max. change [%]',
+      header: true,
+    },
+    {
+      data: 'Result',
+      header: true,
+    }
+
+  ];
+
+  const rows = [];
+  const evaluationResults = evaluationResult.results.result
+  const evaluationParameters = evaluationResult.evalParameters
+  const evaluationConfiguration = completeConfig.evaluationConfig
+  for (let i = 0; i < evaluationResults.length; i++) {
+    const resultStatus = evaluationResults[i];
+    const metricName = evaluationParameters.metricNames[i];
+    const metricUnit = evaluationParameters.metricUnits[i];
+
+    const currValue = currentBenchmark.simpleMetricResults[i].value;
+    const currPlusUnit = currValue + ' ' + metricUnit;
+    const shouldBe = evaluationParameters.shouldBe[i];
+    const ratio = evaluationParameters.is[i];
+
+    let line
+
+
+
+    let graphicalRepresentationOfRes;
+    if (resultStatus === 'failed' || resultStatus === 'passed') {
+      graphicalRepresentationOfRes = resultStatus === 'passed' ? '🟢' : '🔴'
+    } else {
+      graphicalRepresentationOfRes= '🔘';
+    }
+
+    rows.push([
+      {
+        data: metricName,
+      },
+      {
+        data: currPlusUnit,
+      },
+      {
+        data: ratio,
+      },
+      {
+        data: shouldBe,
+      },
+      {
+        data: graphicalRepresentationOfRes
+      },
+
+    ])
+  }
+  const movingAveWindowSize = completeConfig.evaluationConfig.movingAveWindowSize;
+  let summaryMessage = module.exports.createSummaryMessage(evaluationResult);
+  const evaluationMethod = evaluationResult.evalParameters.evaluationMethod;
+  module.exports.addSummary(evaluationMethod, headers, rows, summaryMessage, completeConfig.linkToTemplatedGhPageWithResults,
+      completeConfig.eventName, true, movingAveWindowSize);
+}
+
 
 
 module.exports.getEvaluationMethodSpecificDescriptionOfEvalMethod = function (evaluationMethod) {
@@ -1029,9 +1102,9 @@ module.exports.getEvaluationMethodSpecificDescriptionOfEvalMethod = function (ev
     case 'threshold_range':
       return "The method compares the current benchmark in relation to a range of a given values (given by lower and upper bounds)."
     case 'jump_detection':
-      return ""
+      return "The strategy checks if the difference between the current and previous value does not exceed a given threshold"
     case 'trend_detection_moving_ave':
-      return ""
+      return "The procedure checks if the current value does not exceed the average of a particular number of last measurements more than a given threshold"
     case 'trend_detection_deltas':
       return "The method tries to identify software performance degradation by comparing current performance against three benchmarks:" +
           " the immediate previous run, a run closest to one week ago, and the last stable release." +

src/main.js

@@ -16,7 +16,8 @@ const { createCurrBench} = require('./bench')
 
 const { createComment, createWorkflowSummaryForCompWithPrev, createWorkflowSummaryThreshold,
   summaryForMethodNotSupported, createWorkflowSummaryForThresholdRange,
-  createWorkflowSummaryForTrendDetDeltas, createWorkflowSummaryForJumpDetection} = require('./comment')
+  createWorkflowSummaryForTrendDetDeltas, createWorkflowSummaryForJumpDetection,
+  createWorkflowSummaryForTrendDetAve} = require('./comment')
 
 const {
   addCompleteBenchmarkToFile,