Skip to content

NAS-3996 declarative workspaceDataFilters implementation #110

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.

Sign up for GitHub

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

Merged
2 commits merged into from
Jun 20, 2022
Merged

NAS-3996 declarative workspaceDataFilters implementation #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b97bfb3
NAS-3996 control implementation
hkad98 Jun 20, 2022
5a5a0de
NAS-3996 test support
hkad98 Jun 20, 2022
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
1 change: 1 addition & 0 deletions gooddata-sdk/gooddata_sdk/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
from gooddata_sdk.catalog.entity import BasicCredentials, TokenCredentialsFromFile
from gooddata_sdk.catalog.organization.service import CatalogOrganizationService
from gooddata_sdk.catalog.workspace.declarative_model.workspace.workspace import (
CatalogDeclarativeWorkspaceDataFilters,
CatalogDeclarativeWorkspaceModel,
CatalogDeclarativeWorkspaces,
)
Expand Down
28 changes: 28 additions & 0 deletions gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/workspace.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
from gooddata_metadata_client.model.declarative_workspace_data_filter_setting import (
DeclarativeWorkspaceDataFilterSetting,
)
from gooddata_metadata_client.model.declarative_workspace_data_filters import DeclarativeWorkspaceDataFilters
from gooddata_metadata_client.model.declarative_workspace_model import DeclarativeWorkspaceModel
from gooddata_metadata_client.model.declarative_workspaces import DeclarativeWorkspaces
from gooddata_sdk.catalog.base import Base
Expand Down Expand Up @@ -107,6 +108,33 @@ def client_class() -> Type[DeclarativeWorkspaceDataFilterSetting]:
return DeclarativeWorkspaceDataFilterSetting


@attr.s(auto_attribs=True, kw_only=True)
class CatalogDeclarativeWorkspaceDataFilters(Base):
workspace_data_filters: List[CatalogDeclarativeWorkspaceDataFilter]

@staticmethod
def client_class() -> Type[DeclarativeWorkspaceDataFilters]:
return DeclarativeWorkspaceDataFilters

def store_to_disk(self, layout_organization_folder: Path) -> None:
for workspace_data_filter in self.workspace_data_filters:
workspace_data_filter.store_to_disk(
CatalogDeclarativeWorkspaces.workspace_data_filters_folder(layout_organization_folder)
)

@classmethod
def load_from_disk(cls, layout_organization_folder: Path) -> CatalogDeclarativeWorkspaceDataFilters:
workspace_data_filters_files = get_sorted_yaml_files(
CatalogDeclarativeWorkspaces.workspace_data_filters_folder(layout_organization_folder)
)
workspace_data_filters = []
for workspace_data_filters_file in workspace_data_filters_files:
workspace_data_filters.append(
CatalogDeclarativeWorkspaceDataFilter.load_from_disk(workspace_data_filters_file)
)
return cls(workspace_data_filters=workspace_data_filters)


