Enable profile components to define additional logging instructions (e.g. timestamping).

Author: brdeyo

VERSION

@@ -1 +1 @@
-2.1.34
+2.1.35

src/VirtualClient/VirtualClient.Contracts.UnitTests/ComponentFactoryTests.cs

@@ -69,6 +69,51 @@ public void ComponentFactoryCreatesExpectedComponentsFromAnExecutionProfile(stri
             }
         }
 
+        [Test]
+        [TestCase("TEST-PROFILE-1.json")]
+        public void ComponentFactorySetsComponentPropertiesToExpectedDefaults(string profileName)
+        {
+            ExecutionProfile profile = File.ReadAllText(Path.Combine(MockFixture.TestAssemblyDirectory, "Resources", profileName))
+                .FromJson<ExecutionProfile>();
+
+            foreach (ExecutionProfileElement action in profile.Actions)
+            {
+                VirtualClientComponent component = ComponentFactory.CreateComponent(action, this.mockFixture.Dependencies);
+                Assert.IsNotNull(component);
+                Assert.IsNotNull(component.Parameters);
+                Assert.IsFalse(component.LogToFile);
+                Assert.IsTrue(component.LogTimestamped);
+                Assert.IsNull(component.ContentPathTemplate);
+                Assert.IsNull(component.LogFileName);
+                Assert.IsNull(component.LogFolderName);
+            }
+        }
+
+        [Test]
+        [TestCase("TEST-PROFILE-5.json")]
+        public void ComponentFactoryDoesNotInadvertentlyOverwriteComponentLevelProperties(string profileName)
+        {
+            ExecutionProfile profile = File.ReadAllText(Path.Combine(MockFixture.TestAssemblyDirectory, "Resources", profileName))
+                .FromJson<ExecutionProfile>();
+
+            ComponentSettings settings = new ComponentSettings
+            {
+                ContentPathTemplate = "content/path/template/A",
+                LogToFile = false
+            };
+
+            foreach (ExecutionProfileElement action in profile.Actions)
+            {
+                VirtualClientComponent component = ComponentFactory.CreateComponent(action, this.mockFixture.Dependencies, settings);
+                Assert.IsNotNull(component);
+                Assert.IsNotNull(component.Parameters);
+                Assert.IsTrue(component.LogToFile);
+                Assert.IsFalse(component.LogTimestamped);
+                Assert.AreEqual("test.log", component.LogFileName);
+                Assert.AreEqual("test", component.LogFolderName);
+            }
+        }
+
         [Test]
         [TestCase("TEST-PROFILE-3-PARALLEL.json")]
         public void ComponentFactoryCreatesExpectedParallelExecutionComponentsFromAnExecutionProfile(string profileName)

src/VirtualClient/VirtualClient.Contracts.UnitTests/Resources/TEST-PROFILE-5.json

@@ -0,0 +1,16 @@
+{
+    "Description": "Test Profile Executor (Metadata + Extensions)",
+    "Actions": [
+        {
+            "Type": "TestExecutor",
+            "Parameters": {
+                "CommandLine": "--name=testName --engine=V8",
+                "LogToFile": true,
+                "LogFileName": "test.log",
+                "LogFolderName": "test",
+                "LogTimestamped": false,
+                "Tags": "Test,VC"
+            }
+        }
+    ]
+}

src/VirtualClient/VirtualClient.Contracts.UnitTests/VirtualClientLoggingExtensionsTests.cs

@@ -38,6 +38,8 @@ public void SetupTest()
             this.mockLogger = new Mock<ILogger>();
             this.mockEventContext = new EventContext(Guid.NewGuid());
 
+            this.mockFixture.Parameters[nameof(TestExecutor.LogToFile)] = true;
+
             // When there is a content manager, the application will also write a file
             // upload notification file (e.g. upload.json). We validate this separately.
             this.mockFixture.Dependencies.RemoveAll<IEnumerable<IBlobManager>>();

src/VirtualClient/VirtualClient.Contracts/ComponentFactory.cs

