snapctl 0.31.0__tar.gz → 0.32.0__tar.gz

snapctl-0.32.0/LICENSE

@@ -0,0 +1,29 @@
+Snapser Inc. Proprietary License
+
+This CLI tool, its source code, and any accompanying documentation (collectively referred to as the "Software") are the property of Snapser Inc. ("Snapser"). The Software is provided under the following license terms and conditions:
+
+1. License Grant:
+   Snapser grants you a non-exclusive, non-transferable, revocable license to use the Software solely for your internal business purposes. You may not distribute, sublicense, rent, lease, sell, or otherwise transfer the Software or any portion thereof.
+
+2. Restrictions:
+   You may not modify, adapt, translate, reverse engineer, decompile, disassemble, or create derivative works based on the Software. You may not remove or alter any copyright, trademark, or other proprietary rights notices contained in the Software.
+
+3. Ownership:
+   The Software and all intellectual property rights therein are and shall remain the exclusive property of Snapser Inc. Nothing in this license agreement shall be construed to transfer ownership of the Software to you.
+
+4. Term and Termination:
+   This license is effective until terminated by either party. Snapser may terminate this license at any time if you breach any of its terms and conditions. Upon termination, you must immediately cease all use of the Software and destroy all copies thereof.
+
+5. Disclaimer of Warranty:
+   THE SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, SNAPSER DISCLAIMS ALL WARRANTIES, INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. SNAPSER DOES NOT WARRANT THAT THE FUNCTIONS CONTAINED IN THE SOFTWARE WILL MEET YOUR REQUIREMENTS OR THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE.
+
+6. Limitation of Liability:
+   IN NO EVENT SHALL SNAPSER BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION, LOSS OF INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE, EVEN IF SNAPSER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. Governing Law:
+   This license agreement shall be governed by and construed in accordance with the laws of the United States of America, excluding its conflicts of law principles. Any disputes arising out of or in connection with this agreement shall be subject to the exclusive jurisdiction of the courts located in the United States of America.
+
+By using the Software, you agree to be bound by the terms and conditions of this license agreement. If you do not agree to these terms and conditions, do not use the Software.
+
+Snapser Inc.
+June 4, 2024

