Merge pull request #9 from unity/SupportIgnoringMetrics

ignore metrics

Author: amaestas13

UnityPerformanceBenchmarkReporter/OptionsParser.cs

@@ -74,6 +74,9 @@ private OptionSet GetOptions(PerformanceBenchmark performanceBenchmark)
             optionsSet.Add(
                     "report|reportdirpath:", "OPTIONAL - Path to where the report will be written. Default is current working directory.",
                     performanceBenchmark.AddReportDirPath);
+            optionsSet.Add("ignore:",
+                "send in ; seperated list of metric names. These metrics are ignored and not compared even if they both exist on baseline and results",
+                option => performanceBenchmark.SetIgnoredMetrics(option));
             optionsSet.Add("failonbaseline",
                 "Enable return '1' by the reporter if a baseline is passed in and one or more matching configs is out of threshold. Disabled is default. Use option to enable, or use option and append '-' to explicitly disable.",
                 option => performanceBenchmark.FailOnBaseline = option != null);

UnityPerformanceBenchmarkReporter/PerformanceBenchmark.cs

@@ -38,6 +38,8 @@ public PerformanceBenchmark(Dictionary<Type, string[]> configFieldNames = null)
 
         public bool ResultFilesExist => ResultFilePaths.Any() || ResultDirectoryPaths.Any();
 
+        public List<string> IgnoredMetrics = new List<string>();
+
 
         public void AddPerformanceTestRunResults(
             IParser testResultParser,
@@ -116,7 +118,7 @@ private void AddTestResults(
 
                         testResults.AddRange(results);
 
-                        performanceTestRunProcessor.UpdateTestResultsBasedOnBaselineResults(baselineTestResults, testResults, SigFig);
+                        performanceTestRunProcessor.UpdateTestResultsBasedOnBaselineResults(baselineTestResults, IgnoredMetrics, testResults, SigFig);
 
                         TestRunMetadataProcessor.ProcessMetadata(performanceTestRun, resultFilesOrderedByResultName[i].Key);
 
@@ -131,6 +133,11 @@ private void AddTestResults(
             }
         }
 
+        public void SetIgnoredMetrics(string metrics)
+        {
+            IgnoredMetrics = metrics.Split(';').ToList();
+        }
+
         public void SetDataVersion(string version)
         {
             if (int.TryParse(version, out int result))

UnityPerformanceBenchmarkReporter/PerformanceTestRunProcessor.cs

@@ -62,7 +62,7 @@ public List<TestResult> GetTestResults(
             return performanceTestResults;
         }
 
-        public void UpdateTestResultsBasedOnBaselineResults(List<TestResult> baselineTestResults,
+        public void UpdateTestResultsBasedOnBaselineResults(List<TestResult> baselineTestResults, List<string> ignoredMetrics,
             List<TestResult> testResults, uint sigfig)
         {
             foreach (var testResult in testResults)
@@ -76,7 +76,7 @@ public void UpdateTestResultsBasedOnBaselineResults(List<TestResult> baselineTes
                 foreach (var sampleGroupResult in testResult.SampleGroupResults)
                 {
                     // if we have a corresponding baseline samplegroupname in this sampleGroupResult, compare them
-                    if (baselineSampleGroupResults.Any(sg => sg.SampleGroupName == sampleGroupResult.SampleGroupName))
+                    if ( baselineSampleGroupResults.Any(sg => sg.SampleGroupName == sampleGroupResult.SampleGroupName && !ignoredMetrics.Contains(sampleGroupResult.SampleGroupName)) )
                     {
                         // Get the baselineSampleGroupResult that corresponds to this SampleGroupResults sample group name
                         var baselineSampleGroupResult = baselineSampleGroupResults.First(sg => sg.SampleGroupName == sampleGroupResult.SampleGroupName);