Add features to support application as a test controller. (#576)

Author: brdeyo

VERSION

@@ -1 +1 @@
-2.1.29
+2.1.30

src/VirtualClient/VirtualClient.Actions/GeekBench/GeekbenchExecutor.cs

@@ -275,11 +275,6 @@ private Task ExecuteWorkloadAsync(string pathToExe, string commandLineArguments,
                             await this.LogProcessDetailsAsync(process, telemetryContext, this.PackageName, logToFile: true);
                             process.ThrowIfWorkloadFailed();
 
-                            if (process.StandardError.Length > 0)
-                            {
-                                process.ThrowOnStandardError<WorkloadException>(errorReason: ErrorReason.WorkloadFailed);
-                            }
-
                             string standardOutput = process.StandardOutput.ToString();
                             this.CaptureMetrics(process, standardOutput, commandLineArguments, telemetryContext, cancellationToken);
                         }

src/VirtualClient/VirtualClient.Common.UnitTests/SensitiveDataTests.cs

@@ -151,15 +151,6 @@ public void ObscureSecretsObfuscatesSasUriSignatures_Scenario1()
             Assert.AreEqual(dataContainingSecrets.Item2, obscuredString);
         }
 
-        [Test]
-        public void ObscureSecretsObfuscatesSasUriSignatures_Scenario2()
-        {
-            Tuple<string, string> dataContainingSecrets = SensitiveDataTests.GetSasUriPairScenario2();
-            string obscuredString = SensitiveData.ObscureSecrets(dataContainingSecrets.Item1);
-
-            Assert.AreEqual(dataContainingSecrets.Item2, obscuredString);
-        }
-
         [Test]
         [TestCase("Password=AnySecretHereae09g34YT112", "Password=...")]
         [TestCase("Password AnySecretHereae09g34YT112", "Password ...")]
@@ -216,6 +207,18 @@ public void ObscureSecretsHandlesCasesWhereThePasswordTermIsASubstringThatIsPart
             Assert.AreEqual(expectedString, obscuredString);
         }
 
+        [Test]
+        [TestCase("user@10.2.3.5;pass_;wor;d", "user@10.2.3.5;...")]
+        [TestCase("user@10.2.3.5;pass__w@rd", "user@10.2.3.5;...")]
+        [TestCase("user@machine@somewhere;pass", "user@machine@somewhere;...")]
+        [TestCase("user@machine@somewhere;pass;_w@rd", "user@machine@somewhere;...")]
+        [TestCase("user@2001:db8:85a3:0:0:8a2e:370:7334;pass;_w@rd", "user@2001:db8:85a3:0:0:8a2e:370:7334;...")]
+        public void ObscureSecretsObfuscatesPasswordsInAgentSshConnections(string originalString, string expectedString)
+        {
+            string obscuredString = SensitiveData.ObscureSecrets(originalString);
+            Assert.AreEqual(expectedString, obscuredString);
+        }
+
         [Test]
         public void ObscureSecretsObfuscatesSecretsThatMatchAGivenRegularExpression_Scenario1()
         {

src/VirtualClient/VirtualClient.Common/SensitiveData.cs

@@ -30,6 +30,10 @@ public static class SensitiveData
              // of expressions to allow the handling of special cases (e.g. delimited key/value pair groups (e.g. Password=s@me,val;ue,,,Property1=Value1).
              new Regex("(?<=Password[=\x20]+\"*)(?:,{0,2}[\x21\x23-\x2B\x2D-\x7E]+,{0,2}[\x21\x23-\x2B\x2D-\x7E]+)+\"*", RegexOptions.IgnoreCase),
              new Regex("(?<=Pwd[=\x20]+\"*)(?:,{0,2}[\x21\x23-\x2B\x2D-\x7E]+,{0,2}[\x21\x23-\x2B\x2D-\x7E]+)+\"*", RegexOptions.IgnoreCase),
+
+             // Agent SSH connections allow for passwords
+             // (e.g. user@10.2.3.5;pass_;wor;d).
+             new Regex(@"[0-9a-z_\-\. ]+@[^;]+;([\x20-\x7E]+)", RegexOptions.IgnoreCase)
         };
 
         /// <summary>

src/VirtualClient/VirtualClient.Contracts/AliasAttribute.cs

@@ -10,7 +10,7 @@ namespace VirtualClient.Contracts
     /// <summary>
     /// Defines one or more aliases for a given class for reflection support.
     /// </summary>
