js7-client-python 2.0.1__py3-none-any.whl

js7/client/action/inventory/deploy_configurations_action.py

@@ -0,0 +1,138 @@
+from typing import List, Optional
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.public.client.common.configurations import DeployConfiguration, DraftConfiguration
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    DeployFilter as DeployFilter_V_2_8_2,
+    OK as OK_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2,
+    DeployablesValidFilter as DeployablesValidFilter_V_2_8_2,
+    Config as Config_V_2_8_2,
+    PublishConfiguration as Configuration_V_2_8_2,
+    CommonConfigurationType as ConfigurationType_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+# (i) Daily Plan operations such as add_orders_date_from should be executed in a separate function.
+def deploy_configurations_action(
+    *,
+    context: Context,
+    controller_id: str,
+    delete_deployed_configs: Optional[List[DeployConfiguration]],
+    deploy_draft_configs: Optional[List[DraftConfiguration]],
+    redeploy_deployed_configs: Optional[List[DeployConfiguration]],
+    audit_log: Optional[AuditLog]
+) -> bool:
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id,
+            delete_deployed_configs=delete_deployed_configs,
+            deploy_draft_configs=deploy_draft_configs,
+            redeploy_deployed_configs=redeploy_deployed_configs,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    # Calls the dispatcher for the matching JOC version
+    result = context.joc_api.dispatch(endpoint_id="inventory/deployment/deploy", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, OK_V_2_8_2):
+        return bool(result.ok)
+    
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    delete_deployed_configs: Optional[List[DeployConfiguration]],
+    deploy_draft_configs: Optional[List[DraftConfiguration]],
+    redeploy_deployed_configs: Optional[List[DeployConfiguration]],
+    audit_log: Optional[AuditLog]
+) -> DeployFilter_V_2_8_2:
+
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: any_of(delete_deployed_object, deploy_draft_object, redeploy_deployed_object)
+    if not (delete_deployed_configs or deploy_draft_configs or redeploy_deployed_configs):
+        raise ValueError("Any of 'delete_deployed_configs, deploy_draft_configs, redeploy_deployed_configs' must be set.")
+    
+    # Build: audit_log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Build: delete_deployed_object
+    res_delete: Optional[DeployablesValidFilter_V_2_8_2] = None
+    if delete_deployed_configs:
+        res_delete = DeployablesValidFilter_V_2_8_2(
+            deploy_configurations=[
+                Config_V_2_8_2(
+                    configuration=Configuration_V_2_8_2(
+                        commit_id=c.commit_id,
+                        object_type=ConfigurationType_V_2_8_2(c.object_type), # Raises ValueErro() if invalid.
+                        path=c.path,
+                        recursive=c.recursive,
+                    )
+                )
+                for c in delete_deployed_configs
+            ]
+        )
+    
+    # Build: Store
+    store_draft_configs: Optional[List[Config_V_2_8_2]] = None
+    store_deploy_configs: Optional[List[Config_V_2_8_2]] = None
+    if deploy_draft_configs:
+        store_draft_configs = [
+            Config_V_2_8_2(configuration=Configuration_V_2_8_2(
+                commit_id=None,
+                object_type=ConfigurationType_V_2_8_2(c.object_type), # Raises ValueErro() if invalid.
+                path=c.path,
+                recursive=c.recursive,
+            ))
+            for c in deploy_draft_configs
+        ]
+            
+    if redeploy_deployed_configs:    
+        store_deploy_configs = [
+            Config_V_2_8_2(configuration=Configuration_V_2_8_2(
+                commit_id=c.commit_id,
+                object_type=ConfigurationType_V_2_8_2(c.object_type), # Raises ValueError() if invalid.
+                path=c.path,
+                recursive=c.recursive,
+            ))
+            for c in redeploy_deployed_configs
+        ]
+    
+    res_store: Optional[DeployablesValidFilter_V_2_8_2] = None
+    if (store_draft_configs or store_deploy_configs):
+        res_store = DeployablesValidFilter_V_2_8_2(
+            draft_configurations=store_draft_configs, 
+            deploy_configurations=store_deploy_configs
+        )
+    
+    # Result
+    return DeployFilter_V_2_8_2(
+        controller_ids=[controller_id],
+        delete=res_delete,
+        store=res_store,
+        add_orders_date_from=None, # now()
+        include_late=None,
+        audit_log=res_audit_log,
+    )

