thestage 0.5.46__py3-none-any.whl → 0.5.49__py3-none-any.whl

thestage/controllers/instance_controller.py

@@ -1,200 +1,183 @@
-from pathlib import Path
-from typing import Optional, List
-
-from thestage.services.clients.thestage_api.dtos.enums.instance_rented_status import InstanceRentedBusinessStatus
-
-from thestage.entities.rented_instance import RentedInstanceEntity
-from thestage.entities.self_hosted_instance import SelfHostedInstanceEntity
-from thestage.helpers.logger.app_logger import app_logger
-from thestage.services.clients.thestage_api.dtos.enums.selfhosted_status import SelfhostedBusinessStatus
-from thestage.services.instance.mapper.instance_mapper import InstanceMapper
-from thestage.services.instance.mapper.selfhosted_mapper import SelfHostedMapper
-from thestage.services.instance.instance_service import InstanceService
-from thestage.i18n.translation import __
-from thestage.controllers.utils_controller import \
-    validate_config_and_get_service_factory
-
-import typer
-
-
-app = typer.Typer(no_args_is_help=True, help=__("Manage server instances"))
-
-rented = typer.Typer(no_args_is_help=True, help=__("Manage rented server instances"))
-self_hosted = typer.Typer(no_args_is_help=True, help=__("Manage self-hosted instances"))
-
-app.add_typer(rented, name="rented")
-app.add_typer(self_hosted, name="self-hosted")
-
-
-@rented.command(name="ls", help=__("List rented server instances"))
-def rented_list(
-        row: int = typer.Option(
-            5,
-            '--row',
-            '-r',
-            help=__("Set number of rows displayed per page"),
-            is_eager=False,
-        ),
-        page: int = typer.Option(
-            1,
-            '--page',
-            '-p',
-            help=__("Set starting page for displaying output"),
-            is_eager=False,
-        ),
-        statuses: List[str] = typer.Option(
-            None,
-            '--status',
-            '-s',
-            help=__("Filter by status, use --status all to list all rented server instances"),
-            is_eager=False,
-        ),
-):
-    """
-        Lists rented server instances
-    """
-    service_factory = validate_config_and_get_service_factory()
-    config = service_factory.get_config_provider().get_full_config()
-
-    instance_service: InstanceService = service_factory.get_instance_service()
-
-    instance_service.print_rented_instance_list(
-        config=config,
-        statuses=statuses,
-        row=row,
-        page=page
-    )
-
-    typer.echo(__("Rented server instances listing complete"))
-    raise typer.Exit(0)
-
-
-@rented.command(name="connect", no_args_is_help=True, help=__("Connect to rented server instance"))
-def instance_connect(
-        instance_uid: Optional[str] = typer.Argument(
-            help=__("Rented server instance unique ID"),
-        ),
-        private_ssh_key_path: str = typer.Option(
-            None,
-            "--private-key-path",
-            "-pk",
-            help=__("Path to private key that will be accepted by remote server (optional)"),
-            is_eager=False,
-        )
-):
-    """
-        Connects to rented server instance
-    """
-    app_logger.info(f'Connect to rented server instance')
-
-    if not instance_uid:
-        typer.echo(__('Rented server instance unique ID is required'))
-        raise typer.Exit(1)
-
-    if private_ssh_key_path and not Path(private_ssh_key_path).is_file():
-        typer.echo(f'No file found at provided path {private_ssh_key_path}')
-        raise typer.Exit(1)
-
-    service_factory = validate_config_and_get_service_factory()
-    config = service_factory.get_config_provider().get_full_config()
-
-    instance_service: InstanceService = service_factory.get_instance_service()
-
-    instance_service.connect_to_rented_instance(
-        instance_rented_slug=instance_uid,
-        config=config,
-        input_ssh_key_path=private_ssh_key_path
-    )
-
-    app_logger.info(f'Stop connecting to rented server instance')
-    raise typer.Exit(0)
-
-
-@self_hosted.command(name="ls", help=__("List self-hosted instances"))
-def self_hosted_list(
-        row: int = typer.Option(
-            5,
-            '--row',
-            '-r',
-            help=__("Set number of rows displayed per page"),
-            is_eager=False,
-        ),
-        page: int = typer.Option(
-            1,
-            '--page',
-            '-p',
-            help=__("Set starting page for displaying output"),
-            is_eager=False,
-        ),
-        statuses: List[str] = typer.Option(
-            None,
-            '--status',
-            '-s',
-            help=__("Filter by status, use --status all to list all self-hosted server instances"),
-            is_eager=False,
-        ),
-):
-    """
-        Lists self-hosted instances
-    """
-    service_factory = validate_config_and_get_service_factory()
-    config = service_factory.get_config_provider().get_full_config()
-
-    instance_service: InstanceService = service_factory.get_instance_service()
-
-    instance_service.print_self_hosted_instance_list(
-        config=config,
-        statuses=statuses,
-        row=row,
-        page=page
-    )
-
-    typer.echo(__("Self-hosted instances listing complete"))
-    raise typer.Exit(0)
-
-
-@self_hosted.command(name="connect", no_args_is_help=True, help=__("Connect to self-hosted instance"))
-def self_hosted_connect(
-        instance_slug: Optional[str] = typer.Argument(help=__("Self-hosted instance unique ID"),),
-        username: Optional[str] = typer.Option(
-            None,
-            '--username',
-            '-u',
-            help=__("Username for server instance (required when connecting to self-hosted instance)"),
-            is_eager=False,
-        ),
-        private_ssh_key_path: str = typer.Option(
-            None,
-            "--private-key-path",
-            "-pk",
-            help=__("Path to private key that will be accepted by remote server (optional)"),
-            is_eager=False,
-        ),
-):
-    """
-        Connects to self-hosted instance
-    """
-    app_logger.info(f'Connect to self-hosted instance')
-
-    if not instance_slug:
-        typer.echo(__('Self-hosted instance unique ID is required'))
-        raise typer.Exit(1)
-
-    if private_ssh_key_path and not Path(private_ssh_key_path).is_file():
-        typer.echo(f'No file found at provided path {private_ssh_key_path}')
-        raise typer.Exit(1)
-
-    service_factory = validate_config_and_get_service_factory()
-    config = service_factory.get_config_provider().get_full_config()
-
-    instance_service: InstanceService = service_factory.get_instance_service()
-
-    instance_service.connect_to_selfhosted_instance(
-        selfhosted_instance_slug=instance_slug,
-        username=username,
-        config=config,
-        input_ssh_key_path=private_ssh_key_path
-    )
-
-    app_logger.info(f'Stop connecting to self-hosted instance')
-    raise typer.Exit(0)
+from pathlib import Path
+from typing import Optional, List
+
+from thestage.cli_command import CliCommand
+from thestage.cli_command_helper import get_command_group_help_panel, get_command_metadata, check_command_permission
+from thestage.helpers.logger.app_logger import app_logger
+from thestage.services.instance.instance_service import InstanceService
+from thestage.i18n.translation import __
+from thestage.controllers.utils_controller import \
+    validate_config_and_get_service_factory, get_current_directory
+
+import typer
+
+
+app = typer.Typer(no_args_is_help=True, help=__("Manage server instances"))
+
+rented = typer.Typer(no_args_is_help=True, help=__("Manage rented server instances"))
+self_hosted = typer.Typer(no_args_is_help=True, help=__("Manage self-hosted instances"))
+
+app.add_typer(rented, name="rented", rich_help_panel=get_command_group_help_panel())
+app.add_typer(self_hosted, name="self-hosted", rich_help_panel=get_command_group_help_panel())
+
+
+@rented.command(name="ls", help=__("List rented server instances"), **get_command_metadata(CliCommand.INSTANCE_RENTED_LS))
+def rented_list(
+        row: int = typer.Option(
+            5,
+            '--row',
+            '-r',
+            help=__("Set number of rows displayed per page"),
+            is_eager=False,
+        ),
+        page: int = typer.Option(
+            1,
+            '--page',
+            '-p',
+            help=__("Set starting page for displaying output"),
+            is_eager=False,
+        ),
+        statuses: List[str] = typer.Option(
+            None,
+            '--status',
+            '-s',
+            help=__("Filter by status, use --status all to list all rented server instances"),
+            is_eager=False,
+        ),
+):
+    command_name = CliCommand.INSTANCE_RENTED_LS
+    app_logger.info(f'Running {command_name} from {get_current_directory()}')
+    check_command_permission(command_name)
+
+    service_factory = validate_config_and_get_service_factory()
+    instance_service: InstanceService = service_factory.get_instance_service()
+
+    instance_service.print_rented_instance_list(
+        statuses=statuses,
+        row=row,
+        page=page
+    )
+
+    typer.echo(__("Rented server instances listing complete"))
+    raise typer.Exit(0)
+
+
+@rented.command(name="connect", no_args_is_help=True, help=__("Connect to rented server instance"), **get_command_metadata(CliCommand.INSTANCE_RENTED_CONNECT))
+def instance_connect(
+        instance_uid: Optional[str] = typer.Argument(
+            help=__("Rented server instance unique ID"),
+        ),
+        private_ssh_key_path: str = typer.Option(
+            None,
+            "--private-key-path",
+            "-pk",
+            help=__("Path to private key that will be accepted by remote server (optional)"),
+            is_eager=False,
+        )
+):
+    command_name = CliCommand.INSTANCE_RENTED_CONNECT
+    app_logger.info(f'Running {command_name} from {get_current_directory()}')
+    check_command_permission(command_name)
+
+    if not instance_uid:
+        typer.echo(__('Rented server instance unique ID is required'))
+        raise typer.Exit(1)
+
+    if private_ssh_key_path and not Path(private_ssh_key_path).is_file():
+        typer.echo(f'No file found at provided path {private_ssh_key_path}')
+        raise typer.Exit(1)
+
+    service_factory = validate_config_and_get_service_factory()
+    instance_service: InstanceService = service_factory.get_instance_service()
+
+    instance_service.connect_to_rented_instance(
+        instance_rented_slug=instance_uid,
+        input_ssh_key_path=private_ssh_key_path
+    )
+
+    app_logger.info(f'Stop connecting to rented server instance')
+    raise typer.Exit(0)
+
+
+@self_hosted.command(name="ls", help=__("List self-hosted instances"), **get_command_metadata(CliCommand.INSTANCE_SELF_HOSTED_LS))
+def self_hosted_list(
+        row: int = typer.Option(
+            5,
+            '--row',
+            '-r',
+            help=__("Set number of rows displayed per page"),
+            is_eager=False,
+        ),
+        page: int = typer.Option(
+            1,
+            '--page',
+            '-p',
+            help=__("Set starting page for displaying output"),
+            is_eager=False,
+        ),
+        statuses: List[str] = typer.Option(
+            None,
+            '--status',
+            '-s',
+            help=__("Filter by status, use --status all to list all self-hosted server instances"),
+            is_eager=False,
+        ),
+):
+    command_name = CliCommand.INSTANCE_SELF_HOSTED_LS
+    app_logger.info(f'Running {command_name} from {get_current_directory()}')
+    check_command_permission(command_name)
+
+    service_factory = validate_config_and_get_service_factory()
+    instance_service: InstanceService = service_factory.get_instance_service()
+
+    instance_service.print_self_hosted_instance_list(
+        statuses=statuses,
+        row=row,
+        page=page
+    )
+
+    typer.echo(__("Self-hosted instances listing complete"))
+    raise typer.Exit(0)
+
+
+@self_hosted.command(name="connect", no_args_is_help=True, help=__("Connect to self-hosted instance"), **get_command_metadata(CliCommand.INSTANCE_SELF_HOSTED_CONNECT))
+def self_hosted_connect(
+        instance_slug: Optional[str] = typer.Argument(help=__("Self-hosted instance unique ID"),),
+        username: Optional[str] = typer.Option(
+            None,
+            '--username',
+            '-u',
+            help=__("Username for server instance (required when connecting to self-hosted instance)"),
+            is_eager=False,
+        ),
+        private_ssh_key_path: str = typer.Option(
+            None,
+            "--private-key-path",
+            "-pk",
+            help=__("Path to private key that will be accepted by remote server (optional)"),
+            is_eager=False,
+        ),
+):
+    command_name = CliCommand.INSTANCE_SELF_HOSTED_CONNECT
+    app_logger.info(f'Running {command_name} from {get_current_directory()}')
+    check_command_permission(command_name)
+
+    if not instance_slug:
+        typer.echo(__('Self-hosted instance unique ID is required'))
+        raise typer.Exit(1)
+
+    if private_ssh_key_path and not Path(private_ssh_key_path).is_file():
+        typer.echo(f'No file found at provided path {private_ssh_key_path}')
+        raise typer.Exit(1)
+
+    service_factory = validate_config_and_get_service_factory()
+    instance_service: InstanceService = service_factory.get_instance_service()
+
+    instance_service.connect_to_selfhosted_instance(
+        selfhosted_instance_slug=instance_slug,
+        username=username,
+        input_ssh_key_path=private_ssh_key_path
+    )
+
+    app_logger.info(f'Stop connecting to self-hosted instance')
+    raise typer.Exit(0)