Skip to content
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

[REST API] Renamed "type" to "ruleType" and created a CreateRule type #4746

Merged
merged 2 commits into from
Jun 6, 2024
Merged

[REST API] Renamed "type" to "ruleType" and created a CreateRule type #4746

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
a390e14
Renamed "type" to "ruleType" in REST API and created a CreateRule type
EricWittmann Jun 6, 2024
15d7513
Fix artifact page (ruleType change)
EricWittmann Jun 6, 2024
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
29 changes: 15 additions & 14 deletions app/src/main/java/io/apicurio/registry/rest/v3/AdminResourceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import io.apicurio.registry.rest.MissingRequiredParameterException;
import io.apicurio.registry.rest.v3.beans.ArtifactTypeInfo;
import io.apicurio.registry.rest.v3.beans.ConfigurationProperty;
import io.apicurio.registry.rest.v3.beans.CreateRule;
import io.apicurio.registry.rest.v3.beans.DownloadRef;
import io.apicurio.registry.rest.v3.beans.RoleMapping;
import io.apicurio.registry.rest.v3.beans.RoleMappingSearchResults;
Expand Down Expand Up @@ -154,22 +155,22 @@ public List<RuleType> listGlobalRules() {
}

/**
* @see io.apicurio.registry.rest.v3.AdminResource#createGlobalRule(io.apicurio.registry.rest.v3.beans.Rule)
* @see io.apicurio.registry.rest.v3.AdminResource#createGlobalRule(CreateRule)
*/
@Override
@Audited(extractParameters = {"0", KEY_RULE})
@Authorized(style=AuthorizedStyle.None, level=AuthorizedLevel.Admin)
public void createGlobalRule(Rule data) {
RuleType type = data.getType();
requireParameter("type", type);
public void createGlobalRule(CreateRule data) {
RuleType ruleType = data.getRuleType();
requireParameter("ruleType", ruleType);

if (data.getConfig() == null || data.getConfig().isEmpty()) {
throw new MissingRequiredParameterException("Config");
}

RuleConfigurationDto configDto = new RuleConfigurationDto();
configDto.setConfiguration(data.getConfig());
storage.createGlobalRule(data.getType(), configDto);
storage.createGlobalRule(data.getRuleType(), configDto);
}

/**
Expand All @@ -187,19 +188,19 @@ public void deleteAllGlobalRules() {
*/
@Override
@Authorized(style=AuthorizedStyle.None, level=AuthorizedLevel.Read)
public Rule getGlobalRuleConfig(RuleType rule) {
public Rule getGlobalRuleConfig(RuleType ruleType) {
RuleConfigurationDto dto;
try {
dto = storage.getGlobalRule(rule);
dto = storage.getGlobalRule(ruleType);
} catch (RuleNotFoundException ruleNotFoundException) {
// Check if the rule exists in the default global rules
dto = rulesProperties.getDefaultGlobalRuleConfiguration(rule);
dto = rulesProperties.getDefaultGlobalRuleConfiguration(ruleType);
if (dto == null) {
throw ruleNotFoundException;
}
}
Rule ruleBean = new Rule();
ruleBean.setType(rule);
ruleBean.setRuleType(ruleType);
ruleBean.setConfig(dto.getConfiguration());
return ruleBean;
}
Expand All @@ -210,22 +211,22 @@ public Rule getGlobalRuleConfig(RuleType rule) {
@Override
@Audited(extractParameters = {"0", KEY_RULE_TYPE, "1", KEY_RULE})
@Authorized(style=AuthorizedStyle.None, level=AuthorizedLevel.Admin)
public Rule updateGlobalRuleConfig(RuleType rule, Rule data) {
public Rule updateGlobalRuleConfig(RuleType ruleType, Rule data) {
RuleConfigurationDto configDto = new RuleConfigurationDto();
configDto.setConfiguration(data.getConfig());
try {
storage.updateGlobalRule(rule, configDto);
storage.updateGlobalRule(ruleType, configDto);
} catch (RuleNotFoundException ruleNotFoundException) {
// This global rule doesn't exist in artifactStore - if the rule exists in the default
// global rules, override the default by creating a new global rule
if (rulesProperties.isDefaultGlobalRuleConfigured(rule)) {
storage.createGlobalRule(rule, configDto);
if (rulesProperties.isDefaultGlobalRuleConfigured(ruleType)) {
storage.createGlobalRule(ruleType, configDto);
} else {
throw ruleNotFoundException;
}
}
Rule ruleBean = new Rule();
ruleBean.setType(rule);
ruleBean.setRuleType(ruleType);
ruleBean.setConfig(data.getConfig());
return ruleBean;
}
Expand Down
31 changes: 16 additions & 15 deletions app/src/main/java/io/apicurio/registry/rest/v3/GroupsResourceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@
import io.apicurio.registry.rest.v3.beans.CreateArtifact;
import io.apicurio.registry.rest.v3.beans.CreateArtifactResponse;
import io.apicurio.registry.rest.v3.beans.CreateGroup;
import io.apicurio.registry.rest.v3.beans.CreateRule;
import io.apicurio.registry.rest.v3.beans.CreateVersion;
import io.apicurio.registry.rest.v3.beans.EditableArtifactMetaData;
import io.apicurio.registry.rest.v3.beans.EditableGroupMetaData;
Expand Down Expand Up @@ -300,17 +301,16 @@ public List<RuleType> listArtifactRules(String groupId, String artifactId) {
}

/**
* @see io.apicurio.registry.rest.v3.GroupsResource#createArtifactRule(java.lang.String, java.lang.String, io.apicurio.registry.rest.v3.beans.Rule)
* @see io.apicurio.registry.rest.v3.GroupsResource#createArtifactRule(String, String, CreateRule)
*/
@Override
@Audited(extractParameters = {"0", KEY_GROUP_ID, "1", KEY_ARTIFACT_ID, "2", KEY_RULE})
@Authorized(style = AuthorizedStyle.GroupAndArtifact, level = AuthorizedLevel.Write)
public void createArtifactRule(String groupId, String artifactId, Rule data) {
public void createArtifactRule(String groupId, String artifactId, CreateRule data) {
requireParameter("groupId", groupId);
requireParameter("artifactId", artifactId);

RuleType type = data.getType();
requireParameter("type", type);
requireParameter("ruleType", data.getRuleType());
requireParameter("config", data.getConfig());

if (data.getConfig() == null || data.getConfig().isEmpty()) {
throw new MissingRequiredParameterException("Config");
Expand All @@ -323,7 +323,7 @@ public void createArtifactRule(String groupId, String artifactId, Rule data) {
throw new ArtifactNotFoundException(groupId, artifactId);
}

storage.createArtifactRule(new GroupId(groupId).getRawGroupIdWithNull(), artifactId, data.getType(), config);
storage.createArtifactRule(new GroupId(groupId).getRawGroupIdWithNull(), artifactId, data.getRuleType(), config);
}

/**
Expand All @@ -344,33 +344,34 @@ public void deleteArtifactRules(String groupId, String artifactId) {
*/
@Override
@Authorized(style = AuthorizedStyle.GroupAndArtifact, level = AuthorizedLevel.Read)
public Rule getArtifactRuleConfig(String groupId, String artifactId, RuleType rule) {
public Rule getArtifactRuleConfig(String groupId, String artifactId, RuleType ruleType) {
requireParameter("groupId", groupId);
requireParameter("artifactId", artifactId);
requireParameter("rule", rule);
requireParameter("ruleType", ruleType);

RuleConfigurationDto dto = storage.getArtifactRule(new GroupId(groupId).getRawGroupIdWithNull(), artifactId, rule);
RuleConfigurationDto dto = storage.getArtifactRule(new GroupId(groupId).getRawGroupIdWithNull(), artifactId, ruleType);
Rule rval = new Rule();
rval.setConfig(dto.getConfiguration());
rval.setType(rule);
rval.setRuleType(ruleType);
return rval;
}

/**
* @see io.apicurio.registry.rest.v3.GroupsResource#updateArtifactRuleConfig(java.lang.String, java.lang.String, io.apicurio.registry.types.RuleType, io.apicurio.registry.rest.v3.beans.Rule)
* @see io.apicurio.registry.rest.v3.GroupsResource#updateArtifactRuleConfig(String, String, RuleType, Rule)
*/
@Override
@Audited(extractParameters = {"0", KEY_GROUP_ID, "1", KEY_ARTIFACT_ID, "2", KEY_RULE_TYPE, "3", KEY_RULE})
@Authorized(style = AuthorizedStyle.GroupAndArtifact, level = AuthorizedLevel.Write)
public Rule updateArtifactRuleConfig(String groupId, String artifactId, RuleType rule, Rule data) {
public Rule updateArtifactRuleConfig(String groupId, String artifactId, RuleType ruleType, Rule data) {
requireParameter("groupId", groupId);
requireParameter("artifactId", artifactId);
requireParameter("rule", rule);
requireParameter("ruleType", ruleType);
requireParameter("config", data.getConfig());

RuleConfigurationDto dto = new RuleConfigurationDto(data.getConfig());
storage.updateArtifactRule(new GroupId(groupId).getRawGroupIdWithNull(), artifactId, rule, dto);
storage.updateArtifactRule(new GroupId(groupId).getRawGroupIdWithNull(), artifactId, ruleType, dto);
Rule rval = new Rule();
rval.setType(rule);
rval.setRuleType(ruleType);
rval.setConfig(data.getConfig());
return rval;
}
Expand Down
18 changes: 9 additions & 9 deletions app/src/test/java/io/apicurio/registry/AbstractResourceTestBase.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,33 +242,33 @@ protected Long createArtifactVersion(String groupId, String artifactId, String c
}

protected void createArtifactRule(String groupId, String artifactId, RuleType ruleType, String ruleConfig) {
var rule = new io.apicurio.registry.rest.client.models.Rule();
rule.setConfig(ruleConfig);
rule.setType(io.apicurio.registry.rest.client.models.RuleType.forValue(ruleType.value()));
var createRule = new io.apicurio.registry.rest.client.models.CreateRule();
createRule.setConfig(ruleConfig);
createRule.setRuleType(io.apicurio.registry.rest.client.models.RuleType.forValue(ruleType.value()));

clientV3
.groups()
.byGroupId(groupId)
.artifacts()
.byArtifactId(artifactId)
.rules()
.post(rule);
.post(createRule);
}

protected io.apicurio.registry.rest.client.models.Rule createGlobalRule(RuleType ruleType, String ruleConfig) {
var rule = new io.apicurio.registry.rest.client.models.Rule();
rule.setConfig(ruleConfig);
rule.setType(io.apicurio.registry.rest.client.models.RuleType.forValue(ruleType.value()));
var createRule = new io.apicurio.registry.rest.client.models.CreateRule();
createRule.setConfig(ruleConfig);
createRule.setRuleType(io.apicurio.registry.rest.client.models.RuleType.forValue(ruleType.value()));

clientV3
.admin()
.rules()
.post(rule);
.post(createRule);
// TODO: verify this get
return clientV3
.admin()
.rules()
.byRule(ruleType.value())
.byRuleType(ruleType.value())
.get();
}

Expand Down
16 changes: 8 additions & 8 deletions app/src/test/java/io/apicurio/registry/auth/AuthTestLocalRoles.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
import io.apicurio.registry.model.GroupId;
import io.apicurio.registry.rest.client.RegistryClient;
import io.apicurio.registry.rest.client.models.CreateArtifact;
import io.apicurio.registry.rest.client.models.CreateRule;
import io.apicurio.registry.rest.client.models.RoleMapping;
import io.apicurio.registry.rest.client.models.RoleType;
import io.apicurio.registry.rest.client.models.Rule;
import io.apicurio.registry.rest.client.models.RuleType;
import io.apicurio.registry.rest.client.models.UpdateRole;
import io.apicurio.registry.rules.validity.ValidityLevel;
Expand Down Expand Up @@ -56,12 +56,12 @@ protected RegistryClient createRestClientV3() {
return new RegistryClient(adapter);
}

private static final Rule rule = new Rule();
private static final CreateRule createRule = new CreateRule();
private static final CreateArtifact createArtifact;

static {
rule.setConfig(ValidityLevel.FULL.name());
rule.setType(RuleType.VALIDITY);
createRule.setConfig(ValidityLevel.FULL.name());
createRule.setRuleType(RuleType.VALIDITY);
createArtifact = TestUtils.clientCreateArtifact(AuthTestLocalRoles.class.getSimpleName(), ArtifactType.AVRO, TEST_CONTENT, ContentTypes.APPLICATION_JSON);
}

Expand Down Expand Up @@ -92,7 +92,7 @@ public void testLocalRoles() throws Exception {
assertForbidden(exception2);

var exception3 = Assertions.assertThrows(Exception.class, () -> {
client.admin().rules().post(rule);
client.admin().rules().post(createRule);
});
assertForbidden(exception3);

Expand All @@ -115,7 +115,7 @@ public void testLocalRoles() throws Exception {
});
assertForbidden(exception4);
var exception5 = Assertions.assertThrows(Exception.class, () -> {
client.admin().rules().post(rule);
client.admin().rules().post(createRule);
});
assertForbidden(exception5);

Expand All @@ -140,7 +140,7 @@ public void testLocalRoles() throws Exception {
config.headers.add("X-Registry-ArtifactId", getClass().getSimpleName());
});
var exception6 = Assertions.assertThrows(Exception.class, () -> {
client.admin().rules().post(rule);
client.admin().rules().post(createRule);
});
assertForbidden(exception6);

Expand All @@ -162,7 +162,7 @@ public void testLocalRoles() throws Exception {
.byGroupId(UUID.randomUUID().toString())
.artifacts()
.post(createArtifact);
client.admin().rules().post(rule);
client.admin().rules().post(createRule);

// Now delete the role mapping
clientAdmin
Expand Down
12 changes: 6 additions & 6 deletions app/src/test/java/io/apicurio/registry/auth/AuthTestNoRoles.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
import io.apicurio.registry.model.GroupId;
import io.apicurio.registry.rest.client.RegistryClient;
import io.apicurio.registry.rest.client.models.CreateArtifact;
import io.apicurio.registry.rest.client.models.CreateRule;
import io.apicurio.registry.rest.client.models.CreateVersion;
import io.apicurio.registry.rest.client.models.Rule;
import io.apicurio.registry.rest.client.models.RuleType;
import io.apicurio.registry.rest.client.models.VersionContent;
import io.apicurio.registry.rules.validity.ValidityLevel;
Expand Down Expand Up @@ -91,12 +91,12 @@ public void testAdminRole() throws Exception {
);
assertNotNull(client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).get());

Rule ruleConfig = new Rule();
ruleConfig.setType(RuleType.VALIDITY);
ruleConfig.setConfig(ValidityLevel.NONE.name());
CreateRule createRule = new CreateRule();
createRule.setRuleType(RuleType.VALIDITY);
createRule.setConfig(ValidityLevel.NONE.name());

client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).rules().post(ruleConfig);
client.admin().rules().post(ruleConfig);
client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).rules().post(createRule);
client.admin().rules().post(createRule);
} finally {
client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).delete();
}
Expand Down
12 changes: 6 additions & 6 deletions app/src/test/java/io/apicurio/registry/auth/AuthTestProfileBasicClientCredentials.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
import io.apicurio.registry.model.GroupId;
import io.apicurio.registry.rest.client.RegistryClient;
import io.apicurio.registry.rest.client.models.CreateArtifact;
import io.apicurio.registry.rest.client.models.CreateRule;
import io.apicurio.registry.rest.client.models.CreateVersion;
import io.apicurio.registry.rest.client.models.Rule;
import io.apicurio.registry.rest.client.models.RuleType;
import io.apicurio.registry.rest.client.models.VersionContent;
import io.apicurio.registry.rules.validity.ValidityLevel;
Expand Down Expand Up @@ -92,12 +92,12 @@ public void testBasicAuthClientCredentials() throws Exception {
);
assertNotNull(client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).get());

Rule ruleConfig = new Rule();
ruleConfig.setType(RuleType.VALIDITY);
ruleConfig.setConfig(ValidityLevel.NONE.name());
CreateRule createRule = new CreateRule();
createRule.setRuleType(RuleType.VALIDITY);
createRule.setConfig(ValidityLevel.NONE.name());

client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).rules().post(ruleConfig);
client.admin().rules().post(ruleConfig);
client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).rules().post(createRule);
client.admin().rules().post(createRule);
} finally {
client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).delete();
}
Expand Down
30 changes: 15 additions & 15 deletions app/src/test/java/io/apicurio/registry/auth/BasicAuthWithPropertiesTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
import io.apicurio.registry.rest.client.RegistryClient;
import io.apicurio.registry.rest.client.models.ArtifactMetaData;
import io.apicurio.registry.rest.client.models.CreateArtifact;
import io.apicurio.registry.rest.client.models.CreateRule;
import io.apicurio.registry.rest.client.models.EditableArtifactMetaData;
import io.apicurio.registry.rest.client.models.Rule;
import io.apicurio.registry.rest.client.models.RuleType;
import io.apicurio.registry.rest.client.models.UserInfo;
import io.apicurio.registry.rest.client.models.VersionMetaData;
Expand Down Expand Up @@ -135,13 +135,13 @@ public void testDevRole() throws Exception {

assertTrue(client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).versions().byVersionExpression("branch=latest").content().get().readAllBytes().length > 0);

