snapctl 0.22.3__py3-none-any.whl → 0.26.1__py3-none-any.whl

snapctl/commands/byogs.py

@@ -161,16 +161,18 @@ class ByoGs:
             ) as progress:
                 progress.add_task(
                     description='Building your snap...', total=None)
+                docker_file_path = f"{self.path}/{self.dockerfile}"
                 if platform == "win32":
                     response = subprocess.run([
                         # f"docker build --no-cache -t {tag} {path}"
-                        'docker', 'build', '--platform', build_platform, '-t', image_tag, self.path
+                        'docker', 'build', '--platform', build_platform, '-t', image_tag,
+                        '-f', docker_file_path,  self.path
                     ], shell=True, check=False)
                     # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
                 else:
                     response = subprocess.run([
                         # f"docker build --no-cache -t {tag} {path}"
-                        f"docker build --platform {build_platform} -t {image_tag} {self.path}"
+                        f"docker build --platform {build_platform} -t {image_tag} -f {docker_file_path} {self.path}"
                     ], shell=True, check=False)
                     # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
                 if response.returncode:

snapctl/commands/byosnap.py

@@ -169,16 +169,18 @@ class ByoSnap:
             ) as progress:
                 progress.add_task(
                     description='Building your snap...', total=None)
+                docker_file_path = f"{self.path}/{self.dockerfile}"
                 if platform == "win32":
                     response = subprocess.run([
                         # f"docker build --no-cache -t {tag} {path}"
-                        'docker', 'build', '--platform', build_platform, '-t', image_tag, self.path
+                        'docker', 'build', '--platform', build_platform, '-t', image_tag,
+                        '-f', docker_file_path,  self.path
                     ], shell=True, check=False)
                     # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
                 else:
                     response = subprocess.run([
                         # f"docker build --no-cache -t {tag} {path}"
-                        f"docker build --platform {build_platform} -t {image_tag} {self.path}"
+                        f"docker build --platform {build_platform} -t {image_tag} -f {docker_file_path} {self.path}"
                     ], shell=True, check=False)
                     # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
                 if response.returncode:

snapctl/commands/game.py

@@ -0,0 +1,107 @@
+"""
+  Snapend CLI commands
+"""
+import requests
+from requests.exceptions import RequestException
+
+from rich.progress import Progress, SpinnerColumn, TextColumn
+from snapctl.config.constants import SERVER_CALL_TIMEOUT
+from snapctl.types.definitions import ResponseType
+from snapctl.utils.echo import error, success
+
+
+class Game:
+    """
+      CLI commands exposed for a Game
+    """
+    SUBCOMMANDS = ['create', 'enumerate']
+
+    def __init__(
+            self, subcommand: str, base_url: str, api_key: str | None, name: str | None
+    ) -> None:
+        self.subcommand: str = subcommand
+        self.base_url: str = base_url
+        self.api_key: str = api_key
+        self.name: str | None = name
+
+    def validate_input(self) -> ResponseType:
+        """
+          Validator
+        """
+        response: ResponseType = {
+            'error': True,
+            'msg': '',
+            'data': []
+        }
+        # Check API Key and Base URL
+        if not self.api_key or self.base_url == '':
+            response['msg'] = "Missing API Key."
+            return response
+        # Check subcommand
+        if not self.subcommand in Game.SUBCOMMANDS:
+            response['msg'] = \
+                f"Invalid command. Valid commands are {', '.join(Game.SUBCOMMANDS)}."
+            return response
+        # Check sdk-download commands
+        if self.subcommand == 'create':
+            if self.name is None or self.name == '':
+                response['msg'] = "Missing game name."
+                return response
+        # Send success
+        response['error'] = False
+        return response
+
+    def create(self) -> bool:
+        """
+          Create a game
+        """
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        ) as progress:
+            progress.add_task(
+                description='Creating a new game on Snapser...', total=None)
+            try:
+                url = f"{self.base_url}/v1/snapser-api/games"
+                payload = {
+                    'name': self.name
+                }
+                res = requests.post(
+                    url, headers={'api-key': self.api_key},
+                    json=payload, timeout=SERVER_CALL_TIMEOUT
+                )
+                if res.ok:
+                    success(f"Game {self.name} has been created successfully.")
+                    return True
+                error('Unable to create a new game. Reason: ' + res.text)
+            except RequestException as e:
+                error(f"Exception: Unable to download the SDK {e}")
+            return False
+
+    def enumerate(self) -> bool:
+        """
+          Enumerate all games
+        """
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        ) as progress:
+            progress.add_task(
+                description='Enumerating all your games...', total=None)
+            try:
+                url = f"{self.base_url}/v1/snapser-api/games"
+                res = requests.get(
+                    url, headers={'api-key': self.api_key},
+                    timeout=SERVER_CALL_TIMEOUT
+                )
+                response_json = res.json()
+                if res.ok:
+                    if 'games' in response_json:
+                        success(response_json['games'])
+                        return True
+                error(response_json)
+            except RequestException as e:
+                error(f"Exception: Unable to update your snapend {e}")
+            return False

snapctl/commands/snapend.py

@@ -5,13 +5,15 @@ from sys import platform
 from typing import Union
 
 import os
+import json
 import time
 import requests
 from requests.exceptions import RequestException
 
 from rich.progress import Progress, SpinnerColumn, TextColumn
 from snapctl.config.constants import SERVER_CALL_TIMEOUT
