yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2026-01-08 21:48:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixes #6659 Backend : Add support for roles and teams in policy (#6676)

Browse Source
This commit is contained in:
Suresh Srinivas 2022-08-09 14:25:27 -07:00 committed by GitHub
parent e321008cd0
commit cbcc00bc78
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 82 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
catalog-rest-service/src/main/java/org/openmetadata/catalog/jdbi3/PolicyRepository.java
View File

@ -28,6 +28,7 @@ import org.openmetadata.catalog.Entity;
import org.openmetadata.catalog.entity.data.Location;
import org.openmetadata.catalog.entity.policies.Policy;
import org.openmetadata.catalog.exception.CatalogExceptionMessage;
import org.openmetadata.catalog.jdbi3.CollectionDAO.EntityRelationshipRecord;
import org.openmetadata.catalog.resources.policies.PolicyResource;
import org.openmetadata.catalog.type.EntityReference;
import org.openmetadata.catalog.type.PolicyType;
@ -63,9 +64,25 @@ public class PolicyRepository extends EntityRepository<Policy> {
public Policy setFields(Policy policy, Fields fields) throws IOException {
policy.setOwner(fields.contains(FIELD_OWNER) ? getOwner(policy) : null);
policy.setLocation(fields.contains("location") ? getLocationForPolicy(policy) : null);
policy.setTeams(fields.contains("teams") ? getTeams(policy) : null);
policy.setRoles(fields.contains("roles") ? getRoles(policy) : null);
return policy;
}
/* Get all the teams that use this policy */
private List<EntityReference> getTeams(Policy policy) throws IOException {
List<EntityRelationshipRecord> records = findFrom(policy.getId(), POLICY, Relationship.HAS, Entity.TEAM);
List<EntityReference> teams = EntityUtil.populateEntityReferences(records, Entity.TEAM);
return teams;
}
/* Get all the roles that use this policy */
private List<EntityReference> getRoles(Policy policy) throws IOException {
List<EntityRelationshipRecord> records = findFrom(policy.getId(), POLICY, Relationship.HAS, Entity.ROLE);
List<EntityReference> roles = EntityUtil.populateEntityReferences(records, Entity.ROLE);
return roles;
}
/** Generate EntityReference for a given Policy's Location. * */
@Transaction
private EntityReference getLocationReference(Policy policy) throws IOException {

6
catalog-rest-service/src/main/java/org/openmetadata/catalog/jdbi3/UserRepository.java
View File

@ -204,20 +204,20 @@ public class UserRepository extends EntityRepository<User> {
return EntityUtil.populateEntityReferences(refs);
}
/* Add all the roles that user has been assigned and inherited from the team to User entity */
/* Get all the roles that user has been assigned and inherited from the team to User entity */
private List<EntityReference> getRoles(User user) throws IOException {
List<EntityRelationshipRecord> roleIds = findTo(user.getId(), Entity.USER, Relationship.HAS, Entity.ROLE);
return EntityUtil.populateEntityReferences(roleIds, Entity.ROLE);
}
/* Add all the roles that user has been assigned and inherited from the team to User entity */
/* Get all the roles that user has been assigned and inherited from the team to User entity */
private List<EntityReference> getInheritedRoles(User user) throws IOException {
List<EntityReference> roles = getDefaultRole();
roles.addAll(getTeamDefaultRoles(user));
return roles.stream().distinct().collect(Collectors.toList()); // Remove duplicates
}
/* Add all the teams that user belongs to User entity */
/* Get all the teams that user belongs to User entity */
private List<EntityReference> getTeams(User user) throws IOException {
List<EntityRelationshipRecord> records = findFrom(user.getId(), Entity.USER, Relationship.HAS, Entity.TEAM);
List<EntityReference> teams = EntityUtil.populateEntityReferences(records, Entity.TEAM);

4
catalog-rest-service/src/main/java/org/openmetadata/catalog/resources/policies/PolicyResource.java
View File

@ -81,6 +81,8 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
@Override
public Policy addHref(UriInfo uriInfo, Policy policy) {
Entity.withHref(uriInfo, policy.getOwner());
Entity.withHref(uriInfo, policy.getTeams());
Entity.withHref(uriInfo, policy.getRoles());
return policy;
}
@ -117,7 +119,7 @@ public class PolicyResource extends EntityResource<Policy, PolicyRepository> {
}
}
public static final String FIELDS = "owner,location";
public static final String FIELDS = "owner,location,teams,roles";
@GET
@Valid

12
catalog-rest-service/src/main/java/org/openmetadata/catalog/util/EntityUtil.java
View File

@ -38,6 +38,7 @@ import org.apache.http.client.HttpResponseException;
import org.joda.time.Period;
import org.joda.time.format.ISOPeriodFormat;
import org.openmetadata.catalog.Entity;
import org.openmetadata.catalog.EntityInterface;
import org.openmetadata.catalog.api.data.TermReference;
import org.openmetadata.catalog.entity.data.GlossaryTerm;
import org.openmetadata.catalog.entity.data.Table;
@ -263,6 +264,17 @@ public final class EntityUtil {
return CommonUtil.getResources(Pattern.compile(path));
}
public static <T extends EntityInterface> List<EntityReference> toEntityReferences(List<T> entities) {
if (entities == null) {
return null;
}
List<EntityReference> entityReferences = new ArrayList<>();
for (T entity : entities) {
entityReferences.add(entity.getEntityReference());
}
return entityReferences;
}
public static List<EntityReference> toEntityReferences(List<UUID> ids, String entityType) {
if (ids == null) {
return null;

8
catalog-rest-service/src/main/resources/json/schema/entity/policies/policy.json
View File

@ -94,6 +94,14 @@
"description": "Set of rules that the policy contains.",
"$ref": "#/definitions/rules"
},
"teams" : {
"description": "Teams that use this policy directly and not through roles.",
"$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
},
"roles" : {
"description": "Roles that use this policy.",
"$ref": "../../type/entityReference.json#/definitions/entityReferenceList"
},
"location": {
"description": "Location to which a policy is applied. This field is relevant only for `lifeCycle` policies.",
"$ref": "../../type/entityReference.json",

39
catalog-rest-service/src/test/java/org/openmetadata/catalog/resources/policies/PolicyResourceTest.java
View File

@ -41,14 +41,20 @@ import org.junit.jupiter.api.TestInfo;
import org.openmetadata.catalog.Entity;
import org.openmetadata.catalog.api.data.CreateLocation;
import org.openmetadata.catalog.api.policies.CreatePolicy;
import org.openmetadata.catalog.api.teams.CreateRole;
import org.openmetadata.catalog.api.teams.CreateTeam;
import org.openmetadata.catalog.entity.data.Location;
import org.openmetadata.catalog.entity.policies.Policy;
import org.openmetadata.catalog.entity.policies.accessControl.Rule;
import org.openmetadata.catalog.entity.policies.accessControl.Rule.Effect;
import org.openmetadata.catalog.entity.teams.Role;
import org.openmetadata.catalog.entity.teams.Team;
import org.openmetadata.catalog.resources.EntityResourceTest;
import org.openmetadata.catalog.resources.locations.LocationResourceTest;
import org.openmetadata.catalog.resources.policies.PolicyResource.PolicyList;
import org.openmetadata.catalog.resources.policies.PolicyResource.ResourceDescriptorList;
import org.openmetadata.catalog.resources.teams.RoleResourceTest;
import org.openmetadata.catalog.resources.teams.TeamResourceTest;
import org.openmetadata.catalog.type.ChangeDescription;
import org.openmetadata.catalog.type.EntityReference;
import org.openmetadata.catalog.type.FieldChange;
@ -183,7 +189,6 @@ public class PolicyResourceTest extends EntityResourceTest<Policy, CreatePolicy>
// Get list of policy resources and make sure it has all the entities and other resources
ResourceDescriptorList actualResourceDescriptors = getPolicyResources(ADMIN_AUTH_HEADERS);
assertNotNull(actualResourceDescriptors.getData());
System.out.println(actualResourceDescriptors.getData());
// Ensure all entities are captured in resource descriptor list
List<String> entities = Entity.getEntityList();
@ -194,6 +199,38 @@ public class PolicyResourceTest extends EntityResourceTest<Policy, CreatePolicy>
}
}
@Test
void get_policyTeamsAndRoles(TestInfo test) throws IOException {
// Ensure policy returns teams and roles that are part of
// Create 5 policies
List<Policy> policies = new ArrayList<>();
for (int i = 0; i < 3; i++) {
CreatePolicy create = createRequest(test, i);
policies.add(createEntity(create, ADMIN_AUTH_HEADERS));
}
TeamResourceTest teamResourceTest = new TeamResourceTest();
List<Team> teams = new ArrayList<>();
for (int i = 0; i < 3; i++) {
// Team X has Policy X
CreateTeam createTeam = teamResourceTest.createRequest(test, i).withPolicies(List.of(policies.get(i).getId()));
teams.add(teamResourceTest.createEntity(createTeam, ADMIN_AUTH_HEADERS));
}
// Create a role with all the policies
RoleResourceTest roleResourceTest = new RoleResourceTest();
CreateRole createRole = roleResourceTest.createRequest(test).withPolicies(EntityUtil.toEntityReferences(policies));
Role role = roleResourceTest.createEntity(createRole, ADMIN_AUTH_HEADERS);
// Get each policy and ensure the teams and roles are listed correctly
for (int i = 0; i < 3; i++) {
Policy getPolicy = getEntity(policies.get(i).getId(), "teams,roles", ADMIN_AUTH_HEADERS);
assertReference(teams.get(i).getEntityReference(), getPolicy.getTeams().get(0));
assertReference(role.getEntityReference(), getPolicy.getRoles().get(0));
}
}
@Override
public Policy validateGetWithDifferentFields(Policy policy, boolean byName) throws HttpResponseException {
String fields = "";

2
ingestion-core/src/metadata/_version.py
View File

@ -7,5 +7,5 @@ Provides metadata version information.
from incremental import Version
__version__ = Version("metadata", 0, 12, 0, dev=9)
__version__ = Version("metadata", 0, 12, 0, dev=10)
__all__ = ["__version__"]