@attr.s(auto_attribs=True, kw_only=True)
class CatalogDeclarativeWorkspaceDataFilter(Base):
id: str
Expand Down
25 changes: 25 additions & 0 deletions gooddata-sdk/gooddata_sdk/catalog/workspace/service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
from gooddata_sdk.catalog.workspace.declarative_model.workspace.logical_model.ldm import CatalogDeclarativeModel
from gooddata_sdk.catalog.workspace.declarative_model.workspace.workspace import (
LAYOUT_WORKSPACES_DIR,
CatalogDeclarativeWorkspaceDataFilters,
CatalogDeclarativeWorkspaceModel,
CatalogDeclarativeWorkspaces,
)
Expand Down Expand Up @@ -119,6 +120,30 @@ def load_and_put_declarative_workspaces(self, layout_root_path: Path = Path.cwd(
declarative_workspaces = self.load_declarative_workspaces(layout_root_path)
self.put_declarative_workspaces(declarative_workspaces)

def get_declarative_workspace_data_filters(self) -> CatalogDeclarativeWorkspaceDataFilters:
return CatalogDeclarativeWorkspaceDataFilters.from_api(self._layout_api.get_workspace_data_filters_layout())

def put_declarative_workspace_data_filters(
self, workspace_data_filters: CatalogDeclarativeWorkspaceDataFilters
) -> None:
self._layout_api.set_workspace_data_filters_layout(
declarative_workspace_data_filters=workspace_data_filters.to_api()
)

def store_declarative_workspace_data_filters(self, layout_root_path: Path = Path.cwd()) -> None:
self.get_declarative_workspace_data_filters().store_to_disk(self.layout_organization_folder(layout_root_path))

def load_declarative_workspace_data_filters(
self, layout_root_path: Path = Path.cwd()
) -> CatalogDeclarativeWorkspaceDataFilters:
return CatalogDeclarativeWorkspaceDataFilters.load_from_disk(self.layout_organization_folder(layout_root_path))

def load_and_put_declarative_workspace_data_filters(self, layout_root_path: Path = Path.cwd()) -> None:
declarative_workspace_data_filters = CatalogDeclarativeWorkspaceDataFilters.load_from_disk(
self.layout_organization_folder(layout_root_path)
)
self.put_declarative_workspace_data_filters(declarative_workspace_data_filters)


class CatalogWorkspaceContentService(CatalogServiceBase):
# Note on the disabled checking:
Expand Down
48 changes: 48 additions & 0 deletions gooddata-sdk/tests/catalog/expected/declarative_workspace_data_filters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
{
"workspaceDataFilters": [
{
"columnName": "wdf__region",
"id": "wdf__region",
"title": "Customer region",
"workspace": {
"id": "demo",
"type": "workspace"
},
"workspaceDataFilterSettings": [
{
"filterValues": [
"West"
],
"id": "region_west",
"title": "Region West",
"workspace": {
"id": "demo_west",
"type": "workspace"
}
}
]
},
{
"columnName": "wdf__state",
"id": "wdf__state",
"title": "Customer state",
"workspace": {
"id": "demo_west",
"type": "workspace"
},
"workspaceDataFilterSettings": [
{
"filterValues": [
"California"
],
"id": "region_west_california",
"title": "Region West California",
"workspace": {
"id": "demo_west_california",
"type": "workspace"
}
}
]
}
]
}
181 changes: 181 additions & 0 deletions ...ta-sdk/tests/catalog/fixtures/workspaces/demo_get_declarative_workspace_data_filters.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,181 @@
{
"version": 1,
"interactions": [
{
"request": {
"method": "GET",
"uri": "http://localhost:3000/api/v1/layout/workspaceDataFilters",
"body": null,
"headers": {
"Accept": [
"application/json"
],
"X-Requested-With": [
"XMLHttpRequest"
],
"X-GDC-VALIDATE-RELATIONS": [
"true"
]
}
},
"response": {
"status": {
"code": 200,
"message": ""
},
"headers": {
"Access-Control-Allow-Credentials": [
"true"
],
"Access-Control-Expose-Headers": [
"Content-Disposition, Content-Length, Content-Range, Set-Cookie"
],
"Set-Cookie": [
"SPRING_SEC_SECURITY_CONTEXT=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly"
],
"Permission-Policy": [
"geolocation 'none'; midi 'none'; sync-xhr 'none'; microphone 'none'; camera 'none'; magnetometer 'none'; gyroscope 'none'; fullscreen 'none'; payment 'none';"
],
"X-XSS-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Transfer-Encoding": [
"chunked"
],
"Date": [
"Mon, 20 Jun 2022 08:37:43 GMT"
],
"X-Content-Type-Options": [
"nosniff"
],
"Content-Type": [
"application/json"
],
"Pragma": [
"no-cache"
],
"X-Frame-Options": [
"DENY"
],
"Expires": [
"0"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"X-GDC-TRACE-ID": [
"ad55be2500fa39d0"
],
"GoodData-Deployment": [
"aio"
],
"Content-Security-Policy": [
"default-src 'self' *.wistia.com *.wistia.net; script-src 'self' 'unsafe-inline' 'unsafe-eval' *.wistia.com *.wistia.net src.litix.io matomo.anywhere.gooddata.com code.jquery.com unpkg.com cdn.jsdelivr.net cdnjs.cloudflare.com; img-src 'self' data: blob: *.wistia.com *.wistia.net embedwistia-a.akamaihd.net privacy-policy.truste.com www.gooddata.com; style-src 'self' 'unsafe-inline' fonts.googleapis.com cdn.jsdelivr.net fast.fonts.net; font-src 'self' data: fonts.gstatic.com *.alicdn.com *.wistia.com cdn.jsdelivr.net info.gooddata.com; frame-src 'self'; object-src 'none'; worker-src 'self' blob:; child-src blob:; connect-src 'self' *.tiles.mapbox.com *.mapbox.com *.litix.io *.wistia.com embedwistia-a.akamaihd.net matomo.anywhere.gooddata.com; media-src 'self' blob: data: *.wistia.com *.wistia.net embedwistia-a.akamaihd.net"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"Server": [
"nginx"
]
},
"body": {
"string": "{\"workspaceDataFilters\":[{\"columnName\":\"wdf__region\",\"id\":\"wdf__region\",\"title\":\"Customer region\",\"workspace\":{\"id\":\"demo\",\"type\":\"workspace\"},\"workspaceDataFilterSettings\":[{\"filterValues\":[\"West\"],\"id\":\"region_west\",\"title\":\"Region West\",\"workspace\":{\"id\":\"demo_west\",\"type\":\"workspace\"}}]},{\"columnName\":\"wdf__state\",\"id\":\"wdf__state\",\"title\":\"Customer state\",\"workspace\":{\"id\":\"demo_west\",\"type\":\"workspace\"},\"workspaceDataFilterSettings\":[{\"filterValues\":[\"California\"],\"id\":\"region_west_california\",\"title\":\"Region West California\",\"workspace\":{\"id\":\"demo_west_california\",\"type\":\"workspace\"}}]}]}"
}
}
},
{
"request": {
"method": "GET",
"uri": "http://localhost:3000/api/v1/layout/workspaceDataFilters",
"body": null,
"headers": {
"Accept": [
"application/json"
],
"X-Requested-With": [
"XMLHttpRequest"
],
"X-GDC-VALIDATE-RELATIONS": [
"true"
]
}
},
"response": {
"status": {
"code": 200,
"message": ""
},
"headers": {
"Access-Control-Allow-Credentials": [
"true"
],
"Access-Control-Expose-Headers": [
"Content-Disposition, Content-Length, Content-Range, Set-Cookie"
],
"Set-Cookie": [
"SPRING_SEC_SECURITY_CONTEXT=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly"
],
"Permission-Policy": [
"geolocation 'none'; midi 'none'; sync-xhr 'none'; microphone 'none'; camera 'none'; magnetometer 'none'; gyroscope 'none'; fullscreen 'none'; payment 'none';"
],
"X-XSS-Protection": [
"1; mode=block"
],
"Connection": [
"keep-alive"
],
"Transfer-Encoding": [
"chunked"
],
"Date": [
"Mon, 20 Jun 2022 08:37:43 GMT"
],
"X-Content-Type-Options": [
"nosniff"
],
"Content-Type": [
"application/json"
],
"Pragma": [
"no-cache"
],
"X-Frame-Options": [
"DENY"
],
"Expires": [
"0"
],
"Vary": [
"Origin",
"Access-Control-Request-Method",
"Access-Control-Request-Headers"
],
"X-GDC-TRACE-ID": [
"fbe666d07a0518bf"
],
"GoodData-Deployment": [
"aio"
],
"Content-Security-Policy": [
"default-src 'self' *.wistia.com *.wistia.net; script-src 'self' 'unsafe-inline' 'unsafe-eval' *.wistia.com *.wistia.net src.litix.io matomo.anywhere.gooddata.com code.jquery.com unpkg.com cdn.jsdelivr.net cdnjs.cloudflare.com; img-src 'self' data: blob: *.wistia.com *.wistia.net embedwistia-a.akamaihd.net privacy-policy.truste.com www.gooddata.com; style-src 'self' 'unsafe-inline' fonts.googleapis.com cdn.jsdelivr.net fast.fonts.net; font-src 'self' data: fonts.gstatic.com *.alicdn.com *.wistia.com cdn.jsdelivr.net info.gooddata.com; frame-src 'self'; object-src 'none'; worker-src 'self' blob:; child-src blob:; connect-src 'self' *.tiles.mapbox.com *.mapbox.com *.litix.io *.wistia.com embedwistia-a.akamaihd.net matomo.anywhere.gooddata.com; media-src 'self' blob: data: *.wistia.com *.wistia.net embedwistia-a.akamaihd.net"
],
"Cache-Control": [
"no-cache, no-store, max-age=0, must-revalidate"
],
"Server": [
"nginx"
]
},
"body": {
"string": "{\"workspaceDataFilters\":[{\"columnName\":\"wdf__region\",\"id\":\"wdf__region\",\"title\":\"Customer region\",\"workspace\":{\"id\":\"demo\",\"type\":\"workspace\"},\"workspaceDataFilterSettings\":[{\"filterValues\":[\"West\"],\"id\":\"region_west\",\"title\":\"Region West\",\"workspace\":{\"id\":\"demo_west\",\"type\":\"workspace\"}}]},{\"columnName\":\"wdf__state\",\"id\":\"wdf__state\",\"title\":\"Customer state\",\"workspace\":{\"id\":\"demo_west\",\"type\":\"workspace\"},\"workspaceDataFilterSettings\":[{\"filterValues\":[\"California\"],\"id\":\"region_west_california\",\"title\":\"Region West California\",\"workspace\":{\"id\":\"demo_west_california\",\"type\":\"workspace\"}}]}]}"
}
}
}
]
}
Loading