snapctl 0.47.2__tar.gz → 0.48.0__tar.gz

{snapctl-0.47.2 → snapctl-0.48.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.47.2
+Version: 0.48.0
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -24,58 +24,23 @@ Snapser has developed a CLI tool called **snapctl** that can be used on MaxOSX,
 Snapctl will be the best way for game studios to integrate Snapser into their build pipelines.
 
 ## What's new in the latest version?
-### Breaking Changes
-- **BYOSnap**:
-  - BYOSnap commands like `publish`, `sync` and `upload-docs` now take BYOSnap ID as a
-    non-positional argument. You now have to pass the BYOSnap Id using `--byosnap-id`.
-    ```bash
-    # Previously
-    snapctl byosnap publish byosnap-jinks-flask --version "v0.0.1" --path $path
-
-    # New
-    snapctl byosnap publish --byosnap-id byosnap-jinks-flask --version "v0.0.1" --path  $path
-    ```
-  - BYOSnap input parameter `--byosnap-profile-file` has been renamed to `--profile-filename`
-
-- **Generate**: The ability to generate a base BYOSnap profile using the `generate` command has
-  been deprecated. Instead its moved under `byosnap` commands for consistency.
-
-- **Snapend**:
-  - The manifest path variable has been changed for Snapend commands like `apply` and `clone`
-    from `--manifest-path` to `--manifest-path-filename`, for consistency with our new
-    variable naming nomenclature.
-  - The Snapend download command has new variable names like `format` and `type`. This is to add
-    more consistency and clarity to the command.
-    ```bash
-    # Previously
-    # snapctl snapend download --snapend-id gx5x6bc0 --category sdk --type unity --sdk-access-type external --sdk-auth-type user --out-path .
-
-    # New
-    snapctl snapend download --snapend-id gx5x6bc0 --category sdk --format unity --type user --out-path .
-    ```
-
-- Input param `--docker` for BYOGS and BYOSnap commands has been changed to `--docker_filename`
-
-### New Commands
-- **BYOSnap Generate Profile**: You can now use a new command to generate a base BYOSnap profile.
-  ```bash
-  snapctl byosnap generate-profile --out-path $outputPath --profile-filename $profileName
-  ```
-- **BYOSnap Validate Profile**: After you hand edit the base BYOSnap profile, you can use this
-  command to validate your BYOSnap profile before using it in other commands like `publish` and `sync`
-  ```bash
-  snapctl byosnap validate-profile --path $path --profile-filename $profileName
-  # or
-  snapctl byosnap validate-profile --resources-path $resources_path --profile-filename $profileName
-  ```
-- **Release Notes**: You can now view release notes for a specific version of Snapctl using the
-  `release-notes` command.
-  ```bash
-  snapctl release-notes releases
-  snapctl release-notes show
-  # or
-  snapctl release-notes show --version $version
-  ```
+### Features
+1. Dockerfile can now be present either at the root or the resources path. Snapctl will automatically look for the Dockerfile in both locations.
+2. Snapctl now throws a better warning when the swagger for the BYOSnap is not compatible with what the Snapser backed expects. You will get a warning message:
+```bash
+Warning Snapser enforces a strict schema for the swagger.json file. It needs to be a valid OpenAPI 3.0 spec. In addition, ever API needs an operationId. a summary and
+a non-empty description. This allows Snapser to generate your SDK and power the API explorer. If you do not wish to leverage this feature, just remove the
+swagger.json file.
+```
+3. You can now use the `--skip-build` flag with the snapctl sync command. This allows you to skip the build step when syncing your Snapend resources.
+```bash
+byosnap sync --snapend-id $snapendId --byosnap-id $byosnapId --version $version --path $path --skip-build
+```
+
+### Fixes
+1. Snapctl was failing if the user passed in a tag with a `:` in it. This has been fixed. It now checks for the presence of a `:` in the tag and throws an error in the input validation step.
+2. The byosnap generate command was failing. This has been fixed.
+
 
 ## Requirements
 ### Python 3.X and Pip
@@ -310,7 +275,7 @@ can deploy it.
 - This command needs a BYOSnap profile. BYOSnap profile, holds information about
 your BYOSnap like, name, description, etc and hardware requirements like CPU, Memory. We
 recommend you store this file at the root of your BYOSnap and also add it to version control.
-You can generate it using `snapctl generate profile --category byosnap --out-path $outputPath`.
+You can generate it using `snapctl byosnap generate-profile --out-path $outputPath --profile-filename $profileName`.
 
 ```bash
 # Help for the byosnap command
@@ -462,7 +427,7 @@ Publish a new version for your Snap. Only after your Snap version is published,
 to use your snap in your Snapend. This command should be run after `push` or `publish-image` commands.
 
 IMPORTANT: You need to have $byosnapProfile to run this command. BYOSnap profile is a JSON configuration
-of your BYOSnap for the development, staging and production environments. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command.
+of your BYOSnap for the development, staging and production environments. You can generate a base version of this file using the `snapctl byosnap generate-profile --out-path $outputPath --profile-filename $profileName` command.
 
 ```bash
 # Help for the byosnap command
@@ -472,7 +437,7 @@ snapctl byosnap publish-version --help
 # $byosnap_id = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $version = Semantic version for your snap Eg: v0.0.1
-# $byosnap_profile_path = Path to the snapser-byosnap-profile.json 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
+# $byosnap_profile_path = Path to the snapser-byosnap-profile.json BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl byosnap generate-profile --out-path $outputPath --profile-filename $profileName` command
 # Example:
 # snapctl byosnap publish-version --byosnap-id byosnap-jinks-flask --tag my-first-image --version v0.0.1 --path /Users/DevName/Development/SnapserEngine/jinks_flask
 snapctl byosnap publish-version --byosnap-id $byosnap_id --tag $image_tag --version $version --path $byosnap_profile_path

{snapctl-0.47.2 → snapctl-0.48.0}/README.md

@@ -4,58 +4,23 @@ Snapser has developed a CLI tool called **snapctl** that can be used on MaxOSX,
 Snapctl will be the best way for game studios to integrate Snapser into their build pipelines.
 
 ## What's new in the latest version?
-### Breaking Changes
-- **BYOSnap**:
-  - BYOSnap commands like `publish`, `sync` and `upload-docs` now take BYOSnap ID as a
-    non-positional argument. You now have to pass the BYOSnap Id using `--byosnap-id`.
-    ```bash
-    # Previously
-    snapctl byosnap publish byosnap-jinks-flask --version "v0.0.1" --path $path
-
-    # New
-    snapctl byosnap publish --byosnap-id byosnap-jinks-flask --version "v0.0.1" --path  $path
-    ```
-  - BYOSnap input parameter `--byosnap-profile-file` has been renamed to `--profile-filename`
-
-- **Generate**: The ability to generate a base BYOSnap profile using the `generate` command has
-  been deprecated. Instead its moved under `byosnap` commands for consistency.
-
-- **Snapend**:
-  - The manifest path variable has been changed for Snapend commands like `apply` and `clone`
-    from `--manifest-path` to `--manifest-path-filename`, for consistency with our new
-    variable naming nomenclature.
-  - The Snapend download command has new variable names like `format` and `type`. This is to add
-    more consistency and clarity to the command.
-    ```bash
-    # Previously
-    # snapctl snapend download --snapend-id gx5x6bc0 --category sdk --type unity --sdk-access-type external --sdk-auth-type user --out-path .
-
-    # New
-    snapctl snapend download --snapend-id gx5x6bc0 --category sdk --format unity --type user --out-path .
-    ```
-
-- Input param `--docker` for BYOGS and BYOSnap commands has been changed to `--docker_filename`
-
-### New Commands
-- **BYOSnap Generate Profile**: You can now use a new command to generate a base BYOSnap profile.
-  ```bash
-  snapctl byosnap generate-profile --out-path $outputPath --profile-filename $profileName
-  ```
-- **BYOSnap Validate Profile**: After you hand edit the base BYOSnap profile, you can use this
-  command to validate your BYOSnap profile before using it in other commands like `publish` and `sync`
-  ```bash
-  snapctl byosnap validate-profile --path $path --profile-filename $profileName
-  # or
-  snapctl byosnap validate-profile --resources-path $resources_path --profile-filename $profileName
-  ```
-- **Release Notes**: You can now view release notes for a specific version of Snapctl using the
-  `release-notes` command.
-  ```bash
-  snapctl release-notes releases
-  snapctl release-notes show
-  # or
-  snapctl release-notes show --version $version
-  ```
+### Features
+1. Dockerfile can now be present either at the root or the resources path. Snapctl will automatically look for the Dockerfile in both locations.
+2. Snapctl now throws a better warning when the swagger for the BYOSnap is not compatible with what the Snapser backed expects. You will get a warning message:
+```bash
+Warning Snapser enforces a strict schema for the swagger.json file. It needs to be a valid OpenAPI 3.0 spec. In addition, ever API needs an operationId. a summary and
+a non-empty description. This allows Snapser to generate your SDK and power the API explorer. If you do not wish to leverage this feature, just remove the
+swagger.json file.
+```
+3. You can now use the `--skip-build` flag with the snapctl sync command. This allows you to skip the build step when syncing your Snapend resources.
+```bash
+byosnap sync --snapend-id $snapendId --byosnap-id $byosnapId --version $version --path $path --skip-build
+```
+
+### Fixes
+1. Snapctl was failing if the user passed in a tag with a `:` in it. This has been fixed. It now checks for the presence of a `:` in the tag and throws an error in the input validation step.
+2. The byosnap generate command was failing. This has been fixed.
+
 
 ## Requirements
 ### Python 3.X and Pip
@@ -290,7 +255,7 @@ can deploy it.
 - This command needs a BYOSnap profile. BYOSnap profile, holds information about
 your BYOSnap like, name, description, etc and hardware requirements like CPU, Memory. We
 recommend you store this file at the root of your BYOSnap and also add it to version control.
-You can generate it using `snapctl generate profile --category byosnap --out-path $outputPath`.
+You can generate it using `snapctl byosnap generate-profile --out-path $outputPath --profile-filename $profileName`.
 
 ```bash
 # Help for the byosnap command
@@ -442,7 +407,7 @@ Publish a new version for your Snap. Only after your Snap version is published,
 to use your snap in your Snapend. This command should be run after `push` or `publish-image` commands.
 
 IMPORTANT: You need to have $byosnapProfile to run this command. BYOSnap profile is a JSON configuration
-of your BYOSnap for the development, staging and production environments. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command.
+of your BYOSnap for the development, staging and production environments. You can generate a base version of this file using the `snapctl byosnap generate-profile --out-path $outputPath --profile-filename $profileName` command.
 
 ```bash
 # Help for the byosnap command
@@ -452,7 +417,7 @@ snapctl byosnap publish-version --help
 # $byosnap_id = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $version = Semantic version for your snap Eg: v0.0.1
-# $byosnap_profile_path = Path to the snapser-byosnap-profile.json 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
+# $byosnap_profile_path = Path to the snapser-byosnap-profile.json BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl byosnap generate-profile --out-path $outputPath --profile-filename $profileName` command
 # Example:
 # snapctl byosnap publish-version --byosnap-id byosnap-jinks-flask --tag my-first-image --version v0.0.1 --path /Users/DevName/Development/SnapserEngine/jinks_flask
 snapctl byosnap publish-version --byosnap-id $byosnap_id --tag $image_tag --version $version --path $byosnap_profile_path

{snapctl-0.47.2 → snapctl-0.48.0}/pyproject.toml

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

{snapctl-0.47.2 → snapctl-0.48.0}/snapctl/commands/byogs.py

@@ -49,6 +49,9 @@ class ByoGs:
         self.path: Union[str, None] = path
         self.resources_path: Union[str, None] = resources_path
         self.docker_filename: str = docker_filename
+        self.docker_path_filename: Union[str, None] = ByoGs._make_dockerfile_path(
+            path, resources_path, docker_filename
+        )
         self.skip_build: bool = skip_build
         self.snapend_id: Union[str, None] = snapend_id
         self.fleet_names: Union[str, None] = fleet_names
@@ -63,6 +66,22 @@ class ByoGs:
         self.validate_input()
 
     # Protected methods
+    @staticmethod
+    def _make_dockerfile_path(path: str, resources_path: str, docker_filename: str) -> Union[str, None]:
+        """
+        Check for the existence of a Dockerfile in the given `path` and `resources_path`.
+        Returns the path where the Dockerfile is found, or an empty string if not found.
+        """
+        # Check the primary path
+        if path and os.path.isfile(os.path.join(path, docker_filename)):
+            return os.path.join(path, docker_filename)
+
+        # Check the resources path
+        if resources_path and os.path.isfile(os.path.join(resources_path, docker_filename)):
+            return os.path.join(resources_path, docker_filename)
+
+        # Return empty string if not found in either location
+        return None
 
     @staticmethod
     def _get_token_values(token: str) -> Union[None, List]:
@@ -185,17 +204,11 @@ class ByoGs:
             build_platform = ByoGs.DEFAULT_BUILD_PLATFORM
             if len(self.token_parts) == 4:
                 build_platform = self.token_parts[3]
-            # Build your snap
-            if self.resources_path:
-                base_path = self.resources_path
-            else:
-                base_path = self.path
-            docker_file_path = os.path.join(base_path, self.docker_filename)
 
             # Warning check for architecture specific commands
             info(f'Building on system architecture {sys_platform.machine()}')
             check_response = check_dockerfile_architecture(
-                docker_file_path, sys_platform.machine())
+                self.docker_path_filename, sys_platform.machine())
             if check_response['error']:
                 warning(check_response['message'])
             # Build the image
