FIO Job File support (#300)

* Removing dependency from FioExecutor on DiskWorkloadExecutor.

* ScriptPath documentation.

* PERF-IO-FIO-OLTP.json exposes the capability to execute a command which uses a jobfile.

* Attempting to fix formatting errors for ScriptPath documentation.

* Using either job file or command line from profile, can create/update a job file at runtime.

* Fixing issues with creating/updating job file at runtime.

* Simplifying CreateOrUpdateJobFile, the user is expected to provide each parameter within the profile.

* Added unit tests for FioExecutor using a jobfile.

* Removing architecture from unit test, does not need to be specified.

* Removing ioengine & file paths from profile.

* Added a test for multiple job file templates.

* Including a job file template which does not have ioengine or filename.

* Adding more sections to the OLTP profile for different block sizes.

* Documentation.

* Filtering out wranings from standard output to avoid parsing error.

* Regex to replace text from template job files.

* Slight documentation fix.

* Updating vc version.

* Small profile fix in metadata section.

* Small profile fix.

* Resolving comments.

* Resolving comments: Adding seperate template job files, one for disk fill and one for operations.

* Resolving comments.

* Resolving comments.

* Small profile fix.

---------

Co-authored-by: saibulusu <[email protected]>

Author: saibulusu

.pipelines/azure-pipelines-linux.yml

@@ -16,7 +16,7 @@ resources:
     options: --entrypoint=""
 
 variables:
-  VcVersion : 1.14.19
+  VcVersion : 1.14.21
   ROOT: $(Build.SourcesDirectory)
   CDP_DEFINITION_BUILD_COUNT: $[counter('', 0)] # needed for onebranch.pipeline.version task https://aka.ms/obpipelines/versioning
   ENABLE_PRS_DELAYSIGN: 1

.pipelines/azure-pipelines.yml

@@ -18,7 +18,7 @@ pool:
   vmImage: windows-latest
 
 variables:
-  VcVersion : 1.14.20
+  VcVersion : 1.14.21
   ROOT: $(Build.SourcesDirectory)
   CDP_DEFINITION_BUILD_COUNT: $[counter('', 0)] # needed for onebranch.pipeline.version task https://aka.ms/obpipelines/versioning
   ENABLE_PRS_DELAYSIGN: 1

src/VirtualClient/VirtualClient.Actions.UnitTests/FIO/FioExecutorTests.cs

@@ -4,6 +4,7 @@
 namespace VirtualClient.Actions.DiskPerformance
 {
     using System;
+    using System.CodeDom.Compiler;
     using System.Collections.Generic;
     using System.Diagnostics;
     using System.IO;
@@ -27,6 +28,7 @@ public class FioExecutorTests
         private IEnumerable<Disk> disks;
         private string mockCommandLine;
         private string mockResults;
+        private DependencyPath mockWorkloadPackage;
 
         [OneTimeSetUp]
         public void SetupFixture()
@@ -48,14 +50,16 @@ public void SetupTest()
                 { nameof(FioExecutor.CommandLine), this.mockCommandLine },
                 { nameof(FioExecutor.ProcessModel), WorkloadProcessModel.SingleProcess },
                 { nameof(FioExecutor.DeleteTestFilesOnFinish), "true" },
-                { nameof(FioExecutor.TestName), "fio_test_1" }
+                { nameof(FioExecutor.TestName), "fio_test_1" },
+                { nameof(FioExecutor.PackageName), "fio" }
             };
 
             this.disks = this.mockFixture.CreateDisks(PlatformID.Unix, true);
 
             this.mockFixture.DiskManager.Setup(mgr => mgr.GetDisksAsync(It.IsAny<CancellationToken>())).ReturnsAsync(() => this.disks);
             this.mockFixture.PackageManager.OnGetPackage().ReturnsAsync(new DependencyPath("fio", this.mockFixture.GetPackagePath("fio")));
             this.mockFixture.File.OnFileExists().Returns(true);
+            this.mockFixture.File.Setup(file => file.ReadAllText(It.IsAny<string>())).Returns(string.Empty);
             this.mockFixture.ProcessManager.OnCreateProcess = (command, arguments, workingDir) =>
             {
                 return new InMemoryProcess
@@ -71,6 +75,11 @@ public void SetupTest()
                     StandardOutput = new ConcurrentBuffer(new StringBuilder(this.mockResults))
                 };
             };
+
+            string workloadName = "fio";
+            this.mockWorkloadPackage = new DependencyPath(
+                workloadName,
+                this.mockFixture.PlatformSpecifics.GetPackagePath(workloadName));
         }
 
         [Test]
@@ -97,6 +106,74 @@ public void FioExecutorAppliesConfigurationParametersCorrectly()
             }
         }
 
