snapctl 0.48.0__py3-none-any.whl → 0.49.0__py3-none-any.whl

snapctl/config/constants.py

@@ -3,7 +3,7 @@ Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
 VERSION_PREFIX = 'beta-'
-VERSION = '0.48.0'
+VERSION = '0.49.0'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
@@ -27,6 +27,7 @@ HTTP_ERROR_SERVICE_VERSION_EXISTS = 542
 HTTP_ERROR_SERVICE_IN_USE = 543
 HTTP_ERROR_TAG_NOT_AVAILABLE = 544
 HTTP_ERROR_ADD_ON_NOT_ENABLED = 547
+HTTP_ERROR_SNAPEND_MANIFEST_MISMATCH = 594
 
 # CLI Return Codes
 SNAPCTL_SUCCESS = 0
@@ -49,7 +50,7 @@ SNAPCTL_BYOGS_PUBLISH_ERROR = 25
 SNAPCTL_BYOGS_PUBLISH_PERMISSION_ERROR = 26
 SNAPCTL_BYOGS_PUBLISH_DUPLICATE_TAG_ERROR = 27
 
-# BYOSNAP Errors - 30 - 49 then 86 - 99
+# BYOSNAP Errors - 30 - 49 then 86 - 90
 SNAPCTL_BYOSNAP_NOT_FOUND = SNAPCTL_RESOURCE_NOT_FOUND
 SNAPCTL_BYOSNAP_GENERIC_ERROR = 30
 SNAPCTL_BYOSNAP_DEPENDENCY_MISSING = 31
@@ -102,7 +103,11 @@ SNAPCTL_SNAPEND_UPDATE_ERROR = 72
 SNAPCTL_SNAPEND_UPDATE_SERVER_ERROR = 73
 SNAPCTL_SNAPEND_UPDATE_TIMEOUT_ERROR = 74
 SNAPCTL_SNAPEND_STATE_ERROR = 75
+SNAPCTL_SNAPEND_APPLY_MANIFEST_MISMATCH_ERROR = 76
 
 # Generate Errors - 80 - 85
 SNAPCTL_GENERATE_GENERIC_ERROR = 80
 SNAPCTL_GENERATE_CREDENTIALS_ERROR = 81
+
+# BYOWs Errors - 95 - 99
+SNAPCTL_BYOWS_GENERIC_ERROR = 95

snapctl/config/endpoints.py

@@ -9,3 +9,8 @@ END_POINTS: Dict[str, str] = {
     'PLAYTEST': 'https://gateway.dev.snapser.io/playtest',
     'PROD': 'https://gateway.snapser.com/snapser'
 }
+
+GATEWAY_END_POINTS: Dict[str, str] = {
+    'SANDBOX': 'https://gateway.dev.snapser.io',
+    'LIVE': 'https://gateway-accel.snapser.com',
+}

snapctl/config/hashes.py

