Refactor Prime95 to use changes made in internal repo.

Author: brdeyo

VERSION

@@ -1 +1 @@
-2.1.44
+2.1.45

src/VirtualClient/VirtualClient.Actions.UnitTests/Prime95/Prime95ExecutorTests.cs

@@ -153,7 +153,7 @@ public void Prime95ExecutorThrowsWhenTheWorkloadDoesNotProduceValidResults(Platf
         {
             this.SetupTest(platform);
             this.mockFixture.File.Setup(fe => fe.ReadAllTextAsync(It.IsAny<string>(), It.IsAny<CancellationToken>()))
-                .ReturnsAsync("");
+                .ReturnsAsync("Invalid results");
 
             using (TestPrime95Executor executor = new TestPrime95Executor(this.mockFixture))
             {
@@ -162,14 +162,14 @@ public void Prime95ExecutorThrowsWhenTheWorkloadDoesNotProduceValidResults(Platf
                 WorkloadResultsException exception = Assert.ThrowsAsync<WorkloadResultsException>(
                     () => executor.ExecuteAsync(CancellationToken.None));
 
-                Assert.AreEqual(ErrorReason.WorkloadResultsNotFound, exception.Reason);
+                Assert.AreEqual(ErrorReason.InvalidResults, exception.Reason);
             }
         }
 
         [Test]
         [TestCase(PlatformID.Win32NT)]
         [TestCase(PlatformID.Unix)]
-        public void Prime95ExecutorThrowsWhenWorkloadResultsFileNotFound(PlatformID platform)
+        public void Prime95ExecutorHandlesCasesWhereTheResultsFileIsNotProduced(PlatformID platform)
         {
             this.SetupTest(platform);
             this.mockFixture.File.Setup(fe => fe.Exists(It.Is<string>(file => file.EndsWith("results.txt"))))
@@ -178,11 +178,7 @@ public void Prime95ExecutorThrowsWhenWorkloadResultsFileNotFound(PlatformID plat
             using (TestPrime95Executor executor = new TestPrime95Executor(this.mockFixture))
             {
                 this.mockFixture.ProcessManager.OnCreateProcess = (command, arguments, directory) => this.mockFixture.Process;
-
-                WorkloadResultsException exception = Assert.ThrowsAsync<WorkloadResultsException>(
-                    () => executor.ExecuteAsync(CancellationToken.None));
-
-                Assert.AreEqual(ErrorReason.WorkloadResultsNotFound, exception.Reason);
+                Assert.DoesNotThrowAsync(() => executor.ExecuteAsync(CancellationToken.None));
             }
         }
 

src/VirtualClient/VirtualClient.Actions.UnitTests/Prime95/Prime95MetricsParserTests.cs

@@ -34,8 +34,8 @@ public void Prime95ParserVerifyMetricsForPassResults()
             IList<Metric> metrics = this.testParser.Parse();
 
             Assert.AreEqual(2, metrics.Count);
-            MetricAssert.Exists(metrics, "passTestCount", 200);
-            MetricAssert.Exists(metrics, "failTestCount", 0);
+            MetricAssert.Exists(metrics, "Test Pass", 200);
+            MetricAssert.Exists(metrics, "Test Fail", 0);
         }
 
         [Test]
@@ -47,8 +47,8 @@ public void Prime95ParserVerifyMetricsForFailedResults()
             IList<Metric> metrics = this.testParser.Parse();
 
             Assert.AreEqual(2, metrics.Count);
-            MetricAssert.Exists(metrics, "passTestCount", 7);
-            MetricAssert.Exists(metrics, "failTestCount", 3);
+            MetricAssert.Exists(metrics, "Test Pass", 7);
+            MetricAssert.Exists(metrics, "Test Fail", 3);
         }
     }
 }

src/VirtualClient/VirtualClient.Actions/Prime95/Prime95Executor.cs

@@ -8,17 +8,14 @@ namespace VirtualClient.Actions
     using System.IO;
     using System.IO.Abstractions;
     using System.Linq;
-    using System.Runtime.InteropServices;
     using System.Threading;
     using System.Threading.Tasks;
-    using Microsoft.AspNetCore.Http;
-    using Microsoft.AspNetCore.Http.HttpResults;
     using Microsoft.Extensions.DependencyInjection;
+    using Microsoft.Extensions.Logging;
     using VirtualClient.Common;
     using VirtualClient.Common.Extensions;
     using VirtualClient.Common.Telemetry;
     using VirtualClient.Contracts;
-    using VirtualClient.Contracts.Metadata;
 
     /// <summary>
     /// The Prime95 workload executor.
