Changes for 1.9.0.

Author: LogicAppUnit

.azure-devops/pipelines/build.yml

@@ -47,14 +47,14 @@ jobs:
       inputs:
         command: restore
         verbosityRestore: Normal
-        projects: '$(System.DefaultWorkingDirectory)/**/*.csproj'
+        projects: '$(System.DefaultWorkingDirectory)/src/LogicAppUnit.sln'
 
     - task: DotNetCoreCLI@2
       displayName: 'Build (${{ parameters.buildConfiguration }})'
       inputs:
         command: build
         arguments: '--no-restore --configuration ${{ parameters.buildConfiguration }}'
-        projects: '$(System.DefaultWorkingDirectory)/**/*.csproj'
+        projects: '$(System.DefaultWorkingDirectory)/src/LogicAppUnit.sln'
 
     # Install and configure Logic Apps runtime environment
 
@@ -94,12 +94,24 @@ jobs:
     # Run tests and publish test results to Azure DevOps
 
     - task: DotNetCoreCLI@2
-      displayName: 'Run tests'
+      displayName: 'Run tests (not Windows)'
+      condition: and(succeeded(), ne(variables.matrixName, 'Windows'))
+      continueOnError: true
+      inputs:
+        command: test
+        arguments: '--no-restore --verbosity normal --configuration ${{ parameters.buildConfiguration }} --filter TestCategory!="WindowsOnly"'
+        projects: '$(System.DefaultWorkingDirectory)/src/LogicAppUnit.sln'
+        publishTestResults: true
+        testRunTitle: 'Tests ($(matrixName))'
+
+    - task: DotNetCoreCLI@2
+      displayName: 'Run tests (Windows)'
+      condition: and(succeeded(), eq(variables.matrixName, 'Windows'))
       continueOnError: true
       inputs:
         command: test
         arguments: '--no-restore --verbosity normal --configuration ${{ parameters.buildConfiguration }}'
-        projects: '$(System.DefaultWorkingDirectory)/**/*.Tests.csproj'
+        projects: '$(System.DefaultWorkingDirectory)/src/LogicAppUnit.sln'
         publishTestResults: true
         testRunTitle: 'Tests ($(matrixName))'
 
@@ -109,6 +121,6 @@ jobs:
       displayName: 'Publish NuGet package (Release build only)'
       condition: and(succeeded(), eq('${{ parameters.buildConfiguration }}', 'Release'))
       inputs:
-        targetPath: '$(System.DefaultWorkingDirectory)/LogicAppUnit/bin/${{ parameters.buildConfiguration }}'
+        targetPath: '$(System.DefaultWorkingDirectory)/src/LogicAppUnit/bin/${{ parameters.buildConfiguration }}'
         artifact: 'NuGetPackage-$(matrixName)'
         publishLocation: 'pipeline'

.github/workflows/build.yml

@@ -32,10 +32,10 @@ jobs:
         dotnet-version: 6.0.x
 
     - name: Restore dependencies
-      run: dotnet restore
+      run: dotnet restore ${{ github.workspace }}/src/LogicAppUnit.sln
 
     - name: Build
-      run: dotnet build --no-restore
+      run: dotnet build ${{ github.workspace }}/src/LogicAppUnit.sln --no-restore
 
     # Install and configure Logic Apps runtime environment
 
@@ -65,7 +65,12 @@ jobs:
     # Run tests
 
     - name: Run tests
-      run: dotnet test --no-restore --verbosity normal --logger "trx"
+      if: success() && matrix.os != 'windows-latest'
+      run: dotnet test ${{ github.workspace }}/src/LogicAppUnit.sln --no-restore --verbosity normal --logger "trx" --filter TestCategory!="WindowsOnly"
+
+    - name: Run tests
+      if: success() && matrix.os == 'windows-latest'
+      run: dotnet test ${{ github.workspace }}/src/LogicAppUnit.sln --no-restore --verbosity normal --logger "trx"
 
     # Publish artefacts and test results
 
@@ -74,13 +79,13 @@ jobs:
       if: success() || failure()
       with:
         name: test-results.${{ matrix.os }}