@@ -189,11 +189,15 @@ SERVICE_IDS: List[str] = [
 ]
 
 SDK_ACCESS_AUTH_TYPE_LOOKUP: Dict[str, Dict[str, str]] = {
+    # 'omni': {
+    #     'access_type': 'external',
+    #     'auth_type': 'omni'
+    # },
     'user': {
         'access_type': 'external',
         'auth_type': 'user'
     },
-    'server': {
+    'api-key': {
         'access_type': 'external',
         'auth_type': 'api-key'
     },

snapctl/data/releases/beta-0.49.0.mdx

@@ -0,0 +1,12 @@
+## beta-0.49.0
+##### May 9, 2025
+
+### Breaking Change
+1. Renamed SDK type `server` to `api-key` to be consistent with the Snapser Web app.
+
+### Features
+1. You can now download the new Omni SDK via Snapctl.
+
+### Bug Fixes
+1. The `snapctl byosnap generate-profile` command was not working when outside the root snapctl folder. This is now fixed.
+2. The `snapctl release-notes` commands were not working when outside the root snapctl folder. This is now fixed.

snapctl/main.py

@@ -14,11 +14,12 @@ 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.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, \
     SNAPCTL_CONFIGURATION_INCORRECT, VERSION_PREFIX
-from snapctl.config.endpoints import END_POINTS
+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
@@ -109,6 +110,19 @@ def get_base_url(api_key: Union[str, None]) -> str:
         return END_POINTS['PLAYTEST']
     return END_POINTS['PROD']
 
+def get_base_snapend_url(api_key: Union[str, None]) -> str:
+    """
+        Returns the base url for snapend based on the api_key
+    """
+    if api_key is None:
+        return ''
+    if api_key.startswith('dev_'):
+        return GATEWAY_END_POINTS['SANDBOX']
+    if api_key.startswith('devtwo_'):
+        return GATEWAY_END_POINTS['SANDBOX']
+    if api_key.startswith('playtest_'):
+        return GATEWAY_END_POINTS['SANDBOX']
+    return GATEWAY_END_POINTS['LIVE']
 
 def validate_command_context(
         ctx: typer.Context,
@@ -139,6 +153,7 @@ def default_context_callback(ctx: typer.Context):
     ctx.obj['api_key_location'] = api_key_obj['location']
     ctx.obj['profile'] = DEFAULT_PROFILE
     ctx.obj['base_url'] = get_base_url(api_key_obj['value'])
+    ctx.obj['base_snapend_url'] = get_base_snapend_url(api_key_obj['value'])
 
 
 def api_key_context_callback(
@@ -546,6 +561,10 @@ def snapend(
         None, "--manifest-path-filename",
         help="(req: apply|clone) Full Path to the manifest file including the filename."
     ),
+    force: bool = typer.Option(
+        False, "--force",
+        help="(optional: apply) If true, Snapser will ignore the configuration diff validation and allow to force apply the manifest."
+    ),
     # download
     category: str = typer.Option(
         None, "--category",
@@ -646,6 +665,7 @@ def snapend(
         name=name, env=env,
         # Apply, Clone
         manifest_path_filename=manifest_path_filename,
+        force=force,
         # Download
         category=category,
         category_format=category_format,
@@ -660,3 +680,54 @@ def snapend(
     getattr(snapend_obj, subcommand.replace('-', '_'))()
     success(f"Snapend {subcommand} complete")
     raise typer.Exit(code=SNAPCTL_SUCCESS)
+
+
+@app.command()
+def byows(
+    ctx: typer.Context,
+    # Required fields
+    subcommand: str = typer.Argument(
+        ..., help="Byows Subcommands: " + ", ".join(Byows.SUBCOMMANDS) + "."
+    ),
+    # attach
+    snapend_id: str = typer.Option(
+        None, "--snapend-id",
+        help=("(req: attach) Your Snapend Id")
+    ),
+    byosnap_id: str = typer.Option(
+        None, "--byosnap-id",
+        help=("(req: attach) Your BYOSnap Id")
+    ),
+    http_port: str = typer.Option(
+        None, "--http-port",
+        help=("(oneof: attach) HTTP port of your local server. One of --http-port or --grpc-port is required.")
+    ),
+    grpc_port: str = typer.Option(
+        None, "--grpc-port",
+        help=("(oneof: attach) gRPC port of your local server. One of --http-port or --grpc-port is required.")
+    ),
+    # 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)
+    byows_obj: Byows = Byows(
+        subcommand=subcommand,
+        base_url=ctx.obj['base_url'],
+        base_snapend_url=ctx.obj['base_snapend_url'],
+        api_key=ctx.obj['api_key'],
+        snapend_id=snapend_id,
+        byosnap_id=byosnap_id,
+        http_port=http_port,
+        grpc_port=grpc_port,
+    )
+    getattr(byows_obj, subcommand.replace('-', '_'))()
+    success(f"BYOWs {subcommand} complete")
+    raise typer.Exit(code=SNAPCTL_SUCCESS)

snapctl/utils/helper.py

@@ -14,6 +14,7 @@ from snapctl.config.constants import HTTP_NOT_FOUND, HTTP_FORBIDDEN, HTTP_UNAUTH
     SERVER_CALL_TIMEOUT, SNAPCTL_CONFIGURATION_ERROR, SNAPCTL_SUCCESS
 from snapctl.config.hashes import ARCHITECTURE_MAPPING
 from snapctl.utils.echo import error, success
+from pathlib import Path
 
 
 def validate_api_key(base_url: str, api_key: Union[str, None]) -> bool:
@@ -183,3 +184,11 @@ def check_use_containerd_snapshotter() -> bool:
         return False
     except Exception:
         return False
+
+def get_dot_snapser_dir() -> Path:
+    """
+    Returns the .snapser configuration directory, creating it if necessary.
+    """
+    config_dir = Path.home() / ".snapser"
+    config_dir.mkdir(parents=True, exist_ok=True)
+    return config_dir