snapctl 0.26.1__tar.gz → 0.31.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.26.1
+Version: 0.31.0
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -302,7 +302,7 @@ See all the supported commands
 snapctl byogs --help
 ```
 
-#### 2. byogs create
+#### 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.
@@ -336,7 +336,7 @@ snapctl byogs build --help
 # $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/jinks_flask
+# 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
 ```
 
@@ -356,7 +356,7 @@ snapctl byogs push --help
 snapctl byogs push $byogs_sid --tag $image_tag
 ```
 
-#### 5. byogs publish-image
+#### 5. [Deprecated soon] byogs publish-image
 
 Publish your custom game server image. This command executes, `build` and `push` one after the other.
 
@@ -369,11 +369,11 @@ snapctl byogs publish-image --help
 # $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/jinks_flask
+# 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. byogs publish-version
+#### 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.
@@ -393,6 +393,24 @@ snapctl byogs publish-version --help
 snapctl byogs publish-version $byogs_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
 ```
 
+#### 7. [New] 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.
+
+```
+# Help for the byogs command
+snapctl byogs publish --help
+
+# Publish a new image
+# $image_tag = An image tag for your snap
+# $code_root_path = Local code path where your Dockerfile is present
+# Example:
+# snapctl byogs publish --tag my-first-image --path /Users/DevName/Development/SnapserEngine/game_server
+snapctl byogs publish --tag $image_tag --path $code_root_path
+```
+
+
 ### Game
 
 #### 1. snapend help
@@ -443,10 +461,14 @@ snapctl snapend download --help
 #   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)
+#   protos(go, csharp, cpp, raw)
+# $protos-category = messages or services (only with --type protos)
+# $auth-type = user or app (only with --type server-sdk)
 # Example:
 # snapctl snapend download gx5x6bc0 --category snapend-manifest --type yaml
 # snapctl snapend download gx5x6bc0 --category client-sdk --type unity
+# snapctl snapend download gx5x6bc0 --category server-sdk --type unity --auth-type app
+# snapctl snapend download gx5x6bc0 --category protos --type raw --protos-category messages
 snapctl snapend download $snapend_id --category $category --type $type
 ```
 
@@ -455,10 +477,10 @@ snapctl snapend download $snapend_id --category $category --type $type
 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
+# Help for the clone command
 snapctl snapend clone --help
 
-# Download your Snapend SDK and Protos
+# Clone your Snapend
 # $gameId = Game Id
 # $snapendName = Name of your new Snapend
 # $env = One of development, staging
@@ -475,10 +497,10 @@ Apply changes to your Snapend from a manifest. You should have the latest manife
 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
+# Help for the apply command
 snapctl snapend apply --help
 
-# Download your Snapend SDK and Protos
+# Apply changes to a snapend via manifest
 # $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
@@ -502,7 +524,7 @@ snapctl snapend update --help
 # 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 byogs-fleet-one:gs-1:v0.0.1,my-fleet-two:gs-2:v0.0.4 --blocking
+# 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-0.26.1 → snapctl-0.31.0}/README.md

@@ -285,7 +285,7 @@ See all the supported commands
 snapctl byogs --help
 ```
 
-#### 2. byogs create
+#### 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.
@@ -319,7 +319,7 @@ snapctl byogs build --help
 # $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/jinks_flask
+# 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
 ```
 
@@ -339,7 +339,7 @@ snapctl byogs push --help
 snapctl byogs push $byogs_sid --tag $image_tag
 ```
 
-#### 5. byogs publish-image
+#### 5. [Deprecated soon] byogs publish-image
 
 Publish your custom game server image. This command executes, `build` and `push` one after the other.
 
@@ -352,11 +352,11 @@ snapctl byogs publish-image --help
 # $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/jinks_flask
+# 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. byogs publish-version
+#### 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.
@@ -376,6 +376,24 @@ snapctl byogs publish-version --help
 snapctl byogs publish-version $byogs_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port
 ```
 
+#### 7. [New] 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.
+
+```
+# Help for the byogs command
+snapctl byogs publish --help
+
+# Publish a new image
+# $image_tag = An image tag for your snap
+# $code_root_path = Local code path where your Dockerfile is present
+# Example:
+# snapctl byogs publish --tag my-first-image --path /Users/DevName/Development/SnapserEngine/game_server
+snapctl byogs publish --tag $image_tag --path $code_root_path
+```
+
+
 ### Game
 
 #### 1. snapend help
@@ -426,10 +444,14 @@ snapctl snapend download --help
 #   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)
+#   protos(go, csharp, cpp, raw)
+# $protos-category = messages or services (only with --type protos)
+# $auth-type = user or app (only with --type server-sdk)
 # Example:
 # snapctl snapend download gx5x6bc0 --category snapend-manifest --type yaml
 # snapctl snapend download gx5x6bc0 --category client-sdk --type unity
+# snapctl snapend download gx5x6bc0 --category server-sdk --type unity --auth-type app
+# snapctl snapend download gx5x6bc0 --category protos --type raw --protos-category messages
 snapctl snapend download $snapend_id --category $category --type $type
 ```
 
