Changes for 1.8.0.

Author: LogicAppUnit

.azure-devops/pipelines/build.yml

@@ -14,7 +14,7 @@ parameters:
 jobs:
 - job: build
   displayName: 'Build'
-  timeoutInMinutes: 20
+  timeoutInMinutes: 30
 
   strategy:
     matrix:

.editorconfig

@@ -1,3 +1,28 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Don't use tabs for indentation
+[*]
+indent_style = space
+
+# Code files
+[*.{cs,csx}]
+indent_size = 4
+
+# XML project files
+[*.{csproj,vbproj,vcxproj,vcxproj.filters,proj,projitems,shproj,msbuildproj,props,targets}]
+indent_size = 2
+
+# YAML files
+[*.{yaml,yml}]
+indent_size = 2
+
+# JSON files
+[*.json]
+indent_size = 2
 
 # CA1307: Specify StringComparison for clarity
 #   Clarity of intent is not required, this is non-localizable code.

ChangeLog.md

@@ -1,8 +1,19 @@
+# 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.
+- 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)]
+- Added `IMockResponseBuilder.WithAccepted()` as a short-cut when creating a response with a HTTP 202 (Accepted) status code.
+
+
 # 1.7.0 (27th July 2023)
 
 LogicAppUnit Testing Framework:
 
-- Mock responses can be configured using a fluent API, this includes the definition of the request matching conditions and the response. 
+- Mock responses can be configured using `ITestRunner.AddMockResponse()` and a fluent API, this includes the definition of the request matching conditions and the response. 
 - Removed public methods `ContentHelper.SerializeObject()`, `ContentHelper.DeserializeObject()` and `ContentHelper.JClone()`, these were for internal use only and are now obsolete.
 - Include the LogicAppUnit version at the end of the test log.
 - The maximum execution time for a workflow can now be set in the `testConfiguration.json` file using the `runner.maxWorkflowExecutionDuration` option. Previously this duration was hard-coded to 5 minutes. The default value for this option is 300 seconds (5 minutes).
@@ -29,8 +40,6 @@ LogicAppUnit.Samples.LogicApps.Tests:
 
 - Added a `http-async-workflow` workflow and unit tests to demonstrate the use of the testing framework with HTTP triggers and asynchronous responses.
 
-Thanks to [@easchi](https://github.com/eashi) and [@atthevergeof](https://github.com/atthevergeof) for their contributions.
-
 
 # 1.5.0 (14th April 2023)
 

LogicAppUnit.Samples.LogicApps.Tests/BuiltInConnectorWorkflow/BuiltInConnectorWorkflowTest.cs

@@ -53,6 +53,11 @@ public void BuiltInConnectorWorkflowTest_When_No_Language_Code()
                 // Check workflow run status
                 Assert.AreEqual(WorkflowRunStatus.Succeeded, testRunner.WorkflowRunStatus);
 
+                // Check the workflow termination status
+                Assert.IsFalse(testRunner.WorkflowWasTerminated);
+                Assert.IsNull(testRunner.WorkflowTerminationCode);
+                Assert.IsNull(testRunner.WorkflowTerminationMessage);
+
                 // Check workflow response
                 // The workflow does not have a 'Response' action, so no content to validate
                 Assert.AreEqual(HttpStatusCode.Accepted, workflowResponse.StatusCode);
@@ -106,6 +111,11 @@ public void BuiltInConnectorWorkflowTest_When_Valid_Language_Code()
                 // Check workflow run status
                 Assert.AreEqual(WorkflowRunStatus.Succeeded, testRunner.WorkflowRunStatus);
 
+                // Check the workflow termination status
+                Assert.IsFalse(testRunner.WorkflowWasTerminated);
+                Assert.IsNull(testRunner.WorkflowTerminationCode);
+                Assert.IsNull(testRunner.WorkflowTerminationMessage);
+
                 // Check workflow response
                 // The workflow does not have a 'Response' action, so no content to validate
                 Assert.AreEqual(HttpStatusCode.Accepted, workflowResponse.StatusCode);
@@ -159,6 +169,9 @@ public void BuiltInConnectorWorkflowTest_When_Invalid_Language_Code()
                 // Check workflow run status
                 // This workflow has terminated with failure
                 Assert.AreEqual(WorkflowRunStatus.Failed, testRunner.WorkflowRunStatus);
+                Assert.IsTrue(testRunner.WorkflowWasTerminated);
+                Assert.AreEqual((int)HttpStatusCode.InternalServerError, testRunner.WorkflowTerminationCode);
+                Assert.AreEqual("Language Code 'xx-GB' is not valid", testRunner.WorkflowTerminationMessage);
 
                 // Check workflow response
                 // The workflow does not have a 'Response' action, so no content to validate

LogicAppUnit.Samples.LogicApps.Tests/FluentWorkflow/FluentWorkflowResponseBuilderTest.cs

@@ -400,6 +400,28 @@ public void FluentWorkflowTest_ResponseBuilder_ContentResource()
             }
         }
 
+        /// <summary>
+        /// Tests the response when neither a response builder, nor a delegate response, have been configured. A HTTP 200 (OK) response should be received with no content.
+        /// </summary>
+        [TestMethod]
+        public void FluentWorkflowTest_ResponseBuilder_NoResponseConfigured()
+        {
+            using (ITestRunner testRunner = CreateTestRunner())
+            {
+                // Run the workflow
+                var workflowResponse = testRunner.TriggerWorkflow(
+                    GetRequest(),
+                    HttpMethod.Post);
+
+                // Check workflow run status
+                Assert.AreEqual(WorkflowRunStatus.Succeeded, testRunner.WorkflowRunStatus);
+
+                // Check workflow response
+                Assert.AreEqual(HttpStatusCode.OK, workflowResponse.StatusCode);
+                Assert.AreEqual("", workflowResponse.Content.ReadAsStringAsync().Result);
+            }
+        }
+
         private static StringContent GetRequest()
         {
             return ContentHelper.CreateJsonStringContent(new

LogicAppUnit.Samples.LogicApps.Tests/FluentWorkflow/FluentWorkflowResponseBuilderWithBaseTest.cs

@@ -0,0 +1,131 @@
+using LogicAppUnit.Helper;
+using LogicAppUnit.Mocking;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System.Net;
+using System.Net.Http;
+
+namespace LogicAppUnit.Samples.LogicApps.Tests.FluentWorkflow
+{
+    /// <summary>
+    /// Test cases for the <i>fluent-workflow</i> workflow and the Response Builder features, when the test base class defines a mock response.
+    /// </summary>
+    [TestClass]
+    public class FluentWorkflowResponseBuilderWithBaseTest : WorkflowTestBase
+    {
+        [TestInitialize]
+        public void TestInitialize()
+        {
+            Initialize(Constants.LOGIC_APP_TEST_EXAMPLE_BASE_PATH, Constants.FLUENT_REQUEST_MATCHING_WORKFLOW);
+
+            // Configure mock responses for all tests
+            // The request matcher will match all requests because there are no match criteria
+            AddMockResponse("DefinedInTestClass",
+                MockRequestMatcher.Create())
+            .RespondWith(
+                MockResponseBuilder.Create()
+                .WithNoContent());
+        }
+
+        [ClassCleanup]
+        public static void CleanResources()
+        {
+            Close();
+        }
+
+        /// <summary>
+        /// Tests the response builder when no mock response is configured in the test and therefore the mock response in the test class is matched.
+        /// </summary>
+        [TestMethod]
+        public void FluentWorkflowTest_ResponseBuilder_NoTestCaseMock()
+        {
+            using (ITestRunner testRunner = CreateTestRunner())
+            {
+                // Do not configure mock responses, the test base mock response should match
+
+                // Run the workflow
+                var workflowResponse = testRunner.TriggerWorkflow(
+                    GetRequest(),
+                    HttpMethod.Post);
+
+                // Check workflow run status
+                Assert.AreEqual(WorkflowRunStatus.Succeeded, testRunner.WorkflowRunStatus);
+
+                // Check workflow response
+                Assert.AreEqual(HttpStatusCode.NoContent, workflowResponse.StatusCode);
+                Assert.AreEqual(string.Empty, workflowResponse.Content.ReadAsStringAsync().Result);
+            }
+        }
+
+        /// <summary>
+        /// Tests the response builder when a mock response is configured in the test and matches, therefore the mock response in the test class is not used.
+        /// </summary>
+        [TestMethod]
+        public void FluentWorkflowTest_ResponseBuilder_WithTestCaseMockThatMatches()
+        {
+            using (ITestRunner testRunner = CreateTestRunner())
+            {
+                // Configure mock responses
+                testRunner
+                    .AddMockResponse("DefinedInTestCase",
+                        MockRequestMatcher.Create())
+                    .RespondWith(
+                        MockResponseBuilder.Create()
+                        .WithStatusCode(HttpStatusCode.Accepted)
+                        .WithContentAsPlainText("Your request has been queued for processing"));
+
+                // Run the workflow
+                var workflowResponse = testRunner.TriggerWorkflow(
+                    GetRequest(),
+                    HttpMethod.Post);
+
+                // Check workflow run status
+                Assert.AreEqual(WorkflowRunStatus.Succeeded, testRunner.WorkflowRunStatus);
+
+                // Check workflow response
+                Assert.AreEqual(HttpStatusCode.Accepted, workflowResponse.StatusCode);
+                Assert.AreEqual("Your request has been queued for processing", workflowResponse.Content.ReadAsStringAsync().Result);
+            }
+        }
+
+        /// <summary>
+        /// Tests the response builder when a mock response is configured in the test and does not match, therefore the mock response in the test class is matched.
+        /// </summary>
+        [TestMethod]
+        public void FluentWorkflowTest_ResponseBuilder_TestCaseMockNotMatched()
+        {
+            using (ITestRunner testRunner = CreateTestRunner())
+            {
+                // Configure mock responses
+                testRunner
+                    .AddMockResponse("DefinedInTestCase",
+                        MockRequestMatcher.Create()
+                        .WithPath(PathMatchType.Contains, "HelloWorld"))
+                    .RespondWith(
+                        MockResponseBuilder.Create()
+                        .WithStatusCode(HttpStatusCode.InternalServerError)
+                        .WithContentAsPlainText("It all went wrong!"));
+
+                // Run the workflow
+                var workflowResponse = testRunner.TriggerWorkflow(
+                    GetRequest(),
+                    HttpMethod.Post);
+
+                // Check workflow run status
+                Assert.AreEqual(WorkflowRunStatus.Succeeded, testRunner.WorkflowRunStatus);
+
+                // Check workflow response
+                Assert.AreEqual(HttpStatusCode.NoContent, workflowResponse.StatusCode);
+                Assert.AreEqual(string.Empty, workflowResponse.Content.ReadAsStringAsync().Result);
+            }
+        }
+
+        private static StringContent GetRequest()
+        {
+            return ContentHelper.CreateJsonStringContent(new
+            {
+                name = "",
+                manufacturer = "Virgin Orbit"
+            });
+        }
+    }
+}

LogicAppUnit.Samples.LogicApps.Tests/HttpChunkingWorkflow/HttpChunkingWorkflow.cs

@@ -0,0 +1,88 @@
+using LogicAppUnit.Mocking;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System.Net;
+using System.Net.Http;
+
+namespace LogicAppUnit.Samples.LogicApps.Tests.HttpChunkingWorkflow
+{
+    /// <summary>
+    /// Test cases for the <i>http-chunking-workflow</i> workflow which uses a chunked transfer mode within HTTP action.
+    /// </summary>
+    [TestClass]
+    public class HttpChunkingWorkflowTest : WorkflowTestBase
+    {
+        [TestInitialize]
+        public void TestInitialize()
+        {
+            Initialize(Constants.LOGIC_APP_TEST_EXAMPLE_BASE_PATH, "http-chunking-workflow");
+        }
+
+        [ClassCleanup]
+        public static void CleanResources()
+        {
+            Close();
+        }
+
+        [TestMethod]
+        public void ChunkedTransferWorkflow_Success()
+        {
+            using (ITestRunner testRunner = CreateTestRunner())
+            {
+                // Configure mock responses
+                testRunner
+                    .AddMockResponse(
+                        MockRequestMatcher.Create()
+                        .UsingGet()
+                        .WithPath(PathMatchType.Exact, "/api/v1/data"))
+                    .RespondWith(
+                        MockResponseBuilder.Create()
+                        .WithSuccess()
+                        .WithContentAsJson(GetDataResponse()));
+                testRunner
+                    .AddMockResponse(
+                        MockRequestMatcher.Create()
+                        .UsingPost()
+                        .WithPath(PathMatchType.Exact, "/api/v1.1/upload"))
+                    .RespondWithDefault();
+
+                // Run the workflow
+                var workflowResponse = testRunner.TriggerWorkflow(HttpMethod.Post);
+
+                // Check workflow run status
+                Assert.AreEqual(WorkflowRunStatus.Succeeded, testRunner.WorkflowRunStatus);
+
+                // Check workflow response
+                Assert.AreEqual(HttpStatusCode.Accepted, workflowResponse.StatusCode);
+
+                // Check action result
+                Assert.AreEqual(ActionStatus.Succeeded, testRunner.GetWorkflowActionStatus("Get_Action"));
+                Assert.AreEqual(ActionStatus.Succeeded, testRunner.GetWorkflowActionStatus("Post_Action"));
+            }
+        }
+
+        private static dynamic GetDataResponse()
+        {
+            return new
+            {
+                id = 54624,
+                title = "Mr",
+                firstName = "Peter",
+                lastName = "Smith",
+                dateOfBirth = "1970-04-25",
+                languageCode = "en-GB",
+                address = new
+                {
+                    line1 = "8 High Street",
+                    line2 = (string)null,
+                    line3 = (string)null,
+                    town = "Luton",
+                    county = "Bedfordshire",
+                    postcode = "LT12 6TY",
+                    countryCode = "UK",
+                    countryName = "United Kingdom"
+                },
+                extra = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et nisl in tellus sodales aliquet in id sem. Suspendisse cursus mollis erat eu ullamcorper. Nulla congue id odio at facilisis. Sed ultrices dolor nisi, sit amet cursus leo pellentesque eget. Praesent sagittis ligula leo. Vestibulum varius eros posuere tortor tristique eleifend. Praesent ornare accumsan nisi sed auctor. Fusce ullamcorper nisi nec mi euismod, in efficitur quam volutpat.Vestibulum at iaculis felis. Fusce augue sem, efficitur ut vulputate quis, cursus nec mi. Nulla sagittis posuere ornare. Morbi lectus eros, luctus non condimentum eget, pretium eget sem. Aliquam convallis sed sem accumsan ultricies. Quisque commodo at odio sit amet iaculis. Curabitur nec lectus vel leo tristique aliquam et a ipsum. Duis tortor augue, gravida sed dui ac, feugiat pulvinar ex. Integer luctus urna at mauris feugiat, nec mattis elit mattis. Fusce dictum odio quis semper blandit. Pellentesque nunc augue, elementum sit amet nunc et."
+            };
+        }
+    }
+}