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.

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

refactor(ingest): add ALL_ENV_TYPES constant #5866

Merged
merged 1 commit into from
Sep 8, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 9 additions & 10 deletions metadata-ingestion/src/datahub/configuration/source_common.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from typing import Dict, Optional
from typing import Dict, Optional, Set

from pydantic import validator
from pydantic.fields import Field
Expand All @@ -8,6 +8,11 @@

DEFAULT_ENV = FabricTypeClass.PROD

# Get all the constants from the FabricTypeClass. It's not an enum, so this is a bit hacky but works.
ALL_ENV_TYPES: Set[str] = set(
[value for name, value in vars(FabricTypeClass).items() if not name.startswith("_")]
)


class PlatformSourceConfigBase(ConfigModel):
"""
Expand All @@ -30,20 +35,14 @@ class EnvBasedSourceConfigBase(ConfigModel):
"""

env: str = Field(
default=FabricTypeClass.PROD,
default=DEFAULT_ENV,
description="The environment that all assets produced by this connector belong to",
)

@validator("env")
def env_must_be_one_of(cls, v: str) -> str:
# Get all the constants from the FabricTypeClass. It's not an enum, so this is a bit hacky but works
allowed_envs = [
value
for name, value in vars(FabricTypeClass).items()
if not name.startswith("_")
]
if (v.upper()) not in allowed_envs:
raise ConfigurationError(f"env must be one of {allowed_envs}, found {v}")
if v.upper() not in ALL_ENV_TYPES:
raise ConfigurationError(f"env must be one of {ALL_ENV_TYPES}, found {v}")
return v.upper()


Expand Down
17 changes: 4 additions & 13 deletions metadata-ingestion/src/datahub/utilities/urns/data_flow_urn.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from typing import List, Set
from typing import List

from datahub.metadata.schema_classes import FabricTypeClass
from datahub.configuration.source_common import ALL_ENV_TYPES
from datahub.utilities.urns.error import InvalidUrnError
from datahub.utilities.urns.urn import Urn

Expand All @@ -12,13 +12,6 @@ class DataFlowUrn(Urn):
"""

ENTITY_TYPE: str = "dataFlow"
VALID_FABRIC_SET: Set[str] = set(
[
str(getattr(FabricTypeClass, attr)).upper()
for attr in dir(FabricTypeClass)
if not callable(getattr(FabricTypeClass, attr)) and not attr.startswith("_")
]
)

def __init__(
self, entity_type: str, entity_id: List[str], domain: str = Urn.LI_DOMAIN
Expand Down Expand Up @@ -81,7 +74,5 @@ def _validate_entity_id(entity_id: List[str]) -> None:
)

env = entity_id[2].upper()
if env not in DataFlowUrn.VALID_FABRIC_SET:
raise InvalidUrnError(
f"Invalid env:{env}. Allowed evn are {DataFlowUrn.VALID_FABRIC_SET}"
)
if env not in ALL_ENV_TYPES:
raise InvalidUrnError(f"Invalid env:{env}. Allowed evn are {ALL_ENV_TYPES}")
17 changes: 4 additions & 13 deletions metadata-ingestion/src/datahub/utilities/urns/dataset_urn.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from typing import List, Optional, Set
from typing import List, Optional

from datahub.metadata.schema_classes import FabricTypeClass
from datahub.configuration.source_common import ALL_ENV_TYPES
from datahub.utilities.urns.data_platform_urn import DataPlatformUrn
from datahub.utilities.urns.error import InvalidUrnError
from datahub.utilities.urns.urn import Urn
Expand All @@ -13,13 +13,6 @@ class DatasetUrn(Urn):
"""

ENTITY_TYPE: str = "dataset"
VALID_FABRIC_SET: Set[str] = set(
[
str(getattr(FabricTypeClass, attr)).upper()
for attr in dir(FabricTypeClass)
if not callable(getattr(FabricTypeClass, attr)) and not attr.startswith("_")
]
)

def __init__(self, entity_type: str, entity_id: List[str], domain: str = "li"):
super().__init__(entity_type, entity_id, domain)
Expand Down Expand Up @@ -95,10 +88,8 @@ def _validate_entity_id(entity_id: List[str]) -> None:

DataPlatformUrn.validate(platform_urn_str)
env = entity_id[2].upper()
if env not in DatasetUrn.VALID_FABRIC_SET:
raise InvalidUrnError(
f"Invalid env:{env}. Allowed evn are {DatasetUrn.VALID_FABRIC_SET}"
)
if env not in ALL_ENV_TYPES:
raise InvalidUrnError(f"Invalid env:{env}. Allowed evn are {ALL_ENV_TYPES}")

"""A helper function to extract simple . path notation from the v2 field path"""

Expand Down