Skip to content

Commit 19e9532

Browse files
StefHCopilot
StefH
and
Copilot
authored
ProxyUrlTransformer (#1361)
* ProxyUrlTransformer * tests * Update src/WireMock.Net.Shared/Settings/ProxyUrlReplaceSettings.cs Co-authored-by: Copilot <[email protected]> --------- Co-authored-by: Copilot <[email protected]>
1 parent 371bfdc commit 19e9532

File tree

10 files changed

+195
-77
lines changed

10 files changed

+195
-77
lines changed

‎src/WireMock.Net.Minimal/Http/WebhookSender.cs‎

Lines changed: 3 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,17 @@
1111
using WireMock.Models;
1212
using WireMock.Settings;
1313
using WireMock.Transformers;
14-
using WireMock.Transformers.Handlebars;
15-
using WireMock.Transformers.Scriban;
1614
using WireMock.Types;
1715
using WireMock.Util;
1816

1917
namespace WireMock.Http;
2018

21-
internal class WebhookSender
19+
internal class WebhookSender(WireMockServerSettings settings)
2220
{
2321
private const string ClientIp = "::1";
2422
private static readonly ThreadLocal<Random> Random = new(() => new Random(DateTime.UtcNow.Millisecond));
2523

26-
private readonly WireMockServerSettings _settings;
27-
28-
public WebhookSender(WireMockServerSettings settings)
29-
{
30-
_settings = Guard.NotNull(settings);
31-
}
24+
private readonly WireMockServerSettings _settings = Guard.NotNull(settings);
3225

3326
public async Task<HttpResponseMessage> SendAsync(
3427
HttpClient client,
@@ -49,24 +42,7 @@ IResponseMessage originalResponseMessage
4942
string requestUrl;
5043
if (webhookRequest.UseTransformer == true)
5144
{
52-
ITransformer transformer;
53-
switch (webhookRequest.TransformerType)
54-
{
55-
case TransformerType.Handlebars:
56-
var factoryHandlebars = new HandlebarsContextFactory(_settings);
57-
transformer = new Transformer(_settings, factoryHandlebars);
58-
break;
59-
60-
case TransformerType.Scriban:
61-
case TransformerType.ScribanDotLiquid:
62-
var factoryDotLiquid = new ScribanContextFactory(_settings.FileSystemHandler, webhookRequest.TransformerType);
63-
transformer = new Transformer(_settings, factoryDotLiquid);
64-
break;
65-
66-
default:
67-
throw new NotImplementedException($"TransformerType '{webhookRequest.TransformerType}' is not supported.");
68-
}
69-
45+
var transformer = TransformerFactory.Create(webhookRequest.TransformerType, _settings);
7046
bodyData = transformer.TransformBody(mapping, originalRequestMessage, originalResponseMessage, webhookRequest.BodyData, webhookRequest.TransformerReplaceNodeOptions);
7147
headers = transformer.TransformHeaders(mapping, originalRequestMessage, originalResponseMessage, webhookRequest.Headers);
7248
requestUrl = transformer.TransformString(mapping, originalRequestMessage, originalResponseMessage, webhookRequest.Url);

‎src/WireMock.Net.Minimal/Proxy/ProxyHelper.cs‎

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,10 @@
1313

1414
namespace WireMock.Proxy;
1515

16-
internal class ProxyHelper
16+
internal class ProxyHelper(WireMockServerSettings settings)
1717
{
18-
private readonly WireMockServerSettings _settings;
19-
private readonly ProxyMappingConverter _proxyMappingConverter;
20-
21-
public ProxyHelper(WireMockServerSettings settings)
22-
{
23-
_settings = Guard.NotNull(settings);
24-
_proxyMappingConverter = new ProxyMappingConverter(settings, new GuidUtils(), new DateTimeUtils());
25-
}
18+
private readonly WireMockServerSettings _settings = Guard.NotNull(settings);
19+
private readonly ProxyMappingConverter _proxyMappingConverter = new(settings, new GuidUtils(), new DateTimeUtils());
2620

2721
public async Task<(IResponseMessage Message, IMapping? Mapping)> SendAsync(
2822
IMapping? mapping,
@@ -39,18 +33,7 @@ public ProxyHelper(WireMockServerSettings settings)
3933
var requiredUri = new Uri(url);
4034

4135
// Create HttpRequestMessage
42-
var replaceSettings = proxyAndRecordSettings.ReplaceSettings;
43-
string proxyUrl;
44-
if (replaceSettings is not null)
45-
{
46-
var stringComparison = replaceSettings.IgnoreCase ? StringComparison.OrdinalIgnoreCase : StringComparison.Ordinal;
47-
proxyUrl = url.Replace(replaceSettings.OldValue, replaceSettings.NewValue, stringComparison);
48-
}
49-
else
50-
{
51-
proxyUrl = url;
52-
}
53-
36+
var proxyUrl = proxyAndRecordSettings.ReplaceSettings != null ? ProxyUrlTransformer.Transform(_settings, proxyAndRecordSettings.ReplaceSettings, url) : url;
5437
var httpRequestMessage = HttpRequestMessageHelper.Create(requestMessage, proxyUrl);
5538

5639
// Call the URL

‎src/WireMock.Net.Minimal/Proxy/ProxyUrlTransformer.cs‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Copyright © WireMock.Net
2+
3+
using System;
4+
using WireMock.Settings;
5+
using WireMock.Transformers;
6+
7+
namespace WireMock.Proxy;
8+
9+
internal static class ProxyUrlTransformer
10+
{
11+
internal static string Transform(WireMockServerSettings settings, ProxyUrlReplaceSettings replaceSettings, string url)
12+
{
13+
if (!replaceSettings.UseTransformer)
14+
{
15+
return url.Replace(replaceSettings.OldValue, replaceSettings.NewValue, replaceSettings.IgnoreCase ? StringComparison.OrdinalIgnoreCase : StringComparison.Ordinal);
16+
}
17+
18+
var transformer = TransformerFactory.Create(replaceSettings.TransformerType, settings);
19+
return transformer.Transform(replaceSettings.TransformTemplate, url);
20+
}
21+
}

‎src/WireMock.Net.Minimal/ResponseBuilders/Response.cs‎

Lines changed: 2 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -272,25 +272,8 @@ string RemoveFirstOccurrence(string source, string find)
272272
}
273273
}
274274

275-
ITransformer responseMessageTransformer;
276-
switch (TransformerType)
277-
{
278-
case TransformerType.Handlebars:
279-
var factoryHandlebars = new HandlebarsContextFactory(settings);
280-
responseMessageTransformer = new Transformer(settings, factoryHandlebars);
281-
break;
282-
283-
case TransformerType.Scriban:
284-
case TransformerType.ScribanDotLiquid:
285-
var factoryDotLiquid = new ScribanContextFactory(settings.FileSystemHandler, TransformerType);
286-
responseMessageTransformer = new Transformer(settings, factoryDotLiquid);
287-
break;
288-
289-
default:
290-
throw new NotSupportedException($"TransformerType '{TransformerType}' is not supported.");
291-
}
292-
293-
return (responseMessageTransformer.Transform(mapping, requestMessage, responseMessage, UseTransformerForBodyAsFile, TransformerReplaceNodeOptions), null);
275+
var transformer = TransformerFactory.Create(TransformerType, settings);
276+
return (transformer.Transform(mapping, requestMessage, responseMessage, UseTransformerForBodyAsFile, TransformerReplaceNodeOptions), null);
294277
}
295278

296279
if (!UseTransformer && ResponseMessage.BodyData?.BodyAsFileIsCached == true && responseMessage.BodyData?.BodyAsFile is not null)

‎src/WireMock.Net.Minimal/Transformers/ITransformer.cs‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
namespace WireMock.Transformers;
88

9-
interface ITransformer
9+
internal interface ITransformer
1010
{
1111
ResponseMessage Transform(IMapping mapping, IRequestMessage requestMessage, IResponseMessage original, bool useTransformerForBodyAsFile, ReplaceNodeOptions options);
1212

@@ -15,4 +15,6 @@ interface ITransformer
1515
IDictionary<string, WireMockList<string>> TransformHeaders(IMapping mapping, IRequestMessage originalRequestMessage, IResponseMessage originalResponseMessage, IDictionary<string, WireMockList<string>>? headers);
1616

1717
string TransformString(IMapping mapping, IRequestMessage originalRequestMessage, IResponseMessage originalResponseMessage, string? value);
18+
19+
string Transform(string template, object? model);
1820
}

‎src/WireMock.Net.Minimal/Transformers/ITransformerContextFactory.cs‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
// Copyright © WireMock.Net
22

3-
namespace WireMock.Transformers
3+
namespace WireMock.Transformers;
4+
5+
internal interface ITransformerContextFactory
46
{
5-
interface ITransformerContextFactory
6-
{
7-
ITransformerContext Create();
8-
}
7+
ITransformerContext Create();
98
}

‎src/WireMock.Net.Minimal/Transformers/Transformer.cs‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,11 @@ public string TransformString(
7575
return transformerContext.ParseAndRender(value, model);
7676
}
7777

78+
public string Transform(string template, object? model)
79+
{
80+
return model is null ? string.Empty : _factory.Create().ParseAndRender(template, model);
81+
}
82+
7883
public ResponseMessage Transform(IMapping mapping, IRequestMessage requestMessage, IResponseMessage original, bool useTransformerForBodyAsFile, ReplaceNodeOptions options)
7984
{
8085
var responseMessage = new ResponseMessage();

‎src/WireMock.Net.Minimal/Transformers/TransformerFactory.cs‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Copyright © WireMock.Net
2+
3+
using System;
4+
using WireMock.Settings;
5+
using WireMock.Transformers.Handlebars;
6+
using WireMock.Transformers.Scriban;
7+
using WireMock.Types;
8+
9+
namespace WireMock.Transformers;
10+
11+
internal static class TransformerFactory
12+
{
13+
internal static ITransformer Create(TransformerType transformerType, WireMockServerSettings settings)
14+
{
15+
switch (transformerType)
16+
{
17+
case TransformerType.Handlebars:
18+
var factoryHandlebars = new HandlebarsContextFactory(settings);
19+
return new Transformer(settings, factoryHandlebars);
20+
21+
case TransformerType.Scriban:
22+
case TransformerType.ScribanDotLiquid:
23+
var factoryDotLiquid = new ScribanContextFactory(settings.FileSystemHandler, transformerType);
24+
return new Transformer(settings, factoryDotLiquid);
25+
26+
default:
27+
throw new NotSupportedException($"{nameof(TransformerType)} '{transformerType}' is not supported.");
28+
}
29+
}
30+
}

‎src/WireMock.Net.Shared/Settings/ProxyUrlReplaceSettings.cs‎

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
// Copyright © WireMock.Net
22

3+
using System.Diagnostics.CodeAnalysis;
4+
using WireMock.Types;
5+
36
namespace WireMock.Settings;
47

58
/// <summary>
@@ -8,17 +11,35 @@ namespace WireMock.Settings;
811
public class ProxyUrlReplaceSettings
912
{
1013
/// <summary>
11-
/// The old path value to be replaced by the new path value
14+
/// The old path value to be replaced by the new path value.
1215
/// </summary>
13-
public string OldValue { get; set; } = null!;
16+
public string? OldValue { get; set; }
1417

1518
/// <summary>
16-
/// The new path value to replace the old value with
19+
/// The new path value to replace the old value with.
1720
/// </summary>
18-
public string NewValue { get; set; } = null!;
21+
public string? NewValue { get; set; }
1922

2023
/// <summary>
2124
/// Defines if the case should be ignored when replacing.
2225
/// </summary>
2326
public bool IgnoreCase { get; set; }
27+
28+
/// <summary>
29+
/// Holds the transformation template used when <see cref="UseTransformer"/> is true.
30+
/// </summary>
31+
public string? TransformTemplate { get; set; }
32+
33+
/// <summary>
34+
/// Use Transformer.
35+
/// </summary>
36+
[MemberNotNullWhen(true, nameof(TransformTemplate))]
37+
[MemberNotNullWhen(false, nameof(OldValue))]
38+
[MemberNotNullWhen(false, nameof(NewValue))]
39+
public bool UseTransformer => !string.IsNullOrEmpty(TransformTemplate);
40+
41+
/// <summary>
42+
/// The transformer type, in case <see cref="UseTransformer"/> is set to <c>true</c>.
43+
/// </summary>
44+
public TransformerType TransformerType { get; set; } = TransformerType.Handlebars;
2445
}

‎test/WireMock.Net.Tests/Proxy/ProxyUrlTransformerTests.cs‎

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
using System.Globalization;
2+
using Moq;
3+
using WireMock.Handlers;
4+
using WireMock.Proxy;
5+
using WireMock.Settings;
6+
using WireMock.Types;
7+
using Xunit;
8+
9+
namespace WireMock.Net.Tests.Proxy;
10+
11+
public class ProxyUrlTransformerTests
12+
{
13+
private readonly Mock<IFileSystemHandler> _fileSystemHandlerMock = new();
14+
15+
[Fact]
16+
public void Transform_WithUseTransformerFalse_PerformsSimpleReplace_CaseSensitive()
17+
{
18+
// Arrange
19+
var settings = new WireMockServerSettings
20+
{
21+
FileSystemHandler = _fileSystemHandlerMock.Object,
22+
Culture = CultureInfo.InvariantCulture
23+
};
24+
25+
var replaceSettings = new ProxyUrlReplaceSettings
26+
{
27+
TransformTemplate = null,
28+
OldValue = "/old",
29+
NewValue = "/new",
30+
IgnoreCase = false
31+
};
32+
33+
var url = "http://example.com/old/path";
34+
var expected = "http://example.com/new/path";
35+
36+
// Act
37+
var actual = ProxyUrlTransformer.Transform(settings, replaceSettings, url);
38+
39+
// Assert
40+
Assert.Equal(expected, actual);
41+
}
42+
43+
[Fact]
44+
public void Transform_WithUseTransformerFalse_PerformsSimpleReplace_IgnoreCase()
45+
{
46+
// Arrange
47+
var settings = new WireMockServerSettings
48+
{
49+
FileSystemHandler = _fileSystemHandlerMock.Object,
50+
Culture = CultureInfo.InvariantCulture
51+
};
52+
53+
var replaceSettings = new ProxyUrlReplaceSettings
54+
{
55+
TransformTemplate = null, // UseTransformer == false
56+
OldValue = "/OLD",
57+
NewValue = "/new",
58+
IgnoreCase = true
59+
};
60+
61+
var url = "http://example.com/old/path"; // lowercase 'old' but OldValue is uppercase
62+
var expected = "http://example.com/new/path";
63+
64+
// Act
65+
var actual = ProxyUrlTransformer.Transform(settings, replaceSettings, url);
66+
67+
// Assert
68+
Assert.Equal(expected, actual);
69+
}
70+
71+
[Fact]
72+
public void Transform_WithUseTransformerTrue_UsesTransformer_ToTransformUrl()
73+
{
74+
// Arrange
75+
var settings = new WireMockServerSettings
76+
{
77+
FileSystemHandler = _fileSystemHandlerMock.Object,
78+
Culture = CultureInfo.InvariantCulture
79+
};
80+
81+
// Handlebars is the default TransformerType; the TransformTemplate uses the model directly.
82+
var replaceSettings = new ProxyUrlReplaceSettings
83+
{
84+
TransformTemplate = "{{this}}-transformed",
85+
// TransformerType defaults to Handlebars but set explicitly for clarity.
86+
TransformerType = TransformerType.Handlebars
87+
};
88+
89+
var url = "http://example.com/path";
90+
var expected = "http://example.com/path-transformed";
91+
92+
// Act
93+
var actual = ProxyUrlTransformer.Transform(settings, replaceSettings, url);
94+
95+
// Assert
96+
Assert.Equal(expected, actual);
97+
}
98+
}

0 commit comments

Comments
 (0)