{snapctl-0.31.0 → snapctl-0.32.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.31.0
+Version: 0.32.0
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -101,7 +101,10 @@ be evaluated after verifying if there is any command line argument.
 
 Create a file named `~/.snapser/config`. Open it using the editor of your choice and replace with your
 personal Snapser Access key. Save the file. Advantage of using this method is you can use the `--profile`
-argument with your snapctl command to use different API keys.
+argument with your snapctl command to use different API keys. NOTE: You may want to pass your own path
+instead on relying on the default one the CLI looks for. You can do so by setting an environment
+variable `SNAPSER_CONFIG_PATH='<your_custom_path>'`. Doing this will make sure that the CLI tool
+will look for the config file at that path.
 
 ```
 [default]
@@ -241,16 +244,16 @@ snapctl byosnap push $byosnap_sid --tag $image_tag
 Upload swagger.json and README.md for you Snap
 
 ```
-# Help for the byogs command
+# Help for the byosnap command
 snapctl byosnap upload-docs --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
+# $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your swagger.json and README.md files are present
 # Example:
 # snapctl byosnap upload-docs byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap upload-docs $byogs_sid --tag $image_tag --path $code_root_path
+snapctl byosnap upload-docs $byosnap_sid --tag $image_tag --path $code_root_path
 ```
 
 #### 6. byosnap publish-image
@@ -302,28 +305,7 @@ See all the supported commands
 snapctl byogs --help
 ```
 
-#### 2. [Deprecated soon] byogs create
-
-Create a custom game server. Note that you will have to build, push and publish your game server image, for it to be useable
-in a Snapend fleet.
-
-```
-# Help for the byosnap command
-snapctl byogs create --help
-
-# Create a new snap
-# $byogs_sid = Game server ID for your snap. Should start with `byogs-`
-# $name = User friendly name for your BYOGs
-# $desc = User friendly description
-# $platform = Currently only supported platform is linux/amd64
-# $language = One of go, python, ruby, c#, c++, rust, java, node
-
-# Example:
-# snapctl byogs create byosnap-jinks-gs --name "Jinks Flask Microservice" --desc "Custom Microservice" --platform "linux/arm64" --language "go"
-snapctl byogs create $byogs_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
-```
-
-#### 3. byogs build
+#### 2. byogs build
 
 Build your custom game server image.
 
@@ -332,15 +314,14 @@ Build your custom game server image.
 snapctl byogs build --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
 # Example:
 # snapctl byogs build byosnap-jinks-gs --tag my-first-image --path /Users/DevName/Development/SnapserEngine/game_server
-snapctl byogs build $byogs_sid --tag $image_tag --path $code_root_path
+snapctl byogs build --tag $image_tag --path $code_root_path
 ```
 
-#### 4. byogs push
+#### 3. byogs push
 
 Push your custom game server image.
 
@@ -349,51 +330,13 @@ Push your custom game server image.
 snapctl byogs push --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
 # $image_tag = An image tag for your snap
 # Example:
 # snapctl byogs push byosnap-jinks-gs --tag my-first-image
-snapctl byogs push $byogs_sid --tag $image_tag
-```
-
-#### 5. [Deprecated soon] byogs publish-image
-
-Publish your custom game server image. This command executes, `build` and `push` one after the other.
-
-```
-# Help for the byogs command
-snapctl byogs publish-image --help
-
-# Publish a new image
-# $byogs_sid = Game server ID for your snap
-# $image_tag = An image tag for your snap
-# $code_root_path = Local code path where your Dockerfile is present
-# Example:
-# snapctl byogs publish-image byosnap-jinks-gs --tag my-first-image --path /Users/DevName/Development/SnapserEngine/game_server
-snapctl byogs publish-image $byogs_sid --tag $image_tag --path $code_root_path
-```
-
-#### 6. [Deprecated soon] byogs publish-version
-
-Publish a new version for your game server. Only after your game server version is published, you will be able
-to use it in your Snapend fleet. This command should be run after you `push` or `publish-image` commands.
-
-```
-# Help for the byogs command
-snapctl byogs publish-version --help
-
-# Publish a new image
-# $byogs_sid = Snap ID for your snap
-# $image_tag = Any image tag for your snap
-# $prefix = Prefix for your snap Eg: /v1
-# $version = Semantic version for your snap Eg: v0.0.1
-# $ingress_port = Ingress port for your snap Eg: 5003
-# Example:
-# snapctl byogs publish-image byosnap-jinks-gs --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003
-snapctl byogs publish-version $byogs_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
+snapctl byogs push --tag $image_tag
 ```
 
-#### 7. [New] byogs publish
+#### 4. byogs publish
 
 Publish your custom game server image. This commend replaces the old way of creating, publishing image and
 then publishing the byogs. Now all you have to do is publish your image and create a fleet using the web portal.
@@ -523,9 +466,9 @@ snapctl snapend update --help
 # --blocking = (Optional) This makes sure the CLI waits till your Snapend is live.
 # Note at least one of the two needs to be present
 # Example:
-# snapctl snapend update gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs byogs-fleet-one:gs-1:v0.0.1,my-fleet-two:gs-2:v0.0.4
-# snapctl snapend update gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs fleet-one:v0.0.1,fleet-two:v0.0.4 --blocking
-snapctl snapend update $snapend_id --byosnaps $byosnaps --byogs $byogs --blocking
+# snapctl snapend update --snapend-id gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs byogs-fleet-one:gs-1:v0.0.1,my-fleet-two:gs-2:v0.0.4
+# snapctl snapend update --snapend-id gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs fleet-one:v0.0.1,fleet-two:v0.0.4 --blocking
+snapctl snapend update --snapend-id $snapend_id --byosnaps $byosnaps --byogs $byogs --blocking
 ```
 
 #### 6. Get the Snapend state

{snapctl-0.31.0 → snapctl-0.32.0}/README.md

@@ -84,7 +84,10 @@ be evaluated after verifying if there is any command line argument.
 
 Create a file named `~/.snapser/config`. Open it using the editor of your choice and replace with your
 personal Snapser Access key. Save the file. Advantage of using this method is you can use the `--profile`
-argument with your snapctl command to use different API keys.
+argument with your snapctl command to use different API keys. NOTE: You may want to pass your own path
+instead on relying on the default one the CLI looks for. You can do so by setting an environment
+variable `SNAPSER_CONFIG_PATH='<your_custom_path>'`. Doing this will make sure that the CLI tool
+will look for the config file at that path.
 
 ```
 [default]
@@ -224,16 +227,16 @@ snapctl byosnap push $byosnap_sid --tag $image_tag
 Upload swagger.json and README.md for you Snap
 
 ```
-# Help for the byogs command
+# Help for the byosnap command
 snapctl byosnap upload-docs --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
+# $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your swagger.json and README.md files are present
 # Example:
 # snapctl byosnap upload-docs byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap upload-docs $byogs_sid --tag $image_tag --path $code_root_path
+snapctl byosnap upload-docs $byosnap_sid --tag $image_tag --path $code_root_path
 ```
 
 #### 6. byosnap publish-image
@@ -285,28 +288,7 @@ See all the supported commands
 snapctl byogs --help
 ```
 
-#### 2. [Deprecated soon] byogs create
-
-Create a custom game server. Note that you will have to build, push and publish your game server image, for it to be useable
-in a Snapend fleet.
-
-```
-# Help for the byosnap command
-snapctl byogs create --help
-
-# Create a new snap
-# $byogs_sid = Game server ID for your snap. Should start with `byogs-`
-# $name = User friendly name for your BYOGs
-# $desc = User friendly description
-# $platform = Currently only supported platform is linux/amd64
-# $language = One of go, python, ruby, c#, c++, rust, java, node
-
-# Example:
-# snapctl byogs create byosnap-jinks-gs --name "Jinks Flask Microservice" --desc "Custom Microservice" --platform "linux/arm64" --language "go"
-snapctl byogs create $byogs_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
-```
-
-#### 3. byogs build
+#### 2. byogs build
 
 Build your custom game server image.
 
@@ -315,15 +297,14 @@ Build your custom game server image.
 snapctl byogs build --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
 # Example:
 # snapctl byogs build byosnap-jinks-gs --tag my-first-image --path /Users/DevName/Development/SnapserEngine/game_server
-snapctl byogs build $byogs_sid --tag $image_tag --path $code_root_path
+snapctl byogs build --tag $image_tag --path $code_root_path
 ```
 
-#### 4. byogs push
+#### 3. byogs push
 
 Push your custom game server image.
 
@@ -332,51 +313,13 @@ Push your custom game server image.
 snapctl byogs push --help
 
 # Publish a new image
-# $byogs_sid = Game server ID for your snap
 # $image_tag = An image tag for your snap
 # Example:
 # snapctl byogs push byosnap-jinks-gs --tag my-first-image
-snapctl byogs push $byogs_sid --tag $image_tag
-```
-
-#### 5. [Deprecated soon] byogs publish-image
-
-Publish your custom game server image. This command executes, `build` and `push` one after the other.
-
-```
-# Help for the byogs command
-snapctl byogs publish-image --help
-
-# Publish a new image
-# $byogs_sid = Game server ID for your snap
-# $image_tag = An image tag for your snap
-# $code_root_path = Local code path where your Dockerfile is present
-# Example:
-# snapctl byogs publish-image byosnap-jinks-gs --tag my-first-image --path /Users/DevName/Development/SnapserEngine/game_server
-snapctl byogs publish-image $byogs_sid --tag $image_tag --path $code_root_path
-```
-
-#### 6. [Deprecated soon] byogs publish-version
-
-Publish a new version for your game server. Only after your game server version is published, you will be able
-to use it in your Snapend fleet. This command should be run after you `push` or `publish-image` commands.
-
-```
-# Help for the byogs command
-snapctl byogs publish-version --help
-
-# Publish a new image
-# $byogs_sid = Snap ID for your snap
-# $image_tag = Any image tag for your snap
-# $prefix = Prefix for your snap Eg: /v1
-# $version = Semantic version for your snap Eg: v0.0.1
-# $ingress_port = Ingress port for your snap Eg: 5003
-# Example:
-# snapctl byogs publish-image byosnap-jinks-gs --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003
-snapctl byogs publish-version $byogs_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
+snapctl byogs push --tag $image_tag
 ```
 
-#### 7. [New] byogs publish
+#### 4. byogs publish
 
 Publish your custom game server image. This commend replaces the old way of creating, publishing image and
 then publishing the byogs. Now all you have to do is publish your image and create a fleet using the web portal.
@@ -506,9 +449,9 @@ snapctl snapend update --help
 # --blocking = (Optional) This makes sure the CLI waits till your Snapend is live.
 # Note at least one of the two needs to be present
 # Example:
-# snapctl snapend update gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs byogs-fleet-one:gs-1:v0.0.1,my-fleet-two:gs-2:v0.0.4
-# snapctl snapend update gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs fleet-one:v0.0.1,fleet-two:v0.0.4 --blocking
-snapctl snapend update $snapend_id --byosnaps $byosnaps --byogs $byogs --blocking
+# snapctl snapend update --snapend-id gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs byogs-fleet-one:gs-1:v0.0.1,my-fleet-two:gs-2:v0.0.4
+# snapctl snapend update --snapend-id gx5x6bc0 --byosnaps byosnap-service-1:v1.0.0,byosnap-service--2:v1.0.0 --byogs fleet-one:v0.0.1,fleet-two:v0.0.4 --blocking
+snapctl snapend update --snapend-id $snapend_id --byosnaps $byosnaps --byogs $byogs --blocking
 ```
 
 #### 6. Get the Snapend state

{snapctl-0.31.0 → snapctl-0.32.0}/pyproject.toml

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

{snapctl-0.31.0 → snapctl-0.32.0}/snapctl/commands/byogs.py

@@ -3,18 +3,12 @@
 """
 import base64
 from binascii import Error as BinasciiError
-import json
 import os
-import re
 import subprocess
 from sys import platform
 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
-from snapctl.config.constants import ERROR_SERVICE_VERSION_EXISTS, ERROR_TAG_NOT_AVAILABLE
 from snapctl.types.definitions import ResponseType
 from snapctl.utils.echo import error, success
 from snapctl.utils.helper import get_composite_token
@@ -25,11 +19,7 @@ class ByoGs:
         BYOGS CLI commands
     """
     SID = 'byogs'
-    SUBCOMMANDS = [
-        'build', 'push',
-        'create', 'publish-image', 'publish-version',
-        'publish'
-    ]
+    SUBCOMMANDS = ['build', 'push', 'publish']
     PLATFORMS = ['linux/amd64']
     LANGUAGES = ['go', 'python', 'ruby', 'c#', 'c++', 'rust', 'java', 'node']
     DEFAULT_BUILD_PLATFORM = 'linux/amd64'
@@ -37,34 +27,24 @@ class ByoGs:
     TAG_CHARACTER_LIMIT = 80
 
     def __init__(
-        self, subcommand: str, base_url: str, api_key: str | None, sid: str, name: str, desc: str,
-        platform_type: str, language: str, input_tag: Union[str, None], path: Union[str, None],
-        dockerfile: str, version: Union[str, None], http_port: Union[int, None],
-        debug_port: Union[int, None]
+        self, subcommand: str, base_url: str, api_key: str | None,
+        input_tag: Union[str, None], path: Union[str, None], dockerfile: str,
     ) -> None:
         self.subcommand: str = subcommand
         self.base_url: str = base_url
         self.api_key: str = api_key
-        self.sid: str = sid
-        if subcommand == 'publish':
-            self.sid = ByoGs.SID
-        self.name: str = name
-        self.desc: str = desc
-        self.platform_type: str = platform_type
-        self.language: str = language
-        self.token: Union[str, None] = None
-        if subcommand != 'create':
-            self.token: Union[str, None] = get_composite_token(
-                base_url, api_key, 'byogs', {'service_id': self.sid}
-            )
+        # self.sid: str = sid
+        # if subcommand == 'publish':
+        #     self.sid = ByoGs.SID
+
+        self.token: Union[str, None] = get_composite_token(
+            base_url, api_key, 'byogs', {'service_id': ByoGs.SID}
+        )
         self.token_parts: Union[list, None] = ByoGs._get_token_values(
             self.token) if self.token is not None else None
         self.input_tag: Union[str, None] = input_tag
         self.path: Union[str, None] = path
         self.dockerfile: str = dockerfile
-        self.version: Union[str, None] = version
-        self.http_port: Union[int, None] = http_port
-        self.debug_port: Union[int, None] = debug_port
 
     # Protected methods
 
@@ -151,7 +131,7 @@ class ByoGs:
 
     def _docker_build(self) -> bool:
         # Get the data
-        image_tag = f'{self.sid}.{self.input_tag}'
+        image_tag = f'{ByoGs.SID}.{self.input_tag}'
         build_platform = ByoGs.DEFAULT_BUILD_PLATFORM
         if len(self.token_parts) == 4:
             build_platform = self.token_parts[3]
@@ -190,7 +170,7 @@ class ByoGs:
     def _docker_tag(self) -> bool:
         # Get the data
         ecr_repo_url = self.token_parts[0]
-        image_tag = f'{self.sid}.{self.input_tag}'
+        image_tag = f'{ByoGs.SID}.{self.input_tag}'
         full_ecr_repo_url = f'{ecr_repo_url}:{image_tag}'
         try:
             # Tag the repo
@@ -221,7 +201,7 @@ class ByoGs:
     def _docker_push(self) -> bool:
         try:
             ecr_repo_url = self.token_parts[0]
-            image_tag = f'{self.sid}.{self.input_tag}'
+            image_tag = f'{ByoGs.SID}.{self.input_tag}'
             full_ecr_repo_url = f'{ecr_repo_url}:{image_tag}'
 
             # Push the image
@@ -271,80 +251,33 @@ class ByoGs:
         if not self.subcommand in ByoGs.SUBCOMMANDS:
             response['msg'] = f"Invalid command. Valid commands are {', '.join(ByoGs.SUBCOMMANDS)}."
             return response
-        # Validate the SID
-        if not self.sid.startswith(ByoGs.SID):
-            response['msg'] = (
-                "Invalid Game Server ID. Valid Game Server IDs start "
-                f"with {ByoGs.SID}."
-            )
+        # Validation for subcommands
+        if self.token_parts is None:
+            response['msg'] = 'Invalid token. Please reach out to your support team'
             return response
-        if len(self.sid) > ByoGs.SID_CHARACTER_LIMIT:
+        # Check tag
+        if self.input_tag is None or len(self.input_tag.split()) > 1 or \
+                len(self.input_tag) > ByoGs.TAG_CHARACTER_LIMIT:
             response['msg'] = (
-                "Invalid Game Server ID. "
-                f"Game Server ID should be less than {ByoGs.SID_CHARACTER_LIMIT} characters"
+                "Tag should be a single word with maximum of "
+                f"{ByoGs.TAG_CHARACTER_LIMIT} characters"
             )
             return response
-        # Validation for subcommands
-        if self.subcommand == 'create':
-            if self.name == '':
-                response['msg'] = "Missing name"
-                return response
-            if self.language not in ByoGs.LANGUAGES:
-                response['msg'] = (
-                    "Invalid language. Valid languages "
-                    f"are {', '.join(ByoGs.LANGUAGES)}."
-                )
+        if self.subcommand in ['build', 'publish']:
+            if not self.input_tag:
+                response['msg'] = "Missing required parameter:  tag"
                 return response
-            if self.platform_type not in ByoGs.PLATFORMS:
-                response['msg'] = (
-                    "Invalid platform. Valid platforms "
-                    f"are {', '.join(ByoGs.PLATFORMS)}."
-                )
+            if not self.path:
+                response['msg'] = "Missing required parameter:  path"
                 return response
-        else:
-            if self.token_parts is None:
-                response['msg'] = 'Invalid token. Please reach out to your support team'
+            # Check path
+            if not os.path.isfile(f"{self.path}/{self.dockerfile}"):
+                response['msg'] = f"Unable to find {self.dockerfile} at path {self.path}"
                 return response
-            # Check tag
-            if self.input_tag is None or len(self.input_tag.split()) > 1 or \
-                    len(self.input_tag) > ByoGs.TAG_CHARACTER_LIMIT:
-                response['msg'] = (
-                    "Tag should be a single word with maximum of "
-                    f"{ByoGs.TAG_CHARACTER_LIMIT} characters"
-                )
+        elif self.subcommand == 'push':
+            if not self.input_tag:
+                response['msg'] = "Missing required parameter:  tag"
                 return response
-            if self.subcommand in ['build', 'publish-image', 'publish']:
-                if not self.input_tag:
-                    response['msg'] = "Missing required parameter:  tag"
-                    return response
-                if not self.path:
-                    response['msg'] = "Missing required parameter:  path"
-                    return response
-                # Check path
-                if not os.path.isfile(f"{self.path}/{self.dockerfile}"):
-                    response['msg'] = f"Unable to find {self.dockerfile} at path {self.path}"
-                    return response
-            elif self.subcommand == 'push':
-                if not self.input_tag:
-                    response['msg'] = "Missing required parameter:  tag"
-                    return response
-            elif self.subcommand == 'publish-version':
-                if not self.version:
-                    response['msg'] = "Missing required parameter:  version"
-                    return response
-                if not self.http_port:
-                    response['msg'] = "Missing required parameter:  Ingress HTTP Port"
-                    return response
-                pattern = r'^v\d+\.\d+\.\d+$'
-                if not re.match(pattern, self.version):
-                    response['msg'] = "Version should be in the format vX.X.X"
-                    return response
-                if not self.http_port.isdigit():
-                    response['msg'] = "Ingress HTTP Port should be a number"
-                    return response
-                if self.debug_port and not self.debug_port.isdigit():
-                    response['msg'] = "Debug Port should be a number"
-                    return response
         # Send success
         response['error'] = False
         return response
@@ -376,63 +309,6 @@ class ByoGs:
         return True
 
     # Upper echelon commands
-    def create(self) -> bool:
-        """
-            Create a new game server
-        """
-        with Progress(
-            SpinnerColumn(),
-            TextColumn("[progress.description]{task.description}"),
-            transient=True,
-        ) as progress:
-            progress.add_task(
-                description='Creating your game server...', total=None)
-            try:
-                payload = {
-                    "service_id": self.sid,
-                    "name": self.name,
-                    "description": self.desc,
-                    "platform": self.platform_type,
-                    "language": self.language,
-                }
-                res = requests.post(
-                    f"{self.base_url}/v1/snapser-api/byogs",
-                    json=payload, headers={'api-key': self.api_key},
-                    timeout=SERVER_CALL_TIMEOUT
-                )
-                if res.ok:
-                    return True
-                response_json = res.json()
-                if "api_error_code" in response_json:
-                    if response_json['api_error_code'] == ERROR_SERVICE_VERSION_EXISTS:
-                        error(
-                            'Version already exists. Please update your version and try again'
-                        )
-                    if response_json['api_error_code'] == ERROR_TAG_NOT_AVAILABLE:
-                        error('Invalid tag. Please use the correct tag')
-                else:
-                    error(
-                        f'Server error: {json.dumps(response_json, indent=2)}'
-                    )
-            except RequestException as e:
-                error(f"Exception: Unable to create your game server {e}")
-            return False
-
-    def publish_image(self) -> bool:
-        """
-          Publish the image
-          1. Check Dependencies
-          2. Login to Snapser Registry
-          3. Build your snap
-          4. Tag the repo
-          5. Push the image
-          6. Upload swagger.json
-        """
-        if not self._check_dependencies() or not self._docker_login() or \
-                not self._docker_build() or not self._docker_tag() or not self._docker_push():
-            return False
-        return True
-
     def publish(self) -> bool:
         """
           Publish the image
@@ -447,47 +323,3 @@ class ByoGs:
                 not self._docker_build() or not self._docker_tag() or not self._docker_push():
             return False
         return True
-
-    def publish_version(self) -> bool:
-        """
-            Publish your game server version
-        """
-        with Progress(
-            SpinnerColumn(),
-            TextColumn("[progress.description]{task.description}"),
-            transient=True,
-        ) as progress:
-            progress.add_task(
-                description='Publishing your snap...', total=None)
-            try:
-                payload = {
-                    "version": self.version,
-                    "image_tag": self.input_tag,
-                    "http_port": self.http_port,
-                }
-                if self.debug_port:
-                    payload['debug_port'] = self.debug_port
-                res = requests.post(
-                    f"{self.base_url}/v1/snapser-api/byogs/{self.sid}/versions",
-                    json=payload, headers={'api-key': self.api_key},
-                    timeout=SERVER_CALL_TIMEOUT
-                )
-                if res.ok:
-                    return True
-                response_json = res.json()
-                if "api_error_code" in response_json:
-                    if response_json['api_error_code'] == ERROR_SERVICE_VERSION_EXISTS:
-                        error(
-                            'Version already exists. Please update your version and try again'
-                        )
-                    if response_json['api_error_code'] == ERROR_TAG_NOT_AVAILABLE:
-                        error('Invalid tag. Please use the correct tag')
-                else:
-                    error(
-                        f'Server error: {json.dumps(response_json, indent=2)}'
-                    )
-            except RequestException as e:
-                error(
-                    f"Exception: Unable to publish a version for your snap {e}"
-                )
-            return False

{snapctl-0.31.0 → snapctl-0.32.0}/snapctl/commands/byosnap.py

@@ -35,12 +35,14 @@ class ByoSnap:
     DEFAULT_BUILD_PLATFORM = 'linux/arm64'
     SID_CHARACTER_LIMIT = 47
     TAG_CHARACTER_LIMIT = 80
+    VALID_CPU_MARKS = [100, 250, 500, 750, 1000, 1500, 2000, 3000]
+    VALID_MEMORY_MARKS = [0.125, 0.25, 0.5, 1, 2, 3, 4]
 
     def __init__(
         self, subcommand: str, base_url: str, api_key: str | None, sid: str, name: str,
         desc: str, platform_type: str, language: str, input_tag: Union[str, None],
         path: Union[str, None], dockerfile: str, prefix: str, version: Union[str, None],
-        http_port: Union[int, None]
+        http_port: Union[int, None], byosnap_profile: Union[str, None]
     ) -> None:
         self.subcommand: str = subcommand
         self.base_url: str = base_url
@@ -65,6 +67,7 @@ class ByoSnap:
         self.prefix: str = prefix
         self.version: Union[str, None] = version
         self.http_port: Union[int, None] = http_port
+        self.byosnap_profile: Union[str, None] = byosnap_profile
 
     # Protected methods
     @staticmethod
@@ -254,6 +257,63 @@ class ByoSnap:
         success('Snap Upload Successful')
         return True
 
+    def _validate_byosnap_profile(self) -> bool:
+        """
+          Validate the BYOSnap profile
+        """
+        response = {
+            'error': True,
+            'message': ''
+        }
+        if not self.byosnap_profile:
+            response['message'] = "Missing BYOSnap profile path"
+            return response
+        if not os.path.isfile(self.byosnap_profile):
+            response['msg'] = (
+                "Unable to find BYOSnap profile "
+                F"JSON at path {self.byosnap_profile}"
+            )
+            return response
+        with open(self.byosnap_profile, 'rb') as file:
+            try:
+                profile_data = json.load(file)
+            except json.JSONDecodeError:
+                response['message'] = (
+                    'Invalid BYOSnap profile JSON. Please check the JSON structure'
+                )
+                return response
+            if 'dev_template' not in profile_data or \
+                'stage_template' not in profile_data or \
+                    'prod_template' not in profile_data:
+                response['message'] = (
+                    'Invalid BYOSnap profile JSON. Please check the JSON structure'
+                )
+                return response
+            for profile in ['dev_template', 'stage_template', 'prod_template']:
+                if 'cpu' not in profile_data[profile] or \
+                    'memory' not in profile_data[profile] or \
+                        'cmd' not in profile_data[profile] or \
+                        'args' not in profile_data[profile] or \
+                        'env_params' not in profile_data[profile]:
+                    response['message'] = (
+                        'Invalid BYOSnap profile JSON. Please check the JSON structure'
+                    )
+                    return response
+                if profile_data[profile]['cpu'] not in ByoSnap.VALID_CPU_MARKS:
+                    response['message'] = (
+                        'Invalid CPU value in BYOSnap profile. '
+                        f'Valid values are {", ".join(ByoSnap.VALID_CPU_MARKS)}'
+                    )
+                    return response
+                if profile_data[profile]['memory'] not in ByoSnap.VALID_MEMORY_MARKS:
+                    response['message'] = (
+                        'Invalid Memory value in BYOSnap profile. '
+                        f'Valid values are {", ".join(ByoSnap.VALID_MEMORY_MARKS)}'
+                    )
+                    return response
+        response['error'] = False
+        return response
+
     # Public methods
 
     # Validator
@@ -359,6 +419,12 @@ class ByoSnap:
                 if not self.http_port.isdigit():
                     response['msg'] = "Ingress HTTP Port should be a number"
                     return response
+                # Check byosnap_profile path
+                validation_response = self._validate_byosnap_profile()
+                if validation_response['error']:
+                    response['msg'] = validation_response['message']
+                    return response
+
         # Send success
         response['error'] = False
         return response
@@ -539,11 +605,20 @@ class ByoSnap:
             progress.add_task(
                 description='Publishing your snap...', total=None)
             try:
+                profile_data = {}
+                profile_data['dev_template'] = None
+                profile_data['stage_template'] = None
+                profile_data['prod_template'] = None
+                with open(self.byosnap_profile, 'rb') as file:
+                    profile_data = json.load(file)
                 payload = {
                     "version": self.version,
                     "image_tag": self.input_tag,
                     "base_url": f"{self.prefix}/{self.sid}",
                     "http_port": self.http_port,
+                    "dev_template": profile_data['dev_template'],
+                    "stage_template": profile_data['stage_template'],
+                    "prod_template": profile_data['prod_template']
                 }
                 res = requests.post(
                     f"{self.base_url}/v1/snapser-api/byosnaps/{self.sid}/versions",

snapctl-0.32.0/snapctl/commands/generate.py

@@ -0,0 +1,77 @@
+"""
+    Generate CLI commands
+"""
+import json
+from sys import platform
+import os
+from typing import Union
+
+from snapctl.config.hashes import BYOSNAP_TEMPLATE
+from snapctl.types.definitions import ResponseType
+from snapctl.utils.echo import error, success
+
+
+class Generate:
+    """
+        Generate CLI commands
+    """
+    SUBCOMMANDS = ['byosnap-profile']
+    BYOSNAP_PROFILE_FN = 'snapser-byosnap-profile.json'
+
+    def __init__(
+        self, subcommand: str, base_url: str, api_key: str | None,
+        out_path: Union[str, None]
+    ) -> None:
+        self.subcommand: str = subcommand
+        self.base_url: str = base_url
+        self.api_key: str = api_key
+        self.out_path: Union[str, None] = out_path
+
+    # Validator
+
+    def validate_input(self) -> ResponseType:
+        """
+          Validator
+        """
+        response: ResponseType = {
+            'error': True,
+            'msg': '',
+            'data': []
+        }
+        if self.subcommand in ['byosnap-profile']:
+            # Check path
+            if self.out_path and not os.path.isdir(self.out_path):
+                response['msg'] = (
+                    f"Invalid path {self.out_path}. Wont be able to "
+                    "store the byosnap-profile.json file"
+                )
+                return response
+        # Send success
+        response['error'] = False
+        return response
+
+    def byosnap_profile(self) -> bool:
+        """
+            Generate snapser-byosnap-profile.json
+        """
+        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}{Generate.BYOSNAP_PROFILE_FN}"
+        else:
+            file_save_path = f"{os.getcwd()}{file_path_symbol}{Generate.BYOSNAP_PROFILE_FN}"
+        try:
+            with open(file_save_path, "w") as file:
+                json.dump(BYOSNAP_TEMPLATE, file, indent=4)
+                success(
+                    f"{Generate.BYOSNAP_PROFILE_FN} saved at {file_save_path}"
+                )
+                return True
+        except (IOError, OSError) as file_error:
+            error(f"File error: {file_error}")
+        except json.JSONDecodeError as json_error:
+            error(f"JSON error: {json_error}")
+        except Exception as exception_error:
+            error(f"An unexpected error occurred: {exception_error}")
+        return False

{snapctl-0.31.0 → snapctl-0.32.0}/snapctl/config/constants.py

@@ -2,13 +2,14 @@
 Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
-VERSION = '0.31.0'
+VERSION = '0.32.0'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
 DEFAULT_PROFILE = 'default'
 API_KEY = 'SNAPSER_API_KEY'
 URL_KEY = 'SNAPSER_URL_KEY'
+CONFIG_PATH_KEY = 'SNAPSER_CONFIG_PATH'
 SERVER_CALL_TIMEOUT = 30
 
 SNAPCTL_SUCCESS = 0

{snapctl-0.31.0 → snapctl-0.32.0}/snapctl/config/hashes.py

@@ -155,3 +155,17 @@ SERVICE_IDS = [
     'relay', 'remote-config', 'scheduler', 'sequencer', 'social-graph', 'statistics', 'storage',
     'trackables', 'xp'
 ]
+
+DEFAULT_BYOSNAP_TEMPLATE = {
+    'cpu': 100,
+    'memory': 0.125,
+    'cmd': '',
+    'args': [],
+    'env_params': []
+}
+
+BYOSNAP_TEMPLATE = {
+    'dev_template': DEFAULT_BYOSNAP_TEMPLATE,
+    'stage_template': DEFAULT_BYOSNAP_TEMPLATE,
+    'prod_template': DEFAULT_BYOSNAP_TEMPLATE
+}

{snapctl-0.31.0 → snapctl-0.32.0}/snapctl/main.py

@@ -11,9 +11,10 @@ import pyfiglet
 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.config.constants import COMPANY_NAME, API_KEY, URL_KEY, CONFIG_FILE_MAC, \
-    CONFIG_FILE_WIN, DEFAULT_PROFILE, VERSION, SNAPCTL_SUCCESS, SNAPCTL_ERROR
+    CONFIG_FILE_WIN, DEFAULT_PROFILE, VERSION, SNAPCTL_SUCCESS, SNAPCTL_ERROR, CONFIG_PATH_KEY
 from snapctl.config.endpoints import END_POINTS
 from snapctl.config.hashes import CLIENT_SDK_TYPES, SERVER_SDK_TYPES, PROTOS_TYPES, SERVICE_IDS, \
     SNAPEND_MANIFEST_TYPES
@@ -50,22 +51,23 @@ def extract_config(extract_key: str, profile: str | None = None) -> object:
         'location': '',
         'value': None
     }
-    # Option 1
+    # Option 1 - Get the API Key from the environment variable
     env_api_key = os.getenv(extract_key)
     if env_api_key is not None:
         result['location'] = 'environment-variable'
         result['value'] = env_api_key
         return result
-    # Option 2
-    config_file_path: str = ''
-    encoding: str | None = None
-    if platform == 'win32':
-        config_file_path = os.path.expandvars(CONFIG_FILE_WIN)
-        encoding = "utf-8-sig"
-    else:
-        config_file_path = os.path.expanduser(CONFIG_FILE_MAC)
+    encoding: str | None = "utf-8-sig" if platform == 'win32' else None
+    # Option 2 - Get the API Key from CONFIG PATH environment variable
+    config_file_path: str | None = os.getenv(CONFIG_PATH_KEY)
+    # Option 3 - Get the API Key from the hardcoded config file we look for
+    if config_file_path is None:
+        if platform == 'win32':
+            config_file_path = os.path.expandvars(CONFIG_FILE_WIN)
+        else:
+            config_file_path = os.path.expanduser(CONFIG_FILE_MAC)
+    result['location'] = f'config-file:{config_file_path}'
     if os.path.isfile(config_file_path):
-        result['location'] = 'config-file'
         config = configparser.ConfigParser()
         config.read(config_file_path, encoding=encoding)
         config_profile: str = DEFAULT_PROFILE
@@ -282,6 +284,11 @@ def byosnap(
     http_port: Union[str, None] = typer.Option(
         None, "--http-port", help="(req: publish-version) Ingress HTTP port version"
     ),
+    byosnap_profile: Union[str, None] = typer.Option(
+        None, "--byosnap-profile", help=(
+            "(req: publish-version) Path to your byosnap-profile JSON file"
+        )
+    ),
     # overrides
     api_key: Union[str, None] = typer.Option(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
@@ -297,7 +304,7 @@ def byosnap(
     byosnap_obj: ByoSnap = ByoSnap(
         subcommand, ctx.obj['base_url'], ctx.obj['api_key'], sid,
         name, desc, platform_type, language, tag, path, docker_file,
-        prefix, version, http_port
+        prefix, version, http_port, byosnap_profile
     )
     validate_input_response: ResponseType = byosnap_obj.validate_input()
     if validate_input_response['error']:
@@ -318,48 +325,21 @@ def byogs(
     subcommand: str = typer.Argument(
         ..., help="BYOGs Subcommands: " + ", ".join(ByoGs.SUBCOMMANDS) + "."
     ),
-    sid: str = typer.Argument(
-        ByoGs.SID,  help="Game Server Id. Should start with byogs"
-    ),
-    # create
-    name: str = typer.Option(
-        None, "--name", help="(req: create) Name for your snap"
-    ),
-    desc: str = typer.Option(
-        None, "--desc", help="(req: create) Description for your snap"
-    ),
-    platform_type: str = typer.Option(
-        None, "--platform",
-        help="(req: create) Platform for your snap - " + \
-        ", ".join(ByoGs.PLATFORMS) + "."
-    ),
-    language: str = typer.Option(
-        None, "--language",
-        help="(req: create) Language of your snap - " + \
-        ", ".join(ByoGs.LANGUAGES) + "."
-    ),
+    # sid: str = typer.Argument(
+    #     ByoGs.SID,  help="Game Server Id. Should start with byogs"
+    # ),
     # publish, publish-image and publish-version
     tag: str = typer.Option(
         None, "--tag",
-        help="(req: build, push, publish, publish-image and publish-version) Tag for your snap"
+        help="(req: build, push, publish) Tag for your snap"
     ),
     # publish and publish-image
     path: Union[str, None] = typer.Option(
-        None, "--path", help="(req: build, publish, publish-image, upload-docs) Path to your snap code"
+        None, "--path", help="(req: build, publish) Path to your snap code"
     ),
     docker_file: str = typer.Option(
         "Dockerfile", help="Dockerfile name to use"
     ),
-    # publish-version
-    version: Union[str, None] = typer.Option(
-        None, "--version", help="(req: publish-version) Snap version"
-    ),
-    http_port: Union[str, None] = typer.Option(
-        None, "--http-port", help="(req: publish-version) Ingress HTTP port version"
-    ),
-    debug_port: Union[str, None] = typer.Option(
-        None, "--debug-port", help="(optional: publish-version) Debug HTTP port version"
-    ),
     # overrides
     api_key: Union[str, None] = typer.Option(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
@@ -373,9 +353,8 @@ def byogs(
     """
     validate_command_context(ctx)
     byogs_obj: ByoGs = ByoGs(
-        subcommand, ctx.obj['base_url'], ctx.obj['api_key'], sid,
-        name, desc, platform_type, language, tag, path, docker_file,
-        version, http_port, debug_port
+        subcommand, ctx.obj['base_url'], ctx.obj['api_key'],
+        tag, path, docker_file,
     )
     validate_input_response: ResponseType = byogs_obj.validate_input()
     if validate_input_response['error']:
@@ -561,3 +540,42 @@ def snapend(
         error(f"Snapend {subcommand} failed")
         raise typer.Exit(SNAPCTL_ERROR)
     success(f"Snapend {subcommand} complete")
+
+
+@app.command()
+def generate(
+    ctx: typer.Context,
+    # Required fields
+    subcommand: str = typer.Argument(
+        ..., help="Generate Subcommands: " + ", ".join(Generate.SUBCOMMANDS) + "."
+    ),
+    # byosnap-profile
+    out_path: Union[str, None] = typer.Option(
+        None, "--out-path", help="(req: byosnap-profile) Path to output the byosnap profile"
+    ),
+    # overrides
+    api_key: Union[str, None] = typer.Option(
+        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+    ),
+    profile: Union[str, None] = typer.Option(
+        None, "--profile", help="Profile to use.", callback=profile_context_callback
+    ),
+) -> None:
+    """
+      Generate files to be used by other commands
+    """
+    validate_command_context(ctx)
+    generate_obj: Generate = Generate(
+        subcommand, ctx.obj['base_url'], ctx.obj['api_key'],
+        out_path,
+    )
+    validate_input_response: ResponseType = generate_obj.validate_input()
+    if validate_input_response['error']:
+        error(validate_input_response['msg'])
+        raise typer.Exit(SNAPCTL_ERROR)
+    command_method = subcommand.replace('-', '_')
+    method: Callable[..., bool] = getattr(generate_obj, command_method)
+    if not method():
+        error(f"Generate {subcommand} failed")
+        raise typer.Exit(SNAPCTL_ERROR)
+    success(f"Generate {subcommand} complete")