@@ -438,10 +460,10 @@ snapctl snapend download $snapend_id --category $category --type $type
 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
+# Help for the clone command
 snapctl snapend clone --help
 
-# Download your Snapend SDK and Protos
+# Clone your Snapend
 # $gameId = Game Id
 # $snapendName = Name of your new Snapend
 # $env = One of development, staging
@@ -458,10 +480,10 @@ Apply changes to your Snapend from a manifest. You should have the latest manife
 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
+# Help for the apply command
 snapctl snapend apply --help
 
-# Download your Snapend SDK and Protos
+# Apply changes to a snapend via manifest
 # $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
@@ -485,7 +507,7 @@ snapctl snapend update --help
 # 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 byogs-fleet-one:gs-1:v0.0.1,my-fleet-two:gs-2:v0.0.4 --blocking
+# 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-0.26.1 → snapctl-0.31.0}/pyproject.toml

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

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

@@ -24,10 +24,11 @@ class ByoGs:
     """
         BYOGS CLI commands
     """
-    ID_PREFIX = 'byogs-'
+    SID = 'byogs'
     SUBCOMMANDS = [
         'build', 'push',
         'create', 'publish-image', 'publish-version',
+        'publish'
     ]
     PLATFORMS = ['linux/amd64']
     LANGUAGES = ['go', 'python', 'ruby', 'c#', 'c++', 'rust', 'java', 'node']
@@ -45,15 +46,17 @@ class ByoGs:
         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': sid})
-        else:
-            self.token: Union[str, None] = None
+                base_url, api_key, 'byogs', {'service_id': self.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
@@ -269,10 +272,10 @@ class ByoGs:
             response['msg'] = f"Invalid command. Valid commands are {', '.join(ByoGs.SUBCOMMANDS)}."
             return response
         # Validate the SID
-        if not self.sid.startswith(ByoGs.ID_PREFIX):
+        if not self.sid.startswith(ByoGs.SID):
             response['msg'] = (
                 "Invalid Game Server ID. Valid Game Server IDs start "
-                f"with {ByoGs.ID_PREFIX}."
+                f"with {ByoGs.SID}."
             )
             return response
         if len(self.sid) > ByoGs.SID_CHARACTER_LIMIT:
@@ -310,7 +313,7 @@ class ByoGs:
                     f"{ByoGs.TAG_CHARACTER_LIMIT} characters"
                 )
                 return response
-            if self.subcommand == 'build' or self.subcommand == 'publish-image':
+            if self.subcommand in ['build', 'publish-image', 'publish']:
                 if not self.input_tag:
                     response['msg'] = "Missing required parameter:  tag"
                     return response
@@ -430,6 +433,21 @@ class ByoGs:
             return False
         return True
 