Rule ruleConfig = new Rule();
ruleConfig.setType(RuleType.VALIDITY);
ruleConfig.setConfig(ValidityLevel.NONE.name());
client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).rules().post(ruleConfig);
CreateRule createRule = new CreateRule();
createRule.setRuleType(RuleType.VALIDITY);
createRule.setConfig(ValidityLevel.NONE.name());
client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).rules().post(createRule);

var exception = Assertions.assertThrows(Exception.class, () -> {
client.admin().rules().post(ruleConfig);
client.admin().rules().post(createRule);
});
assertForbidden(exception);

Expand Down Expand Up @@ -171,12 +171,12 @@ public void testAdminRole() throws Exception {

assertTrue(client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).versions().byVersionExpression("branch=latest").content().get().readAllBytes().length > 0);

Rule ruleConfig = new Rule();
ruleConfig.setType(RuleType.VALIDITY);
ruleConfig.setConfig(ValidityLevel.NONE.name());
client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).rules().post(ruleConfig);
CreateRule createRule = new CreateRule();
createRule.setRuleType(RuleType.VALIDITY);
createRule.setConfig(ValidityLevel.NONE.name());
client.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId).rules().post(createRule);

client.admin().rules().post(ruleConfig);
client.admin().rules().post(createRule);

UserInfo userInfo = client.users().me().get();
assertNotNull(userInfo);
Expand Down Expand Up @@ -222,10 +222,10 @@ public void testOwnerOnlyAuthorization() throws Exception {
clientDev.groups().byGroupId(groupId).artifacts().post(createArtifact);

// And the Admin user will modify it (allowed because it's the Admin user)
Rule rule = new Rule();
rule.setType(RuleType.COMPATIBILITY);
rule.setConfig(CompatibilityLevel.BACKWARD.name());
clientAdmin.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId2).rules().post(rule);
CreateRule createRule = new CreateRule();
createRule.setRuleType(RuleType.COMPATIBILITY);
createRule.setConfig(CompatibilityLevel.BACKWARD.name());
clientAdmin.groups().byGroupId(groupId).artifacts().byArtifactId(artifactId2).rules().post(createRule);
}

@Test
Expand Down
Loading
Loading