-        path: ${{ github.workspace }}/LogicAppUnit.Samples.LogicApps.Tests/TestResults/*.trx
+        path: ${{ github.workspace }}/src/LogicAppUnit.Samples.LogicApps.Tests/TestResults/*.trx
 
     - name: Publish test results
       if: (success() || failure()) && github.event_name != 'pull_request'
       uses: dorny/test-reporter@v1
       with:
         name: Test Results (${{ matrix.os }})
-        path: ${{ github.workspace }}/LogicAppUnit.Samples.LogicApps.Tests/TestResults/*.trx
+        path: ${{ github.workspace }}/src/LogicAppUnit.Samples.LogicApps.Tests/TestResults/*.trx
         path-replace-backslashes: true
         reporter: dotnet-trx

.gitignore

@@ -23,6 +23,7 @@ mono_crash.*
 [Rr]eleases/
 x64/
 x86/
+[Ww][Ii][Nn]32/
 [Aa][Rr][Mm]/
 [Aa][Rr][Mm]64/
 bld/
@@ -61,6 +62,9 @@ project.lock.json
 project.fragment.lock.json
 artifacts/
 
+# ASP.NET Scaffolding
+ScaffoldingReadMe.txt
+
 # StyleCop
 StyleCopReport.xml
 
@@ -137,6 +141,11 @@ _TeamCity*
 .axoCover/*
 !.axoCover/settings.json
 
+# Coverlet is a free, cross platform Code Coverage Tool
+coverage*.json
+coverage*.xml
+coverage*.info
+
 # Visual Studio code coverage results
 *.coverage
 *.coveragexml
@@ -348,3 +357,6 @@ MigrationBackup/
 
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
+
+# Fody - auto-generated XML schema
+FodyWeavers.xsd

ChangeLog.md

@@ -1,8 +1,27 @@
+# 1.9.0 (23rd January 2024)
+
+LogicAppUnit Testing Framework:
+
+- Improved the logging when using the Fluent API to match requests based on request headers or query parameters. When the actual and expected header or query parameter values do not match, both values are logged to make it easier to diagnose any test issues. Previous versions of the framework logged the match failure but did not log the actual and expected values.
+- Added `IMockRequestMatcher.FromAction(string[] actionNames)` to allow a mock request matcher to match a request based on the name of the workflow action that created the request. This feature depends on the `x-ms-workflow-operation-name` header being present in the request. Refer to the [wiki](https://github.com/LogicAppUnit/TestingFramework/wiki) for details of when the Logic App runtime creates this header.
+- Retry policies for actions using a managed API connection are removed and replaced with a `none` policy. This is the same pre-processing that is applied to HTTP actions. Previous versions of the framework did not remove the retry policies for actions using a managed API connection which meant that tests could take a long time to complete if they were testing failure scenarios.
+- The framework checks the `connections.json` file and will fail a test if there are any managed API connections that are configured using the `ManagedServiceIdentity` authentication type. The Logic Apps runtime only supports the `Raw`
+ and `ActiveDirectoryOAuth` authentication types when running in a local developer environment. [[Issue #30](https://github.com/LogicAppUnit/TestingFramework/issues/30)]
+ - The `testConfiguration.json` file is now optional. If the file does not exist, or contains an empty JSON document (`{}`), the default values are used for all settings. Previous versions of the framework would fail a test if the configuration file did not exist. [[Issue #28](https://github.com/LogicAppUnit/TestingFramework/issues/28)]
+ - `Call a local function` actions are now mocked using HTTP actions. This means that the dependencies between a workflow and a .NET Framework function can be broken to enable better unit testing of the workflow.
+ - Added `IMockResponseBuilder.ThrowsException(Exception exceptionToThrow)` to simulate an exception being thrown by a local .NET Framework function.
+ - Fixed a typo in the name of the `logging.writeFunctionRuntimeStartupLogs` configuration setting. Previously the setting was named `logging.writeFunctionRuntineStartupLogs` (note the incorrect spelling `Runtine`). [[PR #29](https://github.com/LogicAppUnit/TestingFramework/pull/29), [@jeanpaulsmit](https://github.com/jeanpaulsmit)] <br /> :warning: ***This is a breaking change. Any use of the `writeFunctionRuntineStartupLogs` setting in the `testConfiguration.json` file will need to be updated.***
+
+LogicAppUnit.Samples.LogicApps.Tests:
+
+- Added a `call-local-function-workflow` workflow and unit tests to demonstrate the mocking of a local .NET Framework function.
+
+
 # 1.8.0 (24th October 2023)
 
 LogicAppUnit Testing Framework:
 
-- Added new methods `TestRunner.WorkflowWasTerminated`, `TestRunner.WorkflowTerminationCode` and `TestRunner.WorkflowTerminationMessage` to allow the effects of a `Terminate` action in a workflow to be tested.
+- Added new properties `TestRunner.WorkflowWasTerminated`, `TestRunner.WorkflowTerminationCode` and `TestRunner.WorkflowTerminationMessage` to allow the effects of a _Terminate_ action in a workflow to be tested.
 - Mock responses can be configured using the fluent API in the test class initialization method, using the `WorkflowTestBase.AddMockResponse()` method. Mock responses configured using this method will be used by every test runner that is created in the same test class, and have a lower priority compared to the mock responses created using `ITestRunner.AddMockResponse()` and `ITestRunner.AddApiMocks`. This feature removes the need to repeatedly configure the same mocked responses in multiple tests in a test class.
 - The HTTP status code for the default mock response can now be set in the `testConfiguration.json` file using the `runner.defaultHttpResponseStatusCode` option. Previously the status code was hard-coded to HTTP 200 (OK). The default value for this option is HTTP 200 (OK) to ensure backwards compatibility.
 - Added a new feature to remove the chunking configuration for HTTP actions (`runtimeConfiguration.contentTransfer.transferMode`). This feature is enabled/disabled in the `testConfiguration.json` file using the `workflow.removeHttpChunkingConfiguration` option. The default value for this option is `true`. [[Issue #24](https://github.com/LogicAppUnit/TestingFramework/issues/24)]

License.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 LogicAppUnit
+Copyright (c) 2024 LogicAppUnit
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LogicAppUnit.Samples.LogicApps/.debug/Microsoft.Azure.Workflows.Debug.Symbols.dll

@@ -16,7 +16,7 @@ The testing framework has been designed to make it easier to perform isolated un
 - Replace non-HTTP triggers with HTTP triggers to enable automated testing of every workflow, irrespective of the trigger type.
 - Remove external service dependencies for built-in service provider connectors by replacing these actions with HTTP actions and a mock HTTP server that is managed by the framework.
 - Remove external service dependencies for managed API connectors by automatically re-configuring managed API connections to use a mock HTTP server that is managed by the framework.
-- Remove dependencies on invoked workflows by replacing the Invoke Workflow actions with HTTP actions and a mock HTTP server that is managed by the framework.
+- Remove dependencies on invoked workflows and called local functions by replacing the Invoke Workflow and Call Local Function actions with HTTP actions and a mock HTTP server that is managed by the framework.
 - Remove all retry policies to ensure that tests exercising failure scenarios do not take a long time to execute.
 - A fluent API to configure request matching and the creation of responses for the mock HTTP server.
 - Detailed test execution logging to help with workflow test authoring and debugging.
@@ -27,13 +27,14 @@ The testing framework has been designed to make it easier to perform isolated un
 
 ## Projects
 
-This code repository includes three projects:
+This code repository includes four projects:
 
 | Name | Description |
 |:-----|:------------|
 | LogicAppUnit | The testing framework. |
-| LogicAppUnit.Samples.LogicApps.Tests | Sample test project that demonstrates the features of the testing framework. 
+| LogicAppUnit.Samples.LogicApps.Tests | Test project that demonstrates the features of the testing framework. 
 | LogicAppUnit.Samples.LogicApps | Workflows that are tested by the sample test project. |
+| LogicAppUnit.Samples.Functions | Local .NET Framework functions that are called by workflows. |
 
 
 ## Packages
@@ -52,6 +53,10 @@ The framework has been tested with these environments:
 - MacOS
 
 
+## Give a Star :star:
+If you like or are using this project please give it a star. Thanks.
+
+
 ## Main Contributors
 
 - [Mark Abrams](https://github.com/mark-abrams)
@@ -69,7 +74,5 @@ The best way to understand how the framework works and how to write tests using
 This is a list of possible future improvements and changes for the framework. Please create a [new issue](https://github.com/LogicAppUnit/TestingFramework/issues) if there are other features that you would like to see.
 
 - Add more features to the fluent API for request matching and the creation of mock responses.
-- Add a feature to the fluent API to allow a mock response to be matched using just the name of the workflow action that created the request. This would make it easier to match the request, compared to using multiple properties of the request such as the HTTP method, URI path and/or request content.
 - Add a `Verifiable()` feature to the fluent API so that a test case can assert that a test execution did send a request to the mock HTTP server that was successfully matched. This would work in a simialar way to the `Verifiable()` feature in the [moq](https://github.com/devlooped/moq) unit testing framework.
-- Support the `Call a local function` action when calling a .NET Framework function from a Logic App workflow.
 - Auto-generate C# test cases based on a workflow's run history in the local development environment.

LogicAppUnit.Samples.LogicApps/.gitignore

@@ -0,0 +1,6 @@
+{
+  "recommendations": [
+    "ms-azuretools.vscode-azurefunctions",
+    "ms-dotnettools.csharp"
+  ]
+}