Hotfix. Remove extra whitespace from commands when using chaining for ExecuteCommand and ExecuteCommandMonitor components. (#564)

Author: brdeyo

VERSION

@@ -1 +1 @@
-2.1.14
+2.1.15

src/VirtualClient/VirtualClient.Dependencies.UnitTests/ExecuteCommandTests.cs

@@ -103,6 +103,36 @@ public async Task ExecuteCommandSupportsCommandChainingOnUnixSystems(string full
             }
         }
 
+        [Test]
+        [TestCase(
+            "sudo dmesg && sudo lsblk && sudo mount && sudo df -h && sudo find /sys -name scheduler -print",
+            "sudo dmesg;sudo lsblk;sudo mount;sudo df -h;sudo find /sys -name scheduler -print")]
+        public async Task ExecuteCommandSupportsCommandChainingOnUnixSystems_Bug_1(string fullCommand, string expectedCommandExecuted)
+        {
+            // Bug Scenario:
+            // Spaces (whitespace) in the commands due to the chaining SHOULD NOT cause
+            // parsing issues.
+            //
+            // e.g.
+            // "sudo dmesg && sudo lsblk " resulting in the command being identified as "sudo o lsblk"
+
+            this.SetupDefaults(PlatformID.Unix);
+
+            using (TestExecuteCommand command = new TestExecuteCommand(this.mockFixture))
+            {
+                command.Parameters[nameof(ExecuteCommand.Command)] = fullCommand;
+                List<string> expectedCommands = new List<string>(expectedCommandExecuted.Split(';'));
+
+                this.mockFixture.ProcessManager.OnProcessCreated = (process) =>
+                {
+                    expectedCommands.Remove(process.FullCommand());
+                };
+
+                await command.ExecuteAsync(CancellationToken.None);
+                Assert.IsEmpty(expectedCommands);
+            }
+        }
+
         [Test]
         [TestCase("C:\\\\Users\\User\\anycommand&&C:\\\\home\\user\\anyothercommand", "C:\\\\Users\\User\\anycommand;C:\\\\home\\user\\anyothercommand")]
         [TestCase("C:\\\\Users\\User\\anycommand --argument=1&&C:\\\\home\\user\\anyothercommand --argument=2", "C:\\\\Users\\User\\anycommand --argument=1;C:\\\\home\\user\\anyothercommand --argument=2")]

src/VirtualClient/VirtualClient.Dependencies/ExecuteCommand.cs

@@ -188,7 +188,7 @@ private IEnumerable<string> GetCommandsToExecute()
             List<string> commandsToExecute = new List<string>();
             bool sudo = this.Command.StartsWith("sudo", StringComparison.OrdinalIgnoreCase);
 
-            IEnumerable<string> commands = this.Command.Split("&&", StringSplitOptions.RemoveEmptyEntries & StringSplitOptions.TrimEntries);
+            IEnumerable<string> commands = this.Command.Split("&&", StringSplitOptions.RemoveEmptyEntries)?.Select(cmd => cmd.Trim());
 
             foreach (string fullCommand in commands)
             {

src/VirtualClient/VirtualClient.Main/ExecuteProfileCommand.cs

@@ -427,8 +427,11 @@ protected async Task<EnvironmentLayout> ReadEnvironmentLayoutAsync(IServiceColle
                             $"Invalid path specified. An environment layout file does not exist at path '{layoutFullPath}'.");
                     }
 
-                    string layoutContent = await systemManagement.FileSystem.File.ReadAllTextAsync(layoutFullPath)
-                        .ConfigureAwait(false);
+                    string layoutContent = await RetryPolicies.FileOperations
+                        .ExecuteAsync(() =>
+                        {
+                             return systemManagement.FileSystem.File.ReadAllTextAsync(layoutFullPath);
+                        });
 
                     layout = layoutContent.FromJson<EnvironmentLayout>();
                 }

src/VirtualClient/VirtualClient.Monitors.UnitTests/ExecuteCommandMonitorTests.cs

@@ -103,6 +103,36 @@ public async Task ExecuteCommandMonitorSupportsCommandChaining(string originalCo
             }
         }
 
+        [Test]
+        [TestCase(
+           "sudo dmesg && sudo lsblk && sudo mount && sudo df -h && sudo find /sys -name scheduler -print",
+           "sudo dmesg;sudo lsblk;sudo mount;sudo df -h;sudo find /sys -name scheduler -print")]
+        public async Task ExecuteCommandMonitorSupportsCommandChainingOnUnixSystems_Bug_1(string fullCommand, string expectedCommandExecuted)
+        {
+            // Bug Scenario:
+            // Spaces (whitespace) in the commands due to the chaining SHOULD NOT cause
+            // parsing issues.
+            //
+            // e.g.
+            // "sudo dmesg && sudo lsblk " resulting in the command being identified as "sudo o lsblk"
+
+            this.SetupDefaults(PlatformID.Unix);
+            List<string> commandsExecuted = new List<string>(expectedCommandExecuted.Split(";"));
+
+            using (TestExecuteCommandMonitor monitor = new TestExecuteCommandMonitor(this))
+            {
+                monitor.Parameters[nameof(ExecuteCommandMonitor.Command)] = fullCommand;
+
+                this.ProcessManager.OnProcessCreated = (process) =>
+                {
+                    commandsExecuted.Remove(process.FullCommand());
+                };
+
+                await monitor.ExecuteCommandAsync(EventContext.None, CancellationToken.None);
+                Assert.IsEmpty(commandsExecuted);
+            }
+        }
+
         [Test]
         [TestCase("C:\\\\Users\\User\\anycommand&&C:\\\\home\\user\\anyothercommand", "C:\\\\Users\\User\\anycommand;C:\\\\home\\user\\anyothercommand")]
         [TestCase("C:\\\\Users\\User\\anycommand --argument=1&&C:\\\\home\\user\\anyothercommand --argument=2", "C:\\\\Users\\User\\anycommand --argument=1;C:\\\\home\\user\\anyothercommand --argument=2")]

src/VirtualClient/VirtualClient.Monitors/ExecuteCommandMonitor.cs

@@ -357,7 +357,7 @@ private IEnumerable<string> GetCommandsToExecute()
             List<string> commandsToExecute = new List<string>();
             bool sudo = this.Command.StartsWith("sudo", StringComparison.OrdinalIgnoreCase);
 
-            IEnumerable<string> commands = this.Command.Split("&&", StringSplitOptions.RemoveEmptyEntries & StringSplitOptions.TrimEntries);
+            IEnumerable<string> commands = this.Command.Split("&&", StringSplitOptions.RemoveEmptyEntries)?.Select(cmd => cmd.Trim());
 
             foreach (string fullCommand in commands)
             {