@@ -203,7 +216,7 @@ class ByoGs:
                 response = subprocess.run([
                     # f"docker build --no-cache -t {tag} {path}"
                     'docker', 'build', '--platform', build_platform, '-t', self.tag,
-                    '-f', docker_file_path,  self.path
+                    '-f', self.docker_path_filename,  self.path
                 ], shell=True, check=False)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
             else:
@@ -211,7 +224,7 @@ class ByoGs:
                     # f"docker build --no-cache -t {tag} {path}"
                     "docker build --platform " +
                     f"{build_platform} -t {self.tag} " +
-                    f"-f {docker_file_path} {self.path}"
+                    f"-f {self.docker_path_filename} {self.path}"
                 ], shell=True, check=False)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
             if not response.returncode:
@@ -366,37 +379,25 @@ class ByoGs:
                 code=SNAPCTL_INPUT_ERROR
             )
         if self.subcommand in ['build', 'publish']:
+            # Check path
             if not self.skip_build and not self.path:
                 snapctl_error(
                     message="Missing required parameter:  path",
                     code=SNAPCTL_INPUT_ERROR)
-            # Check path
-            if self.resources_path:
-                docker_file_path = f"{self.resources_path}/{self.docker_filename}"
-            else:
-                docker_file_path = f"{self.path}/{self.docker_filename}"
-
-            if not self.skip_build and not os.path.isfile(docker_file_path):
+            # Check docker file path
+            if not self.skip_build and not self.docker_path_filename:
                 snapctl_error(
-                    message="Unable to find " +
-                    f"{self.docker_filename} at path {docker_file_path}",
-                    code=SNAPCTL_INPUT_ERROR)
+                    f"Unable to find {self.docker_path_filename}", SNAPCTL_INPUT_ERROR)
         elif self.subcommand == 'sync':
