snapctl 0.49.4__tar.gz → 0.50.0__tar.gz

{snapctl-0.49.4 → snapctl-0.50.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.49.4
+Version: 0.50.0
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com

{snapctl-0.49.4 → snapctl-0.50.0}/pyproject.toml

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

{snapctl-0.49.4 → snapctl-0.50.0}/snapctl/commands/byogs.py

@@ -105,6 +105,16 @@ class ByoGs:
             pass
         return None
 
+    @staticmethod
+    def _docker_supports_buildkit():
+        try:
+            version = subprocess.check_output(
+                ["docker", "version", "--format", "{{.Server.Version}}"])
+            major, minor = map(int, version.decode().split(".")[:2])
+            return (major > 18) or (major == 18 and minor >= 9)
+        except Exception:
+            return False
+
     def _check_dependencies(self) -> None:
         progress = Progress(
             SpinnerColumn(),
@@ -200,6 +210,10 @@ class ByoGs:
         progress.add_task(
             description='Building your snap...', total=None)
         try:
+            env = os.environ.copy()
+            if ByoGs._docker_supports_buildkit():
+                info('Docker BuildKit is supported. Enabling it.')
+                env["DOCKER_BUILDKIT"] = "1"
             # image_tag = f'{ByoGs.SID}.{self.tag}'
             build_platform = ByoGs.DEFAULT_BUILD_PLATFORM
             if len(self.token_parts) == 4:
@@ -217,7 +231,7 @@ class ByoGs:
                     # f"docker build --no-cache -t {tag} {path}"
                     'docker', 'build', '--platform', build_platform, '-t', self.tag,
                     '-f', self.docker_path_filename,  self.path
-                ], shell=True, check=False)
+                ], shell=True, check=False, env=env)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
             else:
                 response = subprocess.run([
@@ -225,7 +239,7 @@ class ByoGs:
                     "docker build --platform " +
                     f"{build_platform} -t {self.tag} " +
                     f"-f {self.docker_path_filename} {self.path}"
-                ], shell=True, check=False)
+                ], shell=True, check=False, env=env)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
             if not response.returncode:
                 return snapctl_success(

{snapctl-0.49.4 → snapctl-0.50.0}/snapctl/commands/byosnap.py

@@ -509,16 +509,19 @@ class ByoSnap:
                     outfile.write(line)
             return True
         except FileNotFoundError:
-            print(f"[ERROR] Could not find profile file: {resource_filename}")
+            warning(
+                f"[ERROR] Could not find profile file: {resource_filename}")
+            return False
+
+    @staticmethod
+    def _docker_supports_buildkit():
+        try:
+            version = subprocess.check_output(
+                ["docker", "version", "--format", "{{.Server.Version}}"])
+            major, minor = map(int, version.decode().split(".")[:2])
+            return (major > 18) or (major == 18 and minor >= 9)
+        except Exception:
             return False
-    # @staticmethod
-    # def _handle_output_file(input_filepath, output_filepath) -> bool:
-    #     file_written = False
-    #     with open(input_filepath, 'r') as in_file, open(output_filepath, 'w') as outfile:
-    #         for line in in_file:
-    #             outfile.write(line)
-    #         file_written = True
-    #     return file_written
 
     def _get_profile_contents(self) -> dict:
         """
@@ -588,13 +591,15 @@ class ByoSnap:
                 code=SNAPCTL_INPUT_ERROR
             )
         # IMPORTANT: This is where the profile data is set and validated
+        #
+        # Update: June 2, 2025 -  We removed the line that updated the self.platform_type
+        # self.platform_type = profile_data_obj['platform']
         self.profile_data = profile_data_obj
         ByoSnap._validate_byosnap_profile_data(self.profile_data)
         # End: IMPORTANT: This is where the profile data is set
         # Now apply the overrides
         self.name = self.profile_data['name']
         self.desc = self.profile_data['description']
-        self.platform_type = self.profile_data['platform']
         self.language = self.profile_data['language']
         self.prefix = self.profile_data['prefix']
         # Setup the final ingress external port
@@ -716,6 +721,10 @@ class ByoSnap:
         build_platform = ByoSnap.DEFAULT_BUILD_PLATFORM
         if len(self.token_parts) == 4:
             build_platform = self.token_parts[3]
+        if self.platform_type is not None:
+            build_platform = self.platform_type
+        # if len(self.token_parts) == 4:
+        #     build_platform = self.token_parts[3]
         progress = Progress(
             SpinnerColumn(),
             TextColumn("[progress.description]{task.description}"),
@@ -725,6 +734,10 @@ class ByoSnap:
         progress.add_task(
             description='Building your snap...', total=None)
         try:
+            env = os.environ.copy()
+            if ByoSnap._docker_supports_buildkit():
+                info('Docker BuildKit is supported. Enabling it.')
+                env["DOCKER_BUILDKIT"] = "1"
             # Warning check for architecture specific commands
             info(f'Building on system architecture {sys_platform.machine()}')
             check_response = check_dockerfile_architecture(
@@ -737,7 +750,7 @@ class ByoSnap:
                     # 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)
+                ], shell=True, check=False, env=env)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
             else:
                 response = subprocess.run([
@@ -745,7 +758,7 @@ class ByoSnap:
                     "docker build --platform " +
                     f"{build_platform} -t {self.remote_tag} " +
                     f"-f {self.docker_path_filename} {self.path}"
-                ], shell=True, check=False)
+                ], shell=True, check=False, env=env)
                 # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
             if not response.returncode:
                 return snapctl_success(
@@ -943,15 +956,21 @@ class ByoSnap:
             if self.path is None and self.resources_path is None:
                 snapctl_error(
                     "Missing one of: path or resources-path parameter", SNAPCTL_INPUT_ERROR)
-            if not self.tag:
-                snapctl_error("Missing tag", SNAPCTL_INPUT_ERROR)
-            if len(self.tag.split()) > 1 or \
-                    len(self.tag) > ByoSnap.TAG_CHARACTER_LIMIT:
-                snapctl_error(
-                    "Tag should be a single word with maximum of " +
-                    f"{ByoSnap.TAG_CHARACTER_LIMIT} characters",
-                    SNAPCTL_INPUT_ERROR
-                )
+            if not self.tag and not self.version:
+                snapctl_error("Missing tag or version", SNAPCTL_INPUT_ERROR)
+            if self.tag:
+                if len(self.tag.split()) > 1 or \
+                        len(self.tag) > ByoSnap.TAG_CHARACTER_LIMIT:
+                    snapctl_error(
+                        "Tag should be a single word with maximum of " +
+                        f"{ByoSnap.TAG_CHARACTER_LIMIT} characters",
+                        SNAPCTL_INPUT_ERROR
+                    )
+            if self.version:
+                pattern = r'^v\d+\.\d+\.\d+$'
+                if not re.match(pattern, self.version):
+                    snapctl_error(message="Version should be in the format vX.X.X",
+                                  code=SNAPCTL_INPUT_ERROR)
         elif self.subcommand == 'publish-version':
             # Setup
             self._setup_token_and_token_parts(
@@ -1127,6 +1146,9 @@ class ByoSnap:
         progress.add_task(
             description='Uploading your BYOSnap Docs...', total=None)
         try:
+            upload_tag = self.tag
+            if not upload_tag:
+                upload_tag = self.version
             if self.resources_path:
                 base_dir = self.resources_path
             else:
@@ -1141,7 +1163,7 @@ class ByoSnap:
                         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"
+                            f"{self.byosnap_id}/docs/{upload_tag}/openapispec"
                         )
                         test_res = requests.post(
                             url, files={"attachment": attachment_file},
@@ -1181,7 +1203,7 @@ class ByoSnap:
                     with open(readme_file, "rb") as attachment_file:
                         url = (
                             f"{self.base_url}/v1/snapser-api/byosnaps/"
-                            f"{self.byosnap_id}/docs/{self.tag}/markdown"
+                            f"{self.byosnap_id}/docs/{upload_tag}/markdown"
                         )
                         test_res = requests.post(
                             url, files={"attachment": attachment_file},
@@ -1213,7 +1235,7 @@ class ByoSnap:
                             with open(file_path, "rb") as attachment_file:
                                 url = (
                                     f"{self.base_url}/v1/snapser-api/byosnaps/"
-                                    f"{self.byosnap_id}/docs/{self.tag}/tools"
+                                    f"{self.byosnap_id}/docs/{upload_tag}/tools"
                                 )
                                 test_res = requests.post(
                                     url, files={"attachment": attachment_file},
@@ -1370,7 +1392,11 @@ class ByoSnap:
                 "prod_template": prod_template,
                 # Currently not supported so we are just hardcoding an empty list
                 "egress": {"ports": []},
+                # Platform override
             }
+            if self.platform_type is not None:
+                payload['platform_override'] = self.platform_type
+
             res = requests.post(
                 f"{self.base_url}/v1/snapser-api/byosnaps/{self.byosnap_id}/versions",
                 json=payload, headers={'api-key': self.api_key},
@@ -1452,6 +1478,8 @@ class ByoSnap:
                 # Currently not supported so we are just hardcoding an empty list
                 "egress": {"ports": []},
             }
+            if self.platform_type is not None:
+                payload['platform_override'] = self.platform_type
             res = requests.patch(
                 f"{self.base_url}/v1/snapser-api/byosnaps/{self.byosnap_id}/versions/{self.version}",
                 json=payload, headers={'api-key': self.api_key},
@@ -1504,7 +1532,7 @@ class ByoSnap:
                 "service_id": self.byosnap_id,
                 "name": self.name,
                 "description": self.desc,
-                "platform": self.platform_type,
+                "platform": self.profile_data['platform'],
                 "language": self.language,
             }
             res = requests.post(

{snapctl-0.49.4 → snapctl-0.50.0}/snapctl/commands/byows.py

@@ -99,12 +99,11 @@ class Byows:
     def _get_export_commands(snap_ids, port):
         '''
         Generate export commands for the given snap IDs and port.
-        Replace hyphens with underscores in environment variable names.
         '''
         env_vars = []
 
         for snap_id in snap_ids:
-            upper_id = snap_id.upper().replace("-", "_")
+            upper_id = snap_id.upper()
             env_vars.append(f"SNAPEND_{upper_id}_GRPC_URL=localhost:{port}")
             env_vars.append(
                 f"SNAPEND_{upper_id}_HTTP_URL=http://localhost:{port}")
@@ -122,12 +121,11 @@ class Byows:
     def _generate_env_file(snap_ids, port):
         '''
         Generate an environment file with the given snap IDs and port.
-        Replace hyphens with underscores in environment variable names.
         '''
         env_lines = []
 
         for snap_id in snap_ids:
-            upper_id = snap_id.upper().replace("-", "_")
+            upper_id = snap_id.upper()
             env_lines.append(
                 f"export SNAPEND_{upper_id}_GRPC_URL=localhost:{port}")
             env_lines.append(

{snapctl-0.49.4 → snapctl-0.50.0}/snapctl/config/constants.py

@@ -3,7 +3,7 @@ Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
 VERSION_PREFIX = 'beta-'
-VERSION = '0.49.4'
+VERSION = '0.50.0'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 

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

@@ -0,0 +1,10 @@
+## beta-0.50.0
+##### June 5, 2025
+
+### Bug fix
+- Success, info or warning messages were sometimes getting truncated in the CLI output. This has been fixed.
+- Snapctl byosnap and byogs now support features that could only work with Buildkit.
+
+### Feature
+- The `snapctl byosnap upload-docs` command now supports `--version` to keep it consistent with all the new commands like `sync` and `publish`.
+

{snapctl-0.49.4 → snapctl-0.50.0}/snapctl/main.py

@@ -3,7 +3,6 @@
 """
 import configparser
 import os
-import json
 from sys import platform
 from typing import Union
 import typer
@@ -403,7 +402,7 @@ def byosnap(
         help="(req: create) Language of your snap - " +
         ", ".join(ByoSnap.LANGUAGES) + "."
     ),
-    # publish-image, publish-version, publish, sync
+    # publish-image, publish-version, publish, sync, upload-docs
     tag: str = typer.Option(
         None, "--tag", help=(
             "(req: publish-image, publish-version, upload-docs) (optional: publish, sync) Tag for your snap"

snapctl-0.50.0/snapctl/utils/echo.py

@@ -0,0 +1,52 @@
+"""
+This module contains functions to print messages to the console.
+"""
+import json
+import typer
+from rich import print
+from rich.markup import escape
+from snapctl.config.constants import SNAPCTL_ERROR
+from snapctl.types.definitions import ErrorResponse
+# Run `python -m rich.emoji` to get a list of all emojis that are supported
+
+
+def _stringify_message(msg: object) -> str:
+    if isinstance(msg, (dict, list)):
+        return json.dumps(msg, indent=2)
+    return str(msg)
+
+
+def error(msg: object, code: int = SNAPCTL_ERROR, data: object = None) -> None:
+    """
+    Prints an error message to the console.
+    """
+    msg = _stringify_message(msg)
+    error_response = ErrorResponse(
+        error=True, code=code, msg=msg, data=data if data else ''
+    )
+    print(f"[bold red]Error[/bold red] {escape(msg)}")
+    typer.echo(json.dumps(error_response.to_dict()), err=True)
+
+
+def warning(msg: object) -> None:
+    """
+    Prints a warning message to the console.
+    """
+    msg = _stringify_message(msg)
+    print(f"[bold yellow]Warning[/bold yellow] {escape(msg)}")
+
+
+def info(msg: object) -> None:
+    """
+    Prints an info message to the console.
+    """
+    msg = _stringify_message(msg)
+    print(f"[bold blue]Info[/bold blue] {escape(msg)}")
+
+
+def success(msg: object) -> None:
+    """
+    Prints a success message to the console.
+    """
+    msg = _stringify_message(msg)
+    print(f"[bold green]Success[/bold green] {escape(msg)}")

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

@@ -1,8 +0,0 @@
-## beta-0.49.4
-##### May 20, 2025
-
-### Bug Fixes
-
-#### Bring your own workstation (BYOW)
-- Environment exports no longer include hyphens in the variable names.
-

snapctl-0.49.4/snapctl/utils/echo.py

@@ -1,41 +0,0 @@
-"""
-This module contains functions to print messages to the console.
-"""
-import json
-import typer
-from rich import print
-from snapctl.config.constants import SNAPCTL_ERROR
-from snapctl.types.definitions import ErrorResponse
-# Run `python -m rich.emoji` to get a list of all emojis that are supported
-
-
-def error(msg: str, code: int = SNAPCTL_ERROR, data: object = None) -> None:
-    """
-    Prints an error message to the console.
-    """
-    error_response = ErrorResponse(
-        error=True, code=code, msg=msg, data=data if data else ''
-    )
-    print(f"[bold red]Error[/bold red] {msg}")
-    typer.echo(json.dumps(error_response.to_dict()), err=True)
-
-
-def warning(msg: str) -> None:
-    """
-    Prints a warning message to the console.
-    """
-    print(f"[bold yellow]Warning[/bold yellow] {msg}")
-
-
-def info(msg: str) -> None:
-    """
-    Prints an info message to the console.
-    """
-    print(f"[bold blue]Info[/bold blue] {msg}")
-
-
-def success(msg: str) -> None:
-    """
-    Prints a success message to the console.
-    """
-    print(f"[bold green]Success[/bold green] {msg}")