development-framework-cli 1.7.3__py3-none-any.whl

dm_cli/command_group/entities.py

@@ -0,0 +1,116 @@
+import json
+from pathlib import Path
+
+import typer
+from rich import print
+from tenacity import (
+    retry,
+    retry_if_not_exception_type,
+    stop_after_attempt,
+    wait_random_exponential,
+)
+from typing_extensions import Annotated
+
+from dm_cli.dmss import ApplicationException, console, dmss_api, dmss_exception_wrapper
+from dm_cli.dmss_api import ApiException
+from dm_cli.import_entity import import_folder_entity, import_single_entity
+from dm_cli.utils.utils import destination_is_root
+
+entities_app = typer.Typer(help="Import, delete, or validate entities and/or blueprints")
+
+
+@entities_app.command("import")
+def import_entity(
+    source: Annotated[
+        str,
+        typer.Argument(
+            help="Path to file or folder on local filesystem to import. Trailing '/' will result in the content being imported instead of the folder itself."
+        ),
+    ],
+    destination: Annotated[
+        str,
+        typer.Argument(
+            help="Address for the folder or file. Should be on the format <DataSource>/<rootPackage>/<subPackage>/<entity>"
+        ),
+    ],
+    validate: Annotated[bool, typer.Option(help="if True, all entities uploaded will be validated.")] = True,
+) -> bool:
+    """
+    Import an entity (file or package) <source> to the given <destination>.
+    """
+    source_path = Path(source)
+    destination = destination.rstrip("/\\")
+    # Not replacing a package, but appending to. Can therefore not use "fast mode"
+    fast = destination_is_root(Path(destination))
+
+    def inner_import():
+        if source_path.is_dir():
+            # If source path ends with "/" or windows "\", import content instead of the package itself
+            if source[-1] in ("/", "\\"):
+                print(f"Importing all content from '{source}*' --> '{destination}'")
+                for file in source_path.iterdir():
+                    if file.is_file():
+                        import_single_entity(file, destination, validate)
+                        continue
+                    import_folder_entity(file, destination, fast)
+                    if validate:
+                        print(f"Validating entities in: {destination}/{file.name}")
+                        dmss_api.validate_existing_entity(f"{destination}/{file.name}")
+                return True
+            print(f"Importing PACKAGE '{source}' --> '{destination}'")
+            import_folder_entity(source_path, destination, fast)
+            if validate:
+                print(f"Validating entities in: {destination}/{source_path.name}")
+                dmss_api.validate_existing_entity(f"{destination}/{source_path.name}")
+            return True
+        else:
+            import_single_entity(source_path, destination, validate)
+            return True
+
+    return dmss_exception_wrapper(inner_import)
+
+
+@entities_app.command("validate")
+def validate_entity(
+    destination: Annotated[
+        str,
+        typer.Argument(
+            help="Address for the folder or file. Should be on the format <DataSource>/<rootPackage>/<subPackage>/<entity>"
+        ),
+    ],
+) -> bool:
+    """Recursively validate entity at remote target"""
+    print(f"Validating entities recursively in: {destination}")
+
+    @retry(
+        wait=wait_random_exponential(multiplier=1, max=60),
+        stop=stop_after_attempt(5),
+        retry=retry_if_not_exception_type((ApplicationException, RuntimeError)),
+    )
+    def validation_error_wrapper():
+        try:
+            dmss_api.validate_existing_entity(destination)
+        except ApiException as e:
+            exception_body = json.loads(e.body)
+            if exception_body["type"] == "ValidationException":
+                console.print(exception_body, style="red1")
+                raise typer.Exit(code=1)
+            raise e
+
+    dmss_exception_wrapper(validation_error_wrapper)
+
+
+@entities_app.command("delete")
+def delete_entity(
+    target: Annotated[
+        str,
+        typer.Argument(
+            help="Delete an entity from DMSS. Target should be an address on the format <DataSource>/<rootPackage>/<subPackage>/<entity>"
+        ),
+    ],
+):
+    """
+    Delete an entity from DMSS.
+    """
+
+    dmss_exception_wrapper(dmss_api.document_remove, target)

dm_cli/dmss.py

@@ -0,0 +1,104 @@
+import json
+from typing import Any, Callable
+
+import requests
+import typer
+from rich.console import Console
+from rich.text import Text
+from tenacity import (
+    retry,
+    retry_if_exception_type,
+    stop_after_attempt,
+    wait_random_exponential,
+)
+
+from dm_cli.dmss_api import ApiException
+from dm_cli.dmss_api.api.default_api import DefaultApi
+from dm_cli.dmss_api.exceptions import NotFoundException, ServiceException
+from dm_cli.state import state
+
+console = Console()
+
+dmss_api = DefaultApi()
+
+
+class ApplicationException(Exception):
+    status: int = 500
+    type: str = "ApplicationException"
+    message: str = "The requested operation failed"
+    debug: str = "An unknown and unhandled exception occurred in the API"
+    data: dict = None
+
+    def __init__(
+        self,
+        message: str = "The requested operation failed",
+        debug: str = "An unknown and unhandled exception occurred in the API",
+        data: dict = None,
+        status: int = 500,
+        type: str = "ApplicationException",
+    ):
+        self.type = type
+        self.status = status
+        self.type = self.__class__.__name__
+        self.message = message
+        self.debug = debug
+        self.data = data
+
+    def dict(self):
+        return {
+            "status": self.status,
+            "type": self.type,
+            "message": self.message,
+            "debug": self.debug,
+            "data": self.data,
+        }
+
+
+@retry(
+    wait=wait_random_exponential(multiplier=1, max=60),
+    stop=stop_after_attempt(5),
+    reraise=True,
+    retry=retry_if_exception_type(ServiceException),
+)
+def export(absolute_document_ref: str):
+    """Call export endpoint from DMSS to download document(s) as zip.
+
+    The reason dmss_api cannot be used directly is that there were some issues with interpreting the JSON schema,
+    which caused the export function in the generated DMSS api to not work properly.
+    """
+    headers = {"Access-Key": state.token}
+
+    response = requests.get(f"{state.dmss_url}/api/export/{absolute_document_ref}", headers=headers)  # nosec
+    if response.status_code != 200:
+        raise ApplicationException(
+            message=f"Could not export document(s) from {absolute_document_ref} (status code {response.status_code})."
+        )
+
+    return response
+
+
+def dmss_exception_wrapper(
+    function: Callable,
+    *args,
+    **kwargs,
+) -> Any:
+    try:
+        return function(*args, **kwargs)
+    except ApplicationException as e:
+        if state.debug:
+            console.print_exception()
+        exception = e.dict()
+        console.print(exception, style="red1")
+        raise typer.Exit(code=1)
+    except (NotFoundException, ApiException) as e:
+        if state.debug:
+            console.print_exception()
+        exception = json.loads(e.body)
+        console.print(exception, style="red1")
+        raise typer.Exit(code=1)
+    except Exception as error:
+        if state.debug:
+            console.print_exception()
+        text = Text(str(error))
+        console.print(text, style="red1")
+        raise typer.Exit(code=1)

dm_cli/dmss_api/__init__.py

@@ -0,0 +1,27 @@
+# flake8: noqa
+
+"""
+    Data Modelling Storage Service
+
+    API for basic data modelling interaction  # noqa: E501
+
+    The version of the OpenAPI document: 1.3.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+__version__ = "1.0.0"
+
+# import ApiClient
+from dm_cli.dmss_api.api_client import ApiClient
+
+# import Configuration
+from dm_cli.dmss_api.configuration import Configuration
+
+# import exceptions
+from dm_cli.dmss_api.exceptions import OpenApiException
+from dm_cli.dmss_api.exceptions import ApiAttributeError
+from dm_cli.dmss_api.exceptions import ApiTypeError
+from dm_cli.dmss_api.exceptions import ApiValueError
+from dm_cli.dmss_api.exceptions import ApiKeyError
+from dm_cli.dmss_api.exceptions import ApiException

dm_cli/dmss_api/api/__init__.py

@@ -0,0 +1,3 @@
+# do not import all apis into this module because that uses a lot of memory and stack frames
+# if you need the ability to import all apis from one package, import them with
+# from dm_cli.dmss_api.apis import AccessControlApi

dm_cli/dmss_api/api/access_control_api.py

@@ -0,0 +1,349 @@
+"""
+    Data Modelling Storage Service
+
+    API for basic data modelling interaction  # noqa: E501
+
+    The version of the OpenAPI document: 1.3.0
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from dm_cli.dmss_api.api_client import ApiClient
+from dm_cli.dmss_api.api_client import Endpoint as _Endpoint
+from dm_cli.dmss_api.model.access_control_list import AccessControlList
+from dm_cli.dmss_api.model.error_response import ErrorResponse
+from dm_cli.dmss_api.model_utils import (  # noqa: F401
+    check_allowed_values,
+    check_validations,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_and_convert_types,
+)
+
+
+class AccessControlApi(object):
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+        self.get_acl_endpoint = _Endpoint(
+            settings={
+                'response_type': (AccessControlList,),
+                'auth': [
+                    'APIKeyHeader',
+                    'OAuth2AuthorizationCodeBearer'
+                ],
+                'endpoint_path': '/api/acl/{data_source_id}/{document_id}',
+                'operation_id': 'get_acl',
+                'http_method': 'GET',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'data_source_id',
+                    'document_id',
+                ],
+                'required': [
+                    'data_source_id',
+                    'document_id',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'data_source_id':
+                        (str,),
+                    'document_id':
+                        (str,),
+                },
+                'attribute_map': {
+                    'data_source_id': 'data_source_id',
+                    'document_id': 'document_id',
+                },
+                'location_map': {
+                    'data_source_id': 'path',
+                    'document_id': 'path',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json',
+                    'text/plain'
+                ],
+                'content_type': [],
+            },
+            api_client=api_client
+        )
+        self.set_acl_endpoint = _Endpoint(
+            settings={
+                'response_type': (str,),
+                'auth': [
+                    'APIKeyHeader',
+                    'OAuth2AuthorizationCodeBearer'
+                ],
+                'endpoint_path': '/api/acl/{data_source_id}/{document_id}',
+                'operation_id': 'set_acl',
+                'http_method': 'PUT',
+                'servers': None,
+            },
+            params_map={
+                'all': [
+                    'data_source_id',
+                    'document_id',
+                    'access_control_list',
+                    'recursively',
+                ],
+                'required': [
+                    'data_source_id',
+                    'document_id',
+                    'access_control_list',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'data_source_id':
+                        (str,),
+                    'document_id':
+                        (str,),
+                    'access_control_list':
+                        (AccessControlList,),
+                    'recursively':
+                        (bool,),
+                },
+                'attribute_map': {
+                    'data_source_id': 'data_source_id',
+                    'document_id': 'document_id',
+                    'recursively': 'recursively',
+                },
+                'location_map': {
+                    'data_source_id': 'path',
+                    'document_id': 'path',
+                    'access_control_list': 'body',
+                    'recursively': 'query',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json',
+                    'text/plain'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
+
+    def get_acl(
+        self,
+        data_source_id,
+        document_id,
+        **kwargs
+    ):
+        """Get Acl  # noqa: E501
+
+        GET the access control list (ACL) for a document.  The ACL determines which access a given user has for a document (Read, Write or None).  Args: - data_source_id (str): The ID of the data source which the document resides in. - document_id (str): The ID of the document for which to check the ACL. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key.  Returns: - ACL: The access control list requested.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.get_acl(data_source_id, document_id, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            data_source_id (str):
+            document_id (str):
+
+        Keyword Args:
+            _return_http_data_only (bool): response data without head status
+                code and headers. Default is True.
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+            _request_auths (list): set to override the auth_settings for an a single
+                request; this effectively ignores the authentication
+                in the spec for a single request.
+                Default is None
+            async_req (bool): execute request asynchronously
+
+        Returns:
+            AccessControlList
+                If the method is called asynchronously, returns the request
+                thread.
+        """
+        kwargs['async_req'] = kwargs.get(
+            'async_req', False
+        )
+        kwargs['_return_http_data_only'] = kwargs.get(
+            '_return_http_data_only', True
+        )
+        kwargs['_preload_content'] = kwargs.get(
+            '_preload_content', True
+        )
+        kwargs['_request_timeout'] = kwargs.get(
+            '_request_timeout', None
+        )
+        kwargs['_check_input_type'] = kwargs.get(
+            '_check_input_type', True
+        )
+        kwargs['_check_return_type'] = kwargs.get(
+            '_check_return_type', True
+        )
+        kwargs['_spec_property_naming'] = kwargs.get(
+            '_spec_property_naming', False
+        )
+        kwargs['_content_type'] = kwargs.get(
+            '_content_type')
+        kwargs['_host_index'] = kwargs.get('_host_index')
+        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
+        kwargs['data_source_id'] = \
+            data_source_id
+        kwargs['document_id'] = \
+            document_id
+        return self.get_acl_endpoint.call_with_http_info(**kwargs)
+
+    def set_acl(
+        self,
+        data_source_id,
+        document_id,
+        access_control_list,
+        **kwargs
+    ):
+        """Set Acl  # noqa: E501
+
+        Update access control list (ACL) for a document.  Args: - data_source_id (str): The ID of the data source which the document resides in. - document_id (str): The ID of the document for which to set the ACL. - acl (ACL): An access control list. - user (User): The authenticated user accessing the endpoint, automatically generated from provided bearer token or Access-Key.  Returns: - str: \"OK\" (200)  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+
+        >>> thread = api.set_acl(data_source_id, document_id, access_control_list, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            data_source_id (str):
+            document_id (str):
+            access_control_list (AccessControlList):
+
+        Keyword Args:
+            recursively (bool): [optional] if omitted the server will use the default value of True
+            _return_http_data_only (bool): response data without head status
+                code and headers. Default is True.
+            _preload_content (bool): if False, the urllib3.HTTPResponse object
+                will be returned without reading/decoding response data.
+                Default is True.
+            _request_timeout (int/float/tuple): timeout setting for this request. If
+                one number provided, it will be total request timeout. It can also
+                be a pair (tuple) of (connection, read) timeouts.
+                Default is None.
+            _check_input_type (bool): specifies if type checking
+                should be done one the data sent to the server.
+                Default is True.
+            _check_return_type (bool): specifies if type checking
+                should be done one the data received from the server.
+                Default is True.
+            _spec_property_naming (bool): True if the variable names in the input data
+                are serialized names, as specified in the OpenAPI document.
+                False if the variable names in the input data
+                are pythonic names, e.g. snake case (default)
+            _content_type (str/None): force body content-type.
+                Default is None and content-type will be predicted by allowed
+                content-types and body.
+            _host_index (int/None): specifies the index of the server
+                that we want to use.
+                Default is read from the configuration.
+            _request_auths (list): set to override the auth_settings for an a single
+                request; this effectively ignores the authentication
+                in the spec for a single request.
+                Default is None
+            async_req (bool): execute request asynchronously
+
+        Returns:
+            str
+                If the method is called asynchronously, returns the request
+                thread.
+        """
+        kwargs['async_req'] = kwargs.get(
+            'async_req', False
+        )
+        kwargs['_return_http_data_only'] = kwargs.get(
+            '_return_http_data_only', True
+        )
+        kwargs['_preload_content'] = kwargs.get(
+            '_preload_content', True
+        )
+        kwargs['_request_timeout'] = kwargs.get(
+            '_request_timeout', None
+        )
+        kwargs['_check_input_type'] = kwargs.get(
+            '_check_input_type', True
+        )
+        kwargs['_check_return_type'] = kwargs.get(
+            '_check_return_type', True
+        )
+        kwargs['_spec_property_naming'] = kwargs.get(
+            '_spec_property_naming', False
+        )
+        kwargs['_content_type'] = kwargs.get(
+            '_content_type')
+        kwargs['_host_index'] = kwargs.get('_host_index')
+        kwargs['_request_auths'] = kwargs.get('_request_auths', None)
+        kwargs['data_source_id'] = \
+            data_source_id
+        kwargs['document_id'] = \
+            document_id
+        kwargs['access_control_list'] = \
+            access_control_list
+        return self.set_acl_endpoint.call_with_http_info(**kwargs)
+