add unit tests

Author: TylerLeonhardt

src/PowerShell/PowerShellManager.cs

@@ -29,7 +29,7 @@ internal class PowerShellManager
 
         // The path to the FunctionApp root. This is set at the first FunctionLoad message
         //and used for determining the path to the 'Profile.ps1' and 'Modules' folder.
-        internal string FunctionAppRootLocation { get; set; }
+        internal string FunctionAppRootLocation { get; set; } = AppDomain.CurrentDomain.BaseDirectory;
 
         internal PowerShellManager(ILogger logger)
         {
@@ -55,6 +55,16 @@ internal PowerShellManager(ILogger logger)
             _pwsh.Streams.Warning.DataAdding += streamHandler.WarningDataAdding;
         }
 
+        internal void InitializeRunspace()
+        {
+            // Add HttpResponseContext namespace so users can reference
+            // HttpResponseContext without needing to specify the full namespace
+            _pwsh.AddScript($"using namespace {typeof(HttpResponseContext).Namespace}").InvokeAndClearCommands();
+
+            // Set the PSModulePath
+            Environment.SetEnvironmentVariable("PSModulePath", Path.Join(AppDomain.CurrentDomain.BaseDirectory, "Modules"));
+        }
+
         internal void InvokeProfile()
         {
             IEnumerable<string> profiles = Directory.EnumerateFiles(FunctionAppRootLocation, PROFILE_FILENAME);
@@ -65,13 +75,27 @@ internal void InvokeProfile()
             }
 
             var dotSourced = new StringBuilder(". ").Append(QuoteEscapeString(profiles.First()));
-            _pwsh.AddScript(dotSourced.ToString()).InvokeAndClearCommands();
+            
+            try
+            {
+                _pwsh.AddScript(dotSourced.ToString()).InvokeAndClearCommands();
+            }
+            catch (RuntimeException e)
+            {
+                _logger.Log(
+                    LogLevel.Error,
+                    $"Invoking the Profile had errors. See logs for details. Profile location: {FunctionAppRootLocation}",
+                    e,
+                    isUserLog: true);
+                throw;
+            }
 
             if (_pwsh.HadErrors)
             {
-                var logMessage = $"Invoking the Profile had errors. See logs for details. Profile location: {FunctionAppRootLocation}";
-                _logger.Log(LogLevel.Error, logMessage, isUserLog: true);
-                throw new InvalidOperationException(logMessage);
+                _logger.Log(
+                    LogLevel.Error,
+                    $"Invoking the Profile had errors. See logs for details. Profile location: {FunctionAppRootLocation}",
+                    isUserLog: true);
             }
         }
 
@@ -105,16 +129,6 @@ private static StringBuilder QuoteEscapeString(string path)
             return sb;
         }
 
-        internal void InitializeRunspace()
-        {
-            // Add HttpResponseContext namespace so users can reference
-            // HttpResponseContext without needing to specify the full namespace
-            _pwsh.AddScript($"using namespace {typeof(HttpResponseContext).Namespace}").InvokeAndClearCommands();
-
-            // Set the PSModulePath
-            Environment.SetEnvironmentVariable("PSModulePath", Path.Join(AppDomain.CurrentDomain.BaseDirectory, "Modules"));
-        }
-
         /// <summary>
         /// Execution a function fired by a trigger or an activity function scheduled by an orchestration.
         /// </summary>

test/Microsoft.Azure.Functions.PowerShellWorker.Test.csproj

@@ -31,5 +31,14 @@
     <Content Include="Unit\PowerShell\TestScripts\testFunctionCleanup.ps1">
       <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
     </Content>
+    <Content Include="Unit\PowerShell\TestScripts\ProfileBasic\Profile.ps1">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+    <Content Include="Unit\PowerShell\TestScripts\ProfileWithTerminatingError\Profile.ps1">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
+    <Content Include="Unit\PowerShell\TestScripts\ProfileWithNonTerminatingError\Profile.ps1">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </Content>
   </ItemGroup>
 </Project>

test/Unit/PowerShell/PowerShellManagerTests.cs

@@ -6,7 +6,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
-
+using System.Management.Automation;
 using Microsoft.Azure.Functions.PowerShellWorker.PowerShell;
 using Microsoft.Azure.WebJobs.Script.Grpc.Messages;
 using Xunit;
@@ -159,5 +159,63 @@ public void RegisterAndUnregisterFunctionMetadataShouldWork()
             manager.UnregisterFunctionMetadata();
             Assert.Empty(FunctionMetadata.OutputBindingCache);
         }
+
+        [Fact]
+        public void ProfileShouldWork()
+        {
+            var logger = new ConsoleLogger();
+            var manager = new PowerShellManager(logger);
+            manager.FunctionAppRootLocation = System.IO.Path.Join(
+                AppDomain.CurrentDomain.BaseDirectory,
+                "Unit/PowerShell/TestScripts/ProfileBasic");
+            
+            manager.InvokeProfile();
+
+            Assert.Single(logger.FullLog);
+            Assert.Equal("Information: INFORMATION: Hello PROFILE", logger.FullLog[0]);
+        }
+
+        [Fact]
+        public void ProfileDoesNotExist()
+        {
+            var logger = new ConsoleLogger();
+            var manager = new PowerShellManager(logger);
+            manager.FunctionAppRootLocation = AppDomain.CurrentDomain.BaseDirectory;
+            
+            manager.InvokeProfile();
+
+            Assert.Single(logger.FullLog);
+            Assert.Matches("Trace: No 'Profile.ps1' found at: ", logger.FullLog[0]);
+        }
+
+        [Fact]
+        public void ProfileWithTerminatingError()
+        {
+            var logger = new ConsoleLogger();
+            var manager = new PowerShellManager(logger);
+            manager.FunctionAppRootLocation = System.IO.Path.Join(
+                AppDomain.CurrentDomain.BaseDirectory,
+                "Unit/PowerShell/TestScripts/ProfileWithTerminatingError");
+            
+            Assert.Throws(typeof(RuntimeException), () => manager.InvokeProfile());
+            Assert.Single(logger.FullLog);
+            Assert.Matches("Error: Invoking the Profile had errors. See logs for details. Profile location: ", logger.FullLog[0]);
+        }
+
+        [Fact]
+        public void ProfileWithNonTerminatingError()
+        {
+            var logger = new ConsoleLogger();
+            var manager = new PowerShellManager(logger);
+            manager.FunctionAppRootLocation = System.IO.Path.Join(
+                AppDomain.CurrentDomain.BaseDirectory,
+                "Unit/PowerShell/TestScripts/ProfileWithNonTerminatingError");
+            
+            manager.InvokeProfile();
+
+            Assert.Equal(2, logger.FullLog.Count);
+            Assert.Equal("Error: ERROR: help me!", logger.FullLog[0]);
+            Assert.Matches("Error: Invoking the Profile had errors. See logs for details. Profile location: ", logger.FullLog[1]);
+        }
     }
 }

test/Unit/PowerShell/TestScripts/ProfileBasic/profile.ps1

@@ -0,0 +1 @@
+Write-Host "Hello PROFILE"

test/Unit/PowerShell/TestScripts/ProfileWithNonTerminatingError/Profile.ps1

@@ -0,0 +1 @@
+Write-Error "help me!"

test/Unit/PowerShell/TestScripts/ProfileWithTerminatingError/profile.ps1

@@ -0,0 +1 @@
+throw "help me!"