-from snapctl.config.hashes import CLIENT_SDK_TYPES, SERVER_SDK_TYPES, PROTOS_TYPES
+from snapctl.config.hashes import CLIENT_SDK_TYPES, SERVER_SDK_TYPES, PROTOS_TYPES, \
+    SNAPEND_MANIFEST_TYPES
 from snapctl.types.definitions import ResponseType
 from snapctl.utils.echo import error, success, info
 
@@ -20,38 +22,69 @@ class Snapend:
     """
       CLI commands exposed for a Snapend
     """
-    SUBCOMMANDS = ['download', 'update', 'state']
+    SUBCOMMANDS = [
+        'enumerate', 'clone', 'apply',
+        'download', 'update', 'state'
+    ]
     DOWNLOAD_CATEGORY = [
-        'client-sdk', 'server-sdk', 'protos', 'admin-settings'
+        'client-sdk', 'server-sdk', 'protos', 'admin-settings', 'snapend-manifest'
     ]
     DOWNLOAD_TYPE_NOT_REQUIRED = ['admin-settings']
     AUTH_TYPES = ['user', 'app']
+    ENV_TYPES = ['DEVELOPMENT', 'STAGING']
     BLOCKING_CALL_SLEEP = 5
-    MAX_BLOCKING_RETRIES = 24
+    MAX_BLOCKING_RETRIES = 120
 
     def __init__(
-        self, subcommand: str, base_url: str, api_key: str | None, snapend_id: str, category: str,
-        platform_type: str, auth_type: str,  path: Union[str, None], snaps: Union[str, None],
-        byosnaps: Union[str, None], byogs: Union[str, None], blocking: bool = False
+        self, subcommand: str, base_url: str, api_key: str | None, snapend_id: str | None,
+        # Enumerate, Clone
+        game_id: str | None,
+        # Clone
+        name: str | None,
+        env: str | None,
+        # Clone, Apply, Promote
+        manifest_path: str | None,
+        # Download
+        category: str, platform_type: str, auth_type: str, snaps: str | None,
+        # Clone, Apply, Promote, Download
+        out_path: str | None,
+        # Update
+        byosnaps: str | None, byogs: str | None, blocking: bool = False
     ) -> None:
         self.subcommand: str = subcommand
         self.base_url: str = base_url
         self.api_key: str = api_key
         self.snapend_id: str = snapend_id
+        self.game_id: str | None = game_id
+        self.name: str = name
+        self.env: str = env
+        self.manifest_path: str | None = manifest_path
+        self.manifest_file_name: str | None = Snapend._get_manifest_file_name(
+            manifest_path
+        )
         self.category: str = category
         self.download_types: Union[
             dict[str, dict[str, str]], None
         ] = Snapend._make_download_type(category)
         self.auth_type: str = auth_type
         self.platform_type: str = platform_type
-        self.path: Union[str, None] = path
-        self.snaps: Union[str, None] = snaps
+        self.out_path: str | None = out_path
+        self.snaps: str | None = snaps
         self.byosnap_list: Union[list, None] = Snapend._make_byosnap_list(
             byosnaps) if byosnaps else None
