Updates to the DevOps processes.

Author: mark-abrams

.azure-devops/pipelines/build.yml

@@ -1,26 +1,35 @@
-# Enable the pipeline trigger when any specified branch has changed
-trigger:
-  batch: true
-  branches:
-    include:
-    - main
-    - features/*
-
-# Enable the pipeline trigger when new PR is created
-pr:
-  autoCancel: true
-  branches:
-    include:
-    - main
-
-pool:
-  vmImage: ubuntu-latest
+# Manual trigger only
+trigger: none
+
+parameters:
+- name: buildConfiguration
+  displayName: 'Build configuration'
+  type: string
+  default: Debug
+  values:
+    - Debug
+    - Release
 
 jobs:
 - job: build
   displayName: 'Build'
   timeoutInMinutes: 20
 
+  strategy:
+    matrix:
+      Linux:
+        imageName: 'ubuntu-latest'
+        matrixName: Linux
+      Windows:
+        imageName: 'windows-latest'
+        matrixName: Windows
+      #Mac:
+      #  imageName: 'macOS-latest'
+      #  matrixName: Mac
+
+  pool:
+    vmImage: $(imageName)
+
   steps:
 
     # Build .NET solution
@@ -40,10 +49,10 @@ jobs:
         projects: '$(System.DefaultWorkingDirectory)/**/*.csproj'
 
     - task: DotNetCoreCLI@2
-      displayName: 'Build'
+      displayName: 'Build (${{ parameters.buildConfiguration }})'
       inputs:
         command: build
-        arguments: '--no-restore'
+        arguments: '--no-restore --configuration ${{ parameters.buildConfiguration }}'
         projects: '$(System.DefaultWorkingDirectory)/**/*.csproj'
 
     # Install and configure Logic Apps runtime environment
@@ -58,29 +67,53 @@ jobs:
       inputs:
         version: 'latest'
 
+    # - task: Npm@1
+    #   displayName: 'Install Functions core tools (npm install)'
+    #   inputs:
+    #     command: 'custom'
+    #     customCommand: 'install -g azure-functions-core-tools@4 --unsafe-perm true'
+
     - task: CmdLine@2
       displayName: 'Check Functions Core tools installation'
       inputs:
         script: func
-    
+
     - task: Npm@1
       displayName: 'Install Azurite'
       inputs:
         command: 'custom'
         customCommand: 'install -g azurite@3.24.0'
 
     - task: CmdLine@2
-      displayName: 'Start Azurite services'
+      displayName: 'Start Azurite services (not Windows)'
+      condition: and(succeeded(), ne(variables.matrixName, 'Windows'))
       inputs:
         script: 'azurite &'
 
+    - task: CmdLine@2
+      displayName: 'Start Azurite services (Windows)'
+      condition: and(succeeded(), eq(variables.matrixName, 'Windows'))
+      inputs:
+        script: 'start /b azurite'
+
     # Run tests and publish test results to Azure DevOps
 
     - task: DotNetCoreCLI@2
-      continueOnError: true
       displayName: 'Run tests'
+      continueOnError: true
       inputs:
         command: test
-        arguments: '--no-restore --verbosity normal'
+        arguments: '--no-restore --verbosity normal --configuration ${{ parameters.buildConfiguration }}'
         projects: '$(System.DefaultWorkingDirectory)/**/*.Tests.csproj'
         publishTestResults: true
+        testRunTitle: 'Tests ($(matrixName))'
+
+    # Publish NuGet package
+
+    - task: PublishPipelineArtifact@1
+      displayName: 'Publish NuGet package (Release build only)'
+      condition: and(succeeded(), eq('${{ parameters.buildConfiguration }}', 'Release'))
+      inputs:
+        targetPath: '$(System.DefaultWorkingDirectory)/LogicAppUnit/bin/${{ parameters.buildConfiguration }}'
+        artifact: 'NuGetPackage-$(matrixName)'
+        publishLocation: 'pipeline'

.github/workflows/build.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
     - main
-    - automated_build
     - 'features/**'
   pull_request:
     branches:
@@ -14,7 +13,12 @@ on:
 jobs:
 
   Build:
-    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+    
+    runs-on: ${{ matrix.os }}
 
     steps:
     - name: Checkout
@@ -43,6 +47,11 @@ jobs:
     - name: Install Functions Core tools
       run: 'npm install -g azure-functions-core-tools@4 --unsafe-perm true'
 
+    - name: Set Functions Core tools path (Windows only)
+      if: matrix.os == 'windows-latest'
+      run: 'setx /m Path "C:\npm\prefix\node_modules\azure-functions-core-tools\bin;%Path%"'
+      shell: cmd
+
     - name: Check Functions Core tools installation
       run: 'func'
 
@@ -51,25 +60,27 @@ jobs:
 
     - name: Start Azurite services
       run: 'azurite &'
+      shell: bash
 
     # Run tests
 
     - name: Run tests
-      run: dotnet test --no-restore --verbosity normal --logger "TRX"
+      run: dotnet test --no-restore --verbosity normal --logger "trx"
 
     # Publish artefacts and test results
 
     - name: Publish test log
       uses: actions/upload-artifact@v3
-      if: always()
+      if: success() || failure()
       with:
-        name: test-results
-        path: ${{ github.workspace }}/LogicAppUnit.Samples.LogicApps.Tests/TestResults/**.trx
+        name: test-results.${{ matrix.os }}
+        path: ${{ github.workspace }}/LogicAppUnit.Samples.LogicApps.Tests/TestResults/*.trx
 
     - name: Publish test results
+      if: (success() || failure()) && github.event_name != 'pull_request'
       uses: dorny/test-reporter@v1
-      if: always()
       with:
-        name: Test Results
-        path: ${{ github.workspace }}/LogicAppUnit.Samples.LogicApps.Tests/TestResults/**.trx
+        name: Test Results (${{ matrix.os }})
+        path: ${{ github.workspace }}/LogicAppUnit.Samples.LogicApps.Tests/TestResults/*.trx
+        path-replace-backslashes: true
         reporter: dotnet-trx

LogicAppUnit/Hosting/WorkflowTestHost.cs

@@ -1,20 +1,19 @@
-// Copyright (c) .NET Foundation. All rights reserved.
-// Licensed under the MIT License. See License.txt in the project root for license information.
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
 
 namespace LogicAppUnit.Hosting
 {
-    using System;
-    using System.Collections.Generic;
-    using System.Diagnostics;
-    using System.IO;
-    using System.Linq;
-    using System.Threading.Tasks;
-
     /// <summary>
     /// The function test host.
     /// </summary>
     internal class WorkflowTestHost : IDisposable
     {
+        private const string FunctionsExecutableName = "func";
+
         /// <summary>
         /// Get or sets the output data.
         /// </summary>
@@ -127,12 +126,12 @@ protected void StartFunctionRuntime(WorkflowTestInput[] inputs, string localSett
                         RedirectStandardOutput = true,
                         RedirectStandardError = true,
                         UseShellExecute = false,
-                        CreateNoWindow = true,
+                        CreateNoWindow = true
                     }
                 };
 
+                // Hook up an event handler for the Standard Output stream
                 var processStarted = new TaskCompletionSource<bool>();
-
                 this.Process.OutputDataReceived += (sender, args) =>
                 {
                     var outputData = args.Data;
@@ -153,6 +152,7 @@ protected void StartFunctionRuntime(WorkflowTestInput[] inputs, string localSett
                     }
                 };
 
+                // Hook up an event handler for the Standard Error stream
                 var errorData = string.Empty;
                 this.Process.ErrorDataReceived += (sender, args) =>
                 {
@@ -165,11 +165,12 @@ protected void StartFunctionRuntime(WorkflowTestInput[] inputs, string localSett
                     }
                 };
 
+                // Start the Functions Core Tools process
                 this.Process.Start();
-
                 this.Process.BeginOutputReadLine();
                 this.Process.BeginErrorReadLine();
 
+                // Wait for the Functions runtime to start, or timeout after 2 minutes
                 var result = Task.WhenAny(processStarted.Task, Task.Delay(TimeSpan.FromMinutes(2))).Result;
 
                 if (result != processStarted.Task)
@@ -200,15 +201,15 @@ protected void StartFunctionRuntime(WorkflowTestInput[] inputs, string localSett
         /// </summary>
         private static void KillFunctionHostProcesses()
         {
-            Process[] processes = Process.GetProcessesByName("func");
+            Process[] processes = Process.GetProcessesByName(FunctionsExecutableName);
             foreach (var process in processes)
             {
                 process.Kill(true);
             }
         }
 
         /// <summary>
-        /// Retrieve the path of the 'func' executable (Azure Function core tools). 
+        /// Retrieve the path of the 'func' executable (Azure Functions Core tools). 
         /// </summary>
         /// <returns>The path to the 'func' executable.</returns>
         /// <exception cref="Exception">Thrown when the location of the 'func' executable could not be found.</exception>
@@ -220,24 +221,30 @@ private static string GetEnvPathForFunctionTools()
             // Handle the differences between platforms
             if (OperatingSystem.IsWindows())
             {
-                enviromentPath = Environment.GetEnvironmentVariable("PATH", EnvironmentVariableTarget.Process);
-                exeName = "func.exe";
+                // The path to the 'func' executable can be in any of the environment variable scopes, depending on how the Functions Core Tools were installed.
+                // If a DevOps build pipeline has updated the PATH environment variable for the 'Machine' or 'User' scopes, the 'Process' scope is not automatically updated to reflect the change.
+                // So merge all three scopes to be sure!
+                environmentPath = Environment.GetEnvironmentVariable("PATH", EnvironmentVariableTarget.Process) + Path.PathSeparator + 
+                                    Environment.GetEnvironmentVariable("PATH", EnvironmentVariableTarget.User) + Path.PathSeparator +
+                                    Environment.GetEnvironmentVariable("PATH", EnvironmentVariableTarget.Machine);
+                exeName = $"{FunctionsExecutableName}.exe";
             }
             else
             {
                 environmentPath = Environment.GetEnvironmentVariable("PATH");
-                exeName = "func";
+                exeName = FunctionsExecutableName;
             }
 
-            string exePath = environmentPath.Split(Path.PathSeparator).Select(x => Path.Combine(x, exeName)).Where(x => File.Exists(x)).FirstOrDefault();
-            if (!string.IsNullOrWhiteSpace(exePath))
+            var exePaths = environmentPath.Split(Path.PathSeparator).Distinct().Select(x => Path.Combine(x, exeName));
+            string exePathMatch = exePaths.Where(x => File.Exists(x)).FirstOrDefault();
+            if (!string.IsNullOrWhiteSpace(exePathMatch))
             {
-                Console.WriteLine($"Path for Azure Function Core tools: {exePath}");
-                return exePath;
+                Console.WriteLine($"Path for Azure Function Core tools: {exePathMatch}");
+                return exePathMatch;
             }
             else
             {
-                throw new Exception("The enviroment variable PATH does not include the path for the 'func' executable.");
+                throw new TestException($"The enviroment variable PATH does not include the path for the '{FunctionsExecutableName}' executable. Searched: {string.Join(Path.PathSeparator, exePaths)}");
             }
         }