@@ -27,7 +24,6 @@ namespace VirtualClient.Actions
     public class Prime95Executor : VirtualClientComponent
     {
         private IFileSystem fileSystem;
-        private IPackageManager packageManager;
         private ISystemManagement systemManagement;
         private List<int> successExitCodes;
 
@@ -40,7 +36,6 @@ public Prime95Executor(IServiceCollection dependencies, IDictionary<string, ICon
              : base(dependencies, parameters)
         {
             this.systemManagement = this.Dependencies.GetService<ISystemManagement>();
-            this.packageManager = this.systemManagement.PackageManager;
             this.fileSystem = this.systemManagement.FileSystem;
 
             // The exit code on SafeKill is -1 which is not a part of the default success codes.
@@ -163,7 +158,7 @@ public bool UseHyperthreading
         /// <summary>
         /// The path to the Prime95 workload package.
         /// </summary>
-        protected DependencyPath Prime95Package { get; private set; }
+        protected DependencyPath WorkloadPackage { get; private set; }
 
         /// <summary>
         /// Executes cleanup operations.
@@ -180,33 +175,37 @@ protected override async Task CleanupAsync(EventContext telemetryContext, Cancel
             {
                 foreach (IProcessProxy processProxy in runningProcesses)
                 {
-                    processProxy.SafeKill(this.Logger);
+                    try
+                    {
+                        processProxy.SafeKill();
+                    }
+                    catch (Exception exc)
+                    {
+                        // Best effort only but we want to log the issue for debugging/triage.
+                        this.Logger.LogMessage(
+                            $"{this.TypeName}.CleanupProcessError",
+                            LogLevel.Warning,
+                            telemetryContext.Clone().AddError(exc).AddContext("process", processName));
+                    }
                 }
             }
-
-            if (this.fileSystem.File.Exists(this.ResultsFilePath))
-            {
-                await this.fileSystem.File.DeleteAsync(this.ResultsFilePath, RetryPolicies.FileDelete);
-            }
         }
 
         /// <summary>
         /// Initializes the environment for execution of the Prime95 workload.
         /// </summary>
         protected override async Task InitializeAsync(EventContext telemetryContext, CancellationToken cancellationToken)
         {
-            await this.EvaluateParametersAsync(cancellationToken);
-
-            this.Prime95Package = await this.GetPlatformSpecificPackageAsync(this.PackageName, cancellationToken);
+            this.WorkloadPackage = await this.GetPlatformSpecificPackageAsync(this.PackageName, cancellationToken);
 
             switch (this.Platform)
             {
                 case PlatformID.Win32NT:
-                    this.ExecutablePath = this.Combine(this.Prime95Package.Path, "prime95.exe");
+                    this.ExecutablePath = this.Combine(this.WorkloadPackage.Path, "prime95.exe");
                     break;
 
                 case PlatformID.Unix:
-                    this.ExecutablePath = this.Combine(this.Prime95Package.Path, "mprime");
+                    this.ExecutablePath = this.Combine(this.WorkloadPackage.Path, "mprime");
                     break;
 
                 default:
@@ -227,8 +226,8 @@ protected override async Task InitializeAsync(EventContext telemetryContext, Can
                     ErrorReason.DependencyNotFound);
             }
 
-            this.SettingsFilePath = this.Combine(this.GetTempPath(), "prime.txt");
-            this.ResultsFilePath = this.Combine(this.GetTempPath(), FileContext.GetFileName("results.txt", DateTime.UtcNow));
+            this.SettingsFilePath = this.Combine(this.WorkloadPackage.Path, "prime.txt");
+            this.ResultsFilePath = this.Combine(this.WorkloadPackage.Path, "results.txt");
         }
 
         /// <summary>
@@ -262,6 +261,13 @@ protected override void Validate()
                     ErrorReason.InvalidProfileDefinition);
             }
 
+            if (this.MaxTortureFFT <= 0)
+            {
+                throw new WorkloadException(
+                    $"Invalid '{nameof(this.MaxTortureFFT)}' parameter value. The maximum torture FFT value must be greater than zero.",
+                    ErrorReason.InvalidProfileDefinition);
+            }
+
             if (this.MaxTortureFFT < this.MinTortureFFT)
             {
                 throw new WorkloadException(
@@ -285,9 +291,9 @@ private async Task ExecuteWorkloadAsync(EventContext telemetryContext, Cancellat
 
                 await this.Logger.LogMessageAsync($"{this.TypeName}.ExecuteWorkload", telemetryContext, async () =>
                 {
-                    using (IProcessProxy process = this.systemManagement.ProcessManager.CreateProcess(this.ExecutablePath, commandArguments, this.Prime95Package.Path))
+                    using (IProcessProxy process = this.systemManagement.ProcessManager.CreateProcess(this.ExecutablePath, commandArguments, this.WorkloadPackage.Path))
                     {
-                        this.CleanupTasks.Add(() => process.SafeKill(this.Logger));
+                        this.CleanupTasks.Add(() => process.SafeKill());
 
                         // Prime95 does not stop on it's own. It will run until you tell it to stop.
                         // We have to definitively stop the program.
@@ -296,36 +302,24 @@ await this.Logger.LogMessageAsync($"{this.TypeName}.ExecuteWorkload", telemetryC
                         if (process.Start())
                         {
                             await this.WaitAsync(explicitTimeout, cancellationToken);
-                            process.SafeKill(this.Logger);
+                            process.SafeKill();
 
                             if (!cancellationToken.IsCancellationRequested)
                             {
                                 string results = null;
-
-                                try
+                                if (this.fileSystem.File.Exists(this.ResultsFilePath))
                                 {
-                                    await RetryPolicies.FileOperations.ExecuteAsync(async () =>
-                                    {
-                                        if (this.fileSystem.File.Exists(this.ResultsFilePath))
-                                        {
-                                            results = await this.fileSystem.File.ReadAllTextAsync(this.ResultsFilePath);
-                                        }
-                                    });
-                                    
-                                    if (string.IsNullOrWhiteSpace(results))
-                                    {
-                                        throw new WorkloadResultsException(
-                                            $"Prime95 results file not found at path '{this.ResultsFilePath}'.",
-                                            ErrorReason.WorkloadResultsNotFound);
-                                    }
-
-                                    // The exit code on SafeKill is -1 which is not a part of the default success codes.
-                                    process.ThrowIfWorkloadFailed(this.successExitCodes);
-                                    this.CaptureMetrics(process, results, telemetryContext, cancellationToken);
+                                    results = await this.fileSystem.File.ReadAllTextAsync(this.ResultsFilePath);
                                 }
-                                finally
+
+                                await this.LogProcessDetailsAsync(process, telemetryContext, "Prime95", results: results?.AsArray());
+
+                                // The exit code on SafeKill is -1 which is not a part of the default success codes.
+                                process.ThrowIfWorkloadFailed(this.successExitCodes);
+
+                                if (!string.IsNullOrWhiteSpace(results))
                                 {
-                                    await this.LogProcessDetailsAsync(process, telemetryContext, "Prime95", results?.AsArray());
+                                    this.CaptureMetrics(process, results, telemetryContext, cancellationToken);
                                 }
                             }
                         }
@@ -362,13 +356,6 @@ private void CaptureMetrics(IProcessProxy process, string results, EventContext
         {
             if (!cancellationToken.IsCancellationRequested)
             {
-                this.MetadataContract.AddForScenario(
-                    "Prime95",
-                    process.FullCommand(),
-                    toolVersion: this.Prime95Package.Version);
-
-                this.MetadataContract.Apply(telemetryContext);
-
                 Prime95MetricsParser parser = new Prime95MetricsParser(results);
                 IList<Metric> workloadMetrics = parser.Parse();
 

src/VirtualClient/VirtualClient.Actions/Prime95/Prime95MetricsParser.cs

@@ -16,9 +16,9 @@ public class Prime95MetricsParser : MetricsParser
         /// <summary>
         /// Constructor for <see cref="Prime95MetricsParser"/>
         /// </summary>
-        /// <param name="rawText">Raw text to parse.</param>
-        public Prime95MetricsParser(string rawText)
-            : base(rawText)
+        /// <param name="results">Raw text to parse.</param>
+        public Prime95MetricsParser(string results)
+            : base(results)
         {
         }
 
@@ -46,12 +46,12 @@ public override IList<Metric> Parse()
                     }
                 }
 
-                metrics.Add(new Metric("passTestCount", selfTestPassCount, MetricRelativity.HigherIsBetter));
-                metrics.Add(new Metric("failTestCount", fatalErrorsCount, MetricRelativity.LowerIsBetter));
+                metrics.Add(new Metric("Test Pass", selfTestPassCount, "count", MetricRelativity.HigherIsBetter));
+                metrics.Add(new Metric("Test Fail", fatalErrorsCount, "count", MetricRelativity.LowerIsBetter));
 
-                if (metrics.Count != 2)
+                if (selfTestPassCount <= 0 && fatalErrorsCount <= 0)
                 {
-                    throw new WorkloadResultsException($"The Prime95 Workload did not generate valid metrics! ");
+                    throw new WorkloadResultsException($"The Prime95 Workload did not generate any valid pass/fail metrics!");
                 }
 
                 return metrics;
@@ -73,6 +73,6 @@ protected override void Preprocess()
 
             // Removing unnecessary starting and ending space.
             this.PreprocessedText = this.PreprocessedText.Trim();
-        }        
+        }
     }
 }