NAS-3893 add permission service

gooddata-sdk/gooddata_sdk/__init__.py

@@ -25,6 +25,7 @@
 from gooddata_sdk.catalog.data_source.validation.data_source import DataSourceValidator
 from gooddata_sdk.catalog.entity import BasicCredentials, TokenCredentialsFromFile
 from gooddata_sdk.catalog.organization.service import CatalogOrganizationService
+from gooddata_sdk.catalog.permissions.declarative_model.permission import CatalogDeclarativeWorkspacePermissions
 from gooddata_sdk.catalog.workspace.declarative_model.workspace.workspace import (
     CatalogDeclarativeWorkspaceDataFilters,
     CatalogDeclarativeWorkspaceModel,

gooddata-sdk/gooddata_sdk/catalog/base.py

@@ -9,6 +9,16 @@
 T = TypeVar("T", bound="Base")
 
 
+def value_in_allowed(instance: Type[Base], attribute: attr.Attribute, value: str) -> None:
+    client_class = instance.client_class()
+    allowed_values = client_class.allowed_values.get((attribute.name,))
+    if allowed_values is not None and value not in list(allowed_values.values()):
+        raise ValueError(
+            f"Allowed values for attribute {attribute.name} are: {', '.join(list(allowed_values.values()))}. "
+            f"But value {value} was passed."
+        )
+
+
 @attr.s
 class Base:
     @classmethod

gooddata-sdk/gooddata_sdk/catalog/data_source/declarative_model/data_source.py

@@ -12,7 +12,7 @@
 from gooddata_sdk.catalog.base import Base
 from gooddata_sdk.catalog.data_source.declarative_model.physical_model.pdm import CatalogDeclarativeTables
 from gooddata_sdk.catalog.entity import TokenCredentialsFromFile
-from gooddata_sdk.catalog.permissions.permission import CatalogDeclarativeDataSourcePermission
+from gooddata_sdk.catalog.permissions.declarative_model.permission import CatalogDeclarativeDataSourcePermission
 from gooddata_sdk.utils import create_directory, read_layout_from_file, write_layout_to_file
 
 BIGQUERY_TYPE = "BIGQUERY"

gooddata-sdk/gooddata_sdk/catalog/identifier.py

@@ -11,7 +11,7 @@
 from gooddata_metadata_client.model.reference_identifier import ReferenceIdentifier
 from gooddata_metadata_client.model.user_group_identifier import UserGroupIdentifier
 from gooddata_metadata_client.model.workspace_identifier import WorkspaceIdentifier
-from gooddata_sdk.catalog.base import Base
+from gooddata_sdk.catalog.base import Base, value_in_allowed
 
 
 @attr.s(auto_attribs=True, kw_only=True)
@@ -35,7 +35,7 @@ def client_class() -> Type[ReferenceIdentifier]:
 @attr.s(auto_attribs=True, kw_only=True)
 class CatalogGrainIdentifier(Base):
     id: str
-    type: str
+    type: str = attr.field(validator=value_in_allowed)
 
     @staticmethod
     def client_class() -> Type[GrainIdentifier]:
@@ -45,7 +45,7 @@ def client_class() -> Type[GrainIdentifier]:
 @attr.s(auto_attribs=True, kw_only=True)
 class CatalogAssigneeIdentifier(Base):
     id: str
-    type: str
+    type: str = attr.field(validator=value_in_allowed)
 
     @staticmethod
     def client_class() -> Type[AssigneeIdentifier]:
@@ -55,7 +55,7 @@ def client_class() -> Type[AssigneeIdentifier]:
 @attr.s(auto_attribs=True, kw_only=True)
 class CatalogUserGroupIdentifier(Base):
     id: str
-    type: str = "userGroup"
+    type: str = attr.field(validator=value_in_allowed)
 
     @staticmethod
     def client_class() -> Type[UserGroupIdentifier]:
@@ -65,7 +65,7 @@ def client_class() -> Type[UserGroupIdentifier]:
 @attr.s(auto_attribs=True, kw_only=True)
 class CatalogLabelIdentifier(Base):
     id: str
-    type: str = "label"
+    type: str = attr.field(validator=value_in_allowed)
 
     @staticmethod
     def client_class() -> Type[LabelIdentifier]:

gooddata-sdk/gooddata_sdk/catalog/permissions/declarative_model/__init__.py

@@ -0,0 +1 @@
+# (C) 2022 GoodData Corporation

gooddata-sdk/gooddata_sdk/catalog/permissions/permission.py → gooddata-sdk/gooddata_sdk/catalog/permissions/declarative_model/permission.py

@@ -11,13 +11,13 @@
     DeclarativeWorkspaceHierarchyPermission,
 )
 from gooddata_metadata_client.model.declarative_workspace_permissions import DeclarativeWorkspacePermissions
-from gooddata_sdk.catalog.base import Base
+from gooddata_sdk.catalog.base import Base, value_in_allowed
 from gooddata_sdk.catalog.identifier import CatalogAssigneeIdentifier
 
 
 @attr.s(auto_attribs=True, kw_only=True)
 class CatalogDeclarativeSingleWorkspacePermission(Base):
-    name: str
+    name: str = attr.field(validator=value_in_allowed)
     assignee: CatalogAssigneeIdentifier
 
     @staticmethod
@@ -27,7 +27,7 @@ def client_class() -> Type[DeclarativeSingleWorkspacePermission]:
 
 @attr.s(auto_attribs=True, kw_only=True)
 class CatalogDeclarativeWorkspaceHierarchyPermission(Base):
-    name: str
+    name: str = attr.field(validator=value_in_allowed)
     assignee: CatalogAssigneeIdentifier
 
     @staticmethod
@@ -37,7 +37,7 @@ def client_class() -> Type[DeclarativeWorkspaceHierarchyPermission]:
 
 @attr.s(auto_attribs=True, kw_only=True)
 class CatalogDeclarativeDataSourcePermission(Base):
-    name: str
+    name: str = attr.field(validator=value_in_allowed)
     assignee: CatalogAssigneeIdentifier
 
     @staticmethod

gooddata-sdk/gooddata_sdk/catalog/permissions/service.py

@@ -0,0 +1,19 @@
+# (C) 2022 GoodData Corporation
+from gooddata_sdk import GoodDataApiClient
+from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase
+from gooddata_sdk.catalog.permissions.declarative_model.permission import CatalogDeclarativeWorkspacePermissions
+
+
+class CatalogPermissionService(CatalogServiceBase):
+    def __init__(self, api_client: GoodDataApiClient) -> None:
+        super(CatalogPermissionService, self).__init__(api_client)
+
+    def get_declarative_permissions(self, workspace_id: str) -> CatalogDeclarativeWorkspacePermissions:
+        return CatalogDeclarativeWorkspacePermissions.from_api(self._layout_api.get_workspace_permissions(workspace_id))
+
+    def set_declarative_permissions(
+        self, workspace_id: str, declarative_workspace_permissions: CatalogDeclarativeWorkspacePermissions
+    ) -> None:
+        self._layout_api.set_workspace_permissions(
+            workspace_id=workspace_id, declarative_workspace_permissions=declarative_workspace_permissions.to_api()
+        )

gooddata-sdk/gooddata_sdk/catalog/workspace/declarative_model/workspace/workspace.py

@@ -16,7 +16,7 @@
 from gooddata_metadata_client.model.declarative_workspaces import DeclarativeWorkspaces
 from gooddata_sdk.catalog.base import Base
 from gooddata_sdk.catalog.identifier import CatalogWorkspaceIdentifier
-from gooddata_sdk.catalog.permissions.permission import (
+from gooddata_sdk.catalog.permissions.declarative_model.permission import (
     CatalogDeclarativeSingleWorkspacePermission,
     CatalogDeclarativeWorkspaceHierarchyPermission,
 )

gooddata-sdk/gooddata_sdk/sdk.py

@@ -5,6 +5,7 @@
 
 from gooddata_sdk.catalog.data_source.service import CatalogDataSourceService
 from gooddata_sdk.catalog.organization.service import CatalogOrganizationService
+from gooddata_sdk.catalog.permissions.service import CatalogPermissionService
 from gooddata_sdk.catalog.user.service import CatalogUserService
 from gooddata_sdk.catalog.workspace.service import CatalogWorkspaceContentService, CatalogWorkspaceService
 from gooddata_sdk.client import GoodDataApiClient
@@ -53,6 +54,7 @@ def __init__(self, client: GoodDataApiClient) -> None:
         self._insights = InsightService(self._client)
         self._tables = TableService(self._client)
         self._support = SupportService(self._client)
+        self._catalog_permission = CatalogPermissionService(self._client)
 
     @property
     def catalog_workspace(self) -> CatalogWorkspaceService:
@@ -89,3 +91,7 @@ def support(self) -> SupportService:
     @property
     def catalog_user(self) -> CatalogUserService:
         return self._catalog_user
+
+    @property
+    def catalog_permission(self) -> CatalogPermissionService:
+        return self._catalog_permission

gooddata-sdk/tests/catalog/expected/declarative_workspace_permissions.json

@@ -0,0 +1,34 @@
+{
+  "hierarchyPermissions": [
+    {
+      "assignee": {
+        "id": "demo2",
+        "type": "user"
+      },
+      "name": "MANAGE"
+    },
+    {
+      "assignee": {
+        "id": "demoGroup",
+        "type": "userGroup"
+      },
+      "name": "ANALYZE"
+    }
+  ],
+  "permissions": [
+    {
+      "assignee": {
+        "id": "demo2",
+        "type": "user"
+      },
+      "name": "ANALYZE"
+    },
+    {
+      "assignee": {
+        "id": "demoGroup",
+        "type": "userGroup"
+      },
+      "name": "VIEW"
+    }
+  ]
+}

gooddata-sdk/tests/catalog/fixtures/permissions/get_declarative_permissions.json

@@ -0,0 +1,181 @@
+{
+    "version": 1,
+    "interactions": [
+        {
+            "request": {
+                "method": "GET",
+                "uri": "http://localhost:3000/api/v1/layout/workspaces/demo/permissions",
+                "body": null,
+                "headers": {
+                    "Accept": [
+                        "application/json"
+                    ],
+                    "X-Requested-With": [
+                        "XMLHttpRequest"
+                    ],
+                    "X-GDC-VALIDATE-RELATIONS": [
+                        "true"
+                    ]
+                }
+            },
+            "response": {
+                "status": {
+                    "code": 200,
+                    "message": ""
+                },
+                "headers": {
+                    "GoodData-Deployment": [
+                        "aio"
+                    ],
+                    "Cache-Control": [
+                        "no-cache, no-store, max-age=0, must-revalidate"
+                    ],
+                    "Set-Cookie": [
+                        "SPRING_SEC_SECURITY_CONTEXT=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly"
+                    ],
+                    "Connection": [
+                        "keep-alive"
+                    ],
+                    "Permission-Policy": [
+                        "geolocation 'none'; midi 'none'; sync-xhr 'none'; microphone 'none'; camera 'none'; magnetometer 'none'; gyroscope 'none'; fullscreen 'none'; payment 'none';"
+                    ],
+                    "Transfer-Encoding": [
+                        "chunked"
+                    ],
+                    "X-Content-Type-Options": [
+                        "nosniff"
+                    ],
+                    "X-GDC-TRACE-ID": [
+                        "7966d5896dd4991b"
+                    ],
+                    "Pragma": [
+                        "no-cache"
+                    ],
+                    "X-Frame-Options": [
+                        "DENY"
+                    ],
+                    "Content-Type": [
+                        "application/json"
+                    ],
+                    "Expires": [
+                        "0"
+                    ],
+                    "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"
+                    ],
+                    "X-XSS-Protection": [
+                        "1; mode=block"
+                    ],
+                    "Date": [
+                        "Tue, 21 Jun 2022 08:40:13 GMT"
+                    ],
+                    "Server": [
+                        "nginx"
+                    ],
+                    "Access-Control-Allow-Credentials": [
+                        "true"
+                    ],
+                    "Access-Control-Expose-Headers": [
+                        "Content-Disposition, Content-Length, Content-Range, Set-Cookie"
+                    ],
+                    "Vary": [
+                        "Origin",
+                        "Access-Control-Request-Method",
+                        "Access-Control-Request-Headers"
+                    ]
+                },
+                "body": {
+                    "string": "{\"hierarchyPermissions\":[{\"assignee\":{\"id\":\"demo2\",\"type\":\"user\"},\"name\":\"MANAGE\"},{\"assignee\":{\"id\":\"demoGroup\",\"type\":\"userGroup\"},\"name\":\"ANALYZE\"}],\"permissions\":[{\"assignee\":{\"id\":\"demo2\",\"type\":\"user\"},\"name\":\"ANALYZE\"},{\"assignee\":{\"id\":\"demoGroup\",\"type\":\"userGroup\"},\"name\":\"VIEW\"}]}"
+                }
+            }
+        },
+        {
+            "request": {
+                "method": "GET",
+                "uri": "http://localhost:3000/api/v1/layout/workspaces/demo/permissions",
+                "body": null,
+                "headers": {
+                    "Accept": [
+                        "application/json"
+                    ],
+                    "X-Requested-With": [
+                        "XMLHttpRequest"
+                    ],
+                    "X-GDC-VALIDATE-RELATIONS": [
+                        "true"
+                    ]
+                }
+            },
+            "response": {
+                "status": {
+                    "code": 200,
+                    "message": ""
+                },
+                "headers": {
+                    "GoodData-Deployment": [
+                        "aio"
+                    ],
+                    "Cache-Control": [
+                        "no-cache, no-store, max-age=0, must-revalidate"
+                    ],
+                    "Set-Cookie": [
+                        "SPRING_SEC_SECURITY_CONTEXT=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly"
+                    ],
+                    "Connection": [
+                        "keep-alive"
+                    ],
+                    "Permission-Policy": [
+                        "geolocation 'none'; midi 'none'; sync-xhr 'none'; microphone 'none'; camera 'none'; magnetometer 'none'; gyroscope 'none'; fullscreen 'none'; payment 'none';"
+                    ],
+                    "Transfer-Encoding": [
+                        "chunked"
+                    ],
+                    "X-Content-Type-Options": [
+                        "nosniff"
+                    ],
+                    "X-GDC-TRACE-ID": [
+                        "32301a35f61f6c8d"
+                    ],
+                    "Pragma": [
+                        "no-cache"
+                    ],
+                    "X-Frame-Options": [
+                        "DENY"
+                    ],
+                    "Content-Type": [
+                        "application/json"
+                    ],
+                    "Expires": [
+                        "0"
+                    ],
+                    "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"
+                    ],
+                    "X-XSS-Protection": [
+                        "1; mode=block"
+                    ],
+                    "Date": [
+                        "Tue, 21 Jun 2022 08:40:13 GMT"
+                    ],
+                    "Server": [
+                        "nginx"
+                    ],
+                    "Access-Control-Allow-Credentials": [
+                        "true"
+                    ],
+                    "Access-Control-Expose-Headers": [
+                        "Content-Disposition, Content-Length, Content-Range, Set-Cookie"
+                    ],
+                    "Vary": [
+                        "Origin",
+                        "Access-Control-Request-Method",
+                        "Access-Control-Request-Headers"
+                    ]
+                },
+                "body": {
+                    "string": "{\"hierarchyPermissions\":[{\"assignee\":{\"id\":\"demo2\",\"type\":\"user\"},\"name\":\"MANAGE\"},{\"assignee\":{\"id\":\"demoGroup\",\"type\":\"userGroup\"},\"name\":\"ANALYZE\"}],\"permissions\":[{\"assignee\":{\"id\":\"demo2\",\"type\":\"user\"},\"name\":\"ANALYZE\"},{\"assignee\":{\"id\":\"demoGroup\",\"type\":\"userGroup\"},\"name\":\"VIEW\"}]}"
+                }
+            }
+        }
+    ]
+}