Skip to content

[Policy Store] Enforce regex requirement for policy name #1583

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
eric-maynard merged 3 commits into from
May 14, 2025
Merged

[Policy Store] Enforce regex requirement for policy name #1583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7ba4915
Enforce regex requirement for policy name
HonahX May 14, 2025
3e0b175
enable validation in open api builder
HonahX May 14, 2025
7a13991
FIx nit
HonahX May 14, 2025
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
2 changes: 1 addition & 1 deletion api/polaris-catalog-service/build.gradle.kts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ openApiGenerate {
globalProperties.put("modelTests", "false")
configOptions.put("resourceName", "catalog")
configOptions.put("useTags", "true")
configOptions.put("useBeanValidation", "false")
configOptions.put("useBeanValidation", "true")
configOptions.put("sourceFolder", "src/main/java")
configOptions.put("useJakartaEe", "true")
configOptions.put("generateBuilders", "true")
Expand Down
60 changes: 60 additions & 0 deletions ...src/main/java/org/apache/polaris/service/it/test/PolarisPolicyServiceIntegrationTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
import static org.apache.polaris.service.it.env.PolarisClient.polarisClient;

import com.google.common.collect.ImmutableMap;
import jakarta.ws.rs.client.Entity;
import jakarta.ws.rs.core.Response;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.Method;
Expand All @@ -35,6 +37,7 @@
import org.apache.iceberg.catalog.Namespace;
import org.apache.iceberg.catalog.TableIdentifier;
import org.apache.iceberg.rest.RESTCatalog;
import org.apache.iceberg.rest.RESTUtil;
import org.apache.iceberg.types.Types;
import org.apache.polaris.core.admin.model.AwsStorageConfigInfo;
import org.apache.polaris.core.admin.model.Catalog;
Expand All @@ -60,6 +63,7 @@
import org.apache.polaris.service.it.env.PolicyApi;
import org.apache.polaris.service.it.ext.PolarisIntegrationTestExtension;
import org.apache.polaris.service.types.ApplicablePolicy;
import org.apache.polaris.service.types.CreatePolicyRequest;
import org.apache.polaris.service.types.Policy;
import org.apache.polaris.service.types.PolicyAttachmentTarget;
import org.apache.polaris.service.types.PolicyIdentifier;
Expand All @@ -72,6 +76,8 @@
import org.junit.jupiter.api.TestInfo;
import org.junit.jupiter.api.extension.ExtendWith;
import org.junit.jupiter.api.io.TempDir;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

@ExtendWith(PolarisIntegrationTestExtension.class)
public class PolarisPolicyServiceIntegrationTest {
Expand Down Expand Up @@ -260,6 +266,60 @@ public void testCreatePolicy() {
policyApi.dropPolicy(currentCatalogName, NS1_P1);
}

@ParameterizedTest
@ValueSource(
strings = {
" invalid",
"invalid ",
" invalid ",
"",
"policy name",
"policy@name",
"policy#name",
"policy$name",
"policy!name",
"policy name with space",
"policy.name",
"policy,name",
"policy~name",
"policy`name",
"policy;name",
"policy:name",
"policy<>name",
"policy[]name",
"policy{}name",
"policy|name",
"policy\\name",
"policy/name",
"policy*name",
"policy^name",
"policy%name",
})
public void testCreatePolicyWithInvalidName(String policyName) {
restCatalog.createNamespace(NS1);
PolicyIdentifier policyIdentifier = new PolicyIdentifier(NS1, policyName);

String ns = RESTUtil.encodeNamespace(policyIdentifier.getNamespace());
CreatePolicyRequest request =
CreatePolicyRequest.builder()
.setType(PredefinedPolicyTypes.DATA_COMPACTION.getName())
.setName(policyIdentifier.getName())
.setDescription("test policy")
.setContent(EXAMPLE_TABLE_MAINTENANCE_POLICY_CONTENT)
.build();
try (Response res =
policyApi
.request(
"polaris/v1/{cat}/namespaces/{ns}/policies",
Map.of("cat", currentCatalogName, "ns", ns))
.post(Entity.json(request))) {
Assertions.assertThat(res.getStatus()).isEqualTo(Response.Status.BAD_REQUEST.getStatusCode());
Assertions.assertThat(res.readEntity(String.class))
.contains(
"{\"error\":{\"message\":\"Invalid value: createPolicy.arg2.name: must match \\\"^[A-Za-z0-9\\\\-_]+$\\\"\",\"type\":\"ResteasyReactiveViolationException\",\"code\":400}}");
}
}

@Test
public void testDropPolicy() {
restCatalog.createNamespace(NS1);
Expand Down