+            # Check path
             if not self.skip_build and not self.path:
                 snapctl_error(
                     message="Missing required parameter:  path",
                     code=SNAPCTL_INPUT_ERROR)
-            # Check path
-            if self.resources_path:
-                docker_file_path = f"{self.resources_path}/{self.docker_filename}"
-            else:
-                docker_file_path = f"{self.path}/{self.docker_filename}"
-
-            if not self.skip_build and not os.path.isfile(docker_file_path):
+            # Check docker file path
+            if not self.skip_build and not self.docker_path_filename:
                 snapctl_error(
-                    message="Unable to find " +
-                    f"{self.docker_filename} at path {docker_file_path}",
-                    code=SNAPCTL_INPUT_ERROR)
+                    f"Unable to find {self.docker_path_filename}", SNAPCTL_INPUT_ERROR)
             if not self.snapend_id:
                 snapctl_error(
                     message="Missing required parameter: snapend_id",

{snapctl-0.47.2 → snapctl-0.48.0}/snapctl/commands/byosnap.py

@@ -29,7 +29,7 @@ from snapctl.config.constants import HTTP_ERROR_SERVICE_VERSION_EXISTS, \
     SNAPCTL_BYOSNAP_UPDATE_VERSION_ERROR, SNAPCTL_BYOSNAP_UPDATE_VERSION_SERVICE_IN_USE_ERROR, \
     SNAPCTL_BYOSNAP_UPDATE_VERSION_TAG_ERROR, SNAPCTL_BYOSNAP_NOT_FOUND, \
     HTTP_ERROR_RESOURCE_NOT_FOUND, SNAPCTL_BYOSNAP_PUBLISH_ERROR, \
-    SNAPCTL_BYOSNAP_GENERATE_PROFILE_ERROR, SNAPCTL_CONFIGURATION_INCORRECT
+    SNAPCTL_BYOSNAP_GENERATE_PROFILE_ERROR, SNAPCTL_CONFIGURATION_INCORRECT, SNAPCTL_BYOSNAP_SWAGGER_ERROR
 from snapctl.utils.echo import info, warning, success
 from snapctl.utils.helper import get_composite_token, snapctl_error, snapctl_success, \
     check_dockerfile_architecture, check_use_containerd_snapshotter
@@ -84,9 +84,14 @@ class ByoSnap:
         self.api_key: Union[str, None] = api_key
         self.byosnap_id: str = byosnap_id
         self.tag: Union[str, None] = tag
+        # Remote tag is overridden in publish and sync
+        self.remote_tag: Union[str, None] = tag
         self.path: Union[str, None] = path
         self.resources_path: Union[str, None] = resources_path
         self.docker_filename: str = docker_filename
+        self.docker_path_filename: Union[str, None] = ByoSnap._make_dockerfile_path(
+            path, resources_path, docker_filename
+        )
         self.profile_filename: Union[str, None] = profile_filename
         self.version: Union[str, None] = version
         self.name: Union[str, None] = name
@@ -110,9 +115,26 @@ class ByoSnap:
         self.readiness_path: Union[str, None] = None
         self.readiness_delay: Union[str, None] = None
         # Setup and Validate the input
-        self.setup_and_validate_input()
+        self.validate_input()
 
     # Protected methods
+    @staticmethod
+    def _make_dockerfile_path(path: str, resources_path: str, docker_filename: str) -> Union[str, None]:
+        """
+        Check for the existence of a Dockerfile in the given `path` and `resources_path`.
+        Returns the path where the Dockerfile is found, or an empty string if not found.
+        """
+        # Check the primary path
+        if path and os.path.isfile(os.path.join(path, docker_filename)):
+            return os.path.join(path, docker_filename)
+
+        # Check the resources path
+        if resources_path and os.path.isfile(os.path.join(resources_path, docker_filename)):
+            return os.path.join(resources_path, docker_filename)
+
+        # Return empty string if not found in either location
+        return None
+
     @staticmethod
     def _get_token_values(token: str) -> Union[None, List]:
         """
@@ -692,33 +714,26 @@ class ByoSnap:
         progress.add_task(
             description='Building your snap...', total=None)
         try:
-            # Build your snap
-            if self.resources_path:
-                base_path = self.resources_path
-            else:
-                base_path = self.path
-            docker_file_path = os.path.join(base_path, self.docker_filename)
-
             # Warning check for architecture specific commands
             info(f'Building on system architecture {sys_platform.machine()}')
             check_response = check_dockerfile_architecture(
-                docker_file_path, sys_platform.machine())
+                self.docker_path_filename, sys_platform.machine())
             if check_response['error']:
                 warning(check_response['message'])
             # Build the image
             if platform == "win32":
                 response = subprocess.run([
-                    # f"docker build --no-cache -t {tag} {path}"
-                    'docker', 'build', '--platform', build_platform, '-t', self.tag,
-                    '-f', docker_file_path,  self.path
+                    # f"docker build --no-cache -t {remote_tag} {path}"
+                    'docker', 'build', '--platform', build_platform, '-t', self.remote_tag,
+                    '-f', self.docker_path_filename,  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 --no-cache -t {remote_tag} {path}"
                     "docker build --platform " +
-                    f"{build_platform} -t {self.tag} " +
-                    f"-f {docker_file_path} {self.path}"
+                    f"{build_platform} -t {self.remote_tag} " +
+                    f"-f {self.docker_path_filename} {self.path}"
                 ], shell=True, check=False)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
             if not response.returncode:
@@ -737,7 +752,7 @@ class ByoSnap:
     def _docker_tag(self) -> None:
         # Get the data
         ecr_repo_url = self.token_parts[0]
-        image_tag = f'{self.byosnap_id}.{self.tag}'
+        image_tag = f'{self.byosnap_id}.{self.remote_tag}'
         full_ecr_repo_url = f'{ecr_repo_url}:{image_tag}'
         progress = Progress(
             SpinnerColumn(),
@@ -840,7 +855,7 @@ class ByoSnap:
     # Public methods
 
     # Validate
-    def setup_and_validate_input(self) -> None:
+    def validate_input(self) -> None:
         """
           Validator
         """
@@ -895,20 +910,16 @@ class ByoSnap:
                     f"{ByoSnap.TAG_CHARACTER_LIMIT} characters",
                     SNAPCTL_INPUT_ERROR
                 )
+            if ':' in self.tag:
+                snapctl_error("Tag should not contain `:` ",
+                              SNAPCTL_INPUT_ERROR)
             if not self.skip_build and not self.path:
                 snapctl_error("Missing required parameter: path",
                               SNAPCTL_INPUT_ERROR)
-            # Check path
-            if self.resources_path:
-                docker_file_path = \
-                    f"{self.resources_path}/{self.docker_filename}"
-            else:
-                docker_file_path = f"{self.path}/{self.docker_filename}"
-            if not self.skip_build and not os.path.isfile(docker_file_path):
+            # Check docker file path
+            if not self.skip_build and not self.docker_path_filename:
                 snapctl_error(
-                    "Unable to find " +
-                    f"{self.docker_filename} at path {docker_file_path}",
-                    SNAPCTL_INPUT_ERROR)
+                    f"Unable to find {self.docker_path_filename}", SNAPCTL_INPUT_ERROR)
         elif self.subcommand == 'upload-docs':
             # Setup
             self._setup_token_and_token_parts(
@@ -1008,17 +1019,10 @@ class ByoSnap:
                 snapctl_error(
                     message="Missing required parameter: path",
                     code=SNAPCTL_INPUT_ERROR)
-            # Check path
-            if self.resources_path:
-                docker_file_path = \
-                    f"{self.resources_path}/{self.docker_filename}"
-            else:
-                docker_file_path = f"{self.path}/{self.docker_filename}"
-            if not self.skip_build and not os.path.isfile(docker_file_path):
+            # Check docker file path
+            if not self.skip_build and not self.docker_path_filename:
                 snapctl_error(
-                    message="Unable to find " +
-                    f"{self.docker_filename} at path {docker_file_path}",
-                    code=SNAPCTL_INPUT_ERROR)
+                    f"Unable to find {self.docker_path_filename}", SNAPCTL_INPUT_ERROR)
             if not self.snapend_id:
                 snapctl_error(
                     message="Missing required parameter: snapend-id",
@@ -1036,20 +1040,10 @@ class ByoSnap:
                               code=SNAPCTL_INPUT_ERROR)
             if not self.skip_build and not self.path:
                 snapctl_error(
-                    message="Missing required parameter: path",
-                    code=SNAPCTL_INPUT_ERROR)
-            # Check path
-            if self.resources_path:
-                docker_file_path = \
-                    f"{self.resources_path}/{self.docker_filename}"
-            else:
-                docker_file_path = f"{self.path}/{self.docker_filename}"
-            if not self.skip_build and not os.path.isfile(docker_file_path):
+                    message="Missing required parameter: path", code=SNAPCTL_INPUT_ERROR)
+            if not self.skip_build and not self.docker_path_filename:
                 snapctl_error(
-                    message="Unable to find " +
-                    f"{self.docker_filename} at path {docker_file_path}",
-                    code=SNAPCTL_INPUT_ERROR)
-
+                    f"Unable to find {self.docker_path_filename}", SNAPCTL_INPUT_ERROR)
                 # Run the overrides
         elif self.subcommand == 'generate-profile':
             # Setup
@@ -1129,11 +1123,11 @@ class ByoSnap:
 
             swagger_file = os.path.join(base_dir, 'swagger.json')
             readme_file = os.path.join(base_dir, 'README.md')
-
             # Upload swagger.json
             if os.path.isfile(swagger_file):
                 try:
                     with open(swagger_file, "rb") as attachment_file:
+                        info(f'Uploading swagger.json at {swagger_file}')
                         url = (
                             f"{self.base_url}/v1/snapser-api/byosnaps/"
                             f"{self.byosnap_id}/docs/{self.tag}/openapispec"
@@ -1147,7 +1141,18 @@ class ByoSnap:
                             snapctl_success(
                                 message='Uploaded swagger.json', progress=None, no_exit=True)
                         else:
-                            info('Unable to upload your swagger.json')
+                            static_message = 'Snapser enforces a strict schema for the swagger.json ' + \
+                                'file. It needs to be a valid OpenAPI 3.0 spec. In addition, ever API ' + \
+                                'needs an operationId. a summary and a non-empty description. This allows ' + \
+                                'Snapser to generate your SDK and power the API explorer. If you do not ' + \
+                                'wish to leverage this feature, just remove the swagger.json file.'
+                            warning(static_message)
+                            response_json = test_res.json()
+                            if 'details' in response_json:
+                                error_msg = f"Swagger upload error: {response_json['details']}"
+                            else:
+                                error_msg = 'Swagger upload error: In-compatible swagger.json file.'
+                            warning(error_msg)
                 except RequestException as e:
                     info(
                         'Exception: Unable to find swagger.json at ' +
@@ -1506,9 +1511,11 @@ class ByoSnap:
                             msg=f'BYOSnap {self.name} present. ' +
                             'Lets proceed',
                         )
-            # Make the tag same as version
-            self.tag = self.version
             # Setup the token and token parts
+            # Make the remote tag same as version if user is not passing the tag
+            if self.tag is None:
+                self.tag = self.version
+                self.remote_tag = self.version
             self._setup_token_and_token_parts(
                 self.base_url, self.api_key, self.byosnap_id)
             # Now publish the image
@@ -1527,7 +1534,11 @@ class ByoSnap:
         Sync the snap
         '''
         try:
-            self.tag = f'{self.version}-{int(time.time())}'
+            # Make the remote tag same as version if user is not passing the tag
+            if self.tag is None:
+                time_string = str(int(time.time()))
+                self.tag = f'{self.version}-{time_string}'
+                self.remote_tag = f'{self.version}-{time_string}'
             self.publish_image(no_exit=True)
             self.update_version(no_exit=True)
             byosnap_list: str = f"{self.byosnap_id}:{self.version}"

{snapctl-0.47.2 → snapctl-0.48.0}/snapctl/config/constants.py

@@ -3,7 +3,7 @@ Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
 VERSION_PREFIX = 'beta-'
-VERSION = '0.47.2'
+VERSION = '0.48.0'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
@@ -73,6 +73,7 @@ SNAPCTL_BYOSNAP_UPDATE_VERSION_INVALID_VERSION_ERROR = 48
 SNAPCTL_BYOSNAP_PUBLISH_ERROR = 49
 # Starting with new error codes for BYOSNAP post
 SNAPCTL_BYOSNAP_GENERATE_PROFILE_ERROR = 86
+SNAPCTL_BYOSNAP_SWAGGER_ERROR = 87
 
 # Game Errors - 50 - 60
 SNAPCTL_GAME_NOT_FOUND = SNAPCTL_RESOURCE_NOT_FOUND

snapctl-0.48.0/snapctl/data/releases/beta-0.48.0.mdx

@@ -0,0 +1,19 @@
+## beta-0.48.0
+##### April 11, 2025
+
+### Features
+1. Dockerfile can now be present either at the root or the resources path. Snapctl will automatically look for the Dockerfile in both locations.
+2. Snapctl now throws a better warning when the swagger for the BYOSnap is not compatible with what the Snapser backed expects. You will get a warning message:
+```bash
+Warning Snapser enforces a strict schema for the swagger.json file. It needs to be a valid OpenAPI 3.0 spec. In addition, ever API needs an operationId. a summary and
+a non-empty description. This allows Snapser to generate your SDK and power the API explorer. If you do not wish to leverage this feature, just remove the
+swagger.json file.
+```
+3. You can now use the `--skip-build` flag with the snapctl sync command. This allows you to skip the build step when syncing your Snapend resources.
+```bash
+byosnap sync --snapend-id $snapendId --byosnap-id $byosnapId --version $version --path $path --skip-build
+```
+
+### Fixes
+1. Snapctl was failing if the user passed in a tag with a `:` in it. This has been fixed. It now checks for the presence of a `:` in the tag and throws an error in the input validation step.
+2. The byosnap generate command was failing. This has been fixed.

{snapctl-0.47.2 → snapctl-0.48.0}/snapctl/main.py

@@ -386,15 +386,15 @@ def byosnap(
         help="(req: create) Language of your snap - " +
         ", ".join(ByoSnap.LANGUAGES) + "."
     ),
-    # publish-image and publish-version
+    # publish-image, publish-version, publish, sync
     tag: str = typer.Option(
         None, "--tag", help=(
-            "(req: publish-image, publish-version, upload-docs) Tag for your snap"
+            "(req: publish-image, publish-version, upload-docs) (optional: publish, sync) Tag for your snap"
         )
     ),
     # overrides
     skip_build: bool = typer.Option(
-        False, "--skip-build", help="(optional: publish-image, sync) Skip the build step. You have to pass the image tag you used during the build step."
+        False, "--skip-build", help="(optional: publish-image, publish, sync) Skip the build step. You have to pass the image tag you used during the build step."
     ),
     docker_filename: str = typer.Option(
         "Dockerfile", help="(optional override: publish, sync) Dockerfile name to use"