-    [AttributeUsage(validOn: AttributeTargets.Class)]
+    [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
     public class AliasAttribute : Attribute
     {
         /// <summary>

src/VirtualClient/VirtualClient.Contracts/ComponentTypeCache.cs

@@ -8,6 +8,7 @@ namespace VirtualClient.Contracts
     using System.Diagnostics.CodeAnalysis;
     using System.IO;
     using System.Linq;
+    using System.Net;
     using System.Reflection;
     using Microsoft.Extensions.Logging;
     using VirtualClient.Common.Extensions;

src/VirtualClient/VirtualClient.Contracts/Constants.cs

@@ -150,21 +150,6 @@ public static class EnvironmentVariable
         /// </summary>
         public const string PATH = nameof(PATH);
 
-        /// <summary>
-        /// Name = SDK_EVENTHUB_CONNECTION
-        /// </summary>
-        public const string SDK_EVENTHUB_CONNECTION = nameof(SDK_EVENTHUB_CONNECTION);
-
-        /// <summary>
-        /// Name = SDK_PACKAGES_CONNECTION
-        /// </summary>
-        public const string SDK_PACKAGES_CONNECTION = nameof(SDK_PACKAGES_CONNECTION);
-
-        /// <summary>
-        /// Name = SDK_PACKAGES_DIR
-        /// </summary>
-        public const string SDK_PACKAGES_DIR = nameof(SDK_PACKAGES_DIR);
-
         /// <summary>
         /// Name = SUDO_USER
         /// </summary>

src/VirtualClient/VirtualClient.Contracts/PlatformSpecifics.cs

@@ -149,7 +149,7 @@ public PlatformSpecifics(PlatformID platform, Architecture architecture, string
         public string StateDirectory { get; set; }
 
         /// <summary>
-        /// The directory where scripts related to workloads exist.
+        /// The directory where temp files can be saved.
         /// </summary>
         public string TempDirectory { get; set; }
 
@@ -280,8 +280,8 @@ public static string ResolveRelativePaths(string text)
                     {
                         // Ensure that relative working directory paths are fully expanded. Preserve case-sensitivity
                         // to avoid anomalies on Linux.
-                        string relativeDirectory = match.Value;
-                        resolved = resolved.Replace(relativeDirectory, Path.GetFullPath(relativeDirectory), StringComparison.Ordinal);
+                        string relativePath = match.Value;
+                        resolved = resolved.Replace(relativePath, Path.GetFullPath(relativePath), StringComparison.Ordinal);
                     }
                 }
             }

src/VirtualClient/VirtualClient.Contracts/VirtualClientComponent.cs

@@ -377,7 +377,7 @@ protected set
         /// placeholders and well-known terms to be replaced in the values of the parameters before
         /// execution of workloads, monitors or dependencies.
         /// </summary>
-        public bool ParametersEvaluated { get; internal set; }
+        public bool ParametersEvaluated { get; protected set; }
 
         /// <summary>
         /// The OS/system platform (e.g. Windows, Unix).
@@ -659,6 +659,28 @@ public static bool IsSupported(VirtualClientComponent component)
             return platformSupported && component.IsSupported();
         }
 
+        /// <summary>
+        /// Evaluates each of the parameters provided to the component to replace
+        /// supported placeholder expressions (e.g. {PackagePath:anytool} -> replace with path to 'anytool' package).
+        /// </summary>
+        /// <param name="cancellationToken">A token that can be used to cancel the operations.</param>
+        /// <param name="force">Forces the evaluation of the parameters for scenarios where re-evaluation is necessary after an initial pass. Default = false.</param>
+        public async Task EvaluateParametersAsync(CancellationToken cancellationToken, bool force = false)
+        {
+            if (!this.ParametersEvaluated || force)
+            {
+                if (this.Parameters?.Any() == true)
+                {
+                    if (this.Dependencies.TryGetService<IExpressionEvaluator>(out IExpressionEvaluator evaluator))
+                    {
+                        await evaluator.EvaluateAsync(this.Dependencies, this.Parameters, cancellationToken);
+                    }
+                }
+
+                this.ParametersEvaluated = true;
+            }
+        }
+
         /// <summary>
         /// When overriden in a derived class, executes the component logic.
         /// </summary>

src/VirtualClient/VirtualClient.Contracts/VirtualClientComponentExtensions.cs

@@ -220,31 +220,6 @@ public static IEnumerable<FileUploadDescriptor> CreateFileUploadDescriptors(this
             return descriptors;
         }
 
-        /// <summary>
-        /// Evaluates each of the parameters provided to the component to replace
-        /// supported placeholder expressions (e.g. {PackagePath:anytool} -> replace with path to 'anytool' package).
-        /// </summary>
-        /// <param name="component">The component whose parameters to evaluate.</param>
-        /// <param name="cancellationToken">A token that can be used to cancel the operations.</param>
-        /// <param name="force">Forces the evaluation of the parameters for scenarios where re-evaluation is necessary after an initial pass. Default = false.</param>
-        public static async Task EvaluateParametersAsync(this VirtualClientComponent component, CancellationToken cancellationToken, bool force = false)
-        {
-            component.ThrowIfNull(nameof(component));
-
-            if (!component.ParametersEvaluated || force)
-            {
-                if (component.Parameters?.Any() == true)
-                {
-                    if (component.Dependencies.TryGetService<IExpressionEvaluator>(out IExpressionEvaluator evaluator))
-                    {
-                        await evaluator.EvaluateAsync(component.Dependencies, component.Parameters, cancellationToken);
-                    }
-                }
-
-                component.ParametersEvaluated = true;
-            }
-        }
-
         /// <summary>
         /// Returns the client instance defined in the environment layout provided to the Virtual Client
         /// whose ID matches.