+        [Test]
+        public void FioExecutorThrowsOnNullCommandLineAndJobFiles()
+        {
+            this.profileParameters[nameof(TestFioExecutor.CommandLine)] = null;
+            this.profileParameters[nameof(TestFioExecutor.JobFiles)] = null;
+
+            using (TestFioExecutor executor = new TestFioExecutor(this.mockFixture.Dependencies, this.profileParameters))
+            {
+                WorkloadException error = Assert.Throws<WorkloadException>(executor.Validate);
+
+                Assert.AreEqual(ErrorReason.InvalidProfileDefinition, error.Reason);
+            }
+        }
+
+        [Test]
+        public void FioExecutorThrowsIfCommandLineAndJobFilesIncluded()
+        {
+            this.profileParameters[nameof(TestFioExecutor.CommandLine)] = "--name=fio_randwrite_{FileSize}_4k_d{QueueDepth}_th{ThreadCount}_direct --size=496GB --numjobs={ThreadCount} --rw=randwrite --bs=4k --iodepth={QueueDepth}";
+            this.profileParameters[nameof(TestFioExecutor.JobFiles)] = "{ScriptPath:fio}/oltp-c.fio.jobfile";
+
+            using (TestFioExecutor executor = new TestFioExecutor(this.mockFixture.Dependencies, this.profileParameters))
+            {
+                WorkloadException error = Assert.Throws<WorkloadException>(executor.Validate);
+
+                Assert.AreEqual(ErrorReason.InvalidProfileDefinition, error.Reason);
+            }
+        }
+
+        [Test]
+        public async Task FioExecutorRunsCommandWithJobFile()
+        {
+            this.profileParameters[nameof(TestFioExecutor.CommandLine)] = null;
+            this.profileParameters[nameof(TestFioExecutor.JobFiles)] = "jobfile1path";
+
+            DependencyPath workloadPlatformSpecificPackage =
+                this.mockFixture.ToPlatformSpecificPath(this.mockWorkloadPackage, this.mockFixture.Platform, this.mockFixture.CpuArchitecture);
+
+            using (TestFioExecutor executor = new TestFioExecutor(this.mockFixture.Dependencies, this.profileParameters))
+            {
+                await executor.ExecuteAsync(CancellationToken.None);
+
+                string updatedJobFilePath = this.mockFixture.PlatformSpecifics.Combine(workloadPlatformSpecificPackage.Path, "jobfile1path");
+
+                Assert.AreEqual($"{updatedJobFilePath} --output-format=json", executor.CommandLine);
+            }
+        }
+
+        [Test]
+        public async Task FioExecutorRunsCommandWithMultipleJobFiles()
+        {
+            this.profileParameters[nameof(TestFioExecutor.CommandLine)] = null;
+            this.profileParameters[nameof(TestFioExecutor.JobFiles)] = "path/to/jobfile1,path/jobfile2;path/jobfile3";
+
+            DependencyPath workloadPlatformSpecificPackage =
+                this.mockFixture.ToPlatformSpecificPath(this.mockWorkloadPackage, this.mockFixture.Platform, this.mockFixture.CpuArchitecture);
+
+            using (TestFioExecutor executor = new TestFioExecutor(this.mockFixture.Dependencies, this.profileParameters))
+            {
+                await executor.ExecuteAsync(CancellationToken.None);
+
+                string updatedJobFile1Path = this.mockFixture.PlatformSpecifics.Combine(workloadPlatformSpecificPackage.Path, "jobfile1");
+                string updatedJobFile2Path = this.mockFixture.PlatformSpecifics.Combine(workloadPlatformSpecificPackage.Path, "jobfile2");
+                string updatedJobFile3Path = this.mockFixture.PlatformSpecifics.Combine(workloadPlatformSpecificPackage.Path, "jobfile3");
+
+                Assert.AreEqual($"{updatedJobFile1Path} {updatedJobFile2Path} {updatedJobFile3Path} --output-format=json", executor.CommandLine);
+            }
+        }
+
         [Test]
         public void FioExecutorAppliesConfigurationParametersCorrectly_DiskFillScenario()
         {
@@ -267,6 +344,11 @@ public TestFioExecutor(IServiceCollection dependencies, IDictionary<string, ICon
             {
                 return base.CreateWorkloadProcess(executable, commandArguments, testedInstance, disksToTest);
             }
+
+            public new void Validate()
+            {
+                base.Validate();
+            }
         }
     }
 }

src/VirtualClient/VirtualClient.Actions/FIO/FioDiscoveryExecutor.cs

@@ -52,6 +52,23 @@ public List<string> BlockSize
             }
         }
 
+        /// <summary>
+        /// The size of the test file that should use in workload tests (e.g. 496GB).
+        /// </summary>
+        public string FileSize
+        {
+            get
+            {
+                this.Parameters.TryGetValue(nameof(DiskWorkloadExecutor.FileSize), out IConvertible fileSize);
+                return fileSize?.ToString();
+            }
+
+            set
+            {
+                this.Parameters[nameof(DiskWorkloadExecutor.FileSize)] = value;
+            }
+        }
+
         /// <summary>
         /// Parameter. True to used direct, non-buffered I/O (default). False to use buffered I/O.
         /// </summary>