snapctl 0.29.1__py3-none-any.whl → 0.31.1__py3-none-any.whl

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/commands/snapend.py

@@ -117,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
 

snapctl/config/constants.py

@@ -2,13 +2,14 @@
 Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
-VERSION = '0.29.1'
+VERSION = '0.31.1'
 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/main.py

@@ -13,7 +13,7 @@ from snapctl.commands.byogs import ByoGs
 from snapctl.commands.game import Game
 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 +50,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
@@ -319,7 +320,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 +339,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"
@@ -512,7 +513,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"
         )
     ),

{snapctl-0.29.1.dist-info → snapctl-0.31.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.29.1
+Version: 0.31.1
 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]
@@ -302,7 +305,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 +339,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 +359,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 +372,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 +396,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
@@ -505,9 +526,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 byogs-fleet-one:gs-1:v0.0.1,my-fleet-two:gs-2: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.29.1.dist-info → snapctl-0.31.1.dist-info}/RECORD

@@ -1,21 +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/byogs.py,sha256=2Jocaemxn01IrKno3u9QrVeiAsqIpCJBVsWi2ivHuCY,19762
 snapctl/commands/byosnap.py,sha256=RQv3r30dkz8n1BgEnE-tAnAzPLoz-CLEQoiy1WKZQeg,23172
 snapctl/commands/game.py,sha256=rnsTqrXavE5D-KULXkDBQ-PBI8sSKK4it3S_YMJfiUY,3633
-snapctl/commands/snapend.py,sha256=QfmjaGsB_expDdc9JSkrOWPkFmMYtPfBBNFMKFRn-mI,26242
+snapctl/commands/snapend.py,sha256=exMH-8lp9qUociAWHJS15xRr-MtCe1fjbQAQmgODNIw,26187
 snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/config/constants.py,sha256=z-_Wjcw77f_m_H8PRg__eSjzbbdxrmZ3ypugBQXKoYg,525
+snapctl/config/constants.py,sha256=iX5zkftpOqdGJWoCK8-zwP_Mz9GD3BU62DVKrzTygpw,565
 snapctl/config/endpoints.py,sha256=VAeOmx3k3ukB-9XuGI65KtCJwFK-KFgzor-UWE8JU0g,297
 snapctl/config/hashes.py,sha256=tb0ilslgYvI8L4IKeiMfz2qYRDcezat8tg8dPGqlbAU,3093
-snapctl/main.py,sha256=l4VcMszsLyeDfGjTC_uNyv9Weo4kGSqq6xp6cgOf96w,18814
+snapctl/main.py,sha256=QES1PqGgMWjKVcOdUA8b14KHweiE2iJigxKtaoJfBDw,19147
 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.29.1.dist-info/METADATA,sha256=D7zafku1LZjZzYLKgEgjS0pGwjlqVHO7HKIUTS7Dt8k,15526
-snapctl-0.29.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-snapctl-0.29.1.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-0.29.1.dist-info/RECORD,,
+snapctl-0.31.1.dist-info/METADATA,sha256=cIywFLCBwuCumEUspq8sf4qgNcsAcixFSIph1Wz0fvI,16509
+snapctl-0.31.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+snapctl-0.31.1.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-0.31.1.dist-info/RECORD,,