+    def publish(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_version(self) -> bool:
         """
             Publish your game server version

{snapctl-0.26.1 → snapctl-0.31.0}/snapctl/commands/snapend.py

@@ -30,6 +30,7 @@ class Snapend:
         'client-sdk', 'server-sdk', 'protos', 'admin-settings', 'snapend-manifest'
     ]
     DOWNLOAD_TYPE_NOT_REQUIRED = ['admin-settings']
+    PROTOS_CATEGORY = ['messages', 'services']
     AUTH_TYPES = ['user', 'app']
     ENV_TYPES = ['DEVELOPMENT', 'STAGING']
     BLOCKING_CALL_SLEEP = 5
@@ -45,7 +46,7 @@ class Snapend:
         # Clone, Apply, Promote
         manifest_path: str | None,
         # Download
-        category: str, platform_type: str, auth_type: str, snaps: str | None,
+        category: str, platform_type: str, protos_category: str, auth_type: str, snaps: str | None,
         # Clone, Apply, Promote, Download
         out_path: str | None,
         # Update
@@ -66,6 +67,7 @@ class Snapend:
         self.download_types: Union[
             dict[str, dict[str, str]], None
         ] = Snapend._make_download_type(category)
+        self.protos_category: str = protos_category
         self.auth_type: str = auth_type
         self.platform_type: str = platform_type
         self.out_path: str | None = out_path
@@ -115,12 +117,11 @@ class Snapend:
         byogs_list = []
         for byog in byogs.split(','):
             byog = byog.strip()
-            if len(byog.split(':')) != 3:
+            if len(byog.split(':')) != 2:
                 return []
             byogs_list.append({
                 'fleet_name': byog.split(':')[0],
-                'service_id': byog.split(':')[1],
-                'service_version': byog.split(':')[2]
+                'image_tag': byog.split(':')[1],
             })
         return byogs_list
 
@@ -179,14 +180,18 @@ class Snapend:
                 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}"
+                url += f"&type={self.download_types[self.platform_type]['type']}"
+            # If Protos, add protos category
+            if self.category == 'protos':
+                url += f"&subtype={self.protos_category}"
+            # If client or server SDK, add sub type and auth type
+            if self.category in ['client-sdk', 'server-sdk']:
+                url += 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}"
+            # Customize snaps
             if self.snaps:
                 url += f"&snaps={self.snaps}"
             res = requests.get(
@@ -200,6 +205,11 @@ class Snapend:
                     f"snapser-{self.snapend_id}-"
                     f"manifest.{self.download_types[self.platform_type]['type']}"
                 )
+            elif self.category == 'protos':
+                fn = (
+                    f"snapser-{self.snapend_id}-{self.category}"
+                    f"-{self.platform_type}-{self.protos_category}.zip"
+                )
             else:
                 fn = (
                     f"snapser-{self.snapend_id}-{self.category}"
@@ -292,6 +302,13 @@ class Snapend:
                     "Please enter a valid path to save your output file"
                 )
                 return response
+            # Check the Protos category
+            if self.category == 'protos' and self.protos_category not in Snapend.PROTOS_CATEGORY:
+                response['msg'] = (
+                    "Invalid Protos category. Valid categories are "
+                    f"{', '.join(Snapend.PROTOS_CATEGORY)}."
+                )
+                return response
             # Check the auth type
             if self.category == 'server-sdk' and self.auth_type not in Snapend.AUTH_TYPES:
                 response['msg'] = (

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

@@ -2,7 +2,7 @@
 Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
-VERSION = '0.26.1'
+VERSION = '0.31.0'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 

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

@@ -120,10 +120,22 @@ SERVER_SDK_TYPES: dict[str, dict[str, str]] = {
 }
 
 PROTOS_TYPES: dict[str, dict[str, str]] = {
+    'cpp': {
+        'type': 'cpp',
+        'subtype': '',
+    },
+    'csharp': {
+        'type': 'csharp',
+        'subtype': '',
+    },
     'go': {
         'type': 'go',
         'subtype': '',
     },
+    'raw': {
+        'type': 'raw',
+        'subtype': '',
+    },
 }
 
 SNAPEND_MANIFEST_TYPES: dict[str, dict[str, str]] = {

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

@@ -319,7 +319,7 @@ def byogs(
         ..., help="BYOGs Subcommands: " + ", ".join(ByoGs.SUBCOMMANDS) + "."
     ),
     sid: str = typer.Argument(
-        ...,  help="Game Server Id. Should start with byogs-"
+        ByoGs.SID,  help="Game Server Id. Should start with byogs"
     ),
     # create
     name: str = typer.Option(
@@ -338,14 +338,14 @@ def byogs(
         help="(req: create) Language of your snap - " + \
         ", ".join(ByoGs.LANGUAGES) + "."
     ),
-    # publish-image and publish-version
+    # publish, publish-image and publish-version
     tag: str = typer.Option(
         None, "--tag",
-        help="(req: build, push, publish-image and publish-version) Tag for your snap"
+        help="(req: build, push, publish, publish-image and publish-version) Tag for your snap"
     ),
-    # publish-image
+    # publish and publish-image
     path: Union[str, None] = typer.Option(
-        None, "--path", help="(req: build, publish-image, upload-docs) Path to your snap code"
+        None, "--path", help="(req: build, publish, publish-image, upload-docs) Path to your snap code"
     ),
     docker_file: str = typer.Option(
         "Dockerfile", help="Dockerfile name to use"
@@ -468,6 +468,13 @@ def snapend(
             ", ".join(SNAPEND_MANIFEST_TYPES.keys()) + ")"
         )
     ),
+    protos_category: str = typer.Option(
+        'messages', "--protos-category",
+        help=(
+            "(optional: download) Only applicable for --category protos --protos-category"
+            "Protos-Category: (" + ", ".join(Snapend.PROTOS_CATEGORY) + ")"
+        )
+    ),
     auth_type: str = typer.Option(
         'user', "--auth-type",
         help=(
@@ -505,7 +512,7 @@ def snapend(
     byogs: str = typer.Option(
         None, "--byogs",
         help=(
-            "(optional: update) Comma separated list of BYOGs fleet name, ids and versions. "
+            "(optional: update) Comma separated list of BYOGs fleet name:tags. "
             "Eg: fleet-1:service-1:v1.0.0,fleet-2:service-2:v1.0.0"
         )
     ),
@@ -538,7 +545,7 @@ def snapend(
         # Apply, Clone
         manifest_path,
         # Download
-        category, platform_type, auth_type, snaps,
+        category, platform_type, protos_category, auth_type, snaps,
         # Download, Apply and Clone
         out_path,
         # Update