AI code review: fix bugs, rename sld to subdomain, improve usability (#2)
- bug fixes: API errors are no longer wrapped into "Unexpected error!", zoneGet no longer crashes on unknown zones, getSubdomain handles apex and multi-level names, batch operations send the full record name, list methods fetch all pages, recordDelete handles empty results - rename "sld" to "subdomain": getSubdomain(), recordCreateSubdomain(), old methods deprecated; "@" (CfDnsClient.APEX) addresses the apex - one shared HTTP client with connection pooling, CfDnsClient implements AutoCloseable - CloudflareApiException provides HTTP status code and Cloudflare errors, HTTP 404 throws CloudflareNotFoundException - RecordEntity supports priority, data, comment and tags - recordCreate/recordUpdate send only writable attributes and don't modify the given record - breaking: recordList overloads replaced by recordListBySubdomain and recordListByType, timestamps are java.time.Instant - single record type is filtered server-side (?type=) - tests, README and changelog updated refs #2 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
4b560141a1
commit
732f92ee78
22 files changed
+1256
-336
No files matched your search
@@ -0,0 +1,128 @@
|
||||
package codes.thischwa.cf;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertInstanceOf;
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
|
||||
import codes.thischwa.cf.model.ZoneEntity;
|
||||
import com.sun.net.httpserver.HttpServer;
|
||||
import java.io.IOException;
|
||||
import java.io.OutputStream;
|
||||
import java.net.InetSocketAddress;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.util.concurrent.atomic.AtomicInteger;
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
/**
|
||||
* Tests the error handling of {@link CfBasicHttpClient} against a local HTTP server.
|
||||
*/
|
||||
class CfBasicHttpClientErrorTest {
|
||||
|
||||
private static final String ZONE_JSON = """
|
||||
{"success":true,"errors":[],"messages":[],
|
||||
"result_info":{"page":1,"per_page":50,"total_pages":1,"count":1,"total_count":1},
|
||||
"result":[{"id":"zone1","name":"example.com","created_on":"2025-01-20T08:56:34.736214Z"}]}
|
||||
""";
|
||||
|
||||
private HttpServer server;
|
||||
private CfDnsClient client;
|
||||
private final AtomicInteger requestCount = new AtomicInteger();
|
||||
private volatile int status;
|
||||
private volatile String body;
|
||||
|
||||
@BeforeEach
|
||||
void setUp() throws IOException {
|
||||
server = HttpServer.create(new InetSocketAddress("localhost", 0), 0);
|
||||
server.createContext("/", exchange -> {
|
||||
requestCount.incrementAndGet();
|
||||
byte[] bytes = body.getBytes(StandardCharsets.UTF_8);
|
||||
exchange.sendResponseHeaders(status, bytes.length);
|
||||
try (OutputStream out = exchange.getResponseBody()) {
|
||||
out.write(bytes);
|
||||
}
|
||||
});
|
||||
server.start();
|
||||
client = new CfDnsClientBuilder()
|
||||
.withApiTokenAuth("test-token")
|
||||
.withBaseUrl("http://localhost:" + server.getAddress().getPort())
|
||||
.build();
|
||||
}
|
||||
|
||||
@AfterEach
|
||||
void tearDown() throws IOException {
|
||||
client.close();
|
||||
server.stop(0);
|
||||
}
|
||||
|
||||
private void respond(int status, String body) {
|
||||
this.status = status;
|
||||
this.body = body;
|
||||
}
|
||||
|
||||
@Test
|
||||
void apiErrorContainsStatusCodeAndErrors() {
|
||||
respond(400, """
|
||||
{"success":false,"errors":[{"code":1004,"message":"DNS Validation Error"}],"messages":[],"result":null}
|
||||
""");
|
||||
|
||||
CloudflareApiException e = assertThrows(CloudflareApiException.class, () -> client.zoneList());
|
||||
|
||||
assertEquals(CloudflareApiException.class, e.getClass());
|
||||
assertEquals(400, e.getStatusCode());
|
||||
assertEquals(1, e.getErrors().size());
|
||||
assertEquals(1004, e.getErrors().get(0).getCode());
|
||||
assertTrue(e.getMessage().contains("DNS Validation Error"), e.getMessage());
|
||||
}
|
||||
|
||||
@Test
|
||||
void status404ThrowsNotFound() {
|
||||
respond(404, """
|
||||
{"success":false,"errors":[{"code":81044,"message":"Record does not exist."}],"messages":[],"result":null}
|
||||
""");
|
||||
ZoneEntity zone = new ZoneEntity();
|
||||
zone.setId("zone1");
|
||||
zone.setName("example.com");
|
||||
|
||||
CloudflareApiException e = assertThrows(CloudflareApiException.class,
|
||||
() -> client.recordDelete(zone, "0123456789abcdef0123456789abcdef"));
|
||||
|
||||
assertInstanceOf(CloudflareNotFoundException.class, e);
|
||||
assertEquals(404, e.getStatusCode());
|
||||
assertEquals(81044, e.getErrors().get(0).getCode());
|
||||
}
|
||||
|
||||
@Test
|
||||
void nonJsonErrorResponseKeepsStatusCode() {
|
||||
respond(502, "<html><body>Bad Gateway</body></html>");
|
||||
|
||||
CloudflareApiException e = assertThrows(CloudflareApiException.class, () -> client.zoneList());
|
||||
|
||||
assertEquals(502, e.getStatusCode());
|
||||
assertTrue(e.getErrors().isEmpty());
|
||||
assertTrue(e.getMessage().contains("502"), e.getMessage());
|
||||
}
|
||||
|
||||
@Test
|
||||
void successWithTimestampsAndReusedClient() throws CloudflareApiException {
|
||||
respond(200, ZONE_JSON);
|
||||
|
||||
ZoneEntity zone = client.zoneGet("example.com");
|
||||
assertNotNull(zone);
|
||||
assertEquals("2025-01-20T08:56:34.736214Z", zone.getCreatedOn().toString());
|
||||
|
||||
// the same client instance can be used for multiple requests
|
||||
assertEquals(1, client.zoneList().size());
|
||||
assertEquals(2, requestCount.get());
|
||||
}
|
||||
|
||||
@Test
|
||||
void exceptionWithoutResponseHasNoStatusCode() {
|
||||
CloudflareApiException e = new CloudflareApiException("test");
|
||||
assertEquals(CloudflareApiException.NO_STATUS_CODE, e.getStatusCode());
|
||||
assertTrue(e.getErrors().isEmpty());
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,7 @@
|
||||
package codes.thischwa.cf;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertInstanceOf;
|
||||
import static org.junit.jupiter.api.Assertions.assertNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
@@ -79,10 +79,10 @@ class CfBasicHttpClientTest {
|
||||
});
|
||||
|
||||
assertNotNull(exception);
|
||||
assertTrue(exception.getMessage().contains("Unexpected error"));
|
||||
Throwable cause = exception.getCause();
|
||||
assertInstanceOf(CloudflareApiException.class, cause);
|
||||
assertTrue(cause.getMessage().contains("No route for that URI"), "Expected error message: No route for that URI, but it was: " + cause.getMessage());
|
||||
// the API error must not be wrapped into a generic "Unexpected error"
|
||||
assertTrue(exception.getMessage().contains("No route for that URI"),
|
||||
"Expected error message: No route for that URI, but it was: " + exception.getMessage());
|
||||
assertNull(exception.getCause());
|
||||
}
|
||||
|
||||
@Test
|
||||
|
||||
@@ -56,11 +56,11 @@ public class CfClientPenTest {
|
||||
"doesnotexist", "abcdef12345", "unwahrscheinlich-" + System.currentTimeMillis());
|
||||
|
||||
for (String sld : syntacticallyInvalidSlds) {
|
||||
assertThrows(IllegalArgumentException.class, () -> client.recordList(zone, sld),
|
||||
assertThrows(IllegalArgumentException.class, () -> client.recordListBySubdomain(zone, sld),
|
||||
"Should throw IllegalArgumentException for invalid SLD '" + sld + "'");
|
||||
}
|
||||
for (String sld : syntacticallyValidOrNotAllowedFromCloudflare) {
|
||||
assertThrows(CloudflareNotFoundException.class, () -> client.recordList(zone, sld),
|
||||
assertThrows(CloudflareNotFoundException.class, () -> client.recordListBySubdomain(zone, sld),
|
||||
"Should throw CloudflareNotFoundException for valid but non-existing SLD '" + sld + "'");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -44,7 +44,7 @@ public class CfClientTest {
|
||||
@Test
|
||||
void testUnknownSld() throws Exception {
|
||||
ZoneEntity zone = client.zoneGet(ZONE_STR);
|
||||
assertThrows(CloudflareNotFoundException.class, () -> client.recordList(zone, "unknown", RecordType.A));
|
||||
assertThrows(CloudflareNotFoundException.class, () -> client.recordListBySubdomain(zone, "unknown", RecordType.A));
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -58,13 +58,13 @@ public class CfClientTest {
|
||||
RecordEntity record = RecordEntity.build(SLD_STR, RecordType.A, TTL, "127.0.0.1");
|
||||
RecordEntity createdRecord = client.recordCreate(zone, record);
|
||||
assertNotNull(createdRecord.getId());
|
||||
assertEquals(SLD_STR, createdRecord.getSld());
|
||||
assertEquals(SLD_STR, createdRecord.getSubdomain());
|
||||
assertEquals(RecordType.A.getType(), createdRecord.getType());
|
||||
assertEquals(TTL, createdRecord.getTtl());
|
||||
assertEquals("127.0.0.1", createdRecord.getContent());
|
||||
assertNotNull(createdRecord.getCreatedOn());
|
||||
|
||||
List<RecordEntity> records = client.recordList(zone, SLD_STR, RecordType.A);
|
||||
List<RecordEntity> records = client.recordListBySubdomain(zone, SLD_STR, RecordType.A);
|
||||
assertEquals(1, records.size());
|
||||
RecordEntity fetchedRecord = records.get(0);
|
||||
assertEquals(createdRecord.getId(), fetchedRecord.getId());
|
||||
@@ -79,14 +79,14 @@ public class CfClientTest {
|
||||
RecordEntity createdRecordAAAA = client.recordCreate(zone, recordAAAA);
|
||||
assertNotNull(createdRecordA.getId());
|
||||
assertNotNull(createdRecordAAAA.getId());
|
||||
assertEquals(SLD_STR, createdRecordA.getSld());
|
||||
assertEquals(SLD_STR, createdRecordAAAA.getSld());
|
||||
assertEquals(SLD_STR, createdRecordA.getSubdomain());
|
||||
assertEquals(SLD_STR, createdRecordAAAA.getSubdomain());
|
||||
assertEquals(RecordType.A.getType(), createdRecordA.getType());
|
||||
assertEquals(RecordType.AAAA.getType(), createdRecordAAAA.getType());
|
||||
|
||||
client.recordDeleteTypeIfExists(zone, SLD_STR, RecordType.A, RecordType.AAAA);
|
||||
assertThrows(CloudflareNotFoundException.class,
|
||||
() -> client.recordList(zone, SLD_STR, RecordType.A, RecordType.AAAA));
|
||||
() -> client.recordListBySubdomain(zone, SLD_STR, RecordType.A, RecordType.AAAA));
|
||||
} finally {
|
||||
// cleanup in case of failures during test
|
||||
try {
|
||||
@@ -114,7 +114,7 @@ public class CfClientTest {
|
||||
assertEquals(1, zList.size());
|
||||
|
||||
assertThrows(CloudflareNotFoundException.class,
|
||||
() -> client.recordList(zList.get(0), "not-existing"));
|
||||
() -> client.recordListBySubdomain(zList.get(0), "not-existing"));
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -149,7 +149,7 @@ public class CfClientTest {
|
||||
client.recordCreate(z, RecordEntity.build(domain, RecordType.A, TTL, "130.0.0.3"));
|
||||
assertNotNull(createdRe1.getId());
|
||||
assertEquals(randomSld + "." + ZONE_STR, createdRe1.getName());
|
||||
assertEquals(randomSld, createdRe1.getSld());
|
||||
assertEquals(randomSld, createdRe1.getSubdomain());
|
||||
assertEquals(RecordType.A.getType(), createdRe1.getType());
|
||||
assertEquals(z.getId(), createdRe1.getZoneId());
|
||||
assertEquals(TTL, createdRe1.getTtl());
|
||||
@@ -158,15 +158,15 @@ public class CfClientTest {
|
||||
assertNotNull(createdRe1.getModifiedOn());
|
||||
|
||||
// verify recordList for A
|
||||
List<RecordEntity> aRecords = client.recordList(z, randomSld, RecordType.A);
|
||||
List<RecordEntity> aRecords = client.recordListBySubdomain(z, randomSld, RecordType.A);
|
||||
assertEquals(1, aRecords.size());
|
||||
r = aRecords.get(0);
|
||||
assertEquals("130.0.0.3", r.getContent());
|
||||
|
||||
// create AAAA record using recordCreateSld
|
||||
// create AAAA record using recordCreateSubdomain
|
||||
createdRe2 =
|
||||
client.recordCreateSld(z, randomSld, TTL, RecordType.AAAA, "2a0a:4cc0:c0:2e4::1");
|
||||
List<RecordEntity> aaaaRecords = client.recordList(z, randomSld, RecordType.AAAA);
|
||||
client.recordCreateSubdomain(z, randomSld, TTL, RecordType.AAAA, "2a0a:4cc0:c0:2e4::1");
|
||||
List<RecordEntity> aaaaRecords = client.recordListBySubdomain(z, randomSld, RecordType.AAAA);
|
||||
assertEquals(1, aaaaRecords.size());
|
||||
r = aaaaRecords.get(0);
|
||||
assertEquals(z.getId(), r.getZoneId());
|
||||
@@ -174,7 +174,7 @@ public class CfClientTest {
|
||||
assertEquals(RecordType.AAAA.getType(), r.getType());
|
||||
|
||||
// test recordList
|
||||
List<RecordEntity> rList = client.recordList(z, randomSld);
|
||||
List<RecordEntity> rList = client.recordListBySubdomain(z, randomSld);
|
||||
assertEquals(2, rList.size());
|
||||
for (RecordEntity re : rList) {
|
||||
assertEquals(z.getId(), re.getZoneId());
|
||||
@@ -196,7 +196,7 @@ public class CfClientTest {
|
||||
fullList.stream().allMatch(re -> re.getType().equals(RecordType.A.getType()) || re.getType().equals(RecordType.AAAA.getType())));
|
||||
|
||||
// test recordList with types without SLD
|
||||
List<RecordEntity> aList = client.recordList(z, RecordType.A);
|
||||
List<RecordEntity> aList = client.recordListByType(z, RecordType.A);
|
||||
assertFalse(aList.isEmpty());
|
||||
assertTrue(aList.stream().anyMatch(re -> re.getId().equals(createdRe1.getId())));
|
||||
assertTrue(aList.stream().noneMatch(re -> re.getId().equals(createdRe2.getId())));
|
||||
@@ -210,13 +210,13 @@ public class CfClientTest {
|
||||
// update AAAA record
|
||||
createdRe2.setContent("2a0a:4cc0:c0:2e4::2");
|
||||
client.recordUpdate(z, createdRe2);
|
||||
aaaaRecords = client.recordList(z, randomSld, RecordType.AAAA);
|
||||
aaaaRecords = client.recordListBySubdomain(z, randomSld, RecordType.AAAA);
|
||||
assertEquals(1, aaaaRecords.size());
|
||||
r = aaaaRecords.get(0);
|
||||
assertEquals("2a0a:4cc0:c0:2e4::2", r.getContent());
|
||||
|
||||
// verify A record still intact
|
||||
aRecords = client.recordList(z, randomSld, RecordType.A);
|
||||
aRecords = client.recordListBySubdomain(z, randomSld, RecordType.A);
|
||||
assertEquals(1, aRecords.size());
|
||||
r = aRecords.get(0);
|
||||
assertEquals("130.0.0.3", r.getContent());
|
||||
@@ -224,12 +224,12 @@ public class CfClientTest {
|
||||
// delete AAAA record and verify it's gone
|
||||
assertTrue(client.recordDelete(z, createdRe2));
|
||||
assertThrows(CloudflareNotFoundException.class,
|
||||
() -> client.recordList(z, randomSld, RecordType.AAAA));
|
||||
() -> client.recordListBySubdomain(z, randomSld, RecordType.AAAA));
|
||||
|
||||
// delete A record using helper and verify it's gone
|
||||
client.recordDeleteTypeIfExists(z, randomSld, RecordType.A);
|
||||
assertThrows(CloudflareNotFoundException.class,
|
||||
() -> client.recordList(z, randomSld, RecordType.A));
|
||||
() -> client.recordListBySubdomain(z, randomSld, RecordType.A));
|
||||
} finally {
|
||||
// cleanup in case of failures during test
|
||||
try {
|
||||
@@ -303,7 +303,7 @@ public class CfClientTest {
|
||||
|
||||
// Verify only the first 2 records
|
||||
for (int i = 0; i < 2; i++) {
|
||||
List<RecordEntity> records1 = client.recordList(zone, sldNames.get(i), RecordType.A);
|
||||
List<RecordEntity> records1 = client.recordListBySubdomain(zone, sldNames.get(i), RecordType.A);
|
||||
assertEquals(1, records1.size());
|
||||
assertEquals(IP_PREFIX + (i + 1), records1.get(0).getContent());
|
||||
}
|
||||
@@ -313,7 +313,7 @@ public class CfClientTest {
|
||||
// Use first 2 records for PATCH
|
||||
List<RecordEntity> patchRecords = new ArrayList<>();
|
||||
for (int i = 0; i < 2; i++) {
|
||||
List<RecordEntity> records = client.recordList(zone, sldNames.get(i), RecordType.A);
|
||||
List<RecordEntity> records = client.recordListBySubdomain(zone, sldNames.get(i), RecordType.A);
|
||||
RecordEntity record = records.get(0);
|
||||
record.setContent(UPDATED_IP_PREFIX + (i + 1));
|
||||
patchRecords.add(record);
|
||||
@@ -323,7 +323,7 @@ public class CfClientTest {
|
||||
|
||||
// Verify both records were updated
|
||||
for (int i = 0; i < 2; i++) {
|
||||
List<RecordEntity> updatedRecords = client.recordList(zone, sldNames.get(i), RecordType.A);
|
||||
List<RecordEntity> updatedRecords = client.recordListBySubdomain(zone, sldNames.get(i), RecordType.A);
|
||||
assertEquals(1, updatedRecords.size());
|
||||
assertEquals(UPDATED_IP_PREFIX + (i + 1), updatedRecords.get(0).getContent());
|
||||
}
|
||||
@@ -333,7 +333,7 @@ public class CfClientTest {
|
||||
// Delete first 2 records
|
||||
List<RecordEntity> deleteRecords = new ArrayList<>();
|
||||
for (int i = 0; i < 2; i++) {
|
||||
List<RecordEntity> records = client.recordList(zone, sldNames.get(i), RecordType.A);
|
||||
List<RecordEntity> records = client.recordListBySubdomain(zone, sldNames.get(i), RecordType.A);
|
||||
deleteRecords.add(records.get(0));
|
||||
}
|
||||
|
||||
@@ -343,7 +343,7 @@ public class CfClientTest {
|
||||
for (int i = 0; i < 2; i++) {
|
||||
String sldName = sldNames.get(i);
|
||||
assertThrows(CloudflareNotFoundException.class,
|
||||
() -> client.recordList(zone, sldName, RecordType.A));
|
||||
() -> client.recordListBySubdomain(zone, sldName, RecordType.A));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -359,7 +359,7 @@ public class CfClientTest {
|
||||
// Now use PUT to replace them
|
||||
List<RecordEntity> putRecords = new ArrayList<>();
|
||||
for (int i = 0; i < 2; i++) {
|
||||
List<RecordEntity> records = client.recordList(zone, sldNames.get(i), RecordType.A);
|
||||
List<RecordEntity> records = client.recordListBySubdomain(zone, sldNames.get(i), RecordType.A);
|
||||
RecordEntity record = records.get(0);
|
||||
record.setContent(UPDATED_IP_PREFIX + (i + 1));
|
||||
putRecords.add(record);
|
||||
@@ -368,7 +368,7 @@ public class CfClientTest {
|
||||
|
||||
// Verify both records were updated
|
||||
for (int i = 0; i < 2; i++) {
|
||||
List<RecordEntity> updatedRecords = client.recordList(zone, sldNames.get(i), RecordType.A);
|
||||
List<RecordEntity> updatedRecords = client.recordListBySubdomain(zone, sldNames.get(i), RecordType.A);
|
||||
assertEquals(1, updatedRecords.size());
|
||||
assertEquals(UPDATED_IP_PREFIX + (i + 1), updatedRecords.get(0).getContent());
|
||||
}
|
||||
@@ -376,7 +376,7 @@ public class CfClientTest {
|
||||
|
||||
private void assertValidBatchedRecord(RecordEntity batchedRecord, RecordEntity originalRecord) {
|
||||
assertNotNull(batchedRecord.getId());
|
||||
assertEquals(originalRecord.getSld(), batchedRecord.getSld());
|
||||
assertEquals(originalRecord.getSubdomain(), batchedRecord.getSubdomain());
|
||||
assertEquals(originalRecord.getType(), batchedRecord.getType());
|
||||
assertNotNull(batchedRecord.getCreatedOn());
|
||||
}
|
||||
@@ -393,7 +393,7 @@ public class CfClientTest {
|
||||
.create(RecordType.A, "192.168.100.1", TTL);
|
||||
|
||||
assertNotNull(created.getId());
|
||||
assertEquals(fluentSld, created.getSld());
|
||||
assertEquals(fluentSld, created.getSubdomain());
|
||||
assertEquals("192.168.100.1", created.getContent());
|
||||
|
||||
// Test fluent get
|
||||
|
||||
@@ -5,6 +5,7 @@ import codes.thischwa.cf.model.*;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
import org.mockito.ArgumentCaptor;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.junit.jupiter.MockitoExtension;
|
||||
|
||||
@@ -218,7 +219,7 @@ class CfDnsClientMockTest {
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(mockResponse).when(spyClient).getRequest(anyString(), eq(RecordMultipleResponse.class));
|
||||
|
||||
List<RecordEntity> records = spyClient.recordList(zone, "test");
|
||||
List<RecordEntity> records = spyClient.recordListBySubdomain(zone, "test");
|
||||
|
||||
assertNotNull(records);
|
||||
assertEquals(1, records.size());
|
||||
@@ -239,7 +240,7 @@ class CfDnsClientMockTest {
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(mockResponse).when(spyClient).getRequest(anyString(), eq(RecordMultipleResponse.class));
|
||||
|
||||
List<RecordEntity> records = spyClient.recordList(zone, "test", RecordType.A);
|
||||
List<RecordEntity> records = spyClient.recordListBySubdomain(zone, "test", RecordType.A);
|
||||
|
||||
assertNotNull(records);
|
||||
assertEquals(1, records.size());
|
||||
@@ -260,7 +261,7 @@ class CfDnsClientMockTest {
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(mockResponse).when(spyClient).getRequest(anyString(), eq(RecordMultipleResponse.class));
|
||||
|
||||
List<RecordEntity> records = spyClient.recordList(zone, RecordType.A);
|
||||
List<RecordEntity> records = spyClient.recordListByType(zone, RecordType.A);
|
||||
|
||||
assertNotNull(records);
|
||||
assertEquals(1, records.size());
|
||||
@@ -360,7 +361,7 @@ class CfDnsClientMockTest {
|
||||
ZoneEntity zone = createTestZone();
|
||||
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doThrow(new CloudflareNotFoundException("Not found")).when(spyClient).recordList(any(), anyString(), any());
|
||||
doThrow(new CloudflareNotFoundException("Not found")).when(spyClient).recordListBySubdomain(any(), anyString(), any());
|
||||
|
||||
// Should not throw exception when record doesn't exist
|
||||
assertDoesNotThrow(() -> spyClient.recordDeleteTypeIfExists(zone, "test", RecordType.A));
|
||||
@@ -396,4 +397,338 @@ class CfDnsClientMockTest {
|
||||
assertEquals(1, result.getPosts().size());
|
||||
assertEquals(TEST_ZONE_ID, result.getPosts().get(0).getZoneId());
|
||||
}
|
||||
|
||||
private ZoneMultipleResponse zoneResponse(List<ZoneEntity> zones, ResultInfo resultInfo) {
|
||||
ZoneMultipleResponse resp = new ZoneMultipleResponse();
|
||||
resp.setResult(zones);
|
||||
resp.setResultInfo(resultInfo);
|
||||
resp.setResponseResultInfo(createSuccessResultInfo());
|
||||
return resp;
|
||||
}
|
||||
|
||||
private RecordMultipleResponse recordResponse(List<RecordEntity> records, ResultInfo resultInfo) {
|
||||
RecordMultipleResponse resp = new RecordMultipleResponse();
|
||||
resp.setResult(records);
|
||||
resp.setResultInfo(resultInfo);
|
||||
resp.setResponseResultInfo(createSuccessResultInfo());
|
||||
return resp;
|
||||
}
|
||||
|
||||
private static ZoneEntity zone(String id, String name) {
|
||||
ZoneEntity zone = new ZoneEntity();
|
||||
zone.setId(id);
|
||||
zone.setName(name);
|
||||
return zone;
|
||||
}
|
||||
|
||||
@Test
|
||||
void testZoneGet_NotFound_ReturnsNull() throws Exception {
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(zoneResponse(List.of(), new ResultInfo(0)))
|
||||
.when(spyClient).getRequest(anyString(), eq(ZoneMultipleResponse.class));
|
||||
|
||||
assertNull(spyClient.zoneGet("unknown.com"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testZoneGet_NotFound_ThrowsIfEnabled() throws Exception {
|
||||
CfDnsClient throwingClient = spy(new CfDnsClientBuilder()
|
||||
.withApiTokenAuth("test-token")
|
||||
.withEmptyResultThrowsException(true)
|
||||
.build());
|
||||
doReturn(zoneResponse(List.of(), new ResultInfo(0)))
|
||||
.when(throwingClient).getRequest(anyString(), eq(ZoneMultipleResponse.class));
|
||||
|
||||
assertThrows(CloudflareNotFoundException.class, () -> throwingClient.zoneGet("unknown.com"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testZone_NotFound_Throws() throws Exception {
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(zoneResponse(List.of(), new ResultInfo(0)))
|
||||
.when(spyClient).getRequest(anyString(), eq(ZoneMultipleResponse.class));
|
||||
|
||||
assertThrows(CloudflareNotFoundException.class, () -> spyClient.zone("unknown.com"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testZoneList_FetchesAllPages() throws Exception {
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(zoneResponse(List.of(zone("z1", "a.com"), zone("z2", "b.com")),
|
||||
new ResultInfo(1, 2, 2, 2, 3)))
|
||||
.when(spyClient).getRequest(eq("/zones?page=1&per_page=" + CfDnsClient.ZONES_PER_PAGE),
|
||||
eq(ZoneMultipleResponse.class));
|
||||
doReturn(zoneResponse(List.of(zone("z3", "c.com")), new ResultInfo(2, 2, 2, 1, 3)))
|
||||
.when(spyClient).getRequest(eq("/zones?page=2&per_page=" + CfDnsClient.ZONES_PER_PAGE),
|
||||
eq(ZoneMultipleResponse.class));
|
||||
|
||||
List<ZoneEntity> zones = spyClient.zoneList();
|
||||
|
||||
assertEquals(List.of("a.com", "b.com", "c.com"), zones.stream().map(ZoneEntity::getName).toList());
|
||||
verify(spyClient, times(2)).getRequest(anyString(), eq(ZoneMultipleResponse.class));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordListByType_FetchesAllPages() throws Exception {
|
||||
ZoneEntity zone = createTestZone();
|
||||
String base = "/zones/" + TEST_ZONE_ID + "/dns_records?type=A&page=%d&per_page=" + CfDnsClient.RECORDS_PER_PAGE;
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(recordResponse(List.of(RecordEntity.build("a.example.com", RecordType.A, 60, "1.1.1.1")),
|
||||
new ResultInfo(1, 1, 2, 1, 2)))
|
||||
.when(spyClient).getRequest(eq(String.format(base, 1)), eq(RecordMultipleResponse.class));
|
||||
doReturn(recordResponse(List.of(RecordEntity.build("b.example.com", RecordType.A, 60, "2.2.2.2")),
|
||||
new ResultInfo(2, 1, 2, 1, 2)))
|
||||
.when(spyClient).getRequest(eq(String.format(base, 2)), eq(RecordMultipleResponse.class));
|
||||
|
||||
List<RecordEntity> records = spyClient.recordListByType(zone, RecordType.A);
|
||||
|
||||
assertEquals(2, records.size());
|
||||
assertEquals("b.example.com", records.get(1).getName());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordListBySld_FetchesAllPages() throws Exception {
|
||||
ZoneEntity zone = createTestZone();
|
||||
String base = "/zones/" + TEST_ZONE_ID + "/dns_records?name=test.example.com&page=%d&per_page="
|
||||
+ CfDnsClient.RECORDS_PER_PAGE;
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(recordResponse(List.of(RecordEntity.build("test.example.com", RecordType.A, 60, "1.1.1.1")),
|
||||
new ResultInfo(1, 1, 2, 1, 2)))
|
||||
.when(spyClient).getRequest(eq(String.format(base, 1)), eq(RecordMultipleResponse.class));
|
||||
doReturn(recordResponse(List.of(RecordEntity.build("test.example.com", RecordType.AAAA, 60, "::1")),
|
||||
new ResultInfo(2, 1, 2, 1, 2)))
|
||||
.when(spyClient).getRequest(eq(String.format(base, 2)), eq(RecordMultipleResponse.class));
|
||||
|
||||
assertEquals(2, spyClient.recordListBySubdomain(zone, "test").size());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordList_SetsZoneNameForSld() throws Exception {
|
||||
ZoneEntity zone = createTestZone();
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(recordResponse(List.of(
|
||||
RecordEntity.build("example.com", RecordType.A, 60, "1.1.1.1"),
|
||||
RecordEntity.build("my.sub.example.com", RecordType.A, 60, "2.2.2.2")),
|
||||
new ResultInfo(2)))
|
||||
.when(spyClient).getRequest(anyString(), eq(RecordMultipleResponse.class));
|
||||
|
||||
List<RecordEntity> records = spyClient.recordList(zone);
|
||||
|
||||
assertEquals(TEST_ZONE_NAME, records.get(0).getZoneName());
|
||||
assertEquals("@", records.get(0).getSubdomain());
|
||||
assertEquals("my.sub", records.get(1).getSubdomain());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordListByApex() throws Exception {
|
||||
ZoneEntity zone = createTestZone();
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(recordResponse(List.of(), new ResultInfo(0)))
|
||||
.when(spyClient).getRequest(anyString(), eq(RecordMultipleResponse.class));
|
||||
|
||||
spyClient.recordListBySubdomain(zone, CfDnsClient.APEX);
|
||||
|
||||
verify(spyClient).getRequest(
|
||||
eq("/zones/" + TEST_ZONE_ID + "/dns_records?name=example.com&page=1&per_page="
|
||||
+ CfDnsClient.RECORDS_PER_PAGE),
|
||||
eq(RecordMultipleResponse.class));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordDelete_NoResult_ReturnsFalse() throws Exception {
|
||||
RecordSingleResponse mockResponse = new RecordSingleResponse();
|
||||
mockResponse.setResponseResultInfo(createSuccessResultInfo());
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(mockResponse).when(spyClient).deleteRequest(anyString(), eq(RecordSingleResponse.class));
|
||||
|
||||
assertFalse(spyClient.recordDelete(createTestZone(), TEST_RECORD_ID));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordDelete_OtherId_ReturnsFalse() throws Exception {
|
||||
RecordSingleResponse mockResponse = new RecordSingleResponse();
|
||||
RecordEntity other = new RecordEntity();
|
||||
other.setId("other");
|
||||
mockResponse.setResult(other);
|
||||
mockResponse.setResponseResultInfo(createSuccessResultInfo());
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(mockResponse).when(spyClient).deleteRequest(anyString(), eq(RecordSingleResponse.class));
|
||||
|
||||
assertFalse(spyClient.recordDelete(createTestZone(), TEST_RECORD_ID));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordBatch_UsesFullRecordName() throws Exception {
|
||||
ZoneEntity zone = createTestZone();
|
||||
RecordEntity apex = RecordEntity.build("example.com", RecordType.A, 300, "1.2.3.4");
|
||||
RecordEntity multiLevel = RecordEntity.build("a.b.example.com", RecordType.A, 300, "1.2.3.5");
|
||||
|
||||
BatchResponse mockResponse = createBatchResponse();
|
||||
mockResponse.setResult(new BatchEntry());
|
||||
mockResponse.setResponseResultInfo(createSuccessResultInfo());
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(mockResponse).when(spyClient).postRequest(anyString(), any(), eq(BatchResponse.class));
|
||||
|
||||
spyClient.recordBatch(zone, List.of(apex, multiLevel), List.of(multiLevel), null, List.of(apex));
|
||||
|
||||
ArgumentCaptor<Object> payload = ArgumentCaptor.forClass(Object.class);
|
||||
verify(spyClient).postRequest(anyString(), payload.capture(), eq(BatchResponse.class));
|
||||
BatchEntry sent = (BatchEntry) payload.getValue();
|
||||
assertEquals(List.of("example.com", "a.b.example.com"),
|
||||
sent.getPosts().stream().map(RecordEntity::getName).toList());
|
||||
assertEquals("a.b.example.com", sent.getPuts().get(0).getName());
|
||||
// deletes only need the ID
|
||||
assertNull(sent.getDeletes().get(0).getName());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordList_NullPagingIsUnambiguousAndFetchesAll() throws Exception {
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(recordResponse(List.of(RecordEntity.build("a.example.com", RecordType.A, 60, "1.1.1.1")),
|
||||
new ResultInfo(1)))
|
||||
.when(spyClient).getRequest(anyString(), eq(RecordMultipleResponse.class));
|
||||
|
||||
assertEquals(1, spyClient.recordList(createTestZone(), null).size());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordListByType_SingleTypeIsFilteredServerSide() throws Exception {
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(recordResponse(List.of(), new ResultInfo(0)))
|
||||
.when(spyClient).getRequest(anyString(), eq(RecordMultipleResponse.class));
|
||||
|
||||
spyClient.recordListByType(createTestZone(), RecordType.MX);
|
||||
spyClient.recordListBySubdomain(createTestZone(), "www", RecordType.TXT);
|
||||
|
||||
verify(spyClient).getRequest(eq("/zones/" + TEST_ZONE_ID + "/dns_records?type=MX&page=1&per_page="
|
||||
+ CfDnsClient.RECORDS_PER_PAGE), eq(RecordMultipleResponse.class));
|
||||
verify(spyClient).getRequest(eq("/zones/" + TEST_ZONE_ID
|
||||
+ "/dns_records?name=www.example.com&type=TXT&page=1&per_page="
|
||||
+ CfDnsClient.RECORDS_PER_PAGE), eq(RecordMultipleResponse.class));
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordListByType_MultipleTypesAreFilteredClientSide() throws Exception {
|
||||
RecordEntity unknownType = new RecordEntity();
|
||||
unknownType.setName("x.example.com");
|
||||
unknownType.setType("UNKNOWN_FUTURE_TYPE");
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(recordResponse(List.of(
|
||||
RecordEntity.build("a.example.com", RecordType.A, 60, "1.1.1.1"),
|
||||
RecordEntity.build("a.example.com", RecordType.AAAA, 60, "::1"),
|
||||
RecordEntity.build("a.example.com", RecordType.TXT, 60, "txt"),
|
||||
unknownType), new ResultInfo(4)))
|
||||
.when(spyClient).getRequest(anyString(), eq(RecordMultipleResponse.class));
|
||||
|
||||
// an unknown record type in the response must not break the filter
|
||||
List<RecordEntity> records = spyClient.recordListByType(createTestZone(), RecordType.A, RecordType.AAAA);
|
||||
|
||||
assertEquals(List.of("A", "AAAA"), records.stream().map(RecordEntity::getType).toList());
|
||||
verify(spyClient).getRequest(eq("/zones/" + TEST_ZONE_ID + "/dns_records?page=1&per_page="
|
||||
+ CfDnsClient.RECORDS_PER_PAGE), eq(RecordMultipleResponse.class));
|
||||
}
|
||||
|
||||
private static RecordEntity fetchedMxRecord() {
|
||||
RecordEntity rec = RecordEntity.build("example.com", RecordType.MX, 300, "mail.example.com");
|
||||
rec.setId(TEST_RECORD_ID);
|
||||
rec.setPriority(10);
|
||||
rec.setProxied(false);
|
||||
rec.setComment("primary mx");
|
||||
rec.setTags(List.of("env:prod"));
|
||||
rec.setZoneId(TEST_ZONE_ID);
|
||||
rec.setZoneName(TEST_ZONE_NAME);
|
||||
rec.setLocked(false);
|
||||
rec.setProxiable(false);
|
||||
rec.setCreatedOn(java.time.Instant.parse("2025-01-01T00:00:00Z"));
|
||||
rec.setModifiedOn(java.time.Instant.parse("2025-01-02T00:00:00Z"));
|
||||
return rec;
|
||||
}
|
||||
|
||||
private static void assertOnlyWritableFields(RecordEntity sent) {
|
||||
assertEquals("example.com", sent.getName());
|
||||
assertEquals("MX", sent.getType());
|
||||
assertEquals("mail.example.com", sent.getContent());
|
||||
assertEquals(10, sent.getPriority());
|
||||
assertEquals(false, sent.getProxied());
|
||||
assertEquals("primary mx", sent.getComment());
|
||||
assertEquals(List.of("env:prod"), sent.getTags());
|
||||
assertNull(sent.getZoneId());
|
||||
assertNull(sent.getZoneName());
|
||||
assertNull(sent.getLocked());
|
||||
assertNull(sent.getProxiable());
|
||||
assertNull(sent.getCreatedOn());
|
||||
assertNull(sent.getModifiedOn());
|
||||
}
|
||||
|
||||
private RecordSingleResponse singleResponse(RecordEntity rec) {
|
||||
RecordSingleResponse resp = new RecordSingleResponse();
|
||||
resp.setResult(rec);
|
||||
resp.setResponseResultInfo(createSuccessResultInfo());
|
||||
return resp;
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordUpdate_DoesNotModifyGivenRecordAndSendsWritableFields() throws Exception {
|
||||
RecordEntity rec = fetchedMxRecord();
|
||||
RecordEntity before = fetchedMxRecord();
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(singleResponse(fetchedMxRecord()))
|
||||
.when(spyClient).patchRequest(anyString(), any(), eq(RecordSingleResponse.class));
|
||||
|
||||
spyClient.recordUpdate(createTestZone(), rec);
|
||||
|
||||
assertEquals(before, rec);
|
||||
ArgumentCaptor<Object> payload = ArgumentCaptor.forClass(Object.class);
|
||||
verify(spyClient).patchRequest(eq("/zones/" + TEST_ZONE_ID + "/dns_records/" + TEST_RECORD_ID),
|
||||
payload.capture(), eq(RecordSingleResponse.class));
|
||||
assertOnlyWritableFields((RecordEntity) payload.getValue());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordCreate_SendsWritableFieldsWithoutId() throws Exception {
|
||||
RecordEntity rec = fetchedMxRecord();
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(singleResponse(fetchedMxRecord()))
|
||||
.when(spyClient).postRequest(anyString(), any(), eq(RecordSingleResponse.class));
|
||||
|
||||
spyClient.recordCreate(createTestZone(), rec);
|
||||
|
||||
ArgumentCaptor<Object> payload = ArgumentCaptor.forClass(Object.class);
|
||||
verify(spyClient).postRequest(anyString(), payload.capture(), eq(RecordSingleResponse.class));
|
||||
RecordEntity sent = (RecordEntity) payload.getValue();
|
||||
assertOnlyWritableFields(sent);
|
||||
assertNull(sent.getId());
|
||||
assertEquals(TEST_RECORD_ID, rec.getId());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordBatch_KeepsPriorityDataAndProxied() throws Exception {
|
||||
RecordEntity srv = RecordEntity.build("_sip._tcp.example.com", RecordType.SRV, 300, null);
|
||||
srv.setId("srv1");
|
||||
srv.setPriority(10);
|
||||
srv.setData(Map.of("weight", 5, "port", 5060, "target", "sip.example.com"));
|
||||
RecordEntity proxied = RecordEntity.build("www.example.com", RecordType.A, 1, "1.2.3.4");
|
||||
proxied.setId("www1");
|
||||
proxied.setProxied(true);
|
||||
|
||||
BatchResponse mockResponse = createBatchResponse();
|
||||
mockResponse.setResult(new BatchEntry());
|
||||
mockResponse.setResponseResultInfo(createSuccessResultInfo());
|
||||
CfDnsClient spyClient = spy(client);
|
||||
doReturn(mockResponse).when(spyClient).postRequest(anyString(), any(), eq(BatchResponse.class));
|
||||
|
||||
spyClient.recordBatch(createTestZone(), List.of(srv), List.of(proxied), List.of(srv), null);
|
||||
|
||||
ArgumentCaptor<Object> payload = ArgumentCaptor.forClass(Object.class);
|
||||
verify(spyClient).postRequest(anyString(), payload.capture(), eq(BatchResponse.class));
|
||||
BatchEntry sent = (BatchEntry) payload.getValue();
|
||||
RecordEntity sentPost = sent.getPosts().get(0);
|
||||
assertNull(sentPost.getId());
|
||||
assertEquals(10, sentPost.getPriority());
|
||||
assertEquals(5060, sentPost.getData().get("port"));
|
||||
assertEquals("www1", sent.getPuts().get(0).getId());
|
||||
assertEquals(true, sent.getPuts().get(0).getProxied());
|
||||
assertEquals("srv1", sent.getPatches().get(0).getId());
|
||||
assertEquals(10, sent.getPatches().get(0).getPriority());
|
||||
}
|
||||
}
|
||||
@@ -3,12 +3,15 @@ package codes.thischwa.cf;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
import static org.junit.jupiter.api.Assertions.fail;
|
||||
|
||||
import codes.thischwa.cf.model.AbstractResponse;
|
||||
import codes.thischwa.cf.model.BatchResponse;
|
||||
import codes.thischwa.cf.model.RecordEntity;
|
||||
import codes.thischwa.cf.model.RecordMultipleResponse;
|
||||
import codes.thischwa.cf.model.RecordSingleResponse;
|
||||
import codes.thischwa.cf.model.RecordType;
|
||||
import codes.thischwa.cf.model.ResponseResultInfo;
|
||||
import codes.thischwa.cf.model.ZoneMultipleResponse;
|
||||
import java.io.InputStream;
|
||||
@@ -50,4 +53,35 @@ public class ObjectMapperTest {
|
||||
fail("fail for " + clazz + ": " + e.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
@Test
|
||||
void testSubdomainIsNotSerialized() {
|
||||
RecordEntity rec = RecordEntity.build("www.example.com", RecordType.A, 60, "1.2.3.4");
|
||||
rec.setZoneName("example.com");
|
||||
String json = mapper.writeValueAsString(rec);
|
||||
assertTrue(json.contains("\"name\":\"www.example.com\""), json);
|
||||
assertFalse(json.contains("subdomain"), json);
|
||||
assertFalse(json.contains("sld"), json);
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordFieldsAreMappedInSnakeCase() {
|
||||
String json = """
|
||||
{"id":"r1","name":"_sip._tcp.example.com","type":"SRV","ttl":300,"priority":10,
|
||||
"comment":"sip","tags":["env:prod"],
|
||||
"data":{"weight":5,"port":5060,"target":"sip.example.com"},
|
||||
"created_on":"2025-01-20T08:56:34.736214Z","modified_on":"2025-01-21T08:56:34Z"}
|
||||
""";
|
||||
RecordEntity rec = mapper.readValue(json, RecordEntity.class);
|
||||
assertEquals(10, rec.getPriority());
|
||||
assertEquals("sip", rec.getComment());
|
||||
assertEquals(List.of("env:prod"), rec.getTags());
|
||||
assertEquals(5060, rec.getData().get("port"));
|
||||
assertEquals(java.time.Instant.parse("2025-01-20T08:56:34.736214Z"), rec.getCreatedOn());
|
||||
assertEquals(java.time.Instant.parse("2025-01-21T08:56:34Z"), rec.getModifiedOn());
|
||||
|
||||
String out = mapper.writeValueAsString(rec);
|
||||
assertTrue(out.contains("\"priority\":10"), out);
|
||||
assertTrue(out.contains("\"created_on\":\"2025-01-20T08:56:34.736214Z\""), out);
|
||||
}
|
||||
}
|
||||
@@ -11,6 +11,8 @@ import codes.thischwa.cf.model.RecordMultipleResponse;
|
||||
import codes.thischwa.cf.model.RecordSingleResponse;
|
||||
import codes.thischwa.cf.model.ResponseResultInfo;
|
||||
import codes.thischwa.cf.model.ResultInfo;
|
||||
import codes.thischwa.cf.model.ZoneEntity;
|
||||
import codes.thischwa.cf.model.ZoneMultipleResponse;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
@@ -130,4 +132,44 @@ class ResponseValidatorTest {
|
||||
assertDoesNotThrow(() -> validatorWithException.validate(mockSingleResponse, false));
|
||||
assertDoesNotThrow(() -> validatorWithoutException.validate(mockSingleResponse, false));
|
||||
}
|
||||
}
|
||||
|
||||
private static ZoneMultipleResponse zoneResponse(int count) {
|
||||
ZoneMultipleResponse resp = new ZoneMultipleResponse();
|
||||
ResponseResultInfo info = new ResponseResultInfo();
|
||||
info.setSuccess(true);
|
||||
resp.setResponseResultInfo(info);
|
||||
List<ZoneEntity> zones = new ArrayList<>();
|
||||
for (int i = 0; i < count; i++) {
|
||||
zones.add(new ZoneEntity());
|
||||
}
|
||||
resp.setResult(zones);
|
||||
return resp;
|
||||
}
|
||||
|
||||
@Test
|
||||
void validateZoneResponseEmptyWithExceptionEnabled() {
|
||||
ZoneMultipleResponse resp = zoneResponse(0);
|
||||
resp.setResultInfo(new ResultInfo(0));
|
||||
assertThrows(CloudflareNotFoundException.class, () -> validatorWithException.validate(resp, true));
|
||||
assertDoesNotThrow(() -> validatorWithoutException.validate(resp, true));
|
||||
}
|
||||
|
||||
@Test
|
||||
void validateZoneResponseMultipleWhenSingleExpected() {
|
||||
ZoneMultipleResponse resp = zoneResponse(2);
|
||||
resp.setResultInfo(new ResultInfo(2));
|
||||
CloudflareApiException exception = assertThrows(CloudflareApiException.class,
|
||||
() -> validatorWithoutException.validate(resp, true));
|
||||
assertTrue(exception.getMessage().contains("Unexpected result count: 2"));
|
||||
}
|
||||
|
||||
@Test
|
||||
void validateMultipleResponseWithoutResultInfoFallsBackToResultSize() {
|
||||
// no result_info -> count is derived from the result list
|
||||
assertThrows(CloudflareNotFoundException.class,
|
||||
() -> validatorWithException.validate(zoneResponse(0), false));
|
||||
assertThrows(CloudflareApiException.class,
|
||||
() -> validatorWithoutException.validate(zoneResponse(2), true));
|
||||
assertDoesNotThrow(() -> validatorWithException.validate(zoneResponse(1), true));
|
||||
}
|
||||
}
|
||||
@@ -59,7 +59,7 @@ class FluentApiTest {
|
||||
RecordEntity rec2 = RecordEntity.build("www.example.com", RecordType.A, 300, "1.2.3.5");
|
||||
List<RecordEntity> expectedRecords = List.of(rec1, rec2);
|
||||
|
||||
when(mockClient.recordList(eq(testZone), any(RecordType[].class)))
|
||||
when(mockClient.recordListByType(eq(testZone), any(RecordType[].class)))
|
||||
.thenReturn(expectedRecords);
|
||||
|
||||
ZoneOperations zoneOps = new ZoneOperationsImpl(mockClient, testZone);
|
||||
@@ -67,7 +67,7 @@ class FluentApiTest {
|
||||
|
||||
assertNotNull(result);
|
||||
assertEquals(2, result.size());
|
||||
verify(mockClient, times(1)).recordList(eq(testZone), any(RecordType[].class));
|
||||
verify(mockClient, times(1)).recordListByType(eq(testZone), any(RecordType[].class));
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -75,7 +75,7 @@ class FluentApiTest {
|
||||
RecordEntity rec1 = RecordEntity.build("test.example.com", RecordType.A, 300, "1.2.3.4");
|
||||
List<RecordEntity> expectedRecords = List.of(rec1);
|
||||
|
||||
when(mockClient.recordList(eq(testZone), any(RecordType[].class)))
|
||||
when(mockClient.recordListByType(eq(testZone), any(RecordType[].class)))
|
||||
.thenReturn(expectedRecords);
|
||||
|
||||
ZoneOperations zoneOps = new ZoneOperationsImpl(mockClient, testZone);
|
||||
@@ -83,7 +83,7 @@ class FluentApiTest {
|
||||
|
||||
assertNotNull(result);
|
||||
assertEquals(1, result.size());
|
||||
verify(mockClient, times(1)).recordList(eq(testZone), any(RecordType[].class));
|
||||
verify(mockClient, times(1)).recordListByType(eq(testZone), any(RecordType[].class));
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -91,7 +91,7 @@ class FluentApiTest {
|
||||
RecordEntity rec1 = RecordEntity.build("test.example.com", RecordType.A, 300, "1.2.3.4");
|
||||
List<RecordEntity> expectedRecords = List.of(rec1);
|
||||
|
||||
when(mockClient.recordList(eq(testZone), eq(TEST_SLD), any()))
|
||||
when(mockClient.recordListBySubdomain(eq(testZone), eq(TEST_SLD), any()))
|
||||
.thenReturn(expectedRecords);
|
||||
|
||||
RecordOperations recordOps = new RecordOperationsImpl(mockClient, testZone, TEST_SLD, null);
|
||||
@@ -100,7 +100,7 @@ class FluentApiTest {
|
||||
assertNotNull(result);
|
||||
assertEquals(1, result.size());
|
||||
assertEquals("1.2.3.4", result.get(0).getContent());
|
||||
verify(mockClient, times(1)).recordList(eq(testZone), eq(TEST_SLD), any());
|
||||
verify(mockClient, times(1)).recordListBySubdomain(eq(testZone), eq(TEST_SLD), any());
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -109,7 +109,7 @@ class FluentApiTest {
|
||||
List<RecordEntity> expectedRecords = List.of(rec1);
|
||||
|
||||
RecordType[] types = {RecordType.A};
|
||||
when(mockClient.recordList(eq(testZone), eq(TEST_SLD), eq(types)))
|
||||
when(mockClient.recordListBySubdomain(eq(testZone), eq(TEST_SLD), eq(types)))
|
||||
.thenReturn(expectedRecords);
|
||||
|
||||
RecordOperations recordOps = new RecordOperationsImpl(mockClient, testZone, TEST_SLD, types);
|
||||
@@ -117,7 +117,7 @@ class FluentApiTest {
|
||||
|
||||
assertNotNull(result);
|
||||
assertEquals(1, result.size());
|
||||
verify(mockClient, times(1)).recordList(eq(testZone), eq(TEST_SLD), eq(types));
|
||||
verify(mockClient, times(1)).recordListBySubdomain(eq(testZone), eq(TEST_SLD), eq(types));
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -125,7 +125,7 @@ class FluentApiTest {
|
||||
RecordEntity createdRecord = RecordEntity.build("test.example.com", RecordType.A, 300, "1.2.3.4");
|
||||
createdRecord.setId(TEST_RECORD_ID);
|
||||
|
||||
when(mockClient.recordCreateSld(eq(testZone), eq(TEST_SLD), eq(300), eq(RecordType.A), eq("1.2.3.4")))
|
||||
when(mockClient.recordCreateSubdomain(eq(testZone), eq(TEST_SLD), eq(300), eq(RecordType.A), eq("1.2.3.4")))
|
||||
.thenReturn(createdRecord);
|
||||
|
||||
RecordOperations recordOps = new RecordOperationsImpl(mockClient, testZone, TEST_SLD, null);
|
||||
@@ -134,7 +134,7 @@ class FluentApiTest {
|
||||
assertNotNull(result);
|
||||
assertEquals(TEST_RECORD_ID, result.getId());
|
||||
assertEquals("1.2.3.4", result.getContent());
|
||||
verify(mockClient, times(1)).recordCreateSld(eq(testZone), eq(TEST_SLD), eq(300), eq(RecordType.A), eq("1.2.3.4"));
|
||||
verify(mockClient, times(1)).recordCreateSubdomain(eq(testZone), eq(TEST_SLD), eq(300), eq(RecordType.A), eq("1.2.3.4"));
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -145,7 +145,7 @@ class FluentApiTest {
|
||||
RecordEntity updatedRecord = RecordEntity.build("test.example.com", RecordType.A, 300, "1.2.3.5");
|
||||
updatedRecord.setId(TEST_RECORD_ID);
|
||||
|
||||
when(mockClient.recordList(eq(testZone), eq(TEST_SLD), any()))
|
||||
when(mockClient.recordListBySubdomain(eq(testZone), eq(TEST_SLD), any()))
|
||||
.thenReturn(List.of(existingRecord));
|
||||
when(mockClient.recordUpdate(eq(testZone), any(RecordEntity.class)))
|
||||
.thenReturn(updatedRecord);
|
||||
@@ -155,13 +155,17 @@ class FluentApiTest {
|
||||
|
||||
assertNotNull(result);
|
||||
assertEquals("1.2.3.5", result.getContent());
|
||||
verify(mockClient, times(1)).recordList(eq(testZone), eq(TEST_SLD), any());
|
||||
verify(mockClient, times(1)).recordUpdate(eq(testZone), any(RecordEntity.class));
|
||||
verify(mockClient, times(1)).recordListBySubdomain(eq(testZone), eq(TEST_SLD), any());
|
||||
// only ID and new content are sent (partial update)
|
||||
verify(mockClient, times(1)).recordUpdate(eq(testZone), argThat(rec ->
|
||||
TEST_RECORD_ID.equals(rec.getId()) && "1.2.3.5".equals(rec.getContent())
|
||||
&& rec.getName() == null && rec.getTtl() == null));
|
||||
assertEquals("1.2.3.4", existingRecord.getContent());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testRecordOperations_Update_NoRecordsFound() throws CloudflareApiException {
|
||||
when(mockClient.recordList(eq(testZone), eq(TEST_SLD), any()))
|
||||
when(mockClient.recordListBySubdomain(eq(testZone), eq(TEST_SLD), any()))
|
||||
.thenReturn(List.of());
|
||||
|
||||
RecordOperations recordOps = new RecordOperationsImpl(mockClient, testZone, TEST_SLD, null);
|
||||
@@ -171,7 +175,7 @@ class FluentApiTest {
|
||||
});
|
||||
|
||||
assertTrue(exception.getMessage().contains("No recs found"));
|
||||
verify(mockClient, times(1)).recordList(eq(testZone), eq(TEST_SLD), any());
|
||||
verify(mockClient, times(1)).recordListBySubdomain(eq(testZone), eq(TEST_SLD), any());
|
||||
verify(mockClient, never()).recordUpdate(any(), any());
|
||||
}
|
||||
|
||||
@@ -180,7 +184,7 @@ class FluentApiTest {
|
||||
RecordEntity rec1 = RecordEntity.build("test.example.com", RecordType.A, 300, "1.2.3.4");
|
||||
RecordEntity rec2 = RecordEntity.build("test.example.com", RecordType.AAAA, 300, "::1");
|
||||
|
||||
when(mockClient.recordList(eq(testZone), eq(TEST_SLD), any()))
|
||||
when(mockClient.recordListBySubdomain(eq(testZone), eq(TEST_SLD), any()))
|
||||
.thenReturn(List.of(rec1, rec2));
|
||||
|
||||
RecordOperations recordOps = new RecordOperationsImpl(mockClient, testZone, TEST_SLD, null);
|
||||
@@ -190,7 +194,7 @@ class FluentApiTest {
|
||||
});
|
||||
|
||||
assertTrue(exception.getMessage().contains("Multiple recs found"));
|
||||
verify(mockClient, times(1)).recordList(eq(testZone), eq(TEST_SLD), any());
|
||||
verify(mockClient, times(1)).recordListBySubdomain(eq(testZone), eq(TEST_SLD), any());
|
||||
verify(mockClient, never()).recordUpdate(any(), any());
|
||||
}
|
||||
|
||||
@@ -220,7 +224,7 @@ class FluentApiTest {
|
||||
RecordEntity createdRecord = RecordEntity.build("test.example.com", RecordType.A, 300, "1.2.3.4");
|
||||
createdRecord.setId(TEST_RECORD_ID);
|
||||
|
||||
when(mockClient.recordCreateSld(eq(testZone), eq(TEST_SLD), eq(300), eq(RecordType.A), eq("1.2.3.4")))
|
||||
when(mockClient.recordCreateSubdomain(eq(testZone), eq(TEST_SLD), eq(300), eq(RecordType.A), eq("1.2.3.4")))
|
||||
.thenReturn(createdRecord);
|
||||
|
||||
ZoneOperations zoneOps = new ZoneOperationsImpl(mockClient, testZone);
|
||||
|
||||
@@ -41,19 +41,19 @@ public class RecordEntityTest {
|
||||
@Test
|
||||
void testGetSld() {
|
||||
RecordEntity rec = new RecordEntity();
|
||||
assertNull(rec.getSld());
|
||||
assertNull(rec.getSubdomain());
|
||||
|
||||
rec.setName("sub.example.com");
|
||||
assertEquals("sub", rec.getSld());
|
||||
assertEquals("sub", rec.getSubdomain());
|
||||
|
||||
rec.setName("example.com");
|
||||
assertEquals("example", rec.getSld());
|
||||
assertEquals("example", rec.getSubdomain());
|
||||
|
||||
rec.setName("host");
|
||||
assertEquals("host", rec.getSld());
|
||||
assertEquals("host", rec.getSubdomain());
|
||||
|
||||
rec.setName(".dotstart");
|
||||
assertEquals(".dotstart", rec.getSld());
|
||||
assertEquals(".dotstart", rec.getSubdomain());
|
||||
}
|
||||
|
||||
@Test
|
||||
@@ -61,10 +61,47 @@ public class RecordEntityTest {
|
||||
RecordEntity rec = new RecordEntity();
|
||||
rec.setName("sub.example.com");
|
||||
rec.setZoneName("example.com");
|
||||
assertEquals("sub", rec.getSld());
|
||||
assertEquals("sub", rec.getSubdomain());
|
||||
|
||||
rec.setName("my.sub.example.com");
|
||||
rec.setZoneName("example.com");
|
||||
assertEquals("my.sub", rec.getSld());
|
||||
assertEquals("my.sub", rec.getSubdomain());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testGetSldApexWithZoneName() {
|
||||
RecordEntity rec = new RecordEntity();
|
||||
rec.setName("example.com");
|
||||
rec.setZoneName("example.com");
|
||||
assertEquals("@", rec.getSubdomain());
|
||||
|
||||
rec.setName("Example.COM");
|
||||
assertEquals("@", rec.getSubdomain());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testGetSldZoneNameIsNoLabelSuffix() {
|
||||
// "notexample.com" ends with "example.com", but is not part of the zone
|
||||
RecordEntity rec = new RecordEntity();
|
||||
rec.setName("notexample.com");
|
||||
rec.setZoneName("example.com");
|
||||
assertEquals("notexample", rec.getSubdomain());
|
||||
}
|
||||
|
||||
@Test
|
||||
void testGetSldCaseInsensitive() {
|
||||
RecordEntity rec = new RecordEntity();
|
||||
rec.setName("WWW.Example.com");
|
||||
rec.setZoneName("example.com");
|
||||
assertEquals("WWW", rec.getSubdomain());
|
||||
}
|
||||
|
||||
@Test
|
||||
@SuppressWarnings("removal")
|
||||
void testDeprecatedGetSldDelegatesToGetSubdomain() {
|
||||
RecordEntity rec = new RecordEntity();
|
||||
rec.setName("my.sub.example.com");
|
||||
rec.setZoneName("example.com");
|
||||
assertEquals(rec.getSubdomain(), rec.getSld());
|
||||
}
|
||||
}
|
||||
@@ -3,7 +3,7 @@ package codes.thischwa.cf.model;
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||
|
||||
import java.time.LocalDateTime;
|
||||
import java.time.Instant;
|
||||
import java.util.Set;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
@@ -18,7 +18,7 @@ public class ZoneEntityTest {
|
||||
Set<String> ns = Set.of("ns1.cloudflare.com", "ns2.cloudflare.com");
|
||||
zone.setNameServers(ns);
|
||||
zone.setOriginalNameServers(ns);
|
||||
LocalDateTime now = LocalDateTime.now();
|
||||
Instant now = Instant.now();
|
||||
zone.setCreatedOn(now);
|
||||
zone.setModifiedOn(now);
|
||||
zone.setActivatedOn(now);
|
||||
|
||||
Reference in new issue
Block a user