-        self.byogs_list: Union[str, None] = Snapend._make_byogs_list(
+        self.byogs_list: str | None = Snapend._make_byogs_list(
             byogs) if byogs else None
         self.blocking: bool = blocking
 
+    @staticmethod
+    def _get_manifest_file_name(manifest_path: str) -> str | None:
+        if manifest_path and manifest_path != '' and os.path.isfile(manifest_path):
+            file_name = os.path.basename(manifest_path)
+            if file_name.endswith('.json') or file_name.endswith('.yml') or \
+                    file_name.endswith('.yaml'):
+                return file_name
+        return None
+
     @staticmethod
     def _make_download_type(category: str):
         if category == 'client-sdk':
@@ -60,6 +93,8 @@ class Snapend:
             return SERVER_SDK_TYPES
         if category == 'protos':
             return PROTOS_TYPES
+        if category == 'snapend-manifest':
+            return SNAPEND_MANIFEST_TYPES
         return None
 
     @staticmethod
@@ -112,16 +147,88 @@ class Snapend:
                 error("Going past maximum tries. Exiting...")
                 return False
             current_state = self._get_snapend_state()
-            if current_state == 'INVALID':
-                error("Unable to get the snapend state. Exiting...")
+            if current_state != 'IN_PROGRESS':
+                if current_state == 'LIVE':
+                    success('Updated your snapend. Your snapend is Live.')
+                    return True
+                error(
+                    f"Update not completed successfully. Your Snapend status is {current_state}.")
                 return False
-            if current_state == 'LIVE':
-                success('Updated your snapend. Your snapend is Live.')
-                return True
             info(f'Current snapend state is {current_state}')
             info(f"Retrying in {Snapend.BLOCKING_CALL_SLEEP} seconds...")
             time.sleep(Snapend.BLOCKING_CALL_SLEEP)
 
+    def _assign_snapend_id(self, snapend_id: str) -> None:
+        self.snapend_id = snapend_id
+
+    def _setup_for_download(self, platform_type: str) -> bool:
+        '''
+            Called by subcommands that want to initiate a download of the new manifest post update
+        '''
+        download_category: str = 'snapend-manifest'
+        self.category = download_category
+        self.platform_type = platform_type
+        self.download_types: Union[
+            dict[str, dict[str, str]], None
+        ] = Snapend._make_download_type(download_category)
+
+    def _execute_download(self) -> bool:
+        try:
+            url = (
+                f"{self.base_url}/v1/snapser-api/snapends/{self.snapend_id}/"
+                f"download?category={self.category}"
+            )
+            if self.category not in Snapend.DOWNLOAD_TYPE_NOT_REQUIRED:
+                url += (
+                    f"&type={self.download_types[self.platform_type]['type']}"
+                    f"&subtype={self.download_types[self.platform_type]['subtype']}"
+                )
+            url_auth_type: str = 'user'
+            if self.category == 'server-sdk' and self.auth_type == 'app':
+                url_auth_type = 'app'
+            url += f"&auth_type={url_auth_type}"
+            if self.snaps:
+                url += f"&snaps={self.snaps}"
+            res = requests.get(
+                url, headers={'api-key': self.api_key}, timeout=SERVER_CALL_TIMEOUT
+            )
+            fn: str = ''
+            if self.category == 'admin-settings':
+                fn = f"snapser-{self.snapend_id}-admin-settings.json"
+            elif self.category == 'snapend-manifest':
+                fn = (
+                    f"snapser-{self.snapend_id}-"
+                    f"manifest.{self.download_types[self.platform_type]['type']}"
+                )
+            else:
+                fn = (
+                    f"snapser-{self.snapend_id}-{self.category}"
+                    f"-{self.platform_type}-{self.auth_type}.zip"
+                )
+            file_path_symbol = '/'
+            if platform == 'win32':
+                file_path_symbol = '\\'
+            if self.out_path is not None:
+                file_save_path = f"{self.out_path}{file_path_symbol}{fn}"
+            else:
+                file_save_path = f"{os.getcwd()}{file_path_symbol}{fn}"
+            if res.ok:
+                content: bytes = res.content
+                with open(file_save_path, "wb") as file:
+                    if self.category in ['admin-settings']:
+                        content = json.loads(res.content)
+                        json.dump(content, file, indent=4)
+                    else:
+                        file.write(res.content)
+                success(f"{self.category} saved at {file_save_path}")
+                return True
+            error(f'Unable to download {self.category}')
+        except RequestException as e:
+            error(
+                f"Exception: Unable to download {self.category}. Reason: {e}"
+            )
+        return False
+
     def validate_input(self) -> ResponseType:
         """
           Validator
@@ -140,8 +247,34 @@ class Snapend:
             response['msg'] = \
                 f"Invalid command. Valid commands are {', '.join(Snapend.SUBCOMMANDS)}."
             return response
-        # Check sdk-download commands
-        if self.subcommand == 'download':
+        if self.subcommand == 'enumerate':
+            if not self.game_id:
+                response['msg'] = "Missing required parameter: game_id"
+                return response
+        elif self.subcommand == 'clone':
+            if not self.game_id:
+                response['msg'] = "Missing required parameter: game_id"
+                return response
+            if not self.name:
+                response['msg'] = "Missing required parameter: name"
+                return response
+            if self.env.upper() not in Snapend.ENV_TYPES:
+                response['msg'] = (
+                    "Invalid environment. Valid environments are "
+                    f"{', '.join(Snapend.ENV_TYPES)}."
+                )
+                return response
+            if not self.manifest_path:
+                response['msg'] = "Missing required parameter: manifest_path"
+                return response
+        elif self.subcommand == 'apply':
+            if not self.manifest_path:
+                response['msg'] = "Missing required parameter: manifest_path"
+                return response
+            if not self.manifest_file_name:
+                response['msg'] = "Invalid manifest file. Supported formats are .json, .yml, .yaml"
+                return response
+        elif self.subcommand == 'download':
             if self.category not in Snapend.DOWNLOAD_CATEGORY:
                 response['msg'] = (
                     "Invalid SDK category. Valid categories are "
@@ -153,10 +286,10 @@ class Snapend:
                 response['msg'] = "Invalid Download type."
                 return response
             # Check file path
-            if self.path and not os.path.isdir(f"{self.path}"):
+            if self.out_path and not os.path.isdir(f"{self.out_path}"):
                 response['msg'] = (
-                    f"Invalid path {self.path}. "
-                    "Please enter a valid path to save your SDK"
+                    f"Invalid path {self.out_path}. "
+                    "Please enter a valid path to save your output file"
                 )
                 return response
             # Check the auth type
@@ -166,6 +299,10 @@ class Snapend:
                     f"{', '.join(Snapend.AUTH_TYPES)}."
                 )
                 return response
+        elif self.subcommand == 'promote':
+            if not self.snapend_id:
+                response['msg'] = "Missing required parameter: snapend_id"
+                return response
         # Check update commands
         elif self.subcommand == 'update':
             byosnap_present = True
@@ -181,9 +318,10 @@ class Snapend:
         response['error'] = False
         return response
 
-    def download(self) -> bool:
+    ## Subcommands ##
+    def enumerate(self) -> bool:
         """
-          Download SDKs, Protos and Admin Settings
+          List Snapends
         """
         with Progress(
             SpinnerColumn(),
@@ -191,46 +329,217 @@ class Snapend:
             transient=True,
         ) as progress:
             progress.add_task(
-                description=f'Downloading your Custom {self.category}...', total=None)
+                description='Enumerating all your game snapends...', total=None)
             try:
-                url = (
-                    f"{self.base_url}/v1/snapser-api/snapends/{self.snapend_id}/"
-                    f"download?category={self.category}"
-                )
-                if self.category not in Snapend.DOWNLOAD_TYPE_NOT_REQUIRED:
-                    url += (
-                        f"&type={self.download_types[self.platform_type]['type']}"
-                        f"&subtype={self.download_types[self.platform_type]['subtype']}"
-                    )
-                url_auth_type: str = 'user'
-                if self.category == 'server-sdk' and self.auth_type == 'app':
-                    url_auth_type = 'app'
-                url += f"&auth_type={url_auth_type}"
-                if self.snaps:
-                    url += f"&snaps={self.snaps}"
+                url = f"{self.base_url}/v1/snapser-api/snapends?game_id={self.game_id}"
                 res = requests.get(
-                    url, headers={'api-key': self.api_key}, timeout=SERVER_CALL_TIMEOUT
+                    url, headers={'api-key': self.api_key},
+                    timeout=SERVER_CALL_TIMEOUT
                 )
-                fn: str = f"snapser-{self.snapend_id}-admin-settings.json"
-                if self.category != 'admin-settings':
-                    fn = f"snapser-{self.snapend_id}-{self.category}-{self.platform_type}-{self.auth_type}.zip"
-                file_path_symbol = '/'
-                if platform == 'win32':
-                    file_path_symbol = '\\'
-                if self.path is not None:
-                    sdk_save_path = f"{self.path}{file_path_symbol}{fn}"
-                else:
-                    sdk_save_path = f"{os.getcwd()}{file_path_symbol}{fn}"
+                response_json = res.json()
                 if res.ok:
-                    with open(sdk_save_path, "wb") as file:
-                        file.write(res.content)
-                    success(f"SDK saved at {sdk_save_path}")
-                    return True
-                error('Unable to download your custom SDK')
+                    if 'clusters' in response_json:
+                        success(response_json['clusters'])
+                        return True
+                error(response_json)
+            except RequestException as e:
+                error(f"Exception: Unable to update your snapend {e}")
+            return False
+
+    def clone(self) -> bool:
+        """
+          Create a Snapend from a manifest
+        """
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        ) as progress:
+            progress.add_task(
+                description='Applying your manifest...', total=None)
+            try:
+                with open(self.manifest_path, 'rb') as file:
+                    files = {'snapend-manifest': file}
+                    payload = {
+                        'game_id': self.game_id,
+                        'name': self.name,
+                        'env': self.env.upper(),
+                        'ext': self.manifest_file_name.split('.')[-1]
+                    }
+                    url = f"{self.base_url}/v1/snapser-api/snapends/snapend-manifest"
+                    res = requests.post(
+                        url, headers={'api-key': self.api_key},
+                        files=files, data=payload, timeout=SERVER_CALL_TIMEOUT
+                    )
+                    if res.ok:
+                        # extract the cluster ID
+                        response = res.json()
+                        if 'cluster' not in response or 'id' not in response['cluster']:
+                            error(
+                                'Something went wrong. Please try again in sometime.'
+                            )
+                            return False
+                        self._assign_snapend_id(response['cluster']['id'])
+                        info(
+                            f"Cluster ID assigned: {response['cluster']['id']}")
+                        if self.blocking:
+                            status = self._blocking_get_status()
+                            # Fetch the new manifest
+                            if status is True:
+                                # TODO: Uncomment this if we want to do an auto download
+                                # self._setup_for_download(
+                                #     self.manifest_file_name.split('.')[-1])
+                                # self._execute_download()
+                                info(
+                                    'Do not forget to download the latest manifest.'
+                                )
+                                return True
+                            info(
+                                'Snapend clone has been initiated but the Snapend is not up yet.'
+                                'Please try checking the status of the Snapend in some time'
+                            )
+                            return False
+                        info(
+                            "Snapend clone has been initiated. "
+                            "You can check the status using "
+                            f"`snapctl snapend state --snapend-id {response['cluster']['id']}`"
+                        )
+                        return True
+                    error('Unable to apply the manifest. Reason: ' + res.text)
+            except RequestException as e:
+                error(f"Exception: Unable to apply the manifest snapend {e}")
+            return False
+
+    def apply(self) -> bool:
+        """
+          Apply a manifest
+        """
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        ) as progress:
+            progress.add_task(
+                description='Applying your manifest...', total=None)
+            try:
+                with open(self.manifest_path, 'rb') as file:
+                    files = {'snapend-manifest': file}
+                    payload = {
+                        'ext': self.manifest_file_name.split('.')[-1]
+                    }
+                    url = f"{self.base_url}/v1/snapser-api/snapends/snapend-manifest"
+                    res = requests.put(
+                        url, headers={'api-key': self.api_key},
+                        files=files, data=payload, timeout=SERVER_CALL_TIMEOUT
+                    )
+                    if res.ok:
+                        # extract the cluster ID
+                        response = res.json()
+                        if 'cluster' not in response or 'id' not in response['cluster']:
+                            error(
+                                'Something went wrong. Please try again in sometime.'
+                            )
+                            return False
+                        self._assign_snapend_id(response['cluster']['id'])
+                        if self.blocking:
+                            status = self._blocking_get_status()
+                            # Fetch the new manifest
+                            if status is True:
+                                # TODO: Uncomment this if we want to do an auto download
+                                # self._setup_for_download(
+                                #     self.manifest_file_name.split('.')[-1])
+                                # self._execute_download()
+                                info(
+                                    'Do not forget to download the latest manifest.'
+                                )
+                                return True
+                            info(
+                                'Snapend apply has been initiated but the Snapend is not up yet.'
+                                'Please try checking the status of the Snapend in some time'
+                            )
+                            return False
+                        info(
+                            "Snapend apply has been initiated. "
+                            "You can check the status using "
+                            f"`snapctl snapend state --snapend-id {response['cluster']['id']}`"
+                        )
+                        return True
+                    error('Unable to apply the manifest. Reason: ' + res.text)
+            except RequestException as e:
+                error(f"Exception: Unable to apply the manifest snapend {e}")
+            return False
+
+    def promote(self) -> bool:
+        """
+          Promote a staging manifest to production
+        """
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        ) as progress:
+            progress.add_task(
+                description='Promoting your staging snapend...', total=None)
+            try:
+                with open(self.manifest_path, 'rb') as file:
+                    payload = {
+                        'snapend_id': self.snapend_id
+                    }
+                    url = f"{self.base_url}/v1/snapser-api/snapends/promote"
+                    res = requests.put(
+                        url, headers={'api-key': self.api_key},
+                        json=payload, timeout=SERVER_CALL_TIMEOUT
+                    )
+                    if res.ok:
+                        # extract the cluster ID
+                        response = res.json()
+                        if 'cluster' not in response or 'id' not in response['cluster']:
+                            error(
+                                'Something went wrong. Please try again in sometime.'
+                            )
+                            return False
+                        self._assign_snapend_id(response['cluster']['id'])
+                        if self.blocking:
+                            status = self._blocking_get_status()
+                            if status is True:
+                                # TODO: Uncomment this if we want to do an auto download
+                                # self._setup_for_download(
+                                #     self.manifest_file_name.split('.')[-1])
+                                # self._execute_download()
+                                # Fetch the new manifest
+                                info(
+                                    'Do not forget to download the latest manifest.'
+                                )
+                                return True
+                            info(
+                                'Snapend apply has been initiated but the Snapend is not up yet.'
+                                'Please try checking the status of the Snapend in some time'
+                            )
+                            return False
+                        info(
+                            "Snapend apply has been initiated. "
+                            "You can check the status using "
+                            f"`snapctl snapend state --snapend-id {response['cluster']['id']}`"
+                        )
+                        return True
+                    error('Unable to promote the manifest. Reason: ' + res.text)
             except RequestException as e:
-                error(f"Exception: Unable to download the SDK {e}")
+                error(f"Exception: Unable to apply the manifest snapend {e}")
             return False
 
+    def download(self) -> bool:
+        """
+          Download SDKs, Protos, Admin Settings and Configuration
+        """
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        ) as progress:
+            progress.add_task(
+                description=f'Downloading your Custom {self.category}...', total=None)
+            return self._execute_download()
+
     def update(self) -> bool:
         """
           Update a Snapend

snapctl/config/constants.py

@@ -1,11 +1,14 @@
 """
 Constants used by snapctl
 """
-VERSION = '0.22.3'
+COMPANY_NAME = 'Snapser'
+VERSION = '0.26.1'
 CONFIG_FILE_MAC = '~/.snapser/config'
-CONFIG_FILE_WIN = '%USERPROFILE%\.snapser\config'
+CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
+
 DEFAULT_PROFILE = 'default'
 API_KEY = 'SNAPSER_API_KEY'
+URL_KEY = 'SNAPSER_URL_KEY'
 SERVER_CALL_TIMEOUT = 30
 
 SNAPCTL_SUCCESS = 0

snapctl/config/endpoints.py

@@ -3,6 +3,7 @@ This file contains the endpoints for the Snapser API.
 """
 END_POINTS = {
     'DEV': 'https://gateway.dev.snapser.io/snapser',
+    'DEV_TWO': 'https://gateway.dev.snapser.io/devtwo',
     'PLAYTEST': 'https://gateway.dev.snapser.io/playtest',
     'PROD': 'https://gateway.snapser.com/snapser'
 }

snapctl/config/hashes.py

@@ -126,6 +126,17 @@ PROTOS_TYPES: dict[str, dict[str, str]] = {
     },
 }
 
+SNAPEND_MANIFEST_TYPES: dict[str, dict[str, str]] = {
+    'json': {
+        'type': 'json',
+        'subtype': '',
+    },
+    'yaml': {
+        'type': 'yaml',
+        'subtype': '',
+    },
+}
+
 SERVICE_IDS = [
     'analytics', 'auth', 'client-logs', 'events', 'experiments', 'gdpr', 'guilds', 'hades', 'iap',
     'inventory', 'leaderboards', 'matchmaking', 'notifications', 'parties', 'profiles', 'quests',

snapctl/main.py

@@ -6,23 +6,43 @@ import os
 from sys import platform
 from typing import Union, Callable
 import typer
+import pyfiglet
 
 from snapctl.commands.byosnap import ByoSnap
 from snapctl.commands.byogs import ByoGs
+from snapctl.commands.game import Game
 from snapctl.commands.snapend import Snapend
-from snapctl.config.constants import API_KEY, CONFIG_FILE_MAC, CONFIG_FILE_WIN, DEFAULT_PROFILE, \
-    VERSION, SNAPCTL_SUCCESS, SNAPCTL_ERROR
+from snapctl.config.constants import COMPANY_NAME, API_KEY, URL_KEY, CONFIG_FILE_MAC, \
+    CONFIG_FILE_WIN, DEFAULT_PROFILE, VERSION, SNAPCTL_SUCCESS, SNAPCTL_ERROR
 from snapctl.config.endpoints import END_POINTS
-from snapctl.config.hashes import CLIENT_SDK_TYPES, SERVER_SDK_TYPES, PROTOS_TYPES, SERVICE_IDS
+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
 
-app = typer.Typer()
+######### Globals #########
+
+
+def draw_ascii_text():
+    """
+      Draws the ascii text for Snapser
+    """
+    ascii_text = pyfiglet.figlet_format(COMPANY_NAME)
+    typer.echo(ascii_text)
+
+
+app = typer.Typer(
+    help=draw_ascii_text(),
+    context_settings={
+        "help_option_names": ["-h", "--help"]
+    }
+)
+
 
 ######### HELPER METHODS #########
 
 
-def extract_api_key(profile: str | None = None) -> object:
+def extract_config(extract_key: str, profile: str | None = None) -> object:
     """
       Extracts the API Key from the environment variable and if not present from the config file
     """
@@ -31,7 +51,7 @@ def extract_api_key(profile: str | None = None) -> object:
         'value': None
     }
     # Option 1
-    env_api_key = os.getenv(API_KEY)
+    env_api_key = os.getenv(extract_key)
     if env_api_key is not None:
         result['location'] = 'environment-variable'
         result['value'] = env_api_key
@@ -50,11 +70,11 @@ def extract_api_key(profile: str | None = None) -> object:
         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:profile:{profile}'
+            result['location'] = f'{config_file_path}:profile {profile}'
             config_profile = f'profile {profile}'
-            info(f"Trying to extract API KEY from from profile {profile}")
+            info(f"Trying to extract API KEY from profile {profile}")
         result['value'] = config.get(
-            config_profile, API_KEY, fallback=None, raw=True
+            config_profile, extract_key, fallback=None, raw=True
         )
     else:
         error(
@@ -66,10 +86,17 @@ def get_base_url(api_key: str | None) -> str:
     """
         Returns the base url based on the api_key
     """
+    # Check if the user has a URL override
+    url_key_obj = extract_config(URL_KEY, None)
+    if url_key_obj['value'] is not None:
+        return url_key_obj['value']
+    # If there was no override then we use the default
     if api_key is None:
         return ''
     if api_key.startswith('dev_'):
         return END_POINTS['DEV']
+    if api_key.startswith('devtwo_'):
+        return END_POINTS['DEV_TWO']
     if api_key.startswith('playtest_'):
         return END_POINTS['PLAYTEST']
     return END_POINTS['PROD']
@@ -103,7 +130,7 @@ def default_context_callback(ctx: typer.Context):
     # Ensure ctx object is instantiated
     ctx.ensure_object(dict)
     # Extract the api_key
-    api_key_obj = extract_api_key()
+    api_key_obj = extract_config(API_KEY, None)
     ctx.obj['version'] = VERSION
     ctx.obj['api_key'] = api_key_obj['value']
     ctx.obj['api_key_location'] = api_key_obj['location']
@@ -144,7 +171,7 @@ def profile_context_callback(
     # info("In Profile Callback")
     # Ensure ctx object is instantiated
     ctx.ensure_object(dict)
-    api_key_obj = extract_api_key(profile)
+    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':
@@ -233,7 +260,9 @@ def byosnap(
     ),
     # publish-image and publish-version
     tag: str = typer.Option(
-        None, "--tag", help="(req: build, push  publish-image and publish-version) Tag for your snap"
+        None, "--tag", help=(
+            "(req: build, push  publish-image and publish-version) Tag for your snap"
+        )
     ),
     # publish-image
     path: Union[str, None] = typer.Option(
@@ -360,6 +389,44 @@ def byogs(
     success(f"BYOGs {subcommand} complete")
 
 
+@app.command()
+def game(
+    ctx: typer.Context,
+    # Required fields
+    subcommand: str = typer.Argument(
+        ..., help="Game Subcommands: " + ", ".join(Game.SUBCOMMANDS) + "."
+    ),
+    # name
+    name: str = typer.Option(
+        None, "--name",
+        help=("(req: create) Name of your game: ")
+    ),
+    # 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:
+    """
+      Game 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")
+
+
 @app.command()
 def snapend(
     ctx: typer.Context,
@@ -367,7 +434,21 @@ def snapend(
     subcommand: str = typer.Argument(
         ..., help="Snapend Subcommands: " + ", ".join(Snapend.SUBCOMMANDS) + "."
     ),
-    snapend_id: str = typer.Argument(..., help="Snapend Id"),
+    # snapend_id: str = typer.Argument(..., help="Snapend Id"),
+    snapend_id: str = typer.Option(
+        None, "--snapend-id",
+        help=("(req: update, download) Snapend Id")
+    ),
+    # enumerate
+    game_id: str = typer.Option(
+        None, "--game-id",
+        help="(req: enumerate, clone) Game Id"
+    ),
+    # apply, clone
+    manifest_path: str = typer.Option(
+        None, "--manifest-path",
+        help="(req: apply|clone) Path to the manifest file"
+    ),
     # download
     category: str = typer.Option(
         None, "--category",
@@ -376,22 +457,22 @@ def snapend(
             ", ".join(Snapend.DOWNLOAD_CATEGORY) + "."
         )
     ),
-    path: Union[str, None] = typer.Option(
-        None, "--path", help="(req: download) Path to save the SDK"),
     platform_type: str = typer.Option(
         None, "--type",
         help=(
             "(req: --category client-sdk|server-sdk|protos --type ) "
             "SDK Types: client-sdk(" + ", ".join(CLIENT_SDK_TYPES.keys()) +
             ") server-sdk(" + ", ".join(SERVER_SDK_TYPES.keys()) +
-            ") protos(" + ", ".join(PROTOS_TYPES.keys()) + ")"
+            ") protos(" + ", ".join(PROTOS_TYPES.keys()) + ")" +
+            ") snapend-manifest(" + \
+            ", ".join(SNAPEND_MANIFEST_TYPES.keys()) + ")"
         )
     ),
     auth_type: str = typer.Option(
         'user', "--auth-type",
         help=(
             "(optional: download) Only applicable for --category server-sdk --auth-type"
-            "Auth-Types: ()" + ", ".join(Snapend.AUTH_TYPES) + ")"
+            "Auth-Types: (" + ", ".join(Snapend.AUTH_TYPES) + ")"
         )
     ),
     snaps: Union[str, None] = typer.Option(
@@ -402,6 +483,17 @@ def snapend(
               "snaps(" + ", ".join(SERVICE_IDS)
         )
     ),
+    # Clone
+    name: Union[str, None] = typer.Option(
+        None, "--name", help="(req: clone) Snapend name"),
+    env: Union[str, None] = typer.Option(
+        None, "--env", help=(
+            "(req: clone) 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"),
     # update
     byosnaps: str = typer.Option(
         None, "--byosnaps",
@@ -417,6 +509,7 @@ def snapend(
             "Eg: fleet-1:service-1:v1.0.0,fleet-2:service-2:v1.0.0"
         )
     ),
+    # create, update, promote, apply, clone
     blocking: bool = typer.Option(
         False, "--blocking",
         help=(
@@ -437,9 +530,19 @@ def snapend(
     """
     validate_command_context(ctx)
     snapend_obj: Snapend = Snapend(
-        subcommand, ctx.obj['base_url'], ctx.obj['api_key'],
-        snapend_id, category, platform_type, auth_type,
-        path, snaps, byosnaps, byogs, blocking
+        subcommand, ctx.obj['base_url'], ctx.obj['api_key'], snapend_id,
+        # Enumerate, Clone
+        game_id,
+        # Clone
+        name, env,
+        # Apply, Clone
+        manifest_path,
+        # Download
+        category, platform_type, auth_type, snaps,
+        # Download, Apply and Clone
+        out_path,
+        # Update
+        byosnaps, byogs, blocking
     )
     validate_input_response: ResponseType = snapend_obj.validate_input()
     if validate_input_response['error']:

{snapctl-0.22.3.dist-info → snapctl-0.26.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.22.3
+Version: 0.26.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -10,6 +10,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: configparser (>=6.0.0,<7.0.0)
+Requires-Dist: pyfiglet (>=1.0.2,<2.0.0)
 Requires-Dist: requests (>=2.28.2,<3.0.0)
 Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
 Description-Content-Type: text/markdown
@@ -392,7 +393,7 @@ snapctl byogs publish-version --help
 snapctl byogs publish-version $byogs_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
 ```
 
-### Snapend
+### Game
 
 #### 1. snapend help
 
@@ -403,27 +404,89 @@ See all the supported commands
 snapctl snapend --help
 ```
 
+#### 2. Create a game
+Create a game
+```
+snapctl game create --name $gameName
+```
+
+#### 3. Enumerate games
+List all the games
+```
+snapctl game enumerate
+```
+
+
+### Snapend
+
+#### 1. snapend help
+
+See all the supported commands
+
+```
+# Help for the snapend command
+snapctl snapend --help
+```
+
 #### 2. Snapend Downloads
 
-Download SDKs and Protos for your Snapend
+Download Manifest, SDKs and Protos for your Snapend
 
 ```
-# Help for the byogs command
+# Help for the download command
 snapctl snapend download --help
 
 # Download your Snapend SDK and Protos
 # $snapend_id = Cluster Id
-# $category = client-sdk, server-sdk, protos, admin-settings
-# $sdk_type = One of the supported SDK names:
-# client-sdk(unity, unreal, roblox, godot, cocos, ios-objc, ios-swift, android-java, android-kotlin, web-ts, web-js),
-# server-sdk(csharp, cpp, lua, ts, go, python, kotlin, java, c, node, js, perl, php, closure, ruby, rust),
-# protos(go)
+# $category = snapend-manifest, client-sdk, server-sdk, protos
+# $type = One of the supported types:
+#   snapend-manifest(yaml, json)
+#   client-sdk(unity, unreal, roblox, godot, cocos, ios-objc, ios-swift, android-java, android-kotlin, web-ts, web-js),
+#   server-sdk(csharp, cpp, lua, ts, go, python, kotlin, java, c, node, js, perl, php, closure, ruby, rust),
+#   protos(go, csharp, cpp, python)
 # Example:
+# snapctl snapend download gx5x6bc0 --category snapend-manifest --type yaml
 # snapctl snapend download gx5x6bc0 --category client-sdk --type unity
-snapctl snapend download $snapend_id --category $category --type $sdk_type
+snapctl snapend download $snapend_id --category $category --type $type
+```
+
+#### 3. Clone Snapend
+
+Clone a Snapend from an existing manifest. Passing the blocking flag ensures your CLI command waits till the new Snapend is up.
+
+```
+# Help for the download command
+snapctl snapend clone --help
+
+# Download your Snapend SDK and Protos
+# $gameId = Game Id
+# $snapendName = Name of your new Snapend
+# $env = One of development, staging
+# $pathToManifest = Path to the manifest file; should include the file name
+# Example:
+# snapctl snapend clone --game-id 2581d802-aca-496c-8a76-1953ad0db165 --name new-snapend --env development --manifest-path "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking
+snapctl snapend clone --game-id $gameId --name $snapendName --env $env --manifest-path "$pathToManifest"
+snapctl snapend clone --game-id $gameId --name $snapendName --env $env --manifest-path "$pathToManifest" --blocking
+```
+
+#### 4. Apply Snapend Changes
+
+Apply changes to your Snapend from a manifest. You should have the latest manifest before applying changes. This is to prevent
+a user stomping over someone elses changes. Passing the blocking flag ensures your CLI command waits till the update is complete.
+
+```
+# Help for the download command
+snapctl snapend apply --help
+
+# Download your Snapend SDK and Protos
+# $pathToManifest = Path to the manifest file; should include the file name
+# Example:
+# snapctl snapend apply --manifest-path "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking
+snapctl snapend apply --manifest-path "$pathToManifest"
+snapctl snapend apply --manifest-path "$pathToManifest" --blocking
 ```
 
-#### 3. Update Snapend BYOSnap or BYOGs versions
+#### 5. Update Snapend BYOSnap or BYOGs versions
 
 Update your BYOSnap or BYOGs versions for the Snapend
 
@@ -443,7 +506,7 @@ snapctl snapend update --help
 snapctl snapend update $snapend_id --byosnaps $byosnaps --byogs $byogs --blocking
 ```
 
-#### 4. Get the Snapend state
+#### 6. Get the Snapend state
 
 Get the Snapend state
 

snapctl-0.26.1.dist-info/RECORD

@@ -0,0 +1,21 @@
+snapctl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+snapctl/__main__.py,sha256=43jKoTk8b85hk_MT6499N3ruHdEfM8WBImd_-3VzjI8,116
+snapctl/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+snapctl/commands/byogs.py,sha256=S77gBVT7W-6Ph7D8YU_2YfFNFHhlnBYYg3hafuw_w5Q,19216
+snapctl/commands/byosnap.py,sha256=RQv3r30dkz8n1BgEnE-tAnAzPLoz-CLEQoiy1WKZQeg,23172
+snapctl/commands/game.py,sha256=rnsTqrXavE5D-KULXkDBQ-PBI8sSKK4it3S_YMJfiUY,3633
+snapctl/commands/snapend.py,sha256=Wyw9XEYn5b8YdllJumhsaoXqNeEA6XNxGRxToqmgf5o,25263
+snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+snapctl/config/constants.py,sha256=Lgp7ddPGBBtAaqdFPk7VRV0FIHmeSYWRvXUPVBz8m40,525
+snapctl/config/endpoints.py,sha256=VAeOmx3k3ukB-9XuGI65KtCJwFK-KFgzor-UWE8JU0g,297
+snapctl/config/hashes.py,sha256=R0t5xwY6DJpwiJZfo1SFh2qvADmDIrdPV7lD_IKbnJg,2889
+snapctl/main.py,sha256=aSlAfOj3Lrb4gw5QHTWQ1gqCUHgtZ39GJ8SHxliTDik,18516
+snapctl/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+snapctl/types/definitions.py,sha256=rkRyTBHzeQtCt_uYObgYvL5txnVq8r_n5g4IUAq2FWc,233
+snapctl/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+snapctl/utils/echo.py,sha256=0nhWYDBQTfZGtl8EK21hJhj0now2rQmCT-yYMCKupy4,584
+snapctl/utils/helper.py,sha256=xasSsg-0DgHT-TWejh2IXW-s9AYntO1D2O6Uy6BQLcE,1381
+snapctl-0.26.1.dist-info/METADATA,sha256=7nVCIinJ40Wa14vFcSeWFVq2wdIax7l4eiUPBXrZZ6U,15246
+snapctl-0.26.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+snapctl-0.26.1.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-0.26.1.dist-info/RECORD,,

snapctl-0.22.3.dist-info/RECORD

@@ -1,20 +0,0 @@
-snapctl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/__main__.py,sha256=43jKoTk8b85hk_MT6499N3ruHdEfM8WBImd_-3VzjI8,116
-snapctl/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/commands/byogs.py,sha256=hXRyqEYb_k3gdqmbXn1TqHYa0dDp6yOGQIgvxY03OC8,19077
-snapctl/commands/byosnap.py,sha256=Yf9f5Os6vdfHBRVKx_E4IqAGctAtf32QobqUG0fBukw,23033
-snapctl/commands/snapend.py,sha256=fX35lRZwqs2VSyu8XZL4FGrWmWSN6uFIF7L4qraV5K4,11420
-snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/config/constants.py,sha256=t7i5_OgJmURLXxfv_QKUbsj7mC9AoiOUMjhM5cGM0Ug,472
-snapctl/config/endpoints.py,sha256=7aSu-tWwF4NcSh1eEpNlAa-Cjg2mitBLudSf41Wb47M,241
-snapctl/config/hashes.py,sha256=yf2800SRpq1pr0BrEuj4CndoyZA1i2jrhg7dLRWNp7Y,2696
-snapctl/main.py,sha256=3k7aLK3kcL8AX0CLD9LD7e0-kX6mamruEIYn8Nbpi3o,15356
-snapctl/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/types/definitions.py,sha256=rkRyTBHzeQtCt_uYObgYvL5txnVq8r_n5g4IUAq2FWc,233
-snapctl/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/utils/echo.py,sha256=0nhWYDBQTfZGtl8EK21hJhj0now2rQmCT-yYMCKupy4,584
-snapctl/utils/helper.py,sha256=xasSsg-0DgHT-TWejh2IXW-s9AYntO1D2O6Uy6BQLcE,1381
-snapctl-0.22.3.dist-info/METADATA,sha256=PE7iPefecHhnAIA1bZKHqOWiotsDMeadf0gOKLIrB2g,13204
-snapctl-0.22.3.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-snapctl-0.22.3.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-0.22.3.dist-info/RECORD,,