js7/client/action/inventory/export_configurations_action.py

@@ -0,0 +1,203 @@
+from pathlib import Path
+from typing import List, Literal, Optional, Union
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.public.client.common.configurations import DraftConfiguration, DeployConfiguration
+from ....model.public.client.filter.export_filter import ExportFilter
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    PublishConfiguration as Configuration_V_2_8_2,
+    ExportFilter as ExportFilter_V_2_8_2,
+    ExportForSigning as ExportForSigning_V_2_8_2,
+    DeployablesValidFilter as DeployablesValidFilter_V_2_8_2,
+    CommonConfigurationType as ConfigurationType_V_2_8_2,
+    Config as Config_V_2_8_2,
+    ExportFile as ExportFile_V_2_8_2,
+    ArchiveFormat as ArchiveFormat_V_2_8_2,
+    ExportShallowCopy as ExportShallowCopy_V_2_8_2,
+    DeployablesFilter as DeployablesFilter_V_2_8_2,
+    ReleasablesFilter as ReleasablesFilter_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+from ....util.bytes_converter.bytes_to_file import bytes_to_file
+
+
+def export_configurations_action(
+    *,
+    context: Context,
+    controller_id: str,
+    out_dir: Union[Path, str],
+    filename: str,
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    filter: ExportFilter,
+    audit_log: Optional[AuditLog]
+) -> bool:
+    
+    # Normalize out_path
+    out_dir = Path(out_dir)
+
+    # Determine expected suffix from archive_format
+    expected_suffix = ".tar.gz" if archive_format == "TAR_GZ" else ".zip"
+
+    # Append suffix if missing or wrong
+    if not filename.endswith((".zip", ".tar.gz")):
+        filename = filename + expected_suffix
+
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id,
+            out_dir=out_dir,
+            filename=filename,
+            archive_format=archive_format,
+            filter=filter,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    result = context.joc_api.dispatch(endpoint_id="inventory/export", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, bytes):
+        return bytes_to_file(data=result, out_path=Path(out_dir / filename))
+
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    *,
+    controller_id: str,
+    out_dir: Path,
+    filename: str,
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    filter: ExportFilter,
+    audit_log: Optional[AuditLog]
+) -> ExportFilter_V_2_8_2:
+    
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: out_dir
+    if not out_dir.is_dir():
+        raise ValueError("'out_dir' must be a directory.")
+    
+    # Validate: filename
+    if not filename:
+        raise ValueError("'filename' is required.")
+    
+    # Validate: archive_format
+    if archive_format not in ("ZIP", "TAR_GZ"):
+        raise ValueError("'archive_format' must be 'ZIP' or 'TAR_GZ'.")
+    
+    # Validate: filter.configurations
+    if not filter.configurations:
+        raise ValueError("At least one configuration must be provided.")
+    
+    # Build: export_file
+    res_export_file = ExportFile_V_2_8_2(
+        filename=Path(out_dir / filename).name,
+        format=(ArchiveFormat_V_2_8_2(archive_format)) # Raises ValueError() if invalid.
+    )
+    
+    # Build: configurations
+    res_draft_configurations: Optional[List[Config_V_2_8_2]] = None
+    res_deploy_configurations: Optional[List[Config_V_2_8_2]] = None
+    res_release_configurations: Optional[List[Config_V_2_8_2]] = None
+    for config in filter.configurations:
+        if isinstance(config, DraftConfiguration):
+            if not res_draft_configurations:
+                res_draft_configurations = []
+            
+            res_draft_configurations.append(
+                Config_V_2_8_2(
+                    configuration=Configuration_V_2_8_2(
+                        object_type=ConfigurationType_V_2_8_2(config.object_type), # Raises ValueError() if invalid.
+                        path=config.path,
+                        recursive=config.recursive
+                    )
+                )
+            )
+            
+            continue
+            
+        if isinstance(config, DeployConfiguration):
+            if not res_deploy_configurations:
+                res_deploy_configurations = []
+                
+            res_deploy_configurations.append(
+                Config_V_2_8_2(
+                    configuration=Configuration_V_2_8_2(
+                        commit_id=config.commit_id,
+                        object_type=ConfigurationType_V_2_8_2(config.object_type), # Raises ValueError() if invalid.
+                        path=config.path,
+                        recursive=config.recursive
+                    )
+                )
+            )
+            
+            continue
+        
+        else:
+            if not res_release_configurations:
+                res_release_configurations = []
+                
+            res_release_configurations.append(
+                Config_V_2_8_2(
+                    configuration=Configuration_V_2_8_2(
+                        object_type=ConfigurationType_V_2_8_2(config.object_type), # Raises ValueError() if invalid.
+                        path=config.path,
+                        recursive=config.recursive
+                    )
+                )
+            )
+    
+    # Build: for_signing
+    res_for_signing = ExportForSigning_V_2_8_2(
+        controller_id=controller_id,
+        deployables=DeployablesValidFilter_V_2_8_2(
+            deploy_configurations=res_deploy_configurations,
+            draft_configurations=res_draft_configurations
+        )
+    ) if filter.for_signing is True else None
+        
+    # Build: shallow_copy
+    res_shallow_copy = ExportShallowCopy_V_2_8_2(
+        incl_all_tags=filter.include_all_tags,
+        deployables=DeployablesFilter_V_2_8_2(
+            without_invalid=filter.without_invalid_drafts,
+            draft_configurations=res_draft_configurations,
+            deploy_configurations=res_deploy_configurations
+        ),
+        releasables=ReleasablesFilter_V_2_8_2(
+            without_invalid=filter.without_invalid_drafts,
+            draft_configurations=res_draft_configurations,
+            released_configurations=res_release_configurations
+        ) if (res_draft_configurations or res_release_configurations) else None
+    ) if filter.for_signing is False else None
+
+    # Build: audit_log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    # Result
+    return ExportFilter_V_2_8_2(
+        export_file=res_export_file,
+        for_signing=res_for_signing,
+        shallow_copy=res_shallow_copy,
+        start_folder=filter.start_folder,
+        use_short_path=filter.use_short_path,
+        audit_log=res_audit_log
+    )

