snapctl 0.32.0__py3-none-any.whl → 0.32.1__py3-none-any.whl

snapctl/config/constants.py

@@ -2,7 +2,7 @@
 Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
-VERSION = '0.32.0'
+VERSION = '0.32.1'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
@@ -12,16 +12,80 @@ URL_KEY = 'SNAPSER_URL_KEY'
 CONFIG_PATH_KEY = 'SNAPSER_CONFIG_PATH'
 SERVER_CALL_TIMEOUT = 30
 
-SNAPCTL_SUCCESS = 0
-SNAPCTL_ERROR = 1
-
 # HTTP codes
 HTTP_UNAUTHORIZED = 401
 HTTP_FORBIDDEN = 403
 HTTP_NOT_FOUND = 404
 HTTP_CONFLICT = 409
 
-# Error codes
-ERROR_SERVICE_VERSION_EXISTS = 542
-ERROR_TAG_NOT_AVAILABLE = 544
-ERROR_ADD_ON_NOT_ENABLED = 547
+# HTTP Error codes
+HTTP_ERROR_SERVICE_VERSION_EXISTS = 542
+HTTP_ERROR_TAG_NOT_AVAILABLE = 544
+HTTP_ERROR_ADD_ON_NOT_ENABLED = 547
+HTTP_ERROR_DUPLICATE_GAME_NAME = 2
+
+# CLI Return Codes
+SNAPCTL_SUCCESS = 0
+SNAPCTL_ERROR = 1
+SNAPCTL_INPUT_ERROR = 2
+
+# Configuration Errors
+SNAPCTL_CONFIGURATION_INCORRECT = 10
+SNAPCTL_CONFIGURATION_ERROR = 11
+SNAPCTL_DEPENDENCY_MISSING = 12
+
+# BYOGS Errors
+SNAPCTL_BYOGS_GENERIC_ERROR = 20
+SNAPCTL_BYOGS_DEPENDENCY_MISSING = 21
+SNAPCTL_BYOGS_ECR_LOGIN_ERROR = 22
+SNAPCTL_BYOGS_BUILD_ERROR = 23
+SNAPCTL_BYOGS_TAG_ERROR = 24
+SNAPCTL_BYOGS_PUBLISH_ERROR = 25
+SNAPCTL_BYOGS_PUBLISH_PERMISSION_ERROR = 26
+SNAPCTL_BYOGS_PUBLISH_DUPLICATE_TAG_ERROR = 27
+
+# BYOSNAP Errors
+SNAPCTL_BYOSNAP_GENERIC_ERROR = 30
+SNAPCTL_BYOSNAP_DEPENDENCY_MISSING = 31
+SNAPCTL_BYOSNAP_ECR_LOGIN_ERROR = 32
+SNAPCTL_BYOSNAP_BUILD_ERROR = 33
+SNAPCTL_BYOSNAP_TAG_ERROR = 34
+SNAPCTL_BYOSNAP_PUBLISH_IMAGE_ERROR = 35
+SNAPCTL_BYOSNAP_PUBLISH_IMAGE_PERMISSION_ERROR = 36
+SNAPCTL_BYOSNAP_PUBLISH_IMAGE_DUPLICATE_TAG_ERROR = 37
+SNAPCTL_BYOSNAP_CREATE_ERROR = 38
+SNAPCTL_BYOSNAP_CREATE_PERMISSION_ERROR = 39
+SNAPCTL_BYOSNAP_CREATE_DUPLICATE_NAME_ERROR = 40
+SNAPCTL_BYOSNAP_PUBLISH_VERSION_ERROR = 41
+SNAPCTL_BYOSNAP_PUBLISH_VERSION_PERMISSION_ERROR = 42
+SNAPCTL_BYOSNAP_PUBLISH_VERSION_DUPLICATE_VERSION_ERROR = 43
+SNAPCTL_BYOSNAP_PUBLISH_VERSION_DUPLICATE_TAG_ERROR = 44
+
+# Game Errors
+SNAPCTL_GAME_GENERIC_ERROR = 50
+SNAPCTL_GAME_CREATE_ERROR = 51
+SNAPCTL_GAME_CREATE_PERMISSION_ERROR = 52
+SNAPCTL_GAME_CREATE_DUPLICATE_NAME_ERROR = 53
+SNAPCTL_GAME_ENUMERATE_ERROR = 54
+
+# Snapend Errors
+SNAPCTL_SNAPEND_GENERIC_ERROR = 60
+SNAPCTL_SNAPEND_ENUMERATE_ERROR = 61
+SNAPCTL_SNAPEND_CLONE_ERROR = 62
+SNAPCTL_SNAPEND_CLONE_SERVER_ERROR = 63
+SNAPCTL_SNAPEND_CLONE_TIMEOUT_ERROR = 64
+SNAPCTL_SNAPEND_APPLY_ERROR = 65
+SNAPCTL_SNAPEND_APPLY_SERVER_ERROR = 66
+SNAPCTL_SNAPEND_APPLY_TIMEOUT_ERROR = 67
+SNAPCTL_SNAPEND_PROMOTE_ERROR = 68
+SNAPCTL_SNAPEND_PROMOTE_SERVER_ERROR = 69
+SNAPCTL_SNAPEND_PROMOTE_TIMEOUT_ERROR = 70
+SNAPCTL_SNAPEND_DOWNLOAD_ERROR = 71
+SNAPCTL_SNAPEND_UPDATE_ERROR = 72
+SNAPCTL_SNAPEND_UPDATE_SERVER_ERROR = 73
+SNAPCTL_SNAPEND_UPDATE_TIMEOUT_ERROR = 74
+SNAPCTL_SNAPEND_STATE_ERROR = 75
+
+# Generate Errors
+SNAPCTL_GENERATE_GENERIC_ERROR = 80
+SNAPCTL_GENERATE_BYOSNAP_PROFILE_ERROR = 81

snapctl/main.py

@@ -4,7 +4,7 @@
 import configparser
 import os
 from sys import platform
-from typing import Union, Callable
+from typing import Union
 import typer
 import pyfiglet
 
@@ -14,12 +14,13 @@ from snapctl.commands.game import Game
 from snapctl.commands.generate import Generate
 from snapctl.commands.snapend import Snapend
 from snapctl.config.constants import COMPANY_NAME, API_KEY, URL_KEY, CONFIG_FILE_MAC, \
-    CONFIG_FILE_WIN, DEFAULT_PROFILE, VERSION, SNAPCTL_SUCCESS, SNAPCTL_ERROR, CONFIG_PATH_KEY
+    CONFIG_FILE_WIN, DEFAULT_PROFILE, VERSION, SNAPCTL_SUCCESS, CONFIG_PATH_KEY, \
+    SNAPCTL_CONFIGURATION_INCORRECT
 from snapctl.config.endpoints import END_POINTS
 from snapctl.config.hashes import CLIENT_SDK_TYPES, SERVER_SDK_TYPES, PROTOS_TYPES, SERVICE_IDS, \
     SNAPEND_MANIFEST_TYPES
-from snapctl.types.definitions import ResponseType
 from snapctl.utils.echo import error, success, info
+from snapctl.utils.helper import validate_api_key
 
 ######### Globals #########
 
@@ -66,20 +67,22 @@ def extract_config(extract_key: str, profile: str | None = None) -> object:
             config_file_path = os.path.expandvars(CONFIG_FILE_WIN)
         else:
             config_file_path = os.path.expanduser(CONFIG_FILE_MAC)
-    result['location'] = f'config-file:{config_file_path}'
+    result['location'] = f'{config_file_path}'
     if os.path.isfile(config_file_path):
         config = configparser.ConfigParser()
         config.read(config_file_path, encoding=encoding)
         config_profile: str = DEFAULT_PROFILE
         if profile is not None and profile != '' and profile != DEFAULT_PROFILE:
-            result['location'] = f'{config_file_path}:profile {profile}'
+            result['location'] = f'"{config_file_path}:profile {profile}"'
             config_profile = f'profile {profile}'
-            info(f"Trying to extract API KEY from profile {profile}")
+            info(
+                f'Trying to extract API KEY from "{config_file_path}:profile {profile}"'
+            )
         result['value'] = config.get(
             config_profile, extract_key, fallback=None, raw=True
         )
     else:
-        error(
+        info(
             f'Config file on platform {platform} not found at {config_file_path}')
     return result
 
@@ -111,14 +114,9 @@ def validate_command_context(
       Validator to confirm if the context has been set properly
     """
     if ctx.obj['api_key'] is None or ctx.obj['base_url'] == '':
-        error(
-            "Unable to set command context. "
-            f"API Key:{ctx.obj['api_key']}  "
-            f"API Key Category:{ctx.obj['api_key_location']} "
-            f"Base URL:{ctx.obj['base_url']}"
-        )
-        raise typer.Exit(SNAPCTL_ERROR)
-    info(f"Using API Key from {ctx.obj['api_key_location']}")
+        error("Snapctl Configuration Incorrect. Unable to extract API Key",
+              SNAPCTL_CONFIGURATION_INCORRECT)
+        raise typer.Exit(code=SNAPCTL_CONFIGURATION_INCORRECT)
 
 ######### CALLBACKS #########
 
@@ -174,16 +172,16 @@ def profile_context_callback(
     # Ensure ctx object is instantiated
     ctx.ensure_object(dict)
     api_key_obj = extract_config(API_KEY, profile)
-    if api_key_obj['value'] is None and profile is not None and profile != '':
-        conf_file = ''
-        if platform == 'win32':
-            conf_file = os.path.expandvars(CONFIG_FILE_WIN)
-        else:
-            conf_file = os.path.expanduser(CONFIG_FILE_MAC)
-        error(
-            f'Invalid profile input {profile}. '
-            f'Please check your snap config file at {conf_file}'
-        )
+    # if api_key_obj['value'] is None and profile is not None and profile != '':
+    #     conf_file = ''
+    #     if platform == 'win32':
+    #         conf_file = os.path.expandvars(CONFIG_FILE_WIN)
+    #     else:
+    #         conf_file = os.path.expanduser(CONFIG_FILE_MAC)
+    #     error(
+    #         f'Invalid profile input {profile}. '
+    #         f'Please check your snap config file at {conf_file}'
+    #     )
     ctx.obj['version'] = VERSION
     ctx.obj['api_key'] = api_key_obj['value']
     ctx.obj['api_key_location'] = api_key_obj['location']
@@ -198,7 +196,7 @@ def version_callback(value: bool = True):
     """
     if value:
         success(f"Snapctl version: {VERSION}")
-        raise typer.Exit(SNAPCTL_SUCCESS)
+        raise typer.Exit(code=SNAPCTL_SUCCESS)
 
 
 @app.callback()
@@ -227,12 +225,57 @@ def validate(
     profile: Union[str, None] = typer.Option(
         None, "--profile", help="Profile to use.", callback=profile_context_callback
     ),
-):
+) -> None:
     """
     Validate your Snapctl setup
     """
     validate_command_context(ctx)
+    validate_api_key(ctx.obj['base_url'], ctx.obj['api_key'])
     success("Setup is valid")
+    raise typer.Exit(code=SNAPCTL_SUCCESS)
+
+
+@app.command()
+def byogs(
+    ctx: typer.Context,
+    # Required fields
+    subcommand: str = typer.Argument(
+        ..., help="BYOGs Subcommands: " + ", ".join(ByoGs.SUBCOMMANDS) + "."
+    ),
+    # sid: str = typer.Argument(
+    #     ByoGs.SID,  help="Game Server Id. Should start with byogs"
+    # ),
+    # publish, publish-image and publish-version
+    tag: str = typer.Option(
+        None, "--tag",
+        help="(req: build, push, publish) Tag for your snap"
+    ),
+    # publish and publish-image
+    path: Union[str, None] = typer.Option(
+        None, "--path", help="(req: build, publish) Path to your snap code"
+    ),
+    docker_file: str = typer.Option(
+        "Dockerfile", help="Dockerfile name to use"
+    ),
+    # overrides
+    api_key: Union[str, None] = typer.Option(
+        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+    ),
+    profile: Union[str, None] = typer.Option(
+        None, "--profile", help="Profile to use.", callback=profile_context_callback
+    ),
+) -> None:
+    """
+      Bring your own game server commands
+    """
+    validate_command_context(ctx)
+    byogs_obj: ByoGs = ByoGs(
+        subcommand, ctx.obj['base_url'], ctx.obj['api_key'],
+        tag, path, docker_file,
+    )
+    getattr(byogs_obj, subcommand.replace('-', '_'))()
+    success(f"BYOGs {subcommand} complete")
+    raise typer.Exit(code=SNAPCTL_SUCCESS)
 
 
 @app.command()
@@ -306,39 +349,22 @@ def byosnap(
         name, desc, platform_type, language, tag, path, docker_file,
         prefix, version, http_port, byosnap_profile
     )
-    validate_input_response: ResponseType = byosnap_obj.validate_input()
-    if validate_input_response['error']:
-        error(validate_input_response['msg'])
-        raise typer.Exit(SNAPCTL_ERROR)
-    command_method = subcommand.replace('-', '_')
-    method: Callable[..., bool] = getattr(byosnap_obj, command_method)
-    if not method():
-        error(f"BYOSnap {subcommand} failed")
-        raise typer.Exit(SNAPCTL_ERROR)
+    getattr(byosnap_obj, subcommand.replace('-', '_'))()
     success(f"BYOSnap {subcommand} complete")
+    raise typer.Exit(code=SNAPCTL_SUCCESS)
 
 
 @app.command()
-def byogs(
+def game(
     ctx: typer.Context,
     # Required fields
     subcommand: str = typer.Argument(
-        ..., help="BYOGs Subcommands: " + ", ".join(ByoGs.SUBCOMMANDS) + "."
-    ),
-    # sid: str = typer.Argument(
-    #     ByoGs.SID,  help="Game Server Id. Should start with byogs"
-    # ),
-    # publish, publish-image and publish-version
-    tag: str = typer.Option(
-        None, "--tag",
-        help="(req: build, push, publish) Tag for your snap"
-    ),
-    # publish and publish-image
-    path: Union[str, None] = typer.Option(
-        None, "--path", help="(req: build, publish) Path to your snap code"
+        ..., help="Game Subcommands: " + ", ".join(Game.SUBCOMMANDS) + "."
     ),
-    docker_file: str = typer.Option(
-        "Dockerfile", help="Dockerfile name to use"
+    # name
+    name: str = typer.Option(
+        None, "--name",
+        help=("(req: create) Name of your game: ")
     ),
     # overrides
     api_key: Union[str, None] = typer.Option(
@@ -349,36 +375,26 @@ def byogs(
     ),
 ) -> None:
     """
-      Bring your own game server commands
+      Game commands
     """
     validate_command_context(ctx)
-    byogs_obj: ByoGs = ByoGs(
-        subcommand, ctx.obj['base_url'], ctx.obj['api_key'],
-        tag, path, docker_file,
-    )
-    validate_input_response: ResponseType = byogs_obj.validate_input()
-    if validate_input_response['error']:
-        error(validate_input_response['msg'])
-        raise typer.Exit(SNAPCTL_ERROR)
-    command_method = subcommand.replace('-', '_')
-    method: Callable[..., bool] = getattr(byogs_obj, command_method)
-    if not method():
-        error(f"BYOGs {subcommand} failed")
-        raise typer.Exit(SNAPCTL_ERROR)
-    success(f"BYOGs {subcommand} complete")
+    game_obj: Game = Game(
+        subcommand, ctx.obj['base_url'], ctx.obj['api_key'], name)
+    getattr(game_obj, subcommand.replace('-', '_'))()
+    success(f"Game {subcommand} complete")
+    raise typer.Exit(code=SNAPCTL_SUCCESS)
 
 
 @app.command()
-def game(
+def generate(
     ctx: typer.Context,
     # Required fields
     subcommand: str = typer.Argument(
-        ..., help="Game Subcommands: " + ", ".join(Game.SUBCOMMANDS) + "."
+        ..., help="Generate Subcommands: " + ", ".join(Generate.SUBCOMMANDS) + "."
     ),
-    # name
-    name: str = typer.Option(
-        None, "--name",
-        help=("(req: create) Name of your game: ")
+    # byosnap-profile
+    out_path: Union[str, None] = typer.Option(
+        None, "--out-path", help="(req: byosnap-profile) Path to output the byosnap profile"
     ),
     # overrides
     api_key: Union[str, None] = typer.Option(
@@ -389,21 +405,16 @@ def game(
     ),
 ) -> None:
     """
-      Game commands
+      Generate files to be used by other commands
     """
     validate_command_context(ctx)
-    game_obj: Game = Game(
-        subcommand, ctx.obj['base_url'], ctx.obj['api_key'], name)
-    validate_input_response: ResponseType = game_obj.validate_input()
-    if validate_input_response['error']:
-        error(validate_input_response['msg'])
-        raise typer.Exit(SNAPCTL_ERROR)
-    command_method = subcommand.replace('-', '_')
-    method: Callable[..., bool] = getattr(game_obj, command_method)
-    if not method():
-        error(f"Game {subcommand} failed")
-        raise typer.Exit(SNAPCTL_ERROR)
-    success(f"Game {subcommand} complete")
+    generate_obj: Generate = Generate(
+        subcommand, ctx.obj['base_url'], ctx.obj['api_key'],
+        out_path,
+    )
+    getattr(generate_obj, subcommand.replace('-', '_'))()
+    success(f"Generate {subcommand} complete")
+    raise typer.Exit(code=SNAPCTL_SUCCESS)
 
 
 @app.command()
@@ -416,7 +427,7 @@ def snapend(
     # snapend_id: str = typer.Argument(..., help="Snapend Id"),
     snapend_id: str = typer.Option(
         None, "--snapend-id",
-        help=("(req: update, download) Snapend Id")
+        help=("(req: state, update, download) Snapend Id")
     ),
     # enumerate
     game_id: str = typer.Option(
@@ -530,52 +541,6 @@ def snapend(
         # Update
         byosnaps, byogs, blocking
     )
-    validate_input_response: ResponseType = snapend_obj.validate_input()
-    if validate_input_response['error']:
-        error(validate_input_response['msg'])
-        raise typer.Exit(SNAPCTL_ERROR)
-    command_method = subcommand.replace('-', '_')
-    method: Callable[..., bool] = getattr(snapend_obj, command_method)
-    if not method():
-        error(f"Snapend {subcommand} failed")
-        raise typer.Exit(SNAPCTL_ERROR)
+    getattr(snapend_obj, subcommand.replace('-', '_'))()
     success(f"Snapend {subcommand} complete")
-
-
-@app.command()
-def generate(
-    ctx: typer.Context,
-    # Required fields
-    subcommand: str = typer.Argument(
-        ..., help="Generate Subcommands: " + ", ".join(Generate.SUBCOMMANDS) + "."
-    ),
-    # byosnap-profile
-    out_path: Union[str, None] = typer.Option(
-        None, "--out-path", help="(req: byosnap-profile) Path to output the byosnap profile"
-    ),
-    # overrides
-    api_key: Union[str, None] = typer.Option(
-        None, "--api-key", help="API Key override.", callback=api_key_context_callback
-    ),
-    profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile to use.", callback=profile_context_callback
-    ),
-) -> None:
-    """
-      Generate files to be used by other commands
-    """
-    validate_command_context(ctx)
-    generate_obj: Generate = Generate(
-        subcommand, ctx.obj['base_url'], ctx.obj['api_key'],
-        out_path,
-    )
-    validate_input_response: ResponseType = generate_obj.validate_input()
-    if validate_input_response['error']:
-        error(validate_input_response['msg'])
-        raise typer.Exit(SNAPCTL_ERROR)
-    command_method = subcommand.replace('-', '_')
-    method: Callable[..., bool] = getattr(generate_obj, command_method)
-    if not method():
-        error(f"Generate {subcommand} failed")
-        raise typer.Exit(SNAPCTL_ERROR)
-    success(f"Generate {subcommand} complete")
+    raise typer.Exit(code=SNAPCTL_SUCCESS)

snapctl/types/definitions.py

@@ -1,12 +1,28 @@
 """
 This file contains the definitions of the types used in the snapctl package.
 """
+from typing import List, Union
 
 
-class ResponseType():
+class ErrorResponse:
     """
     This class represents the response type of the Snapser API.
     """
-    error: bool
-    msg: str
-    data: list
+
+    def __init__(self, error: bool, code: int, msg: str, data: Union[List, str]):
+        self.error = error
+        self.code = code
+        self.msg = msg
+        self.data = data
+
+    def to_dict(self):
+        '''
+        Convert the object to a dictionary
+
+        '''
+        return {
+            'error': self.error,
+            'code': self.code,
+            'msg': self.msg,
+            'data': self.data
+        }

snapctl/utils/echo.py

@@ -1,15 +1,23 @@
 """
 This module contains functions to print messages to the console.
 """
+import json
+import typer
 from rich import print
+from snapctl.config.constants import SNAPCTL_ERROR
+from snapctl.types.definitions import ErrorResponse
 # Run `python -m rich.emoji` to get a list of all emojis that are supported
 
 
-def error(msg: str) -> None:
+def error(msg: str, code: int = SNAPCTL_ERROR, data: object = None) -> None:
     """
     Prints an error message to the console.
     """
+    error_response = ErrorResponse(
+        error=True, code=code, msg=msg, data=data if data else ''
+    )
     print(f"[bold red]Error[/bold red] {msg}")
+    typer.echo(json.dumps(error_response.to_dict()), err=True)
 
 
 def info(msg: str) -> None:
@@ -23,4 +31,4 @@ def success(msg: str) -> None:
     """
     Prints a success message to the console.
     """
-    print(f"[green]Success[/green] {msg}")
+    print(f"[bold green]Success[/bold green] {msg}")

snapctl/utils/helper.py

@@ -3,11 +3,46 @@ Helper functions for snapctl
 """
 import requests
 import typer
+from requests.exceptions import RequestException
+from rich.progress import Progress
 from snapctl.config.constants import HTTP_NOT_FOUND, HTTP_FORBIDDEN, HTTP_UNAUTHORIZED, \
-    SERVER_CALL_TIMEOUT
+    SERVER_CALL_TIMEOUT, SNAPCTL_CONFIGURATION_ERROR, SNAPCTL_SUCCESS
 from snapctl.utils.echo import error, success
 
 
+def validate_api_key(base_url: str, api_key: str | None):
+    """
+    This function validates the API Key
+    """
+    try:
+        url = f"{base_url}/v1/snapser-api/games"
+        res = requests.get(
+            url, headers={'api-key': api_key},
+            timeout=SERVER_CALL_TIMEOUT
+        )
+        if res.ok:
+            success('API Key validated')
+            return True
+        if res.status_code == HTTP_NOT_FOUND:
+            error('Service ID is invalid.', SNAPCTL_CONFIGURATION_ERROR)
+        elif res.status_code == HTTP_UNAUTHORIZED:
+            error(
+                'API Key verification failed. Your API Key is either invalid or may have expired. ',
+                SNAPCTL_CONFIGURATION_ERROR
+            )
+        elif res.status_code == HTTP_FORBIDDEN:
+            error(
+                'Permission denied. Your role has been revoked. Please contact your administrator.',
+                SNAPCTL_CONFIGURATION_ERROR
+            )
+        else:
+            error('Failed to validate API Key. Error:',
+                  SNAPCTL_CONFIGURATION_ERROR)
+    except RequestException as e:
+        error(f"Exception: Unable to update your snapend {e}")
+    raise typer.Exit(code=SNAPCTL_CONFIGURATION_ERROR)
+
+
 def get_composite_token(base_url: str, api_key: str | None, action: str, params: object) -> str:
     """
     This function exchanges the api_key for a composite token.
@@ -30,9 +65,31 @@ def get_composite_token(base_url: str, api_key: str | None, action: str, params:
             )
         elif res.status_code == HTTP_FORBIDDEN:
             error(
-                'Permission denied. Your role has been revoked. Please contact your administrator.')
+                'Permission denied. Your role has been revoked. Please contact your administrator.'
+            )
         else:
             error(f'Failed to validate API Key. Error: {res.text}')
-        raise typer.Exit()
+        raise typer.Exit(code=SNAPCTL_CONFIGURATION_ERROR)
     success('API Key validated')
     return res.json()['token']
+
+
+def snapctl_success(message: str, progress: Progress | None = None, no_exit: bool = False):
+    """
+    This function exits the snapctl
+    """
+    if progress:
+        progress.stop()
+    success(message)
+    if not no_exit:
+        raise typer.Exit(code=SNAPCTL_SUCCESS)
+
+
+def snapctl_error(message: str, code: int, progress: Progress | None = None):
+    """
+    This function exits the snapctl
+    """
+    if progress:
+        progress.stop()
+    error(message, code)
+    raise typer.Exit(code=code)