snapctl 0.32.2__tar.gz → 0.35.0__tar.gz

{snapctl-0.32.2 → snapctl-0.35.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.32.2
+Version: 0.35.0
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -272,9 +272,11 @@ snapctl byosnap publish-image --help
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
+# $skip-build = true/false. Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
 # Example:
 # snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
 snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path
+snapctl byosnap publish-image $byosnap_sid --tag $image_tag --skip-build
 ```
 
 #### 7. byosnap publish-version
@@ -292,7 +294,7 @@ snapctl byosnap publish-version --help
 # $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
-# $byosnap_profile = BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl generate byosnap` command
+# $byosnap_profile = BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command
 # Example:
 # snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003 --byosnap-profile /Users/DevName/Development/SnapserEngine/jinks_flask/snapser-byosnap-profile.json
 snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port --byosnap-profile $byosnap_profile
@@ -353,9 +355,11 @@ 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
+# $skip-build = Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
 # 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
+snapctl byogs publish --tag $image_tag --skip-build
 ```
 
 
@@ -393,11 +397,19 @@ See all the supported commands
 snapctl generate --help
 ```
 
-#### 2. BYOSnap Profile
+#### 2. Generate BYOSnap Profile
 Generate the base file for BYOSnap profile to be used in the `snapctl byosnap publish-version` command
 
 ```
-snapctl generate byosnap-profile --out-path $output_path
+snapctl generate profile --category "byosnap" --out-path $output_path
+
+```
+
+#### 3. Generate ECR Credentials
+Generate the ECR credentials. Game studios can use these credentials to self publish their images to Snapser.
+
+```
+snapctl generate credentials --category "ecr" --out-path $output_path
 
 ```
 
@@ -596,5 +608,6 @@ snapctl snapend state $snapend_id
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
 | 80         | Generic generate error                                   |
-| 81         | Generate BYOSNAP profile error                           |
+| 81         | Generate profile error                                   |
+| 82         | Generate credentials error                               |
 

{snapctl-0.32.2 → snapctl-0.35.0}/README.md

@@ -253,9 +253,11 @@ snapctl byosnap publish-image --help
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
+# $skip-build = true/false. Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
 # Example:
 # snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
 snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path
+snapctl byosnap publish-image $byosnap_sid --tag $image_tag --skip-build
 ```
 
 #### 7. byosnap publish-version
@@ -273,7 +275,7 @@ snapctl byosnap publish-version --help
 # $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
-# $byosnap_profile = BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl generate byosnap` command
+# $byosnap_profile = BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command
 # Example:
 # snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --prefix /v1 --version v0.0.1 --http-port 5003 --byosnap-profile /Users/DevName/Development/SnapserEngine/jinks_flask/snapser-byosnap-profile.json
 snapctl byosnap publish-version $byosnap_sid --tag $image_tag --prefix $prefix --version $version --http-port $ingress_port --byosnap-profile $byosnap_profile
@@ -334,9 +336,11 @@ 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
+# $skip-build = Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
 # 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
+snapctl byogs publish --tag $image_tag --skip-build
 ```
 
 
@@ -374,11 +378,19 @@ See all the supported commands
 snapctl generate --help
 ```
 
-#### 2. BYOSnap Profile
+#### 2. Generate BYOSnap Profile
 Generate the base file for BYOSnap profile to be used in the `snapctl byosnap publish-version` command
 
 ```
-snapctl generate byosnap-profile --out-path $output_path
+snapctl generate profile --category "byosnap" --out-path $output_path
+
+```
+
+#### 3. Generate ECR Credentials
+Generate the ECR credentials. Game studios can use these credentials to self publish their images to Snapser.
+
+```
+snapctl generate credentials --category "ecr" --out-path $output_path
 
 ```
 
@@ -577,4 +589,5 @@ snapctl snapend state $snapend_id
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
 | 80         | Generic generate error                                   |
-| 81         | Generate BYOSNAP profile error                           |
+| 81         | Generate profile error                                   |
+| 82         | Generate credentials error                               |

{snapctl-0.32.2 → snapctl-0.35.0}/pyproject.toml

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

{snapctl-0.32.2 → snapctl-0.35.0}/snapctl/commands/byogs.py

@@ -8,14 +8,13 @@ import subprocess
 from sys import platform
 from typing import Union
 
-import typer
 from rich.progress import Progress, SpinnerColumn, TextColumn
 from snapctl.config.constants import SNAPCTL_BYOGS_DEPENDENCY_MISSING, \
     SNAPCTL_BYOGS_ECR_LOGIN_ERROR, SNAPCTL_BYOGS_BUILD_ERROR, \
     SNAPCTL_BYOGS_TAG_ERROR, SNAPCTL_BYOGS_PUBLISH_ERROR, \
     SNAPCTL_BYOGS_PUBLISH_DUPLICATE_TAG_ERROR, SNAPCTL_INPUT_ERROR
-from snapctl.utils.echo import error, success
 from snapctl.utils.helper import get_composite_token, snapctl_error, snapctl_success
+from snapctl.utils.echo import info
 
 
 class ByoGs:
@@ -33,6 +32,7 @@ class ByoGs:
     def __init__(
         self, subcommand: str, base_url: str, api_key: str | None,
         input_tag: Union[str, None], path: Union[str, None], dockerfile: str,
+        skip_build: bool = False
     ) -> None:
         self.subcommand: str = subcommand
         self.base_url: str = base_url
@@ -49,6 +49,7 @@ class ByoGs:
         self.input_tag: Union[str, None] = input_tag
         self.path: Union[str, None] = path
         self.dockerfile: str = dockerfile
+        self.skip_build: bool = skip_build
         # Validate input
         self.validate_input()
 
@@ -143,7 +144,7 @@ class ByoGs:
         progress.add_task(
             description='Building your snap...', total=None)
         try:
-            image_tag = f'{ByoGs.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]
@@ -152,14 +153,14 @@ class ByoGs:
             if platform == "win32":
                 response = subprocess.run([
                     # f"docker build --no-cache -t {tag} {path}"
-                    'docker', 'build', '--platform', build_platform, '-t', image_tag,
+                    'docker', 'build', '--platform', build_platform, '-t', self.input_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} "
+                    f"docker build --platform {build_platform} -t {self.input_tag} "
                     f"-f {docker_file_path} {self.path}"
                 ], shell=True, check=False)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
