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

Skip looker user folder hierarchies #948

Merged
merged 9 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from 4 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
26 changes: 6 additions & 20 deletions metaphor/looker/extractor.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import os
from typing import Collection, Dict, Iterable, Iterator, List, Sequence, Set, Tuple
from typing import Collection, Dict, Iterable, List, Sequence, Set, Tuple

from metaphor.common.git import clone_repo
from metaphor.models.crawler_run_metadata import Platform
Expand Down Expand Up @@ -29,9 +29,6 @@
DashboardPlatform,
EntityUpstream,
Hierarchy,
HierarchyInfo,
HierarchyLogicalID,
HierarchyType,
SourceInfo,
SystemContact,
SystemContacts,
Expand Down Expand Up @@ -81,6 +78,7 @@
self._project_source_url = config.project_source_url
self._include_personal_folders = config.include_personal_folders
self._explore_view_folder_name = config.explore_view_folder_name
self._folders: Dict[str, Hierarchy] = {}

# Load config using environment variables instead from looker.ini file
# See https://github.com/looker-open-source/sdk-codegen#environment-variable-configuration
Expand Down Expand Up @@ -121,7 +119,7 @@
entities: List[ENTITY_TYPES] = []
entities.extend(dashboards)
entities.extend(virtual_views)
entities.extend(self.build_hierarchy(folder_map))
entities.extend(self._folders.values())

Check warning on line 122 in metaphor/looker/extractor.py

View check run for this annotation

Codecov / codecov/patch

metaphor/looker/extractor.py#L122

Added line #L122 was not covered by tests
return entities

def _fetch_folders(self) -> FolderMap:
Expand Down Expand Up @@ -237,7 +235,9 @@
structure=(
AssetStructure(
directories=build_directories(
dashboard.folder.id, folder_map
dashboard.folder.id,
folder_map,
self._folders,
),
name=dashboard.title,
)
Expand Down Expand Up @@ -320,17 +320,3 @@
source_entities=list(explore_ids),
),
)

def build_hierarchy(
self, folder_map: Dict[str, FolderMetadata]
) -> Iterator[Hierarchy]:
for folder in folder_map.values():
yield Hierarchy(
logical_id=HierarchyLogicalID(
path=[DashboardPlatform.LOOKER.value]
+ build_directories(folder.id, folder_map)
),
hierarchy_info=HierarchyInfo(
type=HierarchyType.LOOKER_FOLDER, name=folder.name
),
)
39 changes: 37 additions & 2 deletions metaphor/looker/folder.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
from typing import Dict, List, Optional

from metaphor.common.logger import get_logger
from metaphor.models.metadata_change_event import (
DashboardPlatform,
Hierarchy,
HierarchyInfo,
HierarchyLogicalID,
HierarchyType,
)


@dataclass
Expand All @@ -16,7 +23,11 @@
logger = get_logger()


def build_directories(folder_id: str, folder_map: FolderMap) -> List[str]:
def build_directories(
folder_id: str,
folder_map: FolderMap,
folder_hierarchies: Dict[str, Hierarchy],
) -> List[str]:
directories: List[str] = []

while True:
Expand All @@ -28,6 +39,30 @@
directories.insert(0, folder.id)

if folder.parent_id is None:
return directories
break

folder_id = folder.parent_id

_build_hierarchies(directories, folder_map, folder_hierarchies)

return directories


def _build_hierarchies(
directories: List[str], folder_map: FolderMap, folders: Dict[str, Hierarchy]
elic-eon marked this conversation as resolved.
Show resolved Hide resolved
):
for i, folder_id in enumerate(directories):
folder = folder_map.get(folder_id)
if folder_id in folders or folder is None:
elic-eon marked this conversation as resolved.
Show resolved Hide resolved
continue

Check warning on line 57 in metaphor/looker/folder.py

View check run for this annotation

Codecov / codecov/patch

metaphor/looker/folder.py#L57

Added line #L57 was not covered by tests

hierarchy = Hierarchy(
logical_id=HierarchyLogicalID(
path=[DashboardPlatform.LOOKER.value] + directories[: i + 1]
),
hierarchy_info=HierarchyInfo(
type=HierarchyType.LOOKER_FOLDER, name=folder.name
),
)

folders[folder_id] = hierarchy
elic-eon marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "metaphor-connectors"
version = "0.14.75"
version = "0.14.76"
license = "Apache-2.0"
description = "A collection of Python-based 'connectors' that extract metadata from various sources to ingest into the Metaphor app."
authors = ["Metaphor <[email protected]>"]
Expand Down
31 changes: 27 additions & 4 deletions tests/looker/test_folder.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from metaphor.looker.folder import FolderMetadata, build_directories
from metaphor.looker.folder import FolderMetadata, _build_hierarchies, build_directories


def test_build_directories(test_root_dir) -> None:
Expand All @@ -9,6 +9,29 @@ def test_build_directories(test_root_dir) -> None:
"3": FolderMetadata(id="3", name="folder3", parent_id="2"),
}

assert build_directories("1", folder_map) == ["1"]
assert build_directories("2", folder_map) == ["1", "2"]
assert build_directories("3", folder_map) == ["1", "2", "3"]
folder_hierarchies: dict = {}

assert build_directories("1", folder_map, folder_hierarchies) == ["1"]
assert build_directories("2", folder_map, folder_hierarchies) == ["1", "2"]
assert build_directories("3", folder_map, folder_hierarchies) == ["1", "2", "3"]
assert len(folder_hierarchies) == 3


def test_build_hierarchy(test_root_dir) -> None:

folder_map = {
"1": FolderMetadata(id="1", name="folder1", parent_id=None),
"2": FolderMetadata(id="2", name="folder2", parent_id="1"),
"3": FolderMetadata(id="3", name="folder3", parent_id="2"),
}

folders: dict = {}

_build_hierarchies(["1", "2", "3"], folder_map, folders)
assert len(folders) == 3
assert folders["1"].hierarchy_info.name == "folder1"
assert folders["1"].logical_id.path == ["LOOKER", "1"]
assert folders["2"].hierarchy_info.name == "folder2"
assert folders["2"].logical_id.path == ["LOOKER", "1", "2"]
assert folders["3"].hierarchy_info.name == "folder3"
assert folders["3"].logical_id.path == ["LOOKER", "1", "2", "3"]
Loading