starred/WireMock.Net
1
0
Fork 0
mirror of https://github.com/wiremock/WireMock.Net.git synced 2026-01-18 16:17:10 +01:00
Code Issues 32 Packages Projects Releases 10 Wiki Activity

Implement prefix for saved mapping file (#1040)

Browse Source 
* Implement PrefixForSavedMappingFile

* Add missing new line

* Add missing new line

* Fix warning

* Fix typo

* Change from readonly to const

* Assign default value

* Use nameof()

* Change from readonly to const

* Update tests

* Update failing test

* Rename settingsMock to settings

* Create public const

* Use const from ProxyAndRecordSettings

---------

Co-authored-by: Mindaugas Laganeckas <mindaugas.laganeckas@nexigroup.com>
This commit is contained in:
Mindaugas Laganeckas
2023-12-14 08:28:21 +01:00
committed by GitHub
parent 68ad015dcf
commit 7b8e7bb684
7 changed files with 229 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/WireMock.Net.Abstractions/Admin/Settings/ProxyAndRecordSettingsModel.cs
View File

@@ -69,6 +69,11 @@ public class ProxyAndRecordSettingsModel
/// </summary>
public bool AppendGuidToSavedMappingFile { get; set; }
/// <summary>
/// Set prefix for saved mapping file.
/// </summary>
public string PrefixForSavedMappingFile { get; set; }
/// <summary>
/// Defines the Replace Settings.
/// </summary>

48
src/WireMock.Net/Serialization/MappingFileNameSanitizer.cs Normal file
View File

@@ -0,0 +1,48 @@
using System.IO;
using System.Linq;
using Stef.Validation;
using WireMock.Settings;
namespace WireMock.Serialization;
/// <summary>
/// Creates sanitized file names for mappings
/// </summary>
public class MappingFileNameSanitizer
{
private const char ReplaceChar = '_';
private readonly WireMockServerSettings _settings;
public MappingFileNameSanitizer(WireMockServerSettings settings)
{
_settings = Guard.NotNull(settings);
}
/// <summary>
/// Creates sanitized file names for mappings
/// </summary>
public string BuildSanitizedFileName(IMapping mapping)
{
string name;
if (!string.IsNullOrEmpty(mapping.Title))
{
// remove 'Proxy Mapping for ' and an extra space character after the HTTP request method
name = mapping.Title.Replace(ProxyAndRecordSettings.DefaultPrefixForSavedMappingFile, "").Replace(' '.ToString(), string.Empty);
if (_settings.ProxyAndRecordSettings?.AppendGuidToSavedMappingFile == true)
{
name += $"{ReplaceChar}{mapping.Guid}";
}
}
else
{
name = mapping.Guid.ToString();
}
if (!string.IsNullOrEmpty(_settings.ProxyAndRecordSettings?.PrefixForSavedMappingFile))
{
name = $"{_settings.ProxyAndRecordSettings.PrefixForSavedMappingFile}{ReplaceChar}{name}";
}
return $"{Path.GetInvalidFileNameChars().Aggregate(name, (current, c) => current.Replace(c, ReplaceChar))}.json";
}
}

23
src/WireMock.Net/Serialization/MappingToFileSaver.cs
View File

@@ -10,11 +10,13 @@ internal class MappingToFileSaver
{
private readonly WireMockServerSettings _settings;
private readonly MappingConverter _mappingConverter;
private readonly MappingFileNameSanitizer _fileNameSanitizer;
public MappingToFileSaver(WireMockServerSettings settings, MappingConverter mappingConverter)
{
_settings = Guard.NotNull(settings);
_mappingConverter = Guard.NotNull(mappingConverter);
_fileNameSanitizer = new MappingFileNameSanitizer(settings);
}
public void SaveMappingsToFile(IMapping[] mappings, string? folder = null)
@@ -42,7 +44,7 @@ internal class MappingToFileSaver
var model = _mappingConverter.ToMappingModel(mapping);
var filename = BuildSanitizedFileName(mapping);
var filename = _fileNameSanitizer.BuildSanitizedFileName(mapping);
var path = Path.Combine(folder, filename);
Save(model, path);
@@ -54,23 +56,4 @@ internal class MappingToFileSaver
_settings.FileSystemHandler.WriteMappingFile(path, JsonConvert.SerializeObject(value, JsonSerializationConstants.JsonSerializerSettingsDefault));
}
private string BuildSanitizedFileName(IMapping mapping, char replaceChar = '_')
{
string name;
if (!string.IsNullOrEmpty(mapping.Title))
{
name = mapping.Title!;
if (_settings.ProxyAndRecordSettings?.AppendGuidToSavedMappingFile == true)
{
name += $"{replaceChar}{mapping.Guid}";
}
}
else
{
name = mapping.Guid.ToString();
}
return $"{Path.GetInvalidFileNameChars().Aggregate(name, (current, c) => current.Replace(c, replaceChar))}.json";
}
}

12
src/WireMock.Net/Settings/ProxyAndRecordSettings.cs
View File

@@ -7,6 +7,11 @@ namespace WireMock.Settings;
/// </summary>
public class ProxyAndRecordSettings : HttpClientSettings
{
/// <summary>
/// Default prefix value for saved mapping file
/// </summary>
public const string DefaultPrefixForSavedMappingFile = "Proxy Mapping for ";
/// <summary>
/// The URL to proxy.
/// </summary>
@@ -95,9 +100,14 @@ public class ProxyAndRecordSettings : HttpClientSettings
/// </summary>
public bool AppendGuidToSavedMappingFile { get; set; }
/// <summary>
/// Set prefix for saved mapping file.
/// </summary>
public string PrefixForSavedMappingFile { get; set; } = DefaultPrefixForSavedMappingFile;
/// <summary>
/// Proxy all Api calls, irrespective of any condition
/// </summary>
[PublicAPI]
public bool ProxyAll { get; set; } = false;
}
}

1
src/WireMock.Net/Settings/WireMockServerSettingsParser.cs
View File

@@ -120,6 +120,7 @@ public static class WireMockServerSettingsParser
SaveMappingToFile = parser.GetBoolValue("SaveMappingToFile"),
UseDefinedRequestMatchers = parser.GetBoolValue(nameof(ProxyAndRecordSettings.UseDefinedRequestMatchers)),
AppendGuidToSavedMappingFile = parser.GetBoolValue(nameof(ProxyAndRecordSettings.AppendGuidToSavedMappingFile)),
PrefixForSavedMappingFile = parser.GetStringValue(nameof(ProxyAndRecordSettings.PrefixForSavedMappingFile), null),
Url = proxyUrl!,
SaveMappingSettings = new ProxySaveMappingSettings
{

160
test/WireMock.Net.Tests/Serialization/MappingFileNameSanitizerTests.cs Normal file
View File

@@ -0,0 +1,160 @@
using System;
using Moq;
using WireMock.Serialization;
using WireMock.Settings;
using Xunit;
namespace WireMock.Net.Tests.Serialization;
public class MappingFileNameSanitizerTests
{
private const string MappingGuid = "ce216a13-e7d6-42d7-91ac-8ae709e2add1";
private const string MappingTitle = "Proxy Mapping for POST _ordermanagement_v1_orders_cancel";
[Fact]
public void BuildSanitizedFileName_WithTitleAndGuid_AppendsGuid()
{
// Arrange
var mappingMock = new Mock<IMapping>();
mappingMock.Setup(m => m.Title).Returns(MappingTitle);
mappingMock.Setup(m => m.Guid).Returns(new Guid(MappingGuid));
var settings = new WireMockServerSettings
{
ProxyAndRecordSettings = new ProxyAndRecordSettings
{
AppendGuidToSavedMappingFile = true
}
};
var sanitizer = new MappingFileNameSanitizer(settings);
// Act
var result = sanitizer.BuildSanitizedFileName(mappingMock.Object);
// Assert
Assert.Equal($"Proxy Mapping for _POST_ordermanagement_v1_orders_cancel_{MappingGuid}.json", result);
}
[Fact]
public void BuildSanitizedFileName_WithoutTitle_UsesGuid()
{
// Arrange
var mappingMock = new Mock<IMapping>();
mappingMock.Setup(m => m.Title).Returns((string?)null);
mappingMock.Setup(m => m.Guid).Returns(new Guid(MappingGuid));
var settings = new WireMockServerSettings
{
ProxyAndRecordSettings = new ()
};
var sanitizer = new MappingFileNameSanitizer(settings);
// Act
var result = sanitizer.BuildSanitizedFileName(mappingMock.Object);
// Assert
Assert.Equal($"Proxy Mapping for _{MappingGuid}.json", result);
}
[Fact]
public void BuildSanitizedFileName_WithTitleAndGuid_NoAppendGuidSetting()
{
// Arrange
var mappingMock = new Mock<IMapping>();
mappingMock.Setup(m => m.Title).Returns(MappingTitle);
mappingMock.Setup(m => m.Guid).Returns(new Guid(MappingGuid));
var settings = new WireMockServerSettings
{
ProxyAndRecordSettings = new ProxyAndRecordSettings
{
AppendGuidToSavedMappingFile = false
}
};
var sanitizer = new MappingFileNameSanitizer(settings);
// Act
var result = sanitizer.BuildSanitizedFileName(mappingMock.Object);
// Assert
Assert.Equal("Proxy Mapping for _POST_ordermanagement_v1_orders_cancel.json", result);
}
[Fact]
public void BuildSanitizedFileName_WithPrefix_AddsPrefix()
{
// Arrange
var mappingMock = new Mock<IMapping>();
mappingMock.Setup(m => m.Title).Returns(MappingTitle);
mappingMock.Setup(m => m.Guid).Returns(new Guid(MappingGuid));
var settings = new WireMockServerSettings
{
ProxyAndRecordSettings = new ProxyAndRecordSettings
{
PrefixForSavedMappingFile = "Prefix"
}
};
var sanitizer = new MappingFileNameSanitizer(settings);
// Act
var result = sanitizer.BuildSanitizedFileName(mappingMock.Object);
// Assert
Assert.Equal($"Prefix_POST_ordermanagement_v1_orders_cancel.json", result);
}
[Fact]
public void BuildSanitizedFileName_WithPrefix_AddsPrefixEmptyString()
{
// Arrange
var mappingMock = new Mock<IMapping>();
mappingMock.Setup(m => m.Title).Returns(MappingTitle);
mappingMock.Setup(m => m.Guid).Returns(new Guid(MappingGuid));
var settings = new WireMockServerSettings
{
ProxyAndRecordSettings = new ProxyAndRecordSettings
{
PrefixForSavedMappingFile = string.Empty
}
};
var sanitizer = new MappingFileNameSanitizer(settings);
// Act
var result = sanitizer.BuildSanitizedFileName(mappingMock.Object);
// Assert
Assert.Equal($"POST_ordermanagement_v1_orders_cancel.json", result);
}
[Fact]
public void BuildSanitizedFileName_WithTitleAndGuid_WithPrefixAndAppendGuidSetting()
{
// Arrange
var mappingMock = new Mock<IMapping>();
mappingMock.Setup(m => m.Title).Returns(MappingTitle);
mappingMock.Setup(m => m.Guid).Returns(new Guid(MappingGuid));
var settings = new WireMockServerSettings
{
ProxyAndRecordSettings = new ProxyAndRecordSettings
{
PrefixForSavedMappingFile = "Prefix",
AppendGuidToSavedMappingFile = true
}
};
var sanitizer = new MappingFileNameSanitizer(settings);
// Act
var result = sanitizer.BuildSanitizedFileName(mappingMock.Object);
// Assert
Assert.Equal($"Prefix_POST_ordermanagement_v1_orders_cancel_{MappingGuid}.json", result);
}
}

2
test/WireMock.Net.Tests/WireMockServer.Proxy.cs
View File

@@ -174,7 +174,7 @@ public class WireMockServerProxyTests
server.Mappings.Should().HaveCount(2);
// Verify
fileSystemHandlerMock.Verify(f => f.WriteMappingFile($"m{System.IO.Path.DirectorySeparatorChar}{title}.json", It.IsRegex(stringBody)), Times.Once);
fileSystemHandlerMock.Verify(f => f.WriteMappingFile($"m{System.IO.Path.DirectorySeparatorChar}Proxy Mapping for _{title}.json", It.IsRegex(stringBody)), Times.Once);
}
[Fact]