js7/client/action/inventory/export_folders_action.py

@@ -0,0 +1,160 @@
+from pathlib import Path
+from typing import List, Literal, Optional, Union
+
+from ...context import Context
+from ....model.public.client.common.audit_log import AuditLog
+from ....model.public.client.enum.object_types import DeployObjectType, ReleaseObjectType
+from ....model.public.client.filter.export_folders_filter import ExportFoldersFilter
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    ArchiveFormat as ArchiveFormat_V_2_8_2,
+    CommonConfigurationType as ConfigurationType_V_2_8_2,
+    ExportFile as ExportFile_V_2_8_2,
+    ExportFolderFilter as ExportFolderFilter_V_2_8_2,
+    ExportFolderForSigning as ExportFolderForSigning_V_2_8_2,
+    ShallowCopy as ShallowCopy_V_2_8_2,
+    AuditParams as AuditParams_V_2_8_2
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def export_folders_action(
+    *,
+    context: Context,
+    controller_id: str,
+    out_dir: Union[Path, str],
+    filename: str,
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    filter: ExportFoldersFilter,
+    audit_log: Optional[AuditLog]
+) -> bool:
+
+    # Normalize out_path
+    out_dir = Path(out_dir)
+
+    # Determine expected suffix from archive_format
+    expected_suffix = ".tar.gz" if archive_format == "TAR_GZ" else ".zip"
+    
+    # Append suffix if missing or wrong
+    if not filename.endswith((".zip", ".tar.gz")):
+        filename = filename + expected_suffix
+    
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(
+            controller_id=controller_id,
+            out_dir=out_dir,
+            filename=filename,
+            archive_format=archive_format,
+            filter=filter,
+            audit_log=audit_log
+        )
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    result = context.joc_api.dispatch(endpoint_id="inventory/export/folder", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+    
+    if isinstance(result, bytes):    
+        out_dir.mkdir(parents=True, exist_ok=True)
+        out_file = out_dir / filename
+        out_file.write_bytes(result)
+        return out_file.exists()
+        
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(
+    controller_id: str,
+    out_dir: Path,
+    filename: str,
+    archive_format: Literal["ZIP", "TAR_GZ"],
+    filter: ExportFoldersFilter,
+    audit_log: Optional[AuditLog]
+) -> ExportFolderFilter_V_2_8_2:
+
+    # Validate: controller_id
+    if not controller_id:
+        raise ValueError("'controller_id' is required.")
+    
+    # Validate: out_dir
+    if not out_dir.is_dir():
+        raise ValueError("'out_dir' must be a directory.")
+    
+    # Validate: filename
+    if not filename:
+        raise ValueError("'filename' is required.")
+    
+    # Validate: archive_format
+    if archive_format not in ("ZIP", "TAR_GZ"):
+        raise ValueError("'archive_format' must be 'ZIP' or 'TAR_GZ'.")
+    
+    # Validate: folder_paths
+    if not filter.folder_paths:
+        raise ValueError("At least one folder path in 'folder_paths' is required")
+    
+    # Build: object_types - Default: All object types.
+    res_object_types: List[ConfigurationType_V_2_8_2] = []
+    if filter.object_types:
+        for obj_type in filter.object_types:
+            res_object_types.append(ConfigurationType_V_2_8_2(obj_type.value)) # Raises ValueError() if invalid
+    elif filter.for_signing:
+        for obj_type in DeployObjectType:
+            res_object_types.append(ConfigurationType_V_2_8_2(obj_type.value)) # Raises ValueError() if invalid
+    else:
+        for obj_type in ReleaseObjectType:
+            res_object_types.append(ConfigurationType_V_2_8_2(obj_type.value)) # Raises ValueError() if invalid
+            
+        for obj_type in DeployObjectType:
+            try:
+                ReleaseObjectType(obj_type.value)  # exists -> skip
+            except ValueError:
+                res_object_types.append(ConfigurationType_V_2_8_2(obj_type.value)) # Raises ValueError() if invalid
+    
+    # Build: for_signing_result and shallow_copy_result
+    for_signing_result: Optional[ExportFolderForSigning_V_2_8_2] = None
+    shallow_copy_result: Optional[ShallowCopy_V_2_8_2] = None
+    if filter.for_signing is True:    
+        for_signing_result = ExportFolderForSigning_V_2_8_2(
+            controller_id=controller_id,
+            folders=filter.folder_paths,
+            object_types=res_object_types,
+            recursive=True,
+            without_deployed=filter.no_deployed,
+            without_drafts=filter.no_draft,
+        )
+    else:
+        shallow_copy_result = ShallowCopy_V_2_8_2(
+            folders=filter.folder_paths,
+            object_types=res_object_types,
+            incl_all_tags=True,
+            only_valid_objects=filter.no_invalid,
+            recursive=filter.recursive,
+            without_deployed=filter.no_deployed,
+            without_drafts=filter.no_draft,
+            without_released=filter.no_released,
+        )
+        
+    # Build: audit_log
+    res_audit_log = AuditParams_V_2_8_2(
+        ticket_link=audit_log.ticket_link,
+        comment=audit_log.comment,
+        time_spent=audit_log.time_spent
+    ) if audit_log else None
+    
+    return ExportFolderFilter_V_2_8_2(
+        export_file=ExportFile_V_2_8_2(
+            filename=filename,
+            format=ArchiveFormat_V_2_8_2(archive_format)
+        ),
+        for_signing=for_signing_result,
+        shallow_copy=shallow_copy_result,
+        use_short_path=filter.use_short_path,
+        audit_log=res_audit_log
+    )

js7/client/action/inventory/get_change_dependencies_action.py

@@ -0,0 +1,161 @@
+from typing import List, Optional, Set
+
+from ...context import Context
+from ....model.public.client.common.changes import Change, ChangeDependencies, ChangeStatus
+from ....model.public.client.enum.object_types import ObjectType
+from ....model.public.client.enum.operation_type import OperationType
+from ....model.private.api.endpoint import EndpointCall
+from ....model.private.http.joc.joc_v_2_8_2 import (
+    GetDependenciesRequest as GetDependenciesRequest_V_2_8_2,
+    GetDependenciesResponse as GetDependenciesResponse_V_2_8_2,
+    OperationType as OperationType_V_2_8_2,
+    RequestItem as RequestItem_V_2_8_2,
+    ResponseObject as ResponseObject_V_2_8_2,
+)
+
+from ....util.check_matching_version import check_matching_version
+
+
+def get_change_dependencies_action(
+    *,
+    context: Context,
+    operation_type: OperationType,
+    changes: List[Change],
+    filter_paths: Optional[List[str]],
+    filter_no_references: bool,
+    filter_no_referencing: bool
+) -> List[ChangeDependencies]:
+    
+    if check_matching_version(min="2.6.5", max="2.8.3", check=context.version):
+        request_data = _build_v_2_8_2_request(operation_type=operation_type, changes=changes)
+    else:
+        raise RuntimeError(f"Version {context.version} is not compatible with building the request.")
+    
+    result = context.joc_api.dispatch(endpoint_id="inventory/dependencies", call=EndpointCall(
+        http_service=context.http_service,
+        access_token=context.auth_provider.login(),
+        payload=request_data,
+        options=None,
+    ))
+
+    if isinstance(result, GetDependenciesResponse_V_2_8_2):
+        return _build_v_2_8_2_response(
+            response=result, 
+            filter_paths=filter_paths, 
+            filter_no_references=filter_no_references, 
+            filter_no_referencing=filter_no_referencing
+        )
+
+    raise RuntimeError(f"Unexpected response type: {type(result).__name__}")
+
+#---------------------#
+# Build 2.8.2 request #
+#---------------------#
+def _build_v_2_8_2_request(*, operation_type: OperationType, changes: List[Change]) -> GetDependenciesRequest_V_2_8_2:    
+    # Validate: changes
+    if not changes:
+        raise ValueError("At least one change in 'changes' is required.")
+    
+    # Validate: changes
+    for c in changes:
+        if not (c.name and c.object_type):
+            raise ValueError("'name' and 'object_type' are required in every change.")
+    
+    return GetDependenciesRequest_V_2_8_2(
+        operation_type=OperationType_V_2_8_2(operation_type.value), # Raises ValueError() if invalid.
+        configurations=[
+            RequestItem_V_2_8_2(name=c.name, type=c.object_type)
+            for c in changes
+            if c.name and c.object_type # Process only valid changes
+        ]
+    )
+
+#----------------------#
+# Build 2.8.2 response #
+#----------------------#
+def _build_v_2_8_2_response(
+    *,
+    response: GetDependenciesResponse_V_2_8_2,
+    filter_paths: Optional[List[str]],
+    filter_no_references: bool,
+    filter_no_referencing: bool,
+) -> List[ChangeDependencies]:
+    
+    # No processable result: Return []
+    if not response.objects or not response.requested_items:
+        return []
+    
+    def _build_status(config: ResponseObject_V_2_8_2) -> Set[ChangeStatus]:
+        status: Set[ChangeStatus] = set()
+        if config.valid is True:
+            status.add("VALID")
+        if config.deployed is True:
+            status.add("DEPLOYED")
+        if config.released is True:
+            status.add("RELEASED")
+        return status
+    
+    result: List[ChangeDependencies] = [] # root_id: value
+    
+    for req_id in response.requested_items:
+        found_parent: Optional[Change] = None
+        found_dependencies: List[Change] = []
+        
+        for id, config in response.objects.items():
+            # Found: Parent configuration
+            if float(id) == req_id:
+                if not config.object_type:
+                    raise RuntimeError("'object_type' is required in response.")
+                
+                found_parent = Change(
+                    path=config.path,
+                    name=config.name,
+                    object_type=ObjectType(config.object_type.value),
+                    status=_build_status(config)
+                )
+                
+                continue
+            
+            in_references = bool(config.references and req_id in config.references)
+            in_referenced_by = bool(config.referenced_by and req_id in config.referenced_by)
+            in_enforced_references = bool(config.enforced_references and req_id in config.enforced_references)
+            in_enforced_referenced_by = bool(config.enforced_referenced_by and req_id in config.enforced_referenced_by)
+            
+            # Append filter logic
+            if filter_no_references:
+                in_references = False
+            if filter_no_referencing:
+                in_referenced_by = False
+            
+            # Skips configurations starting with 'filter_paths'
+            if config.path and filter_paths:
+                skip = False
+                for p in filter_paths:
+                    if config.path.startswith(p):
+                        skip = True
+                        break
+                
+                if skip:
+                    continue
+                
+            if in_references or in_referenced_by or in_enforced_references or in_enforced_referenced_by:
+                if not config.object_type:
+                    raise RuntimeError("'object_type' is required in response.")
+                
+                found_dependencies.append(Change(
+                    path=config.path,
+                    name=config.name,
+                    object_type=ObjectType(config.object_type.value),
+                    status=_build_status(config)
+                ))
+            
+        if found_parent:
+            result.append(ChangeDependencies(
+                path=found_parent.path,
+                name=found_parent.name,
+                object_type=found_parent.object_type,
+                status=found_parent.status,
+                dependencies=found_dependencies  
+            ))
+    
+    return result