snapctl 1.0.4__py3-none-any.whl → 1.1.1__py3-none-any.whl

snapctl/commands/snaps.py

@@ -0,0 +1,109 @@
+"""
+  Snaps CLI commands
+"""
+import json
+from typing import Union
+import requests
+from requests.exceptions import RequestException
+from rich.progress import Progress, SpinnerColumn, TextColumn
+from snapctl.config.constants import SERVER_CALL_TIMEOUT, SNAPCTL_INPUT_ERROR, \
+    SNAPCTL_SNAPS_ENUMERATE_ERROR, SNAPCTL_INTERNAL_SERVER_ERROR
+from snapctl.utils.helper import snapctl_error, snapctl_success
+from snapctl.utils.echo import info
+
+
+class Snaps:
+    """
+      CLI commands exposed for Snaps
+    """
+    SUBCOMMANDS = ['enumerate']
+
+    def __init__(
+            self, *, subcommand: str, base_url: str, api_key: Union[str, None],
+            out_path_filename: Union[str, None] = None
+    ) -> None:
+        self.subcommand: str = subcommand
+        self.base_url: str = base_url
+        self.api_key: Union[str, None] = api_key
+        self.out_path_filename: Union[str, None] = out_path_filename
+        # Validate input
+        self.validate_input()
+
+    def validate_input(self) -> None:
+        """
+          Validator
+        """
+        # Check API Key and Base URL
+        if not self.api_key or self.base_url == '':
+            snapctl_error(
+                message="Missing API Key.", code=SNAPCTL_INPUT_ERROR)
+        # Check subcommand
+        if not self.subcommand in Snaps.SUBCOMMANDS:
+            snapctl_error(
+                message="Invalid command. Valid commands are " +
+                f"{', '.join(Snaps.SUBCOMMANDS)}.",
+                code=SNAPCTL_INPUT_ERROR)
+        if self.subcommand == 'enumerate':
+            if self.out_path_filename:
+                if not (self.out_path_filename.endswith('.json')):
+                    snapctl_error(
+                        message="Output filename should end with .json",
+                        code=SNAPCTL_INPUT_ERROR)
+                info(f"Output will be written to {self.out_path_filename}")
+
+    @staticmethod
+    def get_snaps(base_url: str, api_key: str) -> dict:
+        """
+          Get snaps
+        """
+        response_json = {}
+        try:
+            url = f"{base_url}/v1/snapser-api/services"
+            res = requests.get(
+                url, headers={'api-key': api_key},
+                timeout=SERVER_CALL_TIMEOUT
+            )
+            response_json = res.json()
+        except RequestException as e:
+            pass
+        return response_json
+
+    def enumerate(self) -> bool:
+        """
+          Enumerate all snaps
+        """
+        progress = Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        )
+        progress.start()
+        progress.add_task(
+            description='Enumerating snaps...', total=None)
+        try:
+            response_json = Snaps.get_snaps(self.base_url, self.api_key)
+            if response_json == {}:
+                snapctl_error(
+                    message="Something went wrong. No snaps found. Please try again in some time.",
+                    code=SNAPCTL_INTERNAL_SERVER_ERROR, progress=progress)
+            if 'services' not in response_json:
+                snapctl_error(
+                    message="Something went wrong. No snaps found. Please try again in some time.",
+                    code=SNAPCTL_SNAPS_ENUMERATE_ERROR, progress=progress)
+            if self.out_path_filename:
+                with open(self.out_path_filename, 'w') as out_file:
+                    out_file.write(json.dumps(response_json))
+                snapctl_success(
+                    message=f"Output written to {self.out_path_filename}", progress=progress)
+            else:
+                snapctl_success(
+                    message=response_json, progress=progress)
+        except RequestException as e:
+            snapctl_error(
+                message=f"Exception: Unable to enumerate snaps {e}",
+                code=SNAPCTL_SNAPS_ENUMERATE_ERROR, progress=progress)
+        finally:
+            progress.stop()
+        snapctl_error(
+            message='Failed to enumerate snaps.',
+            code=SNAPCTL_SNAPS_ENUMERATE_ERROR, progress=progress)