@@ -188,11 +189,11 @@ class ByoGs:
             # Tag the repo
             if platform == "win32":
                 response = subprocess.run([
-                    'docker', 'tag', image_tag, full_ecr_repo_url
+                    'docker', 'tag', self.input_tag, full_ecr_repo_url
                 ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
             else:
                 response = subprocess.run([
-                    f"docker tag {image_tag} {full_ecr_repo_url}"
+                    f"docker tag {self.input_tag} {full_ecr_repo_url}"
                 ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
             if not response.returncode:
                 return snapctl_success('BYOGS tag successful', progress, no_exit=True)
@@ -263,11 +264,11 @@ class ByoGs:
                 SNAPCTL_INPUT_ERROR
             )
         if self.subcommand in ['build', 'publish']:
-            if not self.path:
+            if not self.skip_build and not self.path:
                 snapctl_error("Missing required parameter:  path",
                               SNAPCTL_INPUT_ERROR)
             # Check path
-            if not os.path.isfile(f"{self.path}/{self.dockerfile}"):
+            if not self.skip_build and not os.path.isfile(f"{self.path}/{self.dockerfile}"):
                 snapctl_error(
                     f"Unable to find {self.dockerfile} at path {self.path}", SNAPCTL_INPUT_ERROR)
         # elif self.subcommand == 'push':
@@ -313,7 +314,10 @@ class ByoGs:
         """
         self._check_dependencies()
         self._docker_login()
-        self._docker_build()
+        if not self.skip_build:
+            self._docker_build()
+        else:
+            info('--skip-build set. Skipping the build step.')
         self._docker_tag()
         self._docker_push()
         snapctl_success('BYOGS publish successful')

{snapctl-0.32.2 → snapctl-0.35.0}/snapctl/commands/byosnap.py

@@ -46,7 +46,8 @@ class ByoSnap:
         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], byosnap_profile: Union[str, None]
+        http_port: Union[int, None], byosnap_profile: Union[str, None],
+        skip_build: bool = False
     ) -> None:
         self.subcommand: str = subcommand
         self.base_url: str = base_url
@@ -72,6 +73,7 @@ class ByoSnap:
         self.version: Union[str, None] = version
         self.http_port: Union[int, None] = http_port
         self.byosnap_profile: Union[str, None] = byosnap_profile
+        self.skip_build: bool = skip_build
         # Validate the input
         self.validate_input()
 
@@ -162,7 +164,7 @@ class ByoSnap:
 
     def _docker_build(self) -> None:
         # Get the data
-        image_tag = f'{self.sid}.{self.input_tag}'
+        # image_tag = f'{self.sid}.{self.input_tag}'
         build_platform = ByoSnap.DEFAULT_BUILD_PLATFORM
         if len(self.token_parts) == 4:
             build_platform = self.token_parts[3]
@@ -180,14 +182,14 @@ class ByoSnap:
             if platform == "win32":
                 response = subprocess.run([
                     # f"docker build --no-cache -t {tag} {path}"
-                    'docker', 'build', '--platform', build_platform, '-t', image_tag,
+                    'docker', 'build', '--platform', build_platform, '-t', self.input_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} "
+                    f"docker build --platform {build_platform} -t {self.input_tag} "
                     f"-f {docker_file_path} {self.path}"
                 ], shell=True, check=False)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
@@ -217,11 +219,11 @@ class ByoSnap:
             # Tag the repo
             if platform == "win32":
                 response = subprocess.run([
-                    'docker', 'tag', image_tag, full_ecr_repo_url
+                    'docker', 'tag', self.input_tag, full_ecr_repo_url
                 ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
             else:
                 response = subprocess.run([
-                    f"docker tag {image_tag} {full_ecr_repo_url}"
+                    f"docker tag {self.input_tag} {full_ecr_repo_url}"
                 ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
             if not response.returncode:
                 return snapctl_success('BYOSnap tag successful',
@@ -372,7 +374,7 @@ class ByoSnap:
             if self.token_parts is None:
                 snapctl_error('Invalid token. Please reach out to your support team.',
                               SNAPCTL_INPUT_ERROR)
-            if self.subcommand in ['build', 'publish-image']:
+            if self.subcommand in ['publish-image']:
                 if not self.input_tag:
                     snapctl_error(
                         "Missing required parameter: tag", SNAPCTL_INPUT_ERROR)
@@ -383,11 +385,11 @@ class ByoSnap:
                         f"{ByoSnap.TAG_CHARACTER_LIMIT} characters",
                         SNAPCTL_INPUT_ERROR
                     )
-                if not self.path:
+                if not self.skip_build and not self.path:
                     snapctl_error("Missing required parameter: path",
                                   SNAPCTL_INPUT_ERROR)
                 # Check path
-                if not os.path.isfile(f"{self.path}/{self.dockerfile}"):
+                if not self.skip_build and not os.path.isfile(f"{self.path}/{self.dockerfile}"):
                     snapctl_error(
                         f"Unable to find {self.dockerfile} at path {self.path}",
                         SNAPCTL_INPUT_ERROR)
@@ -592,10 +594,14 @@ class ByoSnap:
         """
         self._check_dependencies()
         self._docker_login()
-        self._docker_build()
+        if not self.skip_build:
+            self._docker_build()
+        else:
+            info('--skip-build set. Skipping the build step.')
         self._docker_tag()
         self._docker_push()
-        self.upload_docs()
+        if self.path is not None:
+            self.upload_docs()
         snapctl_success('BYOSNAP publish successful')
 
     def publish_version(self) -> None:

snapctl-0.35.0/snapctl/commands/generate.py

@@ -0,0 +1,215 @@
+"""
+    Generate CLI commands
+"""
+import base64
+from binascii import Error as BinasciiError
+import json
+import os
+from typing import Union
+from rich.progress import Progress, SpinnerColumn, TextColumn
+from snapctl.config.constants import SNAPCTL_INPUT_ERROR, \
+    SNAPCTL_GENERATE_GENERIC_ERROR, SNAPCTL_GENERATE_PROFILE_ERROR, \
+    SNAPCTL_GENERATE_CREDENTIALS_ERROR
+from snapctl.config.hashes import BYOSNAP_TEMPLATE
+from snapctl.utils.helper import get_composite_token, snapctl_error, snapctl_success
+
+
+class Generate:
+    """
+        Generate CLI commands
+    """
+    SUBCOMMANDS = ['byosnap-profile', 'profile', 'credentials']
+    DEPRECATED_SOON_SUBCOMMANDS = ['byosnap-profile']
+    BYOSNAP_PROFILE_FN = 'snapser-byosnap-profile.json'
+    ECR_TOKEN_FN = 'snapser-ecr-credentials.json'
+    CATEGORIES = {
+        'profile': ['byosnap'],
+        'credentials': ['ecr']
+    }
+
+    def __init__(
+        self, subcommand: str, base_url: str, api_key: str | None,
+        category: 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.category: str | None = category
+        self.out_path: Union[str, None] = out_path
+        # Validate input
+        self.validate_input()
+
+    # Private methods
+    @staticmethod
+    def _get_token_values(token: str) -> None | list:
+        """
+            Get the token values
+        """
+        try:
+            input_token = base64.b64decode(token).decode('ascii')
+            token_parts = input_token.split('|')
+            # url|web_app_token|service_id|ecr_repo_url|ecr_repo_username|ecr_repo_token
+            if len(token_parts) >= 3:
+                return token_parts
+        except BinasciiError:
+            pass
+        return None
+    # Validator
+
+    def validate_input(self) -> None:
+        """
+          Validator
+        """
+        if self.subcommand not in Generate.SUBCOMMANDS:
+            snapctl_error(
+                f"Invalid command {self.subcommand}. Valid command are "
+                f"{Generate.SUBCOMMANDS}",
+                SNAPCTL_INPUT_ERROR
+            )
+        # Check path
+        if self.subcommand == 'profile':
+            if self.category not in Generate.CATEGORIES['profile']:
+                snapctl_error(
+                    f"Invalid category {self.category}. Valid category are "
+                    f"{Generate.CATEGORIES['profile']}",
+                    SNAPCTL_INPUT_ERROR
+                )
+            if not self.out_path:
+                snapctl_error(
+                    "Path is required for profile generation",
+                    SNAPCTL_INPUT_ERROR
+                )
+        elif self.subcommand == 'credentials':
+            if self.category not in Generate.CATEGORIES['credentials']:
+                snapctl_error(
+                    f"Invalid category {self.category}. Valid category are "
+                    f"{Generate.CATEGORIES['credentials']}",
+                    SNAPCTL_INPUT_ERROR
+                )
+            if not self.out_path:
+                snapctl_error(
+                    "Path is required for token generation",
+                    SNAPCTL_INPUT_ERROR
+                )
+        # Now confirm that out-path is valid
+        if self.out_path and not os.path.isdir(self.out_path):
+            snapctl_error(
+                f"Invalid path {self.out_path}. Wont be able to "
+                "store the output file",
+                SNAPCTL_INPUT_ERROR
+            )
+
+    def byosnap_profile(self) -> None:
+        """
+            Generate snapser-byosnap-profile.json
+        """
+        progress = Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        )
+        progress.start()
+        progress.add_task(
+            description='Generating BYOSnap profile...', total=None)
+        try:
+            if self.out_path is not None:
+                file_save_path = os.path.join(
+                    self.out_path, Generate.BYOSNAP_PROFILE_FN)
+            else:
+                file_save_path = os.path.join(
+                    os.getcwd(), Generate.BYOSNAP_PROFILE_FN)
+            file_written = False
+            with open(file_save_path, "w") as file:
+                json.dump(BYOSNAP_TEMPLATE, file, indent=4)
+                file_written = True
+            if file_written:
+                snapctl_success(
+                    "BYOSNAP Profile generation successful. "
+                    f"{Generate.BYOSNAP_PROFILE_FN} saved at {file_save_path}",
+                    progress
+                )
+        except (IOError, OSError) as file_error:
+            snapctl_error(f"File error: {file_error}",
+                          SNAPCTL_GENERATE_PROFILE_ERROR, progress)
+        except json.JSONDecodeError as json_error:
+            snapctl_error(f"JSON error: {json_error}",
+                          SNAPCTL_GENERATE_PROFILE_ERROR, progress)
+        snapctl_error(
+            "Failed to generate BYOSNAP Profile",
+            SNAPCTL_GENERATE_PROFILE_ERROR,
+            progress
+        )
+
+    def profile(self) -> None:
+        """
+            Generate profile
+        """
+        if self.category == 'byosnap':
+            self.byosnap_profile()
+
+    def ecr_credentials(self) -> None:
+        """
+            Generate credentials
+        """
+
+        progress = Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        )
+        progress.start()
+        progress.add_task(
+            description='Generating ECR credentials...', total=None)
+        try:
+            composite_token: Union[str, None] = get_composite_token(
+                self.base_url, self.api_key, 'byogs', {'service_id': 'byogs'}
+            )
+            token_parts = Generate._get_token_values(composite_token)
+            # url|web_app_token|service_id|ecr_repo_url|ecr_repo_username|ecr_repo_token
+            if token_parts is None or len(token_parts) != 4:
+                snapctl_error(
+                    "Unable to retrieve token.",
+                    SNAPCTL_GENERATE_GENERIC_ERROR,
+                    progress
+                )
+            token_details = {
+                'ecr_repo_url': token_parts[0],
+                'ecr_repo_username': token_parts[1],
+                'ecr_repo_token': token_parts[2],
+                'ecr_repo_platform': token_parts[3]
+            }
+            if self.out_path is not None:
+                file_save_path = os.path.join(
+                    self.out_path, Generate.ECR_TOKEN_FN)
+            else:
+                file_save_path = os.path.join(
+                    os.getcwd(), Generate.ECR_TOKEN_FN)
+            file_written = False
+            with open(file_save_path, "w") as file:
+                json.dump(token_details, file, indent=4)
+                file_written = True
+            if file_written:
+                snapctl_success(
+                    "ECR Token generation successful. "
+                    f"{Generate.ECR_TOKEN_FN} saved at {file_save_path}",
+                    progress
+                )
+        except (IOError, OSError) as file_error:
+            snapctl_error(f"File error: {file_error}",
+                          SNAPCTL_GENERATE_CREDENTIALS_ERROR, progress)
+        except json.JSONDecodeError as json_error:
+            snapctl_error(f"JSON error: {json_error}",
+                          SNAPCTL_GENERATE_CREDENTIALS_ERROR, progress)
+        snapctl_error(
+            "Failed to generate Token",
+            SNAPCTL_GENERATE_CREDENTIALS_ERROR,
+            progress
+        )
+
+    def credentials(self):
+        """
+            Generate credentials
+        """
+        if self.category == 'ecr':
+            self.ecr_credentials()

{snapctl-0.32.2 → snapctl-0.35.0}/snapctl/config/constants.py

@@ -2,7 +2,7 @@
 Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
-VERSION = '0.32.2'
+VERSION = '0.35.0'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
@@ -88,4 +88,5 @@ SNAPCTL_SNAPEND_STATE_ERROR = 75
 
 # Generate Errors
 SNAPCTL_GENERATE_GENERIC_ERROR = 80
-SNAPCTL_GENERATE_BYOSNAP_PROFILE_ERROR = 81
+SNAPCTL_GENERATE_PROFILE_ERROR = 81
+SNAPCTL_GENERATE_CREDENTIALS_ERROR = 82

{snapctl-0.32.2 → snapctl-0.35.0}/snapctl/config/hashes.py

@@ -156,16 +156,32 @@ SERVICE_IDS = [
     'trackables', 'xp'
 ]
 
-DEFAULT_BYOSNAP_TEMPLATE = {
+DEFAULT_BYOSNAP_DEV_TEMPLATE = {
     'cpu': 100,
     'memory': 0.125,
     'cmd': '',
     'args': [],
-    'env_params': []
+    'env_params': [{'key': "SNAPSER_ENVIRONMENT", 'value': "DEVELOPMENT"}]
+}
+
+DEFAULT_BYOSNAP_STAGE_TEMPLATE = {
+    'cpu': 100,
+    'memory': 0.125,
+    'cmd': '',
+    'args': [],
+    'env_params': [{'key': "SNAPSER_ENVIRONMENT", 'value': "STAGING"}]
+}
+
+DEFAULT_BYOSNAP_PROD_TEMPLATE = {
+    'cpu': 100,
+    'memory': 0.125,
+    'cmd': '',
+    'args': [],
+    'env_params': [{'key': "SNAPSER_ENVIRONMENT", 'value': "PRODUCTION"}]
 }
 
 BYOSNAP_TEMPLATE = {
-    'dev_template': DEFAULT_BYOSNAP_TEMPLATE,
-    'stage_template': DEFAULT_BYOSNAP_TEMPLATE,
-    'prod_template': DEFAULT_BYOSNAP_TEMPLATE
+    'dev_template': DEFAULT_BYOSNAP_DEV_TEMPLATE,
+    'stage_template': DEFAULT_BYOSNAP_STAGE_TEMPLATE,
+    'prod_template': DEFAULT_BYOSNAP_PROD_TEMPLATE
 }

{snapctl-0.32.2 → snapctl-0.35.0}/snapctl/main.py

@@ -203,7 +203,7 @@ def version_callback(value: bool = True):
 def common(
     ctx: typer.Context,
     version: bool = typer.Option(
-        None, "--version",
+        None, "--version", "-v",
         help="Get the Snapctl version.",
         callback=version_callback
     ),
@@ -257,6 +257,9 @@ def byogs(
     docker_file: str = typer.Option(
         "Dockerfile", help="Dockerfile name to use"
     ),
+    skip_build: bool = typer.Option(
+        False, "--skip-build", help="(optional: publish) Skip the build step. You have to pass the image tag you used during the build step."
+    ),
     # overrides
     api_key: Union[str, None] = typer.Option(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
@@ -271,7 +274,7 @@ def byogs(
     validate_command_context(ctx)
     byogs_obj: ByoGs = ByoGs(
         subcommand, ctx.obj['base_url'], ctx.obj['api_key'],
-        tag, path, docker_file,
+        tag, path, docker_file, skip_build
     )
     getattr(byogs_obj, subcommand.replace('-', '_'))()
     success(f"BYOGs {subcommand} complete")
@@ -306,12 +309,12 @@ 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"
+            "(req: publish-image and publish-version) Tag for your snap"
         )
     ),
     # publish-image
     path: Union[str, None] = typer.Option(
-        None, "--path", help="(req: build, publish-image) Path to your snap code"
+        None, "--path", help="(req: publish-image) Path to your snap code"
     ),
     docker_file: str = typer.Option(
         "Dockerfile", help="Dockerfile name to use"
@@ -329,9 +332,13 @@ def byosnap(
     ),
     byosnap_profile: Union[str, None] = typer.Option(
         None, "--byosnap-profile", help=(
-            "(req: publish-version) Path to your byosnap-profile JSON file"
+            "(req: publish-version) Path to your byosnap-profile JSON file. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command."
         )
     ),
+    skip_build: bool = typer.Option(
+        False, "--skip-build", help="(optional: publish-image) Skip the build step. You have to pass the image tag you used during the build step."
+    ),
+
     # overrides
     api_key: Union[str, None] = typer.Option(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
@@ -347,7 +354,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, byosnap_profile
+        prefix, version, http_port, byosnap_profile, skip_build
     )
     getattr(byosnap_obj, subcommand.replace('-', '_'))()
     success(f"BYOSnap {subcommand} complete")
@@ -390,11 +397,28 @@ def generate(
     ctx: typer.Context,
     # Required fields
     subcommand: str = typer.Argument(
-        ..., help="Generate Subcommands: " + ", ".join(Generate.SUBCOMMANDS) + "."
+        ..., help=(
+            "Generate Subcommands: " + \
+            ", ".join(Generate.SUBCOMMANDS) + "." + " "
+            "Deprecation Notice: " + \
+            ",".join(Generate.DEPRECATED_SOON_SUBCOMMANDS) + \
+            " will be deprecated soon. "
+            "Use `snapctl generate profile --category byosnap --out-path <output_path>` command instead."
+        )
+    ),
+    category: Union[str, None] = typer.Option(
+        None, "--category",
+        help=(
+            "(req: profile, token) (profile: " +
+            ", ".join(Generate.CATEGORIES['profile']) +
+            ") (token: " + ", ".join(Generate.CATEGORIES['credentials']) + ')'
+        )
     ),
-    # byosnap-profile
+    # byosnap-profile, profile
     out_path: Union[str, None] = typer.Option(
-        None, "--out-path", help="(req: byosnap-profile) Path to output the byosnap profile"
+        None, "--out-path", help=(
+            "(req: byosnap-profile, profile, token) Path to output the byosnap profile"
+        )
     ),
     # overrides
     api_key: Union[str, None] = typer.Option(
@@ -410,14 +434,14 @@ def generate(
     validate_command_context(ctx)
     generate_obj: Generate = Generate(
         subcommand, ctx.obj['base_url'], ctx.obj['api_key'],
-        out_path,
+        category, out_path,
     )
     getattr(generate_obj, subcommand.replace('-', '_'))()
     success(f"Generate {subcommand} complete")
     raise typer.Exit(code=SNAPCTL_SUCCESS)
 
 
-@app.command()
+@ app.command()
 def snapend(
     ctx: typer.Context,
     # Required fields

snapctl-0.32.2/snapctl/commands/generate.py

@@ -1,93 +0,0 @@
-"""
-    Generate CLI commands
-"""
-import json
-import os
-from typing import Union
-from rich.progress import Progress, SpinnerColumn, TextColumn
-from snapctl.config.constants import SNAPCTL_INPUT_ERROR, \
-    SNAPCTL_GENERATE_GENERIC_ERROR
-from snapctl.config.hashes import BYOSNAP_TEMPLATE
-from snapctl.utils.echo import error
-from snapctl.utils.helper import snapctl_error, snapctl_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
-        # Validate input
-        self.validate_input()
-
-    # Validator
-
-    def validate_input(self) -> None:
-        """
-          Validator
-        """
-        if self.subcommand not in Generate.SUBCOMMANDS:
-            snapctl_error(
-                f"Invalid command {self.subcommand}. Valid command are "
-                f"{Generate.SUBCOMMANDS}",
-                SNAPCTL_INPUT_ERROR
-            )
-        if self.subcommand in ['byosnap-profile']:
-            # Check path
-            if self.out_path and not os.path.isdir(self.out_path):
-                snapctl_error(
-                    f"Invalid path {self.out_path}. Wont be able to "
-                    "store the byosnap-profile.json file",
-                    SNAPCTL_INPUT_ERROR
-                )
-
-    def byosnap_profile(self) -> None:
-        """
-            Generate snapser-byosnap-profile.json
-        """
-        progress = Progress(
-            SpinnerColumn(),
-            TextColumn("[progress.description]{task.description}"),
-            transient=True,
-        )
-        progress.start()
-        progress.add_task(
-            description='Promoting your staging snapend...', total=None)
-        try:
-            if self.out_path is not None:
-                file_save_path = os.path.join(
-                    self.out_path, Generate.BYOSNAP_PROFILE_FN)
-            else:
-                file_save_path = os.path.join(
-                    os.getcwd(), Generate.BYOSNAP_PROFILE_FN)
-            file_written = False
-            with open(file_save_path, "w") as file:
-                json.dump(BYOSNAP_TEMPLATE, file, indent=4)
-                file_written = True
-            if file_written:
-                snapctl_success(
-                    "BYOSNAP Profile generation successful. "
-                    f"{Generate.BYOSNAP_PROFILE_FN} saved at {file_save_path}",
-                    progress
-                )
-        except (IOError, OSError) as file_error:
-            snapctl_error(f"File error: {file_error}",
-                          SNAPCTL_GENERATE_GENERIC_ERROR, progress)
-        except json.JSONDecodeError as json_error:
-            snapctl_error(f"JSON error: {json_error}",
-                          SNAPCTL_GENERATE_GENERIC_ERROR, progress)
-        snapctl_error(
-            "Failed to generate BYOSNAP Profile",
-            SNAPCTL_GENERATE_GENERIC_ERROR,
-            progress
-        )