snapctl 0.49.2__tar.gz → 0.49.4__tar.gz

{snapctl-0.49.2 → snapctl-0.49.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.49.2
+Version: 0.49.4
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -34,10 +34,13 @@ Snapctl will be the best way for game studios to integrate Snapser into their bu
 1. Renamed SDK type `server` to `api-key` to be consistent with the Snapser Web app.
 
 ### Features
-1. Added support for Bring your own Workstation commands.
+1. Added support for Bring your own Workstation commands. This enables local debugging for your BYOSnaps while clients continue to access your cloud Snapend APIs.
 ```bash
 snapctl byows attach --snapend-id $snapend_id --byosnap-id $byosnap_id --http-port $http_port
 ```
+```bash
+snapctl byows reset --snapend-id $snapend_id
+```
 
 ## Requirements
 ### Python 3.X and Pip
@@ -845,4 +848,6 @@ snapctl generate credentials --category "ecr" --out-path $output_path
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
 | 95         | Generic byows error                                      |
+| 96         | Byows attach error                                       |
+| 97         | Byows reset error                                        |
 

{snapctl-0.49.2 → snapctl-0.49.4}/README.md

@@ -14,10 +14,13 @@ Snapctl will be the best way for game studios to integrate Snapser into their bu
 1. Renamed SDK type `server` to `api-key` to be consistent with the Snapser Web app.
 
 ### Features
-1. Added support for Bring your own Workstation commands.
+1. Added support for Bring your own Workstation commands. This enables local debugging for your BYOSnaps while clients continue to access your cloud Snapend APIs.
 ```bash
 snapctl byows attach --snapend-id $snapend_id --byosnap-id $byosnap_id --http-port $http_port
 ```
+```bash
+snapctl byows reset --snapend-id $snapend_id
+```
 
 ## Requirements
 ### Python 3.X and Pip
@@ -825,3 +828,5 @@ snapctl generate credentials --category "ecr" --out-path $output_path
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
 | 95         | Generic byows error                                      |
+| 96         | Byows attach error                                       |
+| 97         | Byows reset error                                        |

{snapctl-0.49.2 → snapctl-0.49.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snapctl"
-version = "0.49.2"
+version = "0.49.4"
 description = "Snapser CLI Tool"
 authors = ["Ajinkya Apte <aj@snapser.com>"]
 readme = "README.md"

{snapctl-0.49.2 → snapctl-0.49.4}/snapctl/commands/byows.py

@@ -6,23 +6,26 @@ import platform
 import subprocess
 import shutil
 import time
-import json
-from pathlib import Path
+import signal
+import functools
+import sys
 from typing import Union
 import threading
 import requests
 from requests.exceptions import RequestException, HTTPError
 from rich.progress import Progress, SpinnerColumn, TextColumn
 from snapctl.config.constants import SERVER_CALL_TIMEOUT, SNAPCTL_INPUT_ERROR, \
-    SNAPCTL_BYOWS_GENERIC_ERROR, SNAPCTL_DEPENDENCY_MISSING
+    SNAPCTL_BYOWS_GENERIC_ERROR, SNAPCTL_DEPENDENCY_MISSING, \
+    SNAPCTL_BYOWS_ATTACH_ERROR, SNAPCTL_BYOWS_RESET_ERROR
 from snapctl.utils.helper import snapctl_error, snapctl_success, get_dot_snapser_dir
 from snapctl.utils.echo import info, warning
 
+
 class Byows:
     """
       CLI commands exposed for a Bring your own Workstation
     """
-    SUBCOMMANDS = ['attach']
+    SUBCOMMANDS = ['attach', 'reset']
     SSH_FILE = 'id_snapser_byows_attach_ed25519'
     PORT_FORWARD_TTL = 3600 * 24 * 7
     BYOWS_ENV_FILE = 'byows_env_setup'
@@ -41,6 +44,7 @@ class Byows:
         self.byosnap_id: Union[str, None] = byosnap_id
         self.http_port: Union[int, None] = http_port
         self.grpc_port: Union[int, None] = grpc_port
+        self._ssh_process = None
         self.validate_input()
 
     def validate_input(self) -> None:
@@ -74,9 +78,14 @@ class Byows:
                 snapctl_error(
                     message="Missing Input. One of --http-port=$your_local_server_port or --grpc-port=$your_local_server_port is required.",
                     code=SNAPCTL_INPUT_ERROR)
-            
+        elif self.subcommand == 'reset':
+            if self.snapend_id is None or self.snapend_id == '':
+                snapctl_error(
+                    message="Missing Input --snapend-id=$your_snapend_id",
+                    code=SNAPCTL_INPUT_ERROR)
 
     # Static methods
+
     @staticmethod
     def stream_output(pipe):
         '''
@@ -90,11 +99,12 @@ class Byows:
     def _get_export_commands(snap_ids, port):
         '''
         Generate export commands for the given snap IDs and port.
+        Replace hyphens with underscores in environment variable names.
         '''
         env_vars = []
 
         for snap_id in snap_ids:
-            upper_id = snap_id.upper()
+            upper_id = snap_id.upper().replace("-", "_")
             env_vars.append(f"SNAPEND_{upper_id}_GRPC_URL=localhost:{port}")
             env_vars.append(
                 f"SNAPEND_{upper_id}_HTTP_URL=http://localhost:{port}")
@@ -112,11 +122,12 @@ class Byows:
     def _generate_env_file(snap_ids, port):
         '''
         Generate an environment file with the given snap IDs and port.
+        Replace hyphens with underscores in environment variable names.
         '''
         env_lines = []
 
         for snap_id in snap_ids:
-            upper_id = snap_id.upper()
+            upper_id = snap_id.upper().replace("-", "_")
             env_lines.append(
                 f"export SNAPEND_{upper_id}_GRPC_URL=localhost:{port}")
             env_lines.append(
@@ -174,6 +185,58 @@ class Byows:
         return f"HTTP Error {http_err.response.status_code}: {http_err.response.reason}\nResponse: {response.text.strip()}"
 
     # Private methods
+    def _terminate_ssh_process(self):
+        if hasattr(self, "_ssh_process") and self._ssh_process:
+            try:
+                self._ssh_process.terminate()
+                if self._ssh_process.poll() is None:
+                    self._ssh_process.wait(timeout=5)
+            except subprocess.TimeoutExpired:
+                warning("SSH process did not shut down gracefully.")
+
+    def _cleanup_files(self):
+        try:
+            dot_snapser_dir = get_dot_snapser_dir()
+            id_file = dot_snapser_dir / Byows.SSH_FILE
+            pub_file = dot_snapser_dir / f"{Byows.SSH_FILE}.pub"
+            if id_file.exists():
+                id_file.unlink()
+            if pub_file.exists():
+                pub_file.unlink()
+        except Exception as e:
+            warning(f"Cleanup warning: Failed to delete SSH key files – {e}")
+
+    def _handle_signal(self, signum, frame):
+        print(f"\nReceived signal {signum}. Cleaning up...", flush=True)
+        self._terminate_ssh_process()
+        self._cleanup_files()
+        try:
+            url = f"{self.base_url}/v1/snapser-api/byows/snapends/" + \
+                f"{self.snapend_id}/snaps/{self.byosnap_id}/enabled"
+            res = requests.put(
+                url, headers={'api-key': self.api_key}, json=False, timeout=SERVER_CALL_TIMEOUT)
+            res.raise_for_status()
+            info('Forwarding disabled')
+        except HTTPError as http_err:
+            snapctl_error(
+                message=Byows._format_portal_http_error(
+                    "Unable to disable BYOWs", http_err, res),
+                code=SNAPCTL_BYOWS_GENERIC_ERROR
+            )
+        except RequestException as req_err:
+            warning(
+                f"Response Status Code: {res.status_code}, Body: {res.text}")
+            snapctl_error(
+                message=f"Request Exception: Unable to disable BYOWs {req_err}",
+                code=SNAPCTL_BYOWS_GENERIC_ERROR
+            )
+        except Exception as e:
+            snapctl_error(
+                message=f"Unexpected error occurred: {e}",
+                code=SNAPCTL_BYOWS_GENERIC_ERROR
+            )
+        sys.exit(0)
+
     def _setup_port_forward(
             self, private_key, public_key, snapend_id, snap_id, port, reverse_port, reverse_grpc_port,
             incoming_http, incoming_grpc, outgoing_http, snap_ids, ssh_connect_addr) -> bool:
@@ -220,7 +283,7 @@ class Byows:
         ssh_command = [
             'ssh',
             '-q',
-            '-4', # use IPv4
+            '-4',  # use IPv4
             '-o', 'ServerAliveInterval=60',
             '-o', 'StrictHostKeyChecking=no',
             '-o', 'UserKnownHostsFile=/dev/null',
@@ -231,12 +294,13 @@ class Byows:
             '-R', f'{reverse_port}:localhost:{incoming_http}',
         ]
         if incoming_grpc:
-            ssh_command += ['-R', f'{reverse_grpc_port}:localhost:{incoming_grpc}']
+            ssh_command += ['-R',
+                            f'{reverse_grpc_port}:localhost:{incoming_grpc}']
         ssh_command += [ssh_host]
 
-        process = None
+        # process = None
         try:
-            process = subprocess.Popen(
+            self._ssh_process = subprocess.Popen(
                 ssh_command,
                 shell=False,
                 stdout=subprocess.PIPE,
@@ -247,9 +311,9 @@ class Byows:
             timeout_seconds = 5
             start_time = time.time()
             while True:
-                if process.poll() is not None:
+                if self._ssh_process.poll() is not None:
                     # Process exited early — likely an error
-                    stderr_output = process.stderr.read().decode().strip()
+                    stderr_output = self._ssh_process.stderr.read().decode().strip()
                     if stderr_output:
                         info(f"[SSH Error] {stderr_output}")
                     else:
@@ -263,60 +327,16 @@ class Byows:
 
             # Start background thread to stream live stderr
             threading.Thread(target=Byows.stream_output, args=(
-                process.stderr,), daemon=True).start()
+                self._ssh_process.stderr,), daemon=True).start()
 
             # Now block for the full tunnel lifetime
-            process.wait(timeout=Byows.PORT_FORWARD_TTL)
+            self._ssh_process.wait(timeout=Byows.PORT_FORWARD_TTL)
         except KeyboardInterrupt:
-            process.terminate()
-            try:
-                process.wait(timeout=5)
-            except subprocess.TimeoutExpired:
-                warning('SSH process did not shut down gracefully.')
-
-            info('Shutting down port forward...')
-
-            try:
-                url = f"{self.base_url}/v1/snapser-api/byows/snapends/" + \
-                    f"{self.snapend_id}/snaps/{self.byosnap_id}/enabled"
-                res = requests.put(
-                    url, headers={'api-key': self.api_key}, json=False, timeout=SERVER_CALL_TIMEOUT)
-                res.raise_for_status()
-                info('Forwarding disabled')
-            except HTTPError as http_err:
-                snapctl_error(
-                    message=Byows._format_portal_http_error(
-                        "Unable to disable BYOWs", http_err, res),
-                    code=SNAPCTL_BYOWS_GENERIC_ERROR
-                )
-                return False
-            except RequestException as req_err:
-                warning(
-                    f"Response Status Code: {res.status_code}, Body: {res.text}")
-                snapctl_error(
-                    message=f"Request Exception: Unable to disable BYOWs {req_err}",
-                    code=SNAPCTL_BYOWS_GENERIC_ERROR
-                )
-                return False
-            except Exception as e:
-                snapctl_error(
-                    message=f"Unexpected error occurred: {e}",
-                    code=SNAPCTL_BYOWS_GENERIC_ERROR
-                )
-                return False
-
+            self._handle_signal(signal.SIGINT, None)
+            return False
         except Exception as e:
             print('Error running SSH command:', e)
             return False
-        finally:
-            # Cleanup the SSH key files
-            # Only remove the files if they exist
-            try:
-                id_file.unlink()
-                pub_file.unlink()
-            except Exception as e:
-                warning(
-                    f"Cleanup warning: Failed to delete SSH key files – {e}")
         return True
 
     # Commands
@@ -330,7 +350,8 @@ class Byows:
             transient=True,
         )
         progress.start()
-        progress.add_task(description='Setting up BYOWs port forward...', total=None)
+        progress.add_task(
+            description='Setting up BYOWs port forward...', total=None)
         try:
             url = f"{self.base_url}/v1/snapser-api/byows/snapends/" + \
                 f"{self.snapend_id}/snaps/{self.byosnap_id}"
@@ -347,7 +368,6 @@ class Byows:
             res.raise_for_status()
             response_json = res.json()
 
-
             if res.ok and 'workstationPort' in response_json and \
                'workstationReversePort' in response_json and \
                'snapendId' in response_json and \
@@ -364,6 +384,16 @@ class Byows:
 
                 progress.stop()
 
+                info('Setting up signal handling')
+                # Set up signal handling for cleanup
+                signal.signal(signal.SIGINT, functools.partial(
+                    self._handle_signal))
+                signal.signal(signal.SIGTERM, functools.partial(
+                    self._handle_signal))
+                if hasattr(signal, "SIGBREAK"):
+                    signal.signal(signal.SIGBREAK,
+                                  functools.partial(self._handle_signal))
+                # Set up port forward
                 self._setup_port_forward(
                     response_json['proxyPrivateKey'],
                     response_json['proxyPublicKey'],
@@ -382,21 +412,56 @@ class Byows:
                     message='complete', progress=progress)
             snapctl_error(
                 message='Unable to setup port forward.',
-                code=SNAPCTL_BYOWS_GENERIC_ERROR, progress=progress)
+                code=SNAPCTL_BYOWS_ATTACH_ERROR, progress=progress)
         except HTTPError as http_err:
             snapctl_error(
                 message=Byows._format_portal_http_error(
                     "Unable to setup port forward", http_err, res),
-                code=SNAPCTL_BYOWS_GENERIC_ERROR, progress=progress)
-            snapctl_error(
-                message=f"Server Error: Unable to setup port forward {http_err}",
-                code=SNAPCTL_BYOWS_GENERIC_ERROR, progress=progress)
+                code=SNAPCTL_BYOWS_ATTACH_ERROR, progress=progress)
         except RequestException as e:
             snapctl_error(
                 message=f"Exception: Unable to setup port forward {e}",
-                code=SNAPCTL_BYOWS_GENERIC_ERROR, progress=progress)
+                code=SNAPCTL_BYOWS_ATTACH_ERROR, progress=progress)
+        finally:
+            progress.stop()
+
+    def reset(self) -> bool:
+        """
+          BYOWs reset
+        """
+        progress = Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        )
+        progress.start()
+        progress.add_task(
+            description='Resetting BYOWS for the Snapend...', total=None)
+        try:
+            url = f"{self.base_url}/v1/snapser-api/byows/snapends/" + \
+                f"{self.snapend_id}"
+            res = requests.delete(
+                url,
+                headers={'api-key': self.api_key},
+                timeout=SERVER_CALL_TIMEOUT,
+                json={
+                    "snapend_id": self.snapend_id,
+                }
+            )
+            res.raise_for_status()
+            if res.ok:
+                return snapctl_success(
+                    message='Reset complete', progress=progress)
+            snapctl_error(
+                message='Unable to reset BYOWS.',
+                code=SNAPCTL_BYOWS_RESET_ERROR, progress=progress)
+        except HTTPError as http_err:
+            snapctl_error(
+                message=f"Server Error: Unable to reset BYOWS {http_err}",
+                code=SNAPCTL_BYOWS_RESET_ERROR, progress=progress)
+        except RequestException as e:
+            snapctl_error(
+                message=f"Exception: Unable to reset BYOWS {e}",
+                code=SNAPCTL_BYOWS_RESET_ERROR, progress=progress)
         finally:
             progress.stop()
-        snapctl_error(
-            message='Failed to setup port forward.',
-            code=SNAPCTL_BYOWS_GENERIC_ERROR, progress=progress)

{snapctl-0.49.2 → snapctl-0.49.4}/snapctl/config/constants.py

@@ -3,7 +3,7 @@ Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
 VERSION_PREFIX = 'beta-'
-VERSION = '0.49.2'
+VERSION = '0.49.4'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
@@ -111,3 +111,5 @@ SNAPCTL_GENERATE_CREDENTIALS_ERROR = 81
 
 # BYOWs Errors - 95 - 99
 SNAPCTL_BYOWS_GENERIC_ERROR = 95
+SNAPCTL_BYOWS_ATTACH_ERROR = 96
+SNAPCTL_BYOWS_RESET_ERROR = 97

snapctl-0.49.4/snapctl/data/releases/beta-0.49.3.mdx

@@ -0,0 +1,7 @@
+## beta-0.49.3
+##### May 13, 2025
+
+### Feature
+#### Bring your own workstation (BYOW)
+- Now supports a new subcommand `snapctl byows reset --snapend-id $snapendId` to reset the BYOW configuration. Useful when you want a clean slate.
+

snapctl-0.49.4/snapctl/data/releases/beta-0.49.4.mdx

@@ -0,0 +1,8 @@
+## beta-0.49.4
+##### May 20, 2025
+
+### Bug Fixes
+
+#### Bring your own workstation (BYOW)
+- Environment exports no longer include hyphens in the variable names.
+

{snapctl-0.49.2 → snapctl-0.49.4}/snapctl/main.py

@@ -110,6 +110,7 @@ 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
@@ -124,6 +125,7 @@ def get_base_snapend_url(api_key: Union[str, None]) -> str:
         return GATEWAY_END_POINTS['SANDBOX']
     return GATEWAY_END_POINTS['LIVE']
 
+
 def validate_command_context(
         ctx: typer.Context,
 ):
@@ -692,7 +694,7 @@ def byows(
     # attach
     snapend_id: str = typer.Option(
         None, "--snapend-id",
-        help=("(req: attach) Your Snapend Id")
+        help=("(req: attach, reset) Your Snapend Id")
     ),
     byosnap_id: str = typer.Option(
         None, "--byosnap-id",