[SENTRY-999] Refactor the sentry to integrate with external components quickly

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.8.0
• Labels: integration
• Assignee: Colin
• Reporter: Colin
• Created: 05/Jan/16 08:40
• Updated: 13/Nov/17 17:19
• Resolved: 22/Apr/16 06:29

Description

Problem
Currently, many components are integrated with Sentry, eg, Solr, Sqoop. But when do the integration, some duplicated work need to be done, for example, sentry-core-model-xxx and sentry-policy-xxx should be created for new component and the code is kind of duplicated. These makes the integration complex and the source maintenance will be hard.
Considering others components will be integrated with Sentry, eg, Kafka. The Sentry should be refactored to be easy integrated.

Refactor point
1. PolicyEngine: Currently, Sentry has many PolicyEngine, eg, SimpleSearchPolicyEngine for Solr, SimpleSqoopPolicyEngine for Sqoop. One CommonPolicyEngine should be ok for these external components.
2. Privilege: Currently, SearchWildcardPrivilege, IndexerWildcardPrivilege, SqoopWildcardPrivilege have the same implementation. One CommonPrivilege is enough.
3. Action: Currently, SearchActionFactory, SqoopActionFactory are never used in Privilege.imply(). The idea for these ActionFactory is good, but it is component related and should be located in sentry-xxx-binding project.

Issue Links

• is related to: SENTRY-1204 Add method to enforce validator when creating the privileges if possible
• is related to: SENTRY-1205 Refactor the code for sentry-provider-db and create sentry-service module
• is related to: SENTRY-1206 Add document for how to integrate with Sentry
• is related to: SENTRY-2043 Understand the reason of the KeyValue class design
• relates to: SENTRY-1080 Uber Jira for improving/redesigning sentry generic model
• links to: Review board

Sub-Tasks

• Create CommonPrivilege for external component: Resolved
• Improvement for CommonPrivilege: Resolved
• Create Model for specific components: Resolved
• Move Class KeyValue and PolicyConstants to sentry-core-common: Resolved
• Create CommonPolicy for external component: Resolved
• Move validator from sentry-policy-xxx to sentry-core-model-xxx: Resolved
• Add method in Privilege model to create privilege validators: Resolved
• Refactor the constructor of PolicyEngine: Resolved
• Add test cases for Hive, Solr, Index, Sqoop with the CommonPrivilege: Resolved
• Move test cases from sentry-policy-xxx to sentry-binding-xxx: Resolved
• Refactor ResourceAuthorizationProvider with CommonPrivilege and CommonPolicy: Resolved
• Authorizable names' case sensitivity must be decided by plugins: Resolved
• Remove unnecessary sentry-policy-xxx: Resolved
• Rebase the code: Resolved