@@ -105,28 +105,24 @@ private static VirtualClientComponent CreateComponent(
             IEnumerable<string> includeScenarios = null,
             IEnumerable<string> excludeScenarios = null)
         {
-            if (!dependencies.TryGetService<ComponentSettings>(out ComponentSettings settings))
-            {
-                settings = new ComponentSettings();
-            }
-
             IDictionary<string, IConvertible> effectiveParameters = new SortedDictionary<string, IConvertible>(StringComparer.OrdinalIgnoreCase);
             if (componentDescription.Parameters?.Any() == true)
             {
                 effectiveParameters.AddRange(componentDescription.Parameters);
             }
 
-            if (componentSettings.FailFast != null)
+            // We do not override profile component-level/defined settings.
+            if (componentSettings.FailFast != null && !effectiveParameters.ContainsKey(nameof(VirtualClientComponent.FailFast)))
             {
                 effectiveParameters[nameof(VirtualClientComponent.FailFast)] = componentSettings.FailFast.Value;
             }
 
-            if (componentSettings.LogToFile != null)
+            if (componentSettings.LogToFile != null && !effectiveParameters.ContainsKey(nameof(VirtualClientComponent.LogToFile)))
             {
                 effectiveParameters[nameof(VirtualClientComponent.LogToFile)] = componentSettings.LogToFile.Value;
             }
 
-            if (componentSettings.Seed != null)
+            if (componentSettings.Seed != null && !effectiveParameters.ContainsKey(nameof(VirtualClientComponent.Seed)))
             {
                 effectiveParameters[nameof(VirtualClientComponent.Seed)] = componentSettings.Seed.Value;
             }

src/VirtualClient/VirtualClient.Contracts/VirtualClientComponent.cs

@@ -295,6 +295,23 @@ protected set
             }
         }
 
+        /// <summary>
+        /// True/false whether log files written will have timestamps appended to the 
+        /// file names (e.g. 2023-02-01-100530635478-geekbench.log). Default = true.
+        /// </summary>
+        public bool LogTimestamped
+        {
+            get
+            {
+                return this.Parameters.GetValue<bool>(nameof(this.LogTimestamped), true);
+            }
+
+            protected set
+            {
+                this.Parameters[nameof(this.LogTimestamped)] = value;
+            }
+        }
+
         /// <summary>
         /// Metadata provided to the application on the command line.
         /// </summary>

src/VirtualClient/VirtualClient.Core.UnitTests/VirtualClientLoggingExtensionsTests.cs

@@ -25,6 +25,7 @@ public class VirtualClientLoggingExtensionsTests : MockFixture
         public void Setup()
         {
             this.Setup(PlatformID.Unix);
+            this.Parameters[nameof(TestExecutor.LogToFile)] = true;
         }
 
         [Test]

src/VirtualClient/VirtualClient.Dependencies/ExecuteCommand.cs

@@ -146,7 +146,7 @@ protected override async Task ExecuteAsync(EventContext telemetryContext, Cancel
 
                                         if (!cancellationToken.IsCancellationRequested)
                                         {
-                                            await this.LogProcessDetailsAsync(process, telemetryContext, toolName: this.LogFolderName, logFileName: this.LogFileName);
+                                            await this.LogProcessDetailsAsync(process, telemetryContext, toolName: this.LogFolderName, logFileName: this.LogFileName, timestamped: this.LogTimestamped);
                                             process.ThrowIfComponentOperationFailed(this.ComponentType);
                                         }
                                     }

src/VirtualClient/VirtualClient.Monitors/ExecuteCommandMonitor.cs

@@ -252,7 +252,7 @@ protected async Task ExecuteCommandAsync(EventContext telemetryContext, Cancella
 
                                     if (!cancellationToken.IsCancellationRequested)
                                     {
-                                        await this.LogProcessDetailsAsync(process, telemetryContext, toolName: this.LogFolderName, logFileName: this.LogFileName);
+                                        await this.LogProcessDetailsAsync(process, telemetryContext, toolName: this.LogFolderName, logFileName: this.LogFileName, timestamped: this.LogTimestamped);
                                         process.ThrowIfMonitorFailed();
                                         this.CaptureEventInformation(process, telemetryContext);
                                     }

src/VirtualClient/VirtualClient.TestFramework/TestExecutor.cs

@@ -22,7 +22,6 @@ public class TestExecutor : VirtualClientComponent
         public TestExecutor(MockFixture fixture)
             : base(fixture?.Dependencies, fixture?.Parameters)
         {
-            this.LogToFile = true;
         }
 
         /// <summary>
@@ -31,7 +30,6 @@ public TestExecutor(MockFixture fixture)
         public TestExecutor(IServiceCollection dependencies, IDictionary<string, IConvertible> parameters)
             : base(dependencies, parameters)
         {
-            this.LogToFile = true;
         }
 
         /// <summary>