snapctl/config/constants.py

@@ -3,7 +3,7 @@ Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
 VERSION_PREFIX = ''
-VERSION = '1.0.4'
+VERSION = '1.1.1'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
@@ -25,7 +25,9 @@ HTTP_CONFLICT = 409
 
 # HTTP Error codes
 HTTP_ERROR_GAME_LIMIT_REACHED = 520
+HTTP_ERROR_GAME_NOT_FOUND = 521
 HTTP_ERROR_DUPLICATE_GAME_NAME = 523
+HTTP_ERROR_CLUSTER_UPDATE_IN_PROGRESS = 535
 HTTP_ERROR_RESOURCE_NOT_FOUND = 541
 HTTP_ERROR_SERVICE_VERSION_EXISTS = 542
 HTTP_ERROR_SERVICE_IN_USE = 543
@@ -38,12 +40,23 @@ SNAPCTL_SUCCESS = 0
 SNAPCTL_ERROR = 1
 SNAPCTL_INPUT_ERROR = 2
 SNAPCTL_RESOURCE_NOT_FOUND = 3
+SNAPCTL_INTERNAL_SERVER_ERROR = 4
 
-# Configuration Errors - 10 - 19
+# Configuration Errors - 10 - 12
 SNAPCTL_CONFIGURATION_INCORRECT = 10
 SNAPCTL_CONFIGURATION_ERROR = 11
 SNAPCTL_DEPENDENCY_MISSING = 12
 
+# Snaps Errors - 13 - 15
+SNAPCTL_SNAPS_GENERIC_ERROR = 13
+SNAPCTL_SNAPS_ENUMERATE_ERROR = 14
+
+# Snapend Manifest Errors - 16 - 19
+SNAPCTL_SNAPEND_MANIFEST_CREATE_ERROR = 16
+SNAPCTL_SNAPEND_MANIFEST_SYNC_ERROR = 17
+SNAPCTL_SNAPEND_MANIFEST_UPGRADE_ERROR = 18
+SNAPCTL_SNAPEND_MANIFEST_UPDATE_ERROR = 19
+
 # BYOGS Errors - 20 - 29
 SNAPCTL_BYOGS_GENERIC_ERROR = 20
 SNAPCTL_BYOGS_DEPENDENCY_MISSING = 21
@@ -108,6 +121,10 @@ SNAPCTL_SNAPEND_UPDATE_SERVER_ERROR = 73
 SNAPCTL_SNAPEND_UPDATE_TIMEOUT_ERROR = 74
 SNAPCTL_SNAPEND_STATE_ERROR = 75
 SNAPCTL_SNAPEND_APPLY_MANIFEST_MISMATCH_ERROR = 76
+SNAPCTL_SNAPEND_CREATE_ERROR = 77
+SNAPCTL_SNAPEND_CREATE_SERVER_ERROR = 78
+SNAPCTL_SNAPEND_CREATE_TIMEOUT_ERROR = 79
+
 
 # Generate Errors - 80 - 85
 SNAPCTL_GENERATE_GENERIC_ERROR = 80

snapctl/data/releases/1.1.0.mdx

@@ -0,0 +1,20 @@
+## Release 1.1.0
+##### Oct 13, 2025
+
+### Deprecation Notice
+1. The `Snapend` command now accepts `--application-id` for consistency with the web app. The `--game-id` parameter is still supported but will be removed in future releases.
+2. The `Game` command has been renamed to `Application`. The old command is still supported but will be removed in future releases. Please use `snapctl application` instead of `snapctl game`.
+
+### New Features
+#### Snapend command
+- Added a new `snapend create` command to create a new Snapend instance using a manifest file.
+
+#### Snaps command
+- Added a new `snaps enumerate` command to get a list of all available snaps for your organization, including all the metadata and dependencies.
+
+#### Snapend Manifest commands
+- We have added a new command `snapend-manifest` that enables you to create CI/CD pipelines for your Snapend manifests. The command supports the following subcommands:
+  - `create`: Allows you to create a brand new manifest file by telling the command which snaps you want to include.
+  - `update`: Tells the snapctl to update your manifest file with a set of snaps and features. These are synced with the manifest file you pass.
+  - `upgrade`: Tells snapctl to upgrade all the snaps in the manifest or selected snaps to their latest versions.
+

snapctl/data/releases/1.1.1.mdx

@@ -0,0 +1,8 @@
+## Release 1.1.1
+##### Oct 15, 2025
+
+### Features
+1. Snapend manifest command now supports `sync` and `update` subcommands.
+
+### Bug Fixes
+1. The update command was always upgrading the auth snap to the latest version. This has now been fixed.

snapctl/main.py

@@ -8,12 +8,15 @@ from typing import Union
 import typer
 import pyfiglet
 
+from snapctl.commands.application import Application
 from snapctl.commands.byosnap import ByoSnap
 from snapctl.commands.byogs import ByoGs
 from snapctl.commands.game import Game
 from snapctl.commands.generate import Generate
 from snapctl.commands.snapend import Snapend
 from snapctl.commands.byows import Byows
+from snapctl.commands.snaps import Snaps
+from snapctl.commands.snapend_manifest import SnapendManifest
 from snapctl.commands.release_notes import ReleaseNotes
 from snapctl.config.constants import COMPANY_NAME, API_KEY, URL_KEY, CONFIG_FILE_MAC, \
     CONFIG_FILE_WIN, DEFAULT_PROFILE, VERSION, SNAPCTL_SUCCESS, CONFIG_PATH_KEY, \
@@ -21,7 +24,7 @@ from snapctl.config.constants import COMPANY_NAME, API_KEY, URL_KEY, CONFIG_FILE
 from snapctl.config.endpoints import END_POINTS, GATEWAY_END_POINTS
 from snapctl.config.hashes import PROTOS_TYPES, SERVICE_IDS, \
     SNAPEND_MANIFEST_TYPES, SDK_TYPES
-from snapctl.utils.echo import error, success, info
+from snapctl.utils.echo import error, success, info, warning
 from snapctl.utils.helper import validate_api_key
 from snapctl.utils.telemetry import telemetry
 
@@ -504,8 +507,10 @@ def game(
     ),
 ) -> None:
     """
-      Game commands
+      Game commands - DEPRECATED: Use Application commands instead
     """
+    warning(
+        "Game commands have been deprecated. Please use Application commands instead.")
     validate_command_context(ctx)
     game_obj: Game = Game(
         subcommand=subcommand,
@@ -518,6 +523,42 @@ def game(
     raise typer.Exit(code=SNAPCTL_SUCCESS)
 
 
+@app.command()
+@telemetry("application", subcommand_arg="subcommand")
+def application(
+    ctx: typer.Context,
+    # Required fields
+    subcommand: str = typer.Argument(
+        ..., help="Application Subcommands: " + ", ".join(Application.SUBCOMMANDS) + "."
+    ),
+    # name
+    name: str = typer.Option(
+        None, "--name",
+        help=("(req: create) Name of your application: ")
+    ),
+    # 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 from the Snapser config to use.", callback=profile_context_callback
+    ),
+) -> None:
+    """
+      Application commands
+    """
+    validate_command_context(ctx)
+    application_obj: Application = Application(
+        subcommand=subcommand,
+        base_url=ctx.obj['base_url'],
+        api_key=ctx.obj['api_key'],
+        name=name
+    )
+    getattr(application_obj, subcommand.replace('-', '_'))()
+    success(f"Application {subcommand} complete")
+    raise typer.Exit(code=SNAPCTL_SUCCESS)
+
+
 @app.command()
 @telemetry("generate", subcommand_arg="subcommand")
 def generate(
@@ -581,12 +622,16 @@ def snapend(
     # enumerate
     game_id: str = typer.Option(
         None, "--game-id",
-        help="(req: enumerate, clone) Game Id"
+        help="(DEPRECATED: Use --application-id instead) Game Id"
+    ),
+    application_id: str = typer.Option(
+        None, "--application-id",
+        help="(req: enumerate, create, clone) Application Id"
     ),
     # apply, clone
     manifest_path_filename: str = typer.Option(
         None, "--manifest-path-filename",
-        help="(req: apply|clone) Full Path to the manifest file including the filename."
+        help="(req: create|apply|clone) Full Path to the manifest file including the filename."
     ),
     force: bool = typer.Option(
         False, "--force",
@@ -627,7 +672,7 @@ def snapend(
             "--http-lib " + Snapend.get_http_formats_str()
         )
     ),
-    snaps: Union[str, None] = typer.Option(
+    snaps_list_str: Union[str, None] = typer.Option(
         None, "--snaps",
         help=(
             "(optional: download) Comma separated list of snap ids to customize the "
@@ -637,15 +682,15 @@ def snapend(
     ),
     # Clone
     name: Union[str, None] = typer.Option(
-        None, "--name", help="(req: clone) Snapend name"),
+        None, "--name", help="(req: clone, optional: create) Snapend name"),
     env: Union[str, None] = typer.Option(
         None, "--env", help=(
-            "(req: clone) Snapend environment"
+            "(req: clone, optional: create) Snapend environment"
             "Environments: (" + ", ".join(Snapend.ENV_TYPES) + ")"
         )),
     # Download, Apply, Clone
     out_path: Union[str, None] = typer.Option(
-        None, "--out-path", help="(optional: download|apply|clone) Path to save the output file"),
+        None, "--out-path", help="(optional: create|download|apply|clone) Path to save the output file"),
     # update
     byosnaps_list: str = typer.Option(
         None, "--byosnaps",
@@ -687,7 +732,7 @@ def snapend(
         api_key=ctx.obj['api_key'],
         snapend_id=snapend_id,
         # Enumerate, Clone
-        game_id=game_id,
+        game_id=application_id if application_id is not None else game_id,
         # Clone
         name=name, env=env,
         # Apply, Clone
@@ -698,7 +743,7 @@ def snapend(
         category_format=category_format,
         category_type=category_type,
         category_http_lib=category_http_lib,
-        snaps=snaps,
+        snaps=snaps_list_str,
         # Download, Apply and Clone
         out_path=out_path,
         # Update
@@ -759,3 +804,129 @@ def byows(
     getattr(byows_obj, subcommand.replace('-', '_'))()
     success(f"BYOWs {subcommand} complete")
     raise typer.Exit(code=SNAPCTL_SUCCESS)
+
+
+@app.command()
+@telemetry("snaps", subcommand_arg="subcommand")
+def snaps(
+    ctx: typer.Context,
+    # Required fields
+    subcommand: str = typer.Argument(
+        ..., help="Snaps Subcommands: " + ", ".join(Snaps.SUBCOMMANDS) + "."
+    ),
+    out_path_filename: Union[str, None] = typer.Option(
+        None, "--out-path-filename", help=(
+            "(optional: enumerate) Path and filename to output the snaps list. The filename should end with .json."
+        )
+    ),
+    # 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 from the Snapser config to use.", callback=profile_context_callback
+    ),
+) -> None:
+    """
+      Bring your own workstation commands
+    """
+    validate_command_context(ctx)
+    snaps_obj: Snaps = Snaps(
+        subcommand=subcommand,
+        base_url=ctx.obj['base_url'],
+        api_key=ctx.obj['api_key'],
+        out_path_filename=out_path_filename,
+    )
+    getattr(snaps_obj, subcommand.replace('-', '_'))()
+    success(f"Snaps {subcommand} complete")
+    raise typer.Exit(code=SNAPCTL_SUCCESS)
+
+
+@app.command()
+@telemetry("snapend_manifest", subcommand_arg="subcommand")
+def snapend_manifest(
+    ctx: typer.Context,
+    # Required fields
+    subcommand: str = typer.Argument(
+        ..., help="Snapend Manifest Subcommands: " + ", ".join(SnapendManifest.SUBCOMMANDS) + "."
+    ),
+    name: Union[str, None] = typer.Option(
+        None, "--name", help="(req: create) Name for your snapend."
+    ),
+    env: Union[str, None] = typer.Option(
+        None, "--env", help=(
+            "(req: create) Environment for your snapend - " +
+            ", ".join(SnapendManifest.ENVIRONMENTS) + "."
+        )
+    ),
+    manifest_path_filename: Union[str, None] = typer.Option(
+        None, "--manifest-path-filename", help=(
+            "(req: sync, upgrade) Full Path to the manifest file including the filename."
+        )
+    ),
+    snaps_list_str: str = typer.Option(
+        None, "--snaps", help=(
+            "(use: create, sync, upgrade) Comma separated list of snap ids to add, sync or upgrade. "
+        )
+    ),
+    features: str = typer.Option(
+        None, "--features", help=(
+            "(use: create, sync) Comma separated list of feature flags to add, sync. "
+            "Features: " + ", ".join(SnapendManifest.FEATURES)
+        )
+    ),
+    add_snaps: str = typer.Option(
+        None, "--add-snaps", help=(
+            "(use: update) Comma separated list of snap ids to add. "
+        )
+    ),
+    remove_snaps: str = typer.Option(
+        None, "--remove-snaps", help=(
+            "(use: update) Comma separated list of snap ids to remove. "
+        )
+    ),
+    add_features: str = typer.Option(
+        None, "--add-features", help=(
+            "(use: update) Comma separated list of features to add. "
+        )
+    ),
+    remove_features: str = typer.Option(
+        None, "--remove-features", help=(
+            "(use: update) Comma separated list of features to remove. "
+        )
+    ),
+    out_path_filename: Union[str, None] = typer.Option(
+        None, "--out-path-filename", help=(
+            "(optional: enumerate) Path and filename to output the manifest. The filename should end with .json or .yaml"
+        )
+    ),
+    # 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 from the Snapser config to use.", callback=profile_context_callback
+    ),
+) -> None:
+    """
+      Bring your own workstation commands
+    """
+    validate_command_context(ctx)
+    snapend_manifest_obj: SnapendManifest = SnapendManifest(
+        subcommand=subcommand,
+        base_url=ctx.obj['base_url'],
+        api_key=ctx.obj['api_key'],
+        name=name,
+        environment=env,
+        manifest_path_filename=manifest_path_filename,
+        snaps=snaps_list_str,
+        features=features,
+        add_snaps=add_snaps,
+        remove_snaps=remove_snaps,
+        add_features=add_features,
+        remove_features=remove_features,
+        out_path_filename=out_path_filename,
+    )
+    getattr(snapend_manifest_obj, subcommand.replace('-', '_'))()
+    success(f"Snapend Manifest {subcommand} complete")
+    raise typer.Exit(code=SNAPCTL_SUCCESS)

snapctl/utils/exceptions.py

@@ -0,0 +1,8 @@
+'''
+Exceptions used in snapctl.
+'''
+
+
+class SnapendDownloadException(Exception):
+    """Raised when a Snapend download fails or is incomplete."""
+    pass

snapctl/utils/helper.py

@@ -3,6 +3,7 @@ Helper functions for snapctl
 """
 from typing import Union, Dict
 from pathlib import Path
+from collections import Counter
 import re
 import platform
 import os
@@ -49,7 +50,8 @@ def validate_api_key(base_url: str, api_key: Union[str, None]) -> bool:
     raise typer.Exit(code=SNAPCTL_CONFIGURATION_ERROR)
 
 
-def get_composite_token(base_url: str, api_key: Union[str, None], action: str, params: object) -> str:
+def get_composite_token(
+        base_url: str, api_key: Union[str, None], action: str, params: object) -> str:
     """
     This function exchanges the api_key for a composite token.
     """
@@ -203,3 +205,10 @@ def get_config_value(environment: str, key: str) -> str:
     if environment == '' or environment not in APP_CONFIG or key not in APP_CONFIG[environment]:
         return ''
     return APP_CONFIG[environment][key]
+
+
+def check_duplicates_in_list(items: list[str]) -> list[str]:
+    '''
+    Check for duplicates in a list and return the duplicate items
+    '''
+    return [k for k, v in Counter(items).items() if v > 1]