Enum refactoring (#978)

### Feature or Bugfix - Refactoring ### Detail - Get rid of redefinitions of the same Enums. Used class GraphQLEnumMapper where it's required - Unhardcoded enum-constants for migrations and tests ### Security N/A By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. --------- Co-authored-by: Sofia Sazonova <[email protected]>
data-dot-all · Jan 26, 2024 · ffb5949 · ffb5949
1 parent 560bdee
commit ffb5949
Show file tree

Hide file tree

Showing 55 changed files with 101 additions and 235 deletions.
diff --git a/backend/dataall/core/environment/db/environment_models.py b/backend/dataall/core/environment/db/environment_models.py
@@ -5,7 +5,7 @@
 from sqlalchemy.orm import query_expression
 from dataall.base.db import Resource, Base, utils
 
-from dataall.core.environment.api.enums import EnvironmentPermission
+from dataall.core.environment.api.enums import EnvironmentPermission, EnvironmentType
 
 
 class Environment(Resource, Base):
@@ -18,7 +18,7 @@ class Environment(Resource, Base):
     resourcePrefix = Column(String, nullable=False, default='dataall')
 
     validated = Column(Boolean, default=False)
-    environmentType = Column(String, nullable=False, default='Data')
+    environmentType = Column(String, nullable=False, default=EnvironmentType.Data.value)
     isOrganizationDefaultEnvironment = Column(Boolean, default=False)
     EnvironmentDefaultIAMRoleName = Column(String, nullable=False)
     EnvironmentDefaultIAMRoleImported = Column(Boolean, default=False)

diff --git a/backend/dataall/core/organizations/api/input_types.py b/backend/dataall/core/organizations/api/input_types.py
@@ -1,6 +1,6 @@
 from dataall.base.api.constants import GraphQLEnumMapper, SortDirection
 from dataall.base.api import gql
-from dataall.core.organizations.api.enums import OrganisationUserRole
+from dataall.core.organizations.services.organizations_enums import OrganisationUserRole
 
 NewOrganizationInput = gql.InputType(
     name='NewOrganizationInput',

diff --git a/backend/dataall/core/organizations/db/organization_models.py b/backend/dataall/core/organizations/db/organization_models.py
@@ -1,5 +1,4 @@
 import datetime
-from enum import Enum
 
 from sqlalchemy import Column, String, DateTime
 from sqlalchemy.orm import query_expression
@@ -8,14 +7,6 @@
 from dataall.base.db import Resource, utils
 
 
-class OrganisationUserRole(Enum):
-    Owner = '999'
-    Admin = '900'
-    Member = '100'
-    NotMember = '000'
-    Invited = '800'
-
-
 class Organization(Resource, Base):
     __tablename__ = 'organization'
     organizationUri = Column(

diff --git a/backend/dataall/core/organizations/services/organization_service.py b/backend/dataall/core/organizations/services/organization_service.py
@@ -3,7 +3,8 @@
 from dataall.core.activity.db.activity_models import Activity
 from dataall.core.environment.db.environment_repositories import EnvironmentRepository
 from dataall.core.organizations.db.organization_repositories import OrganizationRepository
-from dataall.core.organizations.db.organization_models import OrganisationUserRole, OrganizationGroup
+from dataall.core.organizations.services.organizations_enums import OrganisationUserRole
+from dataall.core.organizations.db.organization_models import OrganizationGroup
 from dataall.core.organizations.db import organization_models as models
 from dataall.core.permissions import permissions
 from dataall.core.permissions.permission_checker import has_tenant_permission, has_resource_permission
@@ -137,7 +138,7 @@ def resolve_user_role(organization):
         else:
             with context.db_engine.scoped_session() as session:
                 if OrganizationRepository.find_organization_membership(
-                    session=session, uri=organization.organizationUri, groups=context.groups
+                        session=session, uri=organization.organizationUri, groups=context.groups
                 ):
                     return OrganisationUserRole.Invited.value
         return OrganisationUserRole.NoPermission.value

diff --git a/...d/dataall/core/organizations/api/enums.py → ...nizations/services/organizations_enums.py b/...d/dataall/core/organizations/api/enums.py → ...nizations/services/organizations_enums.py
diff --git a/backend/dataall/modules/dataset_sharing/api/input_types.py b/backend/dataall/modules/dataset_sharing/api/input_types.py
@@ -1,5 +1,5 @@
 from dataall.base.api.constants import *
-from dataall.modules.dataset_sharing.api.enums import ShareableType, ShareSortField
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareableType, ShareSortField
 
 
 NewShareObjectInput = gql.InputType(

diff --git a/backend/dataall/modules/dataset_sharing/api/resolvers.py b/backend/dataall/modules/dataset_sharing/api/resolvers.py
@@ -6,7 +6,7 @@
 from dataall.core.environment.services.environment_service import EnvironmentService
 from dataall.core.organizations.db.organization_repositories import OrganizationRepository
 from dataall.base.db.exceptions import RequiredParameter
-from dataall.modules.dataset_sharing.api.enums import ShareObjectPermission
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareObjectPermission
 from dataall.modules.dataset_sharing.db.share_object_models import ShareObjectItem, ShareObject
 from dataall.modules.dataset_sharing.services.share_item_service import ShareItemService
 from dataall.modules.dataset_sharing.services.share_object_service import ShareObjectService

diff --git a/backend/dataall/modules/dataset_sharing/api/types.py b/backend/dataall/modules/dataset_sharing/api/types.py
@@ -1,5 +1,5 @@
 from dataall.base.api import gql
-from dataall.modules.dataset_sharing.api.enums import ShareableType, PrincipalType
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareableType, PrincipalType
 from dataall.modules.dataset_sharing.api.resolvers import union_resolver, resolve_shared_item, resolve_dataset, \
     resolve_consumption_data, resolve_existing_shared_items, resolve_share_object_statistics, resolve_principal, \
     resolve_group, list_shareable_objects, resolve_user_role

diff --git a/backend/dataall/modules/dataset_sharing/db/enums.py b/backend/dataall/modules/dataset_sharing/db/enums.py
diff --git a/backend/dataall/modules/dataset_sharing/db/share_object_models.py b/backend/dataall/modules/dataset_sharing/db/share_object_models.py
@@ -5,7 +5,7 @@
 from sqlalchemy.orm import query_expression
 
 from dataall.base.db import Base, utils
-from dataall.modules.dataset_sharing.db.enums import ShareObjectStatus, ShareItemStatus
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareObjectStatus, ShareItemStatus
 
 
 def in_one_month():

diff --git a/backend/dataall/modules/dataset_sharing/db/share_object_repositories.py b/backend/dataall/modules/dataset_sharing/db/share_object_repositories.py
@@ -8,7 +8,7 @@
 from dataall.core.environment.services.environment_resource_manager import EnvironmentResource
 from dataall.core.organizations.db.organization_models import Organization
 from dataall.base.db import exceptions, paginate
-from dataall.modules.dataset_sharing.db.enums import ShareObjectActions, ShareObjectStatus, ShareItemActions, \
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareObjectActions, ShareObjectStatus, ShareItemActions, \
     ShareItemStatus, ShareableType, PrincipalType
 from dataall.modules.dataset_sharing.db.share_object_models import ShareObjectItem, ShareObject
 from dataall.modules.datasets_base.db.dataset_repositories import DatasetRepository

diff --git a/backend/dataall/modules/dataset_sharing/services/data_sharing_service.py b/backend/dataall/modules/dataset_sharing/services/data_sharing_service.py
@@ -1,5 +1,8 @@
 import logging
 
+from dataall.base.db import Engine
+from dataall.modules.dataset_sharing.db.share_object_repositories import ShareObjectSM, ShareObjectRepository, \
+    ShareItemSM
 from dataall.modules.dataset_sharing.services.share_processors.lf_process_cross_account_share import \
     ProcessLFCrossAccountShare
 from dataall.modules.dataset_sharing.services.share_processors.lf_process_same_account_share import \
@@ -8,11 +11,7 @@
     ProcessS3AccessPointShare
 from dataall.modules.dataset_sharing.services.share_processors.s3_bucket_process_share import ProcessS3BucketShare
 
-from dataall.base.db import Engine
-from dataall.modules.dataset_sharing.db.enums import (ShareObjectActions, ShareItemStatus, ShareableType,
-                                                      ShareItemActions)
-from dataall.modules.dataset_sharing.db.share_object_repositories import ShareObjectSM, ShareObjectRepository, \
-    ShareItemSM
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import (ShareObjectActions, ShareItemStatus, ShareableType)
 
 log = logging.getLogger(__name__)
 

diff --git a/...aall/modules/dataset_sharing/api/enums.py → ...sharing/services/dataset_sharing_enums.py b/...aall/modules/dataset_sharing/api/enums.py → ...sharing/services/dataset_sharing_enums.py
diff --git a/backend/dataall/modules/dataset_sharing/services/share_item_service.py b/backend/dataall/modules/dataset_sharing/services/share_item_service.py
@@ -8,7 +8,7 @@
 from dataall.core.tasks.db.task_models import Task
 from dataall.base.db import utils
 from dataall.base.db.exceptions import ObjectNotFound, UnauthorizedOperation
-from dataall.modules.dataset_sharing.db.enums import ShareObjectActions, ShareableType, ShareItemStatus, \
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareObjectActions, ShareableType, ShareItemStatus, \
     ShareItemActions
 from dataall.modules.dataset_sharing.db.share_object_models import ShareObjectItem
 from dataall.modules.dataset_sharing.db.share_object_repositories import ShareObjectRepository, ShareObjectSM, ShareItemSM

diff --git a/backend/dataall/modules/dataset_sharing/services/share_notification_service.py b/backend/dataall/modules/dataset_sharing/services/share_notification_service.py
@@ -6,7 +6,7 @@
 from dataall.modules.dataset_sharing.db.share_object_models import ShareObject
 from dataall.modules.datasets_base.db.dataset_models import Dataset
 from dataall.base.context import get_context
-from dataall.modules.dataset_sharing.db.enums import ShareObjectStatus
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareObjectStatus
 from dataall.modules.notifications.db.notification_repositories import NotificationRepository
 
 log = logging.getLogger(__name__)
@@ -32,6 +32,7 @@ class ShareNotificationService:
         - dataset.stewards
         - share.owner (person that opened the request) OR share.groupUri (if group_notifications=true)
     """
+
     def __init__(self, session, dataset: Dataset, share: ShareObject):
         self.dataset = dataset
         self.share = share
@@ -139,11 +140,11 @@ def _create_notification_task(self, subject, msg):
                             action='notification.service',
                             targetUri=self.share.shareUri,
                             payload={
-                                'notificationType' : share_notification_config_type,
+                                'notificationType': share_notification_config_type,
                                 'subject': subject,
                                 'message': msg,
-                                'recipientGroupsList' : notification_recipient_groups_list,
-                                'recipientEmailList' : notification_recipient_email_ids
+                                'recipientGroupsList': notification_recipient_groups_list,
+                                'recipientEmailList': notification_recipient_email_ids
                             },
                         )
                         self.session.add(notification_task)

diff --git a/backend/dataall/modules/dataset_sharing/services/share_object_service.py b/backend/dataall/modules/dataset_sharing/services/share_object_service.py
@@ -9,7 +9,7 @@
 from dataall.base.db import utils
 from dataall.base.aws.quicksight import QuicksightClient
 from dataall.base.db.exceptions import UnauthorizedOperation
-from dataall.modules.dataset_sharing.db.enums import ShareObjectActions, ShareableType, ShareItemStatus, \
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareObjectActions, ShareableType, ShareItemStatus, \
     ShareObjectStatus, PrincipalType
 from dataall.modules.dataset_sharing.db.share_object_models import ShareObjectItem, ShareObject
 from dataall.modules.dataset_sharing.db.share_object_repositories import ShareObjectRepository, ShareObjectSM, ShareItemSM

diff --git a/...taall/modules/dataset_sharing/services/share_processors/lf_process_cross_account_share.py b/...taall/modules/dataset_sharing/services/share_processors/lf_process_cross_account_share.py
@@ -1,8 +1,8 @@
 import logging
 
 from dataall.core.environment.db.environment_models import Environment, EnvironmentGroup
-from dataall.modules.dataset_sharing.db.enums import ShareItemStatus, ShareObjectActions, ShareItemActions
-from ..share_managers import LFShareManager
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareItemStatus, ShareObjectActions, ShareItemActions
+from dataall.modules.dataset_sharing.services.share_managers import LFShareManager
 from dataall.modules.dataset_sharing.aws.ram_client import RamClient
 from dataall.modules.datasets_base.db.dataset_models import DatasetTable, Dataset
 from dataall.modules.dataset_sharing.db.share_object_models import ShareObject

diff --git a/...ataall/modules/dataset_sharing/services/share_processors/lf_process_same_account_share.py b/...ataall/modules/dataset_sharing/services/share_processors/lf_process_same_account_share.py
@@ -1,10 +1,10 @@
 import logging
 
 from dataall.core.environment.db.environment_models import Environment, EnvironmentGroup
-from dataall.modules.dataset_sharing.db.enums import ShareItemStatus, ShareObjectActions, ShareItemActions
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareItemStatus, ShareObjectActions, ShareItemActions
 from dataall.modules.dataset_sharing.db.share_object_models import ShareObject
 from dataall.modules.dataset_sharing.db.share_object_repositories import ShareObjectRepository, ShareItemSM
-from ..share_managers import LFShareManager
+from dataall.modules.dataset_sharing.services.share_managers import LFShareManager
 from dataall.modules.datasets_base.db.dataset_models import DatasetTable, Dataset
 
 log = logging.getLogger(__name__)

diff --git a/...ataall/modules/dataset_sharing/services/share_processors/s3_access_point_process_share.py b/...ataall/modules/dataset_sharing/services/share_processors/s3_access_point_process_share.py
@@ -3,7 +3,7 @@
 from dataall.core.environment.db.environment_models import Environment, EnvironmentGroup
 from dataall.modules.dataset_sharing.services.share_managers import S3AccessPointShareManager
 from dataall.modules.datasets_base.db.dataset_models import DatasetStorageLocation, Dataset
-from dataall.modules.dataset_sharing.db.enums import ShareItemStatus, ShareObjectActions, ShareItemActions
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareItemStatus, ShareObjectActions, ShareItemActions
 from dataall.modules.dataset_sharing.db.share_object_models import ShareObject
 from dataall.modules.dataset_sharing.db.share_object_repositories import ShareObjectRepository, ShareItemSM
 

diff --git a/backend/dataall/modules/dataset_sharing/services/share_processors/s3_bucket_process_share.py b/backend/dataall/modules/dataset_sharing/services/share_processors/s3_bucket_process_share.py
@@ -3,7 +3,7 @@
 from dataall.core.environment.db.environment_models import Environment, EnvironmentGroup
 from dataall.modules.dataset_sharing.services.share_managers import S3BucketShareManager
 from dataall.modules.datasets_base.db.dataset_models import Dataset, DatasetBucket
-from dataall.modules.dataset_sharing.db.enums import ShareItemStatus, ShareObjectActions, ShareItemActions
+from dataall.modules.dataset_sharing.services.dataset_sharing_enums import ShareItemStatus, ShareObjectActions, ShareItemActions
 from dataall.modules.dataset_sharing.db.share_object_models import ShareObject
 from dataall.modules.dataset_sharing.db.share_object_repositories import ShareObjectRepository, ShareItemSM
 

diff --git a/backend/dataall/modules/datasets/api/dataset/__init__.py b/backend/dataall/modules/datasets/api/dataset/__init__.py
@@ -3,8 +3,7 @@
     mutations,
     queries,
     resolvers,
-    types,
-    enums
+    types
 )
 
-__all__ = ['resolvers', 'types', 'input_types', 'queries', 'mutations', 'enums']
+__all__ = ['resolvers', 'types', 'input_types', 'queries', 'mutations']
diff --git a/backend/dataall/modules/datasets/api/dataset/input_types.py b/backend/dataall/modules/datasets/api/dataset/input_types.py
@@ -1,6 +1,6 @@
 from dataall.base.api import gql
 from dataall.base.api.constants import SortDirection
-from dataall.modules.datasets.api.dataset.enums import DatasetSortField
+from dataall.modules.datasets_base.services.datasets_base_enums import DatasetSortField
 
 
 NewDatasetInput = gql.InputType(

diff --git a/backend/dataall/modules/datasets/api/dataset/resolvers.py b/backend/dataall/modules/datasets/api/dataset/resolvers.py
@@ -9,7 +9,7 @@
 from dataall.base.db.exceptions import RequiredParameter, InvalidInput
 from dataall.modules.dataset_sharing.db.share_object_models import ShareObject
 from dataall.modules.datasets_base.db.dataset_models import Dataset
-from dataall.modules.datasets.api.dataset.enums import DatasetRole
+from dataall.modules.datasets_base.services.datasets_base_enums import DatasetRole
 from dataall.modules.datasets.services.dataset_service import DatasetService
 
 log = logging.getLogger(__name__)
@@ -60,7 +60,7 @@ def resolve_user_role(context: Context, source: Dataset, **kwargs):
 
 @is_feature_enabled('modules.datasets.features.file_uploads')
 def get_file_upload_presigned_url(
-    context, source, datasetUri: str = None, input: dict = None
+        context, source, datasetUri: str = None, input: dict = None
 ):
     return DatasetService.get_file_upload_presigned_url(uri=datasetUri, data=input)
 
@@ -162,7 +162,7 @@ def get_dataset_stack(context: Context, source: Dataset, **kwargs):
 
 
 def delete_dataset(
-    context: Context, source, datasetUri: str = None, deleteFromAWS: bool = False
+        context: Context, source, datasetUri: str = None, deleteFromAWS: bool = False
 ):
     return DatasetService.delete_dataset(uri=datasetUri, delete_from_aws=deleteFromAWS)
 
@@ -175,15 +175,15 @@ def get_dataset_glossary_terms(context: Context, source: Dataset, **kwargs):
 
 
 def list_datasets_created_in_environment(
-    context: Context, source, environmentUri: str = None, filter: dict = None
+        context: Context, source, environmentUri: str = None, filter: dict = None
 ):
     if not filter:
         filter = {}
     return DatasetService.list_datasets_created_in_environment(uri=environmentUri, data=filter)
 
 
 def list_datasets_owned_by_env_group(
-    context, source, environmentUri: str = None, groupUri: str = None, filter: dict = None
+        context, source, environmentUri: str = None, groupUri: str = None, filter: dict = None
 ):
     if not filter:
         filter = {}

diff --git a/backend/dataall/modules/datasets/api/dataset/types.py b/backend/dataall/modules/datasets/api/dataset/types.py
@@ -1,5 +1,5 @@
 from dataall.base.api import gql
-from dataall.modules.datasets.api.dataset.enums import DatasetRole
+from dataall.modules.datasets_base.services.datasets_base_enums import DatasetRole
 from dataall.modules.datasets.api.dataset.resolvers import (
     get_dataset_environment,
     get_dataset_organization,
@@ -15,7 +15,6 @@
 )
 from dataall.core.environment.api.enums import EnvironmentPermission
 
-
 DatasetStatistics = gql.ObjectType(
     name='DatasetStatistics',
     fields=[
@@ -154,7 +153,6 @@
     ],
 )
 
-
 DatasetSearchResult = gql.ObjectType(
     name='DatasetSearchResult',
     fields=[
@@ -170,7 +168,6 @@
     ],
 )
 
-
 GlueCrawler = gql.ObjectType(
     name='GlueCrawler',
     fields=[

diff --git a/backend/dataall/modules/datasets/api/table/__init__.py b/backend/dataall/modules/datasets/api/table/__init__.py
@@ -4,7 +4,6 @@
     queries,
     resolvers,
     types,
-    enums,
 )
 
-__all__ = ['resolvers', 'types', 'input_types', 'queries', 'mutations', 'enums']
+__all__ = ['resolvers', 'types', 'input_types', 'queries', 'mutations']