Add "ZoneHold" extensions

2025-06-24 20:44:09 +02:00
parent f9b7dcb7d2
commit 682f25ae75
13 changed files with 724 additions and 0 deletions
--- a/UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/CreateZoneHoldTest.cs
+++ b/UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/CreateZoneHoldTest.cs
@@ -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;
+		}
+	}
+}
--- a/UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/GetZoneHoldTest.cs
+++ b/UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/GetZoneHoldTest.cs
@@ -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;
+		}
+	}
+}
--- a/UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/RemoveZoneHoldTest.cs
+++ b/UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/RemoveZoneHoldTest.cs
@@ -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;
+		}
+	}
+}
--- a/UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/UpdateZoneHoldTest.cs
+++ b/UnitTests/Cloudflare.Zones.Tests/ZoneHoldsExtensions/UpdateZoneHoldTest.cs
@@ -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;
+		}
+	}
+}