Skip to content

[Issue 8346][Admin API] Validate retention policy #8358

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
codelipenghui merged 2 commits into from
Oct 26, 2020
Merged

[Issue 8346][Admin API] Validate retention policy #8358

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
12a463a
Validate retention policy in Admin API
lhotari Oct 23, 2020
a2a0b14
Fix invalid retention policies in tests
lhotari Oct 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/NamespacesBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1753,6 +1753,7 @@ protected void internalRemoveBacklogQuota(BacklogQuotaType backlogQuotaType) {
}

protected void internalSetRetention(RetentionPolicies retention) {
validateRetentionPolicies(retention);
validateNamespacePolicyOperation(namespaceName, PolicyName.RETENTION, PolicyOperation.WRITE);
validatePoliciesReadOnlyAccess();

Expand Down Expand Up @@ -2480,8 +2481,23 @@ private void validatePolicies(NamespaceName ns, Policies policies) {
if (policies.persistence != null) {
validatePersistencePolicies(policies.persistence);
}

if (policies.retention_policies != null) {
validateRetentionPolicies(policies.retention_policies);
}
}

protected void validateRetentionPolicies(RetentionPolicies retention) {
checkArgument(retention.getRetentionSizeInMB() >= -1,
"Invalid retention policy: size limit must be >= -1");
checkArgument(retention.getRetentionTimeInMinutes() >= -1,
"Invalid retention policy: time limit must be >= -1");
checkArgument((retention.getRetentionTimeInMinutes() != 0 && retention.getRetentionSizeInMB() != 0) ||
(retention.getRetentionTimeInMinutes() == 0 && retention.getRetentionSizeInMB() == 0),
"Invalid retention policy: Setting a single time or size limit to 0 is invalid when " +
"one of the limits has a non-zero value. Use the value of -1 instead of 0 to ignore a " +
"specific limit. To disable retention both limits must be set to 0.");
}

protected int internalGetMaxProducersPerTopic() {
validateNamespacePolicyOperation(namespaceName, PolicyName.MAX_PRODUCERS, PolicyOperation.READ);
Expand Down
77 changes: 76 additions & 1 deletion pulsar-broker/src/test/java/org/apache/pulsar/broker/admin/NamespacesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@
import java.util.UUID;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ConcurrentHashMap;
import javax.ws.rs.BadRequestException;
import javax.ws.rs.ClientErrorException;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.container.AsyncResponse;
Expand Down Expand Up @@ -1356,4 +1357,78 @@ public void testDeletePartitionedTopicMultipleTimes() throws Exception {
// Expected
}
}
}

@Test
public void testRetentionPolicyValidation() throws Exception {
String namespace = this.testTenant + "/namespace-" + System.nanoTime();

admin.namespaces().createNamespace(namespace, Sets.newHashSet(testLocalCluster));

// should pass
admin.namespaces().setRetention(namespace, new RetentionPolicies());
admin.namespaces().setRetention(namespace, new RetentionPolicies(-1, -1));
admin.namespaces().setRetention(namespace, new RetentionPolicies(1, 1));

// should not pass validation
assertInvalidRetentionPolicy(namespace, 1, 0);
assertInvalidRetentionPolicy(namespace, 0, 1);
assertInvalidRetentionPolicy(namespace, -1, 0);
assertInvalidRetentionPolicy(namespace, 0, -1);
assertInvalidRetentionPolicy(namespace, -2, 1);
assertInvalidRetentionPolicy(namespace, 1, -2);

admin.namespaces().deleteNamespace(namespace);
}

private void assertInvalidRetentionPolicy(String namespace, int retentionTimeInMinutes, int retentionSizeInMB) {
try {
RetentionPolicies retention = new RetentionPolicies(retentionTimeInMinutes, retentionSizeInMB);
admin.namespaces().setRetention(namespace, retention);
fail("Validation should have failed for " + retention);
} catch (PulsarAdminException e) {
assertTrue(e.getCause() instanceof BadRequestException);
assertTrue(e.getMessage().startsWith("Invalid retention policy"));
}
}

@Test
public void testRetentionPolicyValidationAsPartOfAllPolicies() throws Exception {
Policies policies = new Policies();
policies.replication_clusters = Sets.newHashSet(testLocalCluster);

assertValidRetentionPolicyAsPartOfAllPolicies(policies, 0, 0);
assertValidRetentionPolicyAsPartOfAllPolicies(policies, -1, -1);
assertValidRetentionPolicyAsPartOfAllPolicies(policies, 1, 1);

// should not pass validation
assertInvalidRetentionPolicyAsPartOfAllPolicies(policies, 1, 0);
assertInvalidRetentionPolicyAsPartOfAllPolicies(policies, 0, 1);
assertInvalidRetentionPolicyAsPartOfAllPolicies(policies, -1, 0);
assertInvalidRetentionPolicyAsPartOfAllPolicies(policies, 0, -1);
assertInvalidRetentionPolicyAsPartOfAllPolicies(policies, -2, 1);
assertInvalidRetentionPolicyAsPartOfAllPolicies(policies, 1, -2);
}

private void assertValidRetentionPolicyAsPartOfAllPolicies(Policies policies, int retentionTimeInMinutes,
int retentionSizeInMB) throws PulsarAdminException {
String namespace = this.testTenant + "/namespace-" + System.nanoTime();
RetentionPolicies retention = new RetentionPolicies(retentionTimeInMinutes, retentionSizeInMB);
policies.retention_policies = retention;
admin.namespaces().createNamespace(namespace, policies);
admin.namespaces().deleteNamespace(namespace);
}

private void assertInvalidRetentionPolicyAsPartOfAllPolicies(Policies policies, int retentionTimeInMinutes,
int retentionSizeInMB) {
String namespace = this.testTenant + "/namespace-" + System.nanoTime();
try {
RetentionPolicies retention = new RetentionPolicies(retentionTimeInMinutes, retentionSizeInMB);
policies.retention_policies = retention;
admin.namespaces().createNamespace(namespace, policies);
fail("Validation should have failed for " + retention);
} catch (PulsarAdminException e) {
assertTrue(e.getCause() instanceof BadRequestException);
assertTrue(e.getMessage().startsWith("Invalid retention policy"));
}
}
}
8 changes: 4 additions & 4 deletions pulsar-broker/src/test/java/org/apache/pulsar/broker/service/PersistentTopicE2ETest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -744,7 +744,7 @@ public void testGcAndRetentionPolicy() throws Exception {
assertNotNull(pulsar.getBrokerService().getTopicReference(topicName));

// Remove retention
admin.namespaces().setRetention("prop/ns-abc", new RetentionPolicies(0, 10));
admin.namespaces().setRetention("prop/ns-abc", new RetentionPolicies());
Thread.sleep(300);

// 2. Topic is not GCed with live connection
Expand Down Expand Up @@ -787,7 +787,7 @@ public void testInfiniteRetentionPolicy() throws Exception {
assertNotNull(pulsar.getBrokerService().getTopicReference(topicName));

// Remove retention
admin.namespaces().setRetention("prop/ns-abc", new RetentionPolicies(0, 10));
admin.namespaces().setRetention("prop/ns-abc", new RetentionPolicies());
Thread.sleep(300);

// 2. Topic is not GCed with live connection
Expand Down Expand Up @@ -834,7 +834,7 @@ public void testServiceConfigurationRetentionPolicy() throws Exception {
assertTrue(pulsar.getBrokerService().getTopicReference(topicName).isPresent());

// Remove retention
admin.namespaces().setRetention("prop/ns-abc", new RetentionPolicies(0, 10));
admin.namespaces().setRetention("prop/ns-abc", new RetentionPolicies());
Thread.sleep(300);

// 2. Topic is not GCed with live connection
Expand Down Expand Up @@ -1684,4 +1684,4 @@ public void testWithEventTime() throws Exception {
assertEquals(msg.getValue(), "test");
assertEquals(msg.getEventTime(), 5);
}
}
}