Merge pull request #78 from martincostello/Add-Bundle-Ignore-Support

Add bundle ignore support

Author: martincostello

src/HttpClientInterception/BundleExtensions.cs

@@ -76,10 +76,12 @@ public static HttpClientInterceptorOptions RegisterBundle(
             {
                 foreach (var item in bundle.Items)
                 {
-                    if (item != null)
+                    if (item == null || item.Skip)
                     {
-                        builders.Add(BundleItemConverter.FromItem(item, templateValues));
+                        continue;
                     }
+
+                    builders.Add(BundleItemConverter.FromItem(item, templateValues));
                 }
             }
 

src/HttpClientInterception/Bundles/BundleItem.cs

@@ -97,5 +97,23 @@ internal sealed class BundleItem
         /// </summary>
         [JsonProperty("templateValues", NullValueHandling = NullValueHandling.Ignore)]
         public IDictionary<string, string> TemplateValues { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to ignore the URI's path.
+        /// </summary>
+        [JsonProperty("ignorePath", NullValueHandling = NullValueHandling.Ignore)]
+        public bool IgnorePath { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to ignore the URI's query string.
+        /// </summary>
+        [JsonProperty("ignoreQuery", NullValueHandling = NullValueHandling.Ignore)]
+        public bool IgnoreQuery { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to skip the item.
+        /// </summary>
+        [JsonProperty("skip", NullValueHandling = NullValueHandling.Ignore)]
+        public bool Skip { get; set; }
     }
 }

src/HttpClientInterception/Bundles/BundleItemConverter.cs

@@ -70,6 +70,16 @@ public static HttpRequestInterceptionBuilder FromItem(
                 builder.HavingPriority(item.Priority.Value);
             }
 
+            if (item.IgnorePath)
+            {
+                builder.IgnoringPath(ignorePath: true);
+            }
+
+            if (item.IgnoreQuery)
+            {
+                builder.IgnoringQuery(ignoreQuery: true);
+            }
+
             return builder.SetContent(item);
         }
 

src/HttpClientInterception/Bundles/http-request-bundle-schema.json

@@ -46,6 +46,16 @@
             "type": "string",
             "description": "The absolute URI for the HTTP request."
           },
+          "ignorePath": {
+            "type": "boolean",
+            "description": "Whether to ignore the URI's path when matching the interception.",
+            "default": false
+          },
+          "ignoreQuery": {
+            "type": "boolean",
+            "description": "Whether to ignore the URI's query string when matching the interception.",
+            "default": false
+          },
           "priority": {
             "type": "integer",
             "description": "The optional priority value for the item."
@@ -113,6 +123,11 @@
             "additionalProperties": {
               "type": "string"
             }
+          },
+          "skip": {
+            "type": "boolean",
+            "description": "Whether to skip the item so it is not used.",
+            "default": false
           }
         },
         "required": [ "uri" ]

tests/HttpClientInterception.Tests/Bundles/BundleExtensionsTests.cs

@@ -333,6 +333,58 @@ public static async Task Can_Intercept_Http_Requests_From_Bundle_File_If_No_Cont
             content.ShouldBe(string.Empty);
         }
 
+        [Fact]
+        public static async Task Can_Intercept_Http_Requests_With_Different_Path_If_The_Uri_Path_Is_Ignored()
+        {
+            // Arrange
+            var options = new HttpClientInterceptorOptions().ThrowsOnMissingRegistration();
+
+            // Act
+            options.RegisterBundle(Path.Join("Bundles", "ignoring-path.json"));
+
+            // Assert
+            string content = await HttpAssert.GetAsync(options, "https://api.github.com/orgs/some-other-org");
+
+            content
+                .Replace(" ", string.Empty, StringComparison.Ordinal)
+                .Replace("\n", string.Empty, StringComparison.Ordinal)
+                .Replace("\r", string.Empty, StringComparison.Ordinal)
+                .ShouldBe(@"{""id"":1516790,""login"":""justeat"",""url"":""https://api.github.com/orgs/justeat""}");
+        }
+
+        [Fact]
+        public static async Task Can_Intercept_Http_Requests_With_Different_Path_If_The_Uri_Query_String()
+        {
+            // Arrange
+            var options = new HttpClientInterceptorOptions().ThrowsOnMissingRegistration();
+
+            // Act
+            options.RegisterBundle(Path.Join("Bundles", "ignoring-query.json"));
+
+            // Assert
+            string content = await HttpAssert.GetAsync(options, "https://api.github.com/orgs/justeat?foo=bar");
+
+            content
+                .Replace(" ", string.Empty, StringComparison.Ordinal)
+                .Replace("\n", string.Empty, StringComparison.Ordinal)
+                .Replace("\r", string.Empty, StringComparison.Ordinal)
+                .ShouldBe(@"{""id"":1516790,""login"":""justeat"",""url"":""https://api.github.com/orgs/justeat""}");
+        }
+
+        [Fact]
+        public static async Task Can_Skip_Bundle_Items()
+        {
+            // Arrange
+            var options = new HttpClientInterceptorOptions().ThrowsOnMissingRegistration();
+
+            // Act
+            options.RegisterBundle(Path.Join("Bundles", "skipped-item-bundle.json"));
+
+            // Assert
+            await Assert.ThrowsAsync<InvalidOperationException>(
+                () => HttpAssert.GetAsync(options, "https://www.just-eat.co.uk/"));
+        }
+
         [Theory]
         [MemberData(nameof(BundleFiles))]
         public static async Task Bundle_Schema_Is_Valid_From_Test(string bundlePath)

tests/HttpClientInterception.Tests/Bundles/ignoring-path.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://raw.githubusercontent.com/justeat/httpclient-interception/master/src/HttpClientInterception/Bundles/http-request-bundle-schema.json",
+  "id": "ignoring-path-bundle",
+  "comment": "An HTTP request bundle where the path is ignored.",
+  "items": [
+    {
+      "id": "JSON",
+      "comment": "An HTTP request where the path is ignored.",
+      "uri": "https://api.github.com/orgs/justeat",
+      "ignorePath": true,
+      "contentFormat": "json",
+      "contentJson": {
+        "id": 1516790,
+        "login": "justeat",
+        "url": "https://api.github.com/orgs/justeat"
+      }
+    }
+  ]
+}

tests/HttpClientInterception.Tests/Bundles/ignoring-query.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://raw.githubusercontent.com/justeat/httpclient-interception/master/src/HttpClientInterception/Bundles/http-request-bundle-schema.json",
+  "id": "ignoring-path-bundle",
+  "comment": "An HTTP request bundle where the path is ignored.",
+  "items": [
+    {
+      "id": "JSON",
+      "comment": "An HTTP request where the query string is ignored.",
+      "uri": "https://api.github.com/orgs/justeat",
+      "ignoreQuery": true,
+      "contentFormat": "json",
+      "contentJson": {
+        "id": 1516790,
+        "login": "justeat",
+        "url": "https://api.github.com/orgs/justeat"
+      }
+    }
+  ]
+}

tests/HttpClientInterception.Tests/Bundles/skipped-item-bundle.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://raw.githubusercontent.com/justeat/httpclient-interception/master/src/HttpClientInterception/Bundles/http-request-bundle-schema.json",
+  "id": "test-skipped-item-bundle-bundle",
+  "comment": "An HTTP request bundle where the item is skipped.",
+  "version": 1,
+  "items": [
+    {
+      "id": "html",
+      "comment": "A skipped HTTP request.",
+      "uri": "https://www.just-eat.co.uk/",
+      "contentHeaders": {
+        "content-type": [
+          "text/html; charset=utf-8"
+        ]
+      },
+      "contentString": "<html><head><title>Just Eat</title></head></html>",
+      "skip": true
+    }
+  ]
+}