am-wd/cloudflare-api
1
0
Fork 0
Code Issues Actions Activity

Add "ZoneHold" extensions

Browse Source
This commit is contained in:
Andreas Müller
2025-06-24 20:44:09 +02:00
parent f9b7dcb7d2
commit 682f25ae75
13 changed files with 724 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
Extensions/Cloudflare.Zones/Internals/InternalCreateZoneHoldFilter.cs Normal file
View File

@@ -0,0 +1,17 @@
namespace AMWD.Net.Api.Cloudflare.Zones.Internals
{
internal class InternalCreateZoneHoldFilter : IQueryParameterFilter
{
public bool? IncludeSubdomains { get; set; }
public IDictionary<string, string> GetQueryParameters()
{
var dict = new Dictionary<string, string>();
if (IncludeSubdomains.HasValue)
dict.Add("include_subdomains", IncludeSubdomains.Value ? "true" : "false");
return dict;
}
}
}

17
Extensions/Cloudflare.Zones/Internals/InternalRemoveZoneHoldFilter.cs Normal file
View File

@@ -0,0 +1,17 @@
namespace AMWD.Net.Api.Cloudflare.Zones.Internals
{
internal class InternalRemoveZoneHoldFilter : IQueryParameterFilter
{
public DateTime? HoldAfter { get; set; }
public IDictionary<string, string> GetQueryParameters()
{
var dict = new Dictionary<string, string>();
if (HoldAfter.HasValue)
dict.Add("hold_after", HoldAfter.Value.ToUniversalTime().ToString("yyyy-MM-dd'T'HH:mm:ss'Z'"));
return dict;
}
}
}

11
Extensions/Cloudflare.Zones/Internals/InternalUpdateZoneHoldRequest.cs Normal file
View File

@@ -0,0 +1,11 @@
namespace AMWD.Net.Api.Cloudflare.Zones.Internals
{
internal class InternalUpdateZoneHoldRequest
{
[JsonProperty("hold_after")]
public DateTime? HoldAfter { get; set; }
[JsonProperty("include_subdomains")]
public bool? IncludeSubdomains { get; set; }
}
}

27
Extensions/Cloudflare.Zones/Models/ZoneHold.cs Normal file
View File

@@ -0,0 +1,27 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// A Cloudflare zone hold.
/// <see href="https://github.com/cloudflare/cloudflare-typescript/blob/v4.4.1/src/resources/zones/holds.ts#L88">Source</see>
/// </summary>
public class ZoneHold
{
/// <summary>
/// Whether the zone is on hold.
/// </summary>
[JsonProperty("hold")]
public bool? Hold { get; set; }
/// <summary>
/// The hold is enabled if the value is in the past.
/// </summary>
[JsonProperty("hold_after")]
public DateTime? HoldAfter { get; set; }
/// <summary>
/// Whether to include subdomains in the hold.
/// </summary>
[JsonProperty("include_subdomains")]
public bool? IncludeSubdomains { get; set; }
}
}

8
Extensions/Cloudflare.Zones/README.md
View File

@@ -25,6 +25,13 @@ This package contains the feature set of the _Domain/Zone Management_ section of
- [Rerun The Activation Check](https://developers.cloudflare.com/api/resources/zones/subresources/activation_check/methods/trigger/)
##### [Holds]
- [Create Zone Hold](https://developers.cloudflare.com/api/resources/zones/subresources/holds/methods/create/)
- [Remove Zone Hold](https://developers.cloudflare.com/api/resources/zones/subresources/holds/methods/delete/)
- [Update Zone Hold](https://developers.cloudflare.com/api/resources/zones/subresources/holds/methods/edit/)
- [Get Zone Hold](https://developers.cloudflare.com/api/resources/zones/subresources/holds/methods/get/)
@@ -41,3 +48,4 @@ Published under MIT License (see [choose a license])
[Registrar]: https://developers.cloudflare.com/api/resources/registrar/
[Zones]: https://developers.cloudflare.com/api/resources/zones/
[Activation Check]: https://developers.cloudflare.com/api/resources/zones/subresources/activation_check/
[Holds]: https://developers.cloudflare.com/api/resources/zones/subresources/holds/

32
Extensions/Cloudflare.Zones/Requests/CreateZoneHoldRequest.cs Normal file
View File

@@ -0,0 +1,32 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Represents a request to create a zone hold.
/// </summary>
public class CreateZoneHoldRequest
{
/// <summary>
/// Initializes a new instance of the <see cref="CreateZoneHoldRequest"/> class.
/// </summary>
/// <param name="zoneId">The zone identifier.</param>
public CreateZoneHoldRequest(string zoneId)
{
ZoneId = zoneId;
}
/// <summary>
/// The zone identifier.
/// </summary>
public string ZoneId { get; set; }
/// <summary>
/// If provided, the zone hold will extend to block any subdomain of the given zone, as well as SSL4SaaS Custom Hostnames.
/// </summary>
/// <remarks>
/// For example, a zone hold on a zone with the hostname 'example.com' and
/// <c><see cref="IncludeSubdomains"/>=<see langword="true"/></c> will block
/// 'example.com', 'staging.example.com', 'api.staging.example.com', etc.
/// </remarks>
public bool? IncludeSubdomains { get; set; }
}
}

29
Extensions/Cloudflare.Zones/Requests/RemoveZoneHoldRequest.cs Normal file
View File

@@ -0,0 +1,29 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Represents a request to remove a zone hold.
/// </summary>
public class RemoveZoneHoldRequest
{
/// <summary>
/// Initializes a new instance of the <see cref="RemoveZoneHoldRequest"/> class.
/// </summary>
/// <param name="zoneId">The zone identifier.</param>
public RemoveZoneHoldRequest(string zoneId)
{
ZoneId = zoneId;
}
/// <summary>
/// The zone identifier.
/// </summary>
public string ZoneId { get; set; }
/// <summary>
/// If it is provided, the hold will be temporarily disabled,
/// then automatically re-enabled by the system at the time specified in this timestamp.
/// Otherwise, the hold will be disabled indefinitely.
/// </summary>
public DateTime? HoldAfter { get; set; }
}
}

37
Extensions/Cloudflare.Zones/Requests/UpdateZoneHoldRequest.cs Normal file
View File

@@ -0,0 +1,37 @@
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Represents a request to update a zone hold.
/// </summary>
public class UpdateZoneHoldRequest
{
/// <summary>
/// Initializes a new instance of the <see cref="UpdateZoneHoldRequest"/> class.
/// </summary>
/// <param name="zoneId">The zone identifier.</param>
public UpdateZoneHoldRequest(string zoneId)
{
ZoneId = zoneId;
}
/// <summary>
/// The zone identifier.
/// </summary>
public string ZoneId { get; set; }
/// <summary>
/// If the value is provided and future-dated, the hold will be temporarily disabled,
/// then automatically re-enabled by the system at the time specified in this timestamp.
/// A past-dated value will have no effect on an existing, enabled hold.
/// Providing an empty string will set its value to the current time.
/// </summary>
public DateTime? HoldAfter { get; set; }
/// <summary>
/// If <see langword="true"/>, the zone hold will extend to block any subdomain of the given zone, as well as SSL4SaaS Custom Hostnames.
/// For example, a zone hold on a zone with the hostname 'example.com' and <c><see cref="IncludeSubdomains"/>=<see langword="true"/></c>
/// will block 'example.com', 'staging.example.com', 'api.staging.example.com', etc.
/// </summary>
public bool? IncludeSubdomains { get; set; }
}
}

82
Extensions/Cloudflare.Zones/ZoneHoldsExtensions.cs Normal file
View File

@@ -0,0 +1,82 @@
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare.Zones.Internals;
namespace AMWD.Net.Api.Cloudflare.Zones
{
/// <summary>
/// Extensions for <see href="https://developers.cloudflare.com/api/resources/zones/subresources/holds/">Zone Holds</see>.
/// </summary>
public static class ZoneHoldsExtensions
{
/// <summary>
/// Enforce a zone hold on the zone, blocking the creation and activation of zones with this zone's hostname.
/// </summary>
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
/// <param name="request">The request.</param>
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
public static Task<CloudflareResponse<ZoneHold>> CreateZoneHold(this ICloudflareClient client, CreateZoneHoldRequest request, CancellationToken cancellationToken = default)
{
request.ZoneId.ValidateCloudflareId();
var filter = new InternalCreateZoneHoldFilter
{
IncludeSubdomains = request.IncludeSubdomains
};
return client.PostAsync<ZoneHold, object>($"/zones/{request.ZoneId}/hold", null, filter, cancellationToken);
}
/// <summary>
/// Stop enforcement of a zone hold on the zone, permanently or temporarily,
/// allowing the creation and activation of zones with this zone's hostname.
/// </summary>
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
/// <param name="request">The request.</param>
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
public static Task<CloudflareResponse<ZoneHold>> RemoveZoneHold(this ICloudflareClient client, RemoveZoneHoldRequest request, CancellationToken cancellationToken = default)
{
request.ZoneId.ValidateCloudflareId();
var filter = new InternalRemoveZoneHoldFilter
{
HoldAfter = request.HoldAfter
};
return client.DeleteAsync<ZoneHold>($"/zones/{request.ZoneId}/hold", filter, cancellationToken);
}
/// <summary>
/// Update the <see cref="UpdateZoneHoldRequest.HoldAfter"/> and/or <see cref="UpdateZoneHoldRequest.IncludeSubdomains"/> values on an existing zone hold.
/// The hold is enabled if the <see cref="UpdateZoneHoldRequest.HoldAfter"/> is in the past.
/// </summary>
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
/// <param name="request">The request.</param>
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
public static Task<CloudflareResponse<ZoneHold>> UpdateZoneHold(this ICloudflareClient client, UpdateZoneHoldRequest request, CancellationToken cancellationToken = default)
{
request.ZoneId.ValidateCloudflareId();
var req = new InternalUpdateZoneHoldRequest
{
HoldAfter = request.HoldAfter,
IncludeSubdomains = request.IncludeSubdomains
};
return client.PatchAsync<ZoneHold, InternalUpdateZoneHoldRequest>($"/zones/{request.ZoneId}/hold", req, cancellationToken);
}
/// <summary>
/// Retrieve whether the zone is subject to a zone hold, and metadata about the hold.
/// </summary>
/// <param name="client">The <see cref="ICloudflareClient"/> instance.</param>
/// <param name="zoneId">The zone identifier.</param>
/// <param name="cancellationToken">A cancellation token used to propagate notification that this operation should be canceled.</param>
public static Task<CloudflareResponse<ZoneHold>> GetZoneHold(this ICloudflareClient client, string zoneId, CancellationToken cancellationToken = default)
{
zoneId.ValidateCloudflareId();
return client.GetAsync<ZoneHold>($"/zones/{zoneId}/hold", cancellationToken: cancellationToken);
}
}
}

148
UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/CreateZoneHoldTest.cs Normal file
View File

@@ -0,0 +1,148 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Zones;
using AMWD.Net.Api.Cloudflare.Zones.Internals;
using Moq;
namespace Cloudflare.Zones.Tests.ZoneHoldsExtensions
{
[TestClass]
public class CreateZoneHoldTest
{
private readonly DateTime _date = new(2025, 10, 10, 20, 30, 40, 0, DateTimeKind.Utc);
private const string ZoneId = "023e105f4ecef8ad9ca31a8372d0c353";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<ZoneHold> _response;
private List<(string RequestPath, object Request, IQueryParameterFilter QueryFilter)> _callbacks;
private CreateZoneHoldRequest _request;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<ZoneHold>
{
Success = true,
Messages = [
new ResponseInfo(1000, "Message 1")
],
Errors = [
new ResponseInfo(1000, "Error 1")
],
Result = new ZoneHold
{
Hold = true,
HoldAfter = _date,
IncludeSubdomains = false
}
};
_request = new CreateZoneHoldRequest(ZoneId);
}
[TestMethod]
public async Task ShouldCreateZoneHold()
{
// Arrange
var client = GetClient();
// Act
var response = await client.CreateZoneHold(_request);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/hold", callback.RequestPath);
Assert.IsNotNull(callback.QueryFilter);
Assert.IsInstanceOfType<InternalCreateZoneHoldFilter>(callback.QueryFilter);
Assert.IsNull(((InternalCreateZoneHoldFilter)callback.QueryFilter).IncludeSubdomains);
_clientMock.Verify(m => m.PostAsync<ZoneHold, object>($"/zones/{ZoneId}/hold", null, It.IsAny<InternalCreateZoneHoldFilter>(), It.IsAny<CancellationToken>()), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
[TestMethod]
public async Task ShouldCreateZoneHoldWithSubdomains()
{
// Arrange
_request.IncludeSubdomains = true;
var client = GetClient();
// Act
var response = await client.CreateZoneHold(_request);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/hold", callback.RequestPath);
Assert.IsNotNull(callback.QueryFilter);
Assert.IsInstanceOfType<InternalCreateZoneHoldFilter>(callback.QueryFilter);
Assert.IsTrue(((InternalCreateZoneHoldFilter)callback.QueryFilter).IncludeSubdomains);
_clientMock.Verify(m => m.PostAsync<ZoneHold, object>($"/zones/{ZoneId}/hold", null, It.IsAny<InternalCreateZoneHoldFilter>(), It.IsAny<CancellationToken>()), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
[TestMethod]
public void ShouldReturnEmptyDictionary()
{
// Arrange
var filter = new InternalCreateZoneHoldFilter();
// Act
var dict = filter.GetQueryParameters();
// Assert
Assert.IsNotNull(dict);
Assert.AreEqual(0, dict.Count);
}
[DataTestMethod]
[DataRow(true)]
[DataRow(false)]
public void ShouldReturnQueryParameter(bool includeSubdomains)
{
// Arrange
var filter = new InternalCreateZoneHoldFilter { IncludeSubdomains = includeSubdomains };
// Act
var dict = filter.GetQueryParameters();
// Assert
Assert.IsNotNull(dict);
Assert.AreEqual(1, dict.Count);
Assert.IsTrue(dict.ContainsKey("include_subdomains"));
Assert.AreEqual(includeSubdomains.ToString().ToLower(), dict["include_subdomains"]);
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.PostAsync<ZoneHold, object>(It.IsAny<string>(), It.IsAny<object>(), It.IsAny<IQueryParameterFilter>(), It.IsAny<CancellationToken>()))
.Callback<string, object, IQueryParameterFilter, CancellationToken>((requestPath, request, queryFilter, _) => _callbacks.Add((requestPath, request, queryFilter)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
}
}

80
UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/GetZoneHoldTest.cs Normal file
View File

@@ -0,0 +1,80 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Zones;
using Moq;
namespace Cloudflare.Zones.Tests.ZoneHoldsExtensions
{
[TestClass]
public class GetZoneHoldTest
{
private readonly DateTime _date = new DateTime(2024, 10, 10, 20, 30, 40, 0, DateTimeKind.Utc);
private const string ZoneId = "023e105f4ecef8ad9ca31a8372d0c353";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<ZoneHold> _response;
private List<(string RequestPath, IQueryParameterFilter QueryFilter)> _callbacks;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<ZoneHold>
{
Success = true,
Messages = [
new ResponseInfo(1000, "Message 1")
],
Errors = [
new ResponseInfo(1000, "Error 1")
],
Result = new ZoneHold
{
Hold = true,
HoldAfter = _date,
IncludeSubdomains = false
}
};
}
[TestMethod]
public async Task ShouldGetZoneHold()
{
// Arrange
var client = GetClient();
// Act
var response = await client.GetZoneHold(ZoneId);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/hold", callback.RequestPath);
Assert.IsNull(callback.QueryFilter);
_clientMock.Verify(m => m.GetAsync<ZoneHold>($"/zones/{ZoneId}/hold", null, It.IsAny<CancellationToken>()), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.GetAsync<ZoneHold>(It.IsAny<string>(), It.IsAny<IQueryParameterFilter>(), It.IsAny<CancellationToken>()))
.Callback<string, IQueryParameterFilter, CancellationToken>((requestPath, queryFilter, _) => _callbacks.Add((requestPath, queryFilter)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
}
}

147
UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/RemoveZoneHoldTest.cs Normal file
View File

@@ -0,0 +1,147 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Zones;
using AMWD.Net.Api.Cloudflare.Zones.Internals;
using Moq;
namespace Cloudflare.Zones.Tests.ZoneHoldsExtensions
{
[TestClass]
public class RemoveZoneHoldTest
{
// Local: Europe/Berlin (Germany) - [CEST +2] | CET +1
private readonly DateTime _date = new(2025, 10, 10, 20, 30, 40, 0, DateTimeKind.Unspecified);
private const string ZoneId = "023e105f4ecef8ad9ca31a8372d0c353";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<ZoneHold> _response;
private List<(string RequestPath, IQueryParameterFilter QueryFilter)> _callbacks;
private RemoveZoneHoldRequest _request;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<ZoneHold>
{
Success = true,
Messages = [
new ResponseInfo(1000, "Message 1")
],
Errors = [
new ResponseInfo(1000, "Error 1")
],
Result = new ZoneHold
{
Hold = true,
HoldAfter = _date,
IncludeSubdomains = true
}
};
_request = new RemoveZoneHoldRequest(ZoneId);
}
[TestMethod]
public async Task ShouldRemoveZoneHold()
{
// Arrange
var client = GetClient();
// Act
var response = await client.RemoveZoneHold(_request);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/hold", callback.RequestPath);
Assert.IsNotNull(callback.QueryFilter);
Assert.IsInstanceOfType<InternalRemoveZoneHoldFilter>(callback.QueryFilter);
Assert.IsNull(((InternalRemoveZoneHoldFilter)callback.QueryFilter).HoldAfter);
_clientMock.Verify(m => m.DeleteAsync<ZoneHold>($"/zones/{ZoneId}/hold", It.IsAny<InternalRemoveZoneHoldFilter>(), It.IsAny<CancellationToken>()), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
[TestMethod]
public async Task ShouldRemoveZoneHoldTemporarily()
{
// Arrange
_request.HoldAfter = _date;
var client = GetClient();
// Act
var response = await client.RemoveZoneHold(_request);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/hold", callback.RequestPath);
Assert.IsNotNull(callback.QueryFilter);
Assert.IsInstanceOfType<InternalRemoveZoneHoldFilter>(callback.QueryFilter);
Assert.AreEqual(_date, ((InternalRemoveZoneHoldFilter)callback.QueryFilter).HoldAfter);
_clientMock.Verify(m => m.DeleteAsync<ZoneHold>($"/zones/{ZoneId}/hold", It.IsAny<InternalRemoveZoneHoldFilter>(), It.IsAny<CancellationToken>()), Times.Once);
_clientMock.VerifyNoOtherCalls();
}
[TestMethod]
public void ShouldReturnEmptyDictionary()
{
// Arrange
var filter = new InternalRemoveZoneHoldFilter();
// Act
var dict = filter.GetQueryParameters();
// Assert
Assert.IsNotNull(dict);
Assert.AreEqual(0, dict.Count);
}
[TestMethod]
public void ShouldReturnQueryParameter()
{
// Arrange
var filter = new InternalRemoveZoneHoldFilter { HoldAfter = _date };
// Act
var dict = filter.GetQueryParameters();
// Assert
Assert.IsNotNull(dict);
Assert.AreEqual(1, dict.Count);
Assert.IsTrue(dict.ContainsKey("hold_after"));
Assert.AreEqual("2025-10-10T18:30:40Z", dict["hold_after"]);
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.DeleteAsync<ZoneHold>(It.IsAny<string>(), It.IsAny<IQueryParameterFilter>(), It.IsAny<CancellationToken>()))
.Callback<string, IQueryParameterFilter, CancellationToken>((requestPath, queryFilter, _) => _callbacks.Add((requestPath, queryFilter)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
}
}

89
UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/UpdateZoneHoldTest.cs Normal file
View File

@@ -0,0 +1,89 @@
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using AMWD.Net.Api.Cloudflare;
using AMWD.Net.Api.Cloudflare.Zones;
using AMWD.Net.Api.Cloudflare.Zones.Internals;
using Moq;
namespace Cloudflare.Zones.Tests.ZoneHoldsExtensions
{
[TestClass]
public class UpdateZoneHoldTest
{
private readonly DateTime _date = new DateTime(2024, 10, 10, 20, 30, 40, 0, DateTimeKind.Utc);
private const string ZoneId = "023e105f4ecef8ad9ca31a8372d0c353";
private Mock<ICloudflareClient> _clientMock;
private CloudflareResponse<ZoneHold> _response;
private List<(string RequestPath, InternalUpdateZoneHoldRequest Request)> _callbacks;
private UpdateZoneHoldRequest _request;
[TestInitialize]
public void Initialize()
{
_callbacks = [];
_response = new CloudflareResponse<ZoneHold>
{
Success = true,
Messages = [
new ResponseInfo(1000, "Message 1")
],
Errors = [
new ResponseInfo(1000, "Error 1")
],
Result = new ZoneHold
{
Hold = true,
HoldAfter = _date,
IncludeSubdomains = false
}
};
_request = new UpdateZoneHoldRequest(ZoneId)
{
HoldAfter = _date,
IncludeSubdomains = true
};
}
[TestMethod]
public async Task ShouldUpdateZoneHold()
{
// Arrange
var client = GetClient();
// Act
var response = await client.UpdateZoneHold(_request);
// Assert
Assert.IsNotNull(response);
Assert.IsTrue(response.Success);
Assert.AreEqual(_response.Result, response.Result);
Assert.AreEqual(1, _callbacks.Count);
var callback = _callbacks.First();
Assert.AreEqual($"/zones/{ZoneId}/hold", callback.RequestPath);
Assert.IsNotNull(callback.Request);
Assert.AreEqual(_date, callback.Request.HoldAfter);
Assert.IsTrue(callback.Request.IncludeSubdomains);
}
private ICloudflareClient GetClient()
{
_clientMock = new Mock<ICloudflareClient>();
_clientMock
.Setup(m => m.PatchAsync<ZoneHold, InternalUpdateZoneHoldRequest>(It.IsAny<string>(), It.IsAny<InternalUpdateZoneHoldRequest>(), It.IsAny<CancellationToken>()))
.Callback<string, InternalUpdateZoneHoldRequest, CancellationToken>((requestPath, request, _) => _callbacks.Add((requestPath, request)))
.ReturnsAsync(() => _response);
return _clientMock.Object;
}
}
}