add stateDir in profile expression evaluators (#643)

Co-authored-by: Aditya Abhishek <adityaa@microsoft.com>

Author: imadityaa

VERSION

@@ -1 +1 @@
-2.1.55
+2.1.56

src/VirtualClient/VirtualClient.Core.UnitTests/ProfileExpressionEvaluatorTests.cs

@@ -99,6 +99,75 @@ public async Task ProfileExpressionEvaluatorLogPathLocationReferenceExpressionsA
             }
         }
 
+        [Test]
+        public async Task ProfileExpressionEvaluatorSupportsWellKnownExpressionStatePathReferencesOnUnixSystems()
+        {
+            this.SetupDefaults(PlatformID.Unix);
+            string stateDirectory = this.mockFixture.GetStatePath();
+            string stateFilePath = this.mockFixture.GetStatePath("anylogs", "file1.log");
+
+            Dictionary<string, string> expressions = new Dictionary<string, string>
+            {
+                { "{StatePath}", stateDirectory },
+                { "{StateDir}", stateDirectory },
+                { "--any-path={StatePath}/anylogs/file1.log", $"--any-path={stateFilePath}" },
+                { "--any-path={StateDir}/anylogs/file1.log", $"--any-path={stateFilePath}" }
+            };
+
+            foreach (var entry in expressions)
+            {
+                string expectedExpression = entry.Value;
+                string actualExpression = await ProfileExpressionEvaluator.Instance.EvaluateAsync(this.mockFixture.Dependencies, entry.Key);
+                Assert.AreEqual(expectedExpression, actualExpression);
+            }
+        }
+
+        [Test]
+        public async Task ProfileExpressionEvaluatorSupportsWellKnownExpressionStatePathReferencesOnWindowsSystems()
+        {
+            this.SetupDefaults(PlatformID.Win32NT);
+            string stateDirectory = this.mockFixture.GetStatePath();
+            string stateFilePath = this.mockFixture.GetStatePath("anylogs", "file1.log");
+
+            Dictionary<string, string> expressions = new Dictionary<string, string>
+            {
+                { "{StatePath}", stateDirectory },
+                { "{StateDir}", stateDirectory },
+                { "--any-path={StatePath}/anylogs/file1.log", $"--any-path={stateFilePath}" },
+                { "--any-path={StateDir}/anylogs/file1.log", $"--any-path={stateFilePath}" }
+            };
+
+            foreach (var entry in expressions)
+            {
+                string expectedExpression = entry.Value;
+                string actualExpression = await ProfileExpressionEvaluator.Instance.EvaluateAsync(this.mockFixture.Dependencies, entry.Key);
+                Assert.AreEqual(expectedExpression, actualExpression);
+            }
+        }
+
+        [Test]
+        public async Task ProfileExpressionEvaluatorStatePathLocationReferenceExpressionsAreNotCaseSensitive()
+        {
+            this.SetupDefaults(PlatformID.Unix);
+            string stateDirectory = this.mockFixture.GetStatePath();
+
+            Dictionary<string, string> expressions = new Dictionary<string, string>
+            {
+                { "{StatePath}", stateDirectory },
+                { "{statepath}", stateDirectory },
+                { "{statedir}", stateDirectory },
+                { "{STATEPATH}", stateDirectory },
+                { "{STATEDIR}", stateDirectory }
+            };
+
+            foreach (var entry in expressions)
+            {
+                string expectedExpression = entry.Value;
+                string actualExpression = await ProfileExpressionEvaluator.Instance.EvaluateAsync(this.mockFixture.Dependencies, entry.Key);
+                Assert.AreEqual(expectedExpression, actualExpression);
+            }
+        }
+
         [Test]
         public async Task ProfileExpressionEvaluatorSupportsWellKnownExpressionTempPathReferencesOnUnixSystems()
         {

src/VirtualClient/VirtualClient.Core/ProfileExpressionEvaluator.cs

@@ -61,6 +61,12 @@ public class ProfileExpressionEvaluator : IExpressionEvaluator
             @"\{(?:PackagePath|PackageDir)/Platform\:([a-z0-9-_\. ]+)\}",
             RegexOptions.Compiled | RegexOptions.IgnoreCase);
 
+        // e.g.
+        // {StatePath}, {StateDir}
+        private static readonly Regex StatePathExpression = new Regex(
+            @"\{(?:StatePath|StateDir)\}",
+            RegexOptions.Compiled | RegexOptions.IgnoreCase);
+
         // e.g.
         // {TempPath}, {TempDir}
         private static readonly Regex TempPathExpression = new Regex(
@@ -154,6 +160,30 @@ public class ProfileExpressionEvaluator : IExpressionEvaluator
                     Outcome = evaluatedExpression
                 });
             }),
+            // Expression: {StatePath|StateDir}
+            // Resolves to the path to the state folder location (e.g. /home/users/virtualclient/state).
+            new Func<IServiceCollection, IDictionary<string, IConvertible>, string, Task<EvaluationResult>>((dependencies, parameters, expression) =>
+            {
+                bool isMatched = false;
+                string evaluatedExpression = expression;
+                MatchCollection matches = ProfileExpressionEvaluator.StatePathExpression.Matches(expression);
+
+                if (matches?.Any() == true)
+                {
+                    isMatched = true;
+                    PlatformSpecifics platformSpecifics = dependencies.GetService<PlatformSpecifics>();
+                    foreach (Match match in matches)
+                    {
+                        evaluatedExpression = Regex.Replace(evaluatedExpression, match.Value, platformSpecifics.StateDirectory);
+                    }
+                }
+
+                return Task.FromResult(new EvaluationResult
+                {
+                    IsMatched = isMatched,
+                    Outcome = evaluatedExpression
+                });
+            }),
             // Expression: {OS}
             // Resolves to the current operating system (e.g. linux, windows).
             new Func<IServiceCollection, IDictionary<string, IConvertible>, string, Task<EvaluationResult>>((dependencies, parameters, expression) =>