snapctl 0.35.0__tar.gz → 0.38.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.35.0
+Version: 0.38.0
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -264,6 +264,10 @@ snapctl byosnap upload-docs $byosnap_sid --tag $image_tag --path $code_root_path
 Publish a custom snap code image. This command executes, `build`, `push` and `upload-docs` one
 after the other.
 
+**IMPORTANT**: Take note of the hardware architecture of machine and your Dockerfile commands.
+Commands in docker file may be hardware architecture specific. Snapser throws a warning if it detects
+a mismatch.
+
 ```
 # Help for the byosnap command
 snapctl byosnap publish-image --help
@@ -348,6 +352,10 @@ snapctl byogs push --tag $image_tag
 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.
 
+**IMPORTANT**: Take note of the hardware architecture of machine and your Dockerfile commands.
+Commands in docker file may be hardware architecture specific. Snapser throws a warning if it detects
+a mismatch.
+
 ```
 # Help for the byogs command
 snapctl byogs publish --help

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

@@ -245,6 +245,10 @@ snapctl byosnap upload-docs $byosnap_sid --tag $image_tag --path $code_root_path
 Publish a custom snap code image. This command executes, `build`, `push` and `upload-docs` one
 after the other.
 
+**IMPORTANT**: Take note of the hardware architecture of machine and your Dockerfile commands.
+Commands in docker file may be hardware architecture specific. Snapser throws a warning if it detects
+a mismatch.
+
 ```
 # Help for the byosnap command
 snapctl byosnap publish-image --help
@@ -329,6 +333,10 @@ snapctl byogs push --tag $image_tag
 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.
 
+**IMPORTANT**: Take note of the hardware architecture of machine and your Dockerfile commands.
+Commands in docker file may be hardware architecture specific. Snapser throws a warning if it detects
+a mismatch.
+
 ```
 # Help for the byogs command
 snapctl byogs publish --help

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

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

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

@@ -5,6 +5,7 @@ import base64
 from binascii import Error as BinasciiError
 import os
 import subprocess
+import platform as sys_platform
 from sys import platform
 from typing import Union
 
@@ -13,8 +14,9 @@ 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.helper import get_composite_token, snapctl_error, snapctl_success
-from snapctl.utils.echo import info
+from snapctl.utils.helper import get_composite_token, snapctl_error, snapctl_success, \
+    check_dockerfile_architecture
+from snapctl.utils.echo import info, warning
 
 
 class ByoGs:
@@ -150,6 +152,13 @@ class ByoGs:
                 build_platform = self.token_parts[3]
             # Build your snap
             docker_file_path = os.path.join(self.path, self.dockerfile)
+            # 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())
+            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}"
@@ -160,7 +169,8 @@ class ByoGs:
             else:
                 response = subprocess.run([
                     # f"docker build --no-cache -t {tag} {path}"
-                    f"docker build --platform {build_platform} -t {self.input_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)
@@ -247,7 +257,8 @@ class ByoGs:
         # Check subcommand
         if not self.subcommand in ByoGs.SUBCOMMANDS:
             snapctl_error(
-                f"Invalid command. Valid commands are {', '.join(ByoGs.SUBCOMMANDS)}.",
+                f"Invalid command. Valid commands are {
+                    ', '.join(ByoGs.SUBCOMMANDS)}.",
                 SNAPCTL_INPUT_ERROR)
         # Validation for subcommands
         if self.token_parts is None:

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

@@ -7,6 +7,7 @@ import json
 import os
 import re
 import subprocess
+import platform as sys_platform
 from sys import platform
 from typing import Union
 import requests
@@ -22,8 +23,9 @@ from snapctl.config.constants import HTTP_ERROR_SERVICE_VERSION_EXISTS, \
     SNAPCTL_BYOSNAP_CREATE_DUPLICATE_NAME_ERROR, SNAPCTL_BYOSNAP_CREATE_PERMISSION_ERROR, \
     SNAPCTL_BYOSNAP_CREATE_ERROR, SNAPCTL_BYOSNAP_PUBLISH_VERSION_DUPLICATE_TAG_ERROR, \
     SNAPCTL_BYOSNAP_PUBLISH_VERSION_ERROR
-from snapctl.utils.echo import success, info
-from snapctl.utils.helper import get_composite_token, snapctl_error, snapctl_success
+from snapctl.utils.echo import success, info, warning
+from snapctl.utils.helper import get_composite_token, snapctl_error, snapctl_success, \
+    check_dockerfile_architecture
 
 
 class ByoSnap:
@@ -41,13 +43,16 @@ class ByoSnap:
     TAG_CHARACTER_LIMIT = 80
     VALID_CPU_MARKS = [100, 250, 500, 750, 1000, 1500, 2000, 3000]
     VALID_MEMORY_MARKS = [0.125, 0.25, 0.5, 1, 2, 3, 4]
+    MAX_READINESS_TIMEOUT = 30
+    MAX_MIN_REPLICAS = 4
 
     def __init__(
         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],
-        skip_build: bool = False
+        skip_build: bool = False, readiness_path: Union[str, None] = None,
+        readiness_delay: Union[int, None] = None
     ) -> None:
         self.subcommand: str = subcommand
         self.base_url: str = base_url
@@ -74,6 +79,8 @@ class ByoSnap:
         self.http_port: Union[int, None] = http_port
         self.byosnap_profile: Union[str, None] = byosnap_profile
         self.skip_build: bool = skip_build
+        self.readiness_path: Union[str, None] = readiness_path
+        self.readiness_delay: Union[int, None] = readiness_delay
         # Validate the input
         self.validate_input()
 
@@ -179,6 +186,13 @@ class ByoSnap:
         try:
             # Build your snap
             docker_file_path = os.path.join(self.path, self.dockerfile)
+            # 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())
+            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}"
@@ -189,7 +203,8 @@ class ByoSnap:
             else:
                 response = subprocess.run([
                     # f"docker build --no-cache -t {tag} {path}"
-                    f"docker build --platform {build_platform} -t {self.input_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)
@@ -300,6 +315,7 @@ class ByoSnap:
                 SNAPCTL_INPUT_ERROR
             )
         for profile in ['dev_template', 'stage_template', 'prod_template']:
+            # Currently, not checking for 'min_replicas' not in profile_data[profile]
             if 'cpu' not in profile_data[profile] or \
                 'memory' not in profile_data[profile] or \
                     'cmd' not in profile_data[profile] or \
@@ -312,13 +328,25 @@ class ByoSnap:
             if profile_data[profile]['cpu'] not in ByoSnap.VALID_CPU_MARKS:
                 snapctl_error(
                     'Invalid CPU value in BYOSnap profile. '
-                    f'Valid values are {", ".join(map(str, ByoSnap.VALID_CPU_MARKS))}',
+                    f'Valid values are {
+                        ", ".join(map(str, ByoSnap.VALID_CPU_MARKS))}',
                     SNAPCTL_INPUT_ERROR
                 )
             if profile_data[profile]['memory'] not in ByoSnap.VALID_MEMORY_MARKS:
                 snapctl_error(
                     'Invalid Memory value in BYOSnap profile. '
-                    f'Valid values are {", ".join(map(str, ByoSnap.VALID_MEMORY_MARKS))}',
+                    f'Valid values are {
+                        ", ".join(map(str, ByoSnap.VALID_MEMORY_MARKS))}',
+                    SNAPCTL_INPUT_ERROR
+                )
+            if 'min_replicas' in profile_data[profile] and \
+                (not isinstance(profile_data[profile]['min_replicas'], int) or
+                    int(profile_data[profile]['min_replicas']) < 0 or
+                 int(profile_data[profile]['min_replicas']) > ByoSnap.MAX_MIN_REPLICAS):
+                snapctl_error(
+                    'Invalid Min Replicas value in BYOSnap profile. '
+                    f'Minimum replicas should be between 0 and {
+                        ByoSnap.MAX_MIN_REPLICAS}',
                     SNAPCTL_INPUT_ERROR
                 )
 
@@ -342,13 +370,15 @@ class ByoSnap:
         # Validate the SID
         if not self.sid.startswith(ByoSnap.ID_PREFIX):
             snapctl_error(
-                f"Invalid Snap ID. Valid Snap IDs start with {ByoSnap.ID_PREFIX}.",
+                f"Invalid Snap ID. Valid Snap IDs start with {
+                    ByoSnap.ID_PREFIX}.",
                 SNAPCTL_INPUT_ERROR
             )
         if len(self.sid) > ByoSnap.SID_CHARACTER_LIMIT:
             snapctl_error(
                 "Invalid Snap ID. "
-                f"Snap ID should be less than {ByoSnap.SID_CHARACTER_LIMIT} characters",
+                f"Snap ID should be less than {
+                    ByoSnap.SID_CHARACTER_LIMIT} characters",
                 SNAPCTL_INPUT_ERROR
             )
         # Validation for subcommands
@@ -391,7 +421,8 @@ class ByoSnap:
                 # Check path
                 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}",
+                        f"Unable to find {
+                            self.dockerfile} at path {self.path}",
                         SNAPCTL_INPUT_ERROR)
             # elif self.subcommand == 'push':
             #     if not self.input_tag:
@@ -405,7 +436,8 @@ class ByoSnap:
                 if not self.input_tag:
                     snapctl_error(
                         "Missing required parameter: tag", SNAPCTL_INPUT_ERROR)
-                if len(self.input_tag.split()) > 1 or len(self.input_tag) > ByoSnap.TAG_CHARACTER_LIMIT:
+                if len(self.input_tag.split()) > 1 or \
+                        len(self.input_tag) > ByoSnap.TAG_CHARACTER_LIMIT:
                     snapctl_error(
                         "Tag should be a single word with maximum of "
                         f"{ByoSnap.TAG_CHARACTER_LIMIT} characters",
@@ -431,6 +463,18 @@ class ByoSnap:
                 if not self.http_port.isdigit():
                     snapctl_error("Ingress HTTP Port should be a number",
                                   SNAPCTL_INPUT_ERROR)
+                if self.readiness_path is not None:
+                    if self.readiness_path.strip() == '':
+                        snapctl_error("Readiness path cannot be empty",
+                                      SNAPCTL_INPUT_ERROR)
+                    if not self.readiness_path.strip().startswith('/'):
+                        snapctl_error("Readiness path has to start with /",
+                                      SNAPCTL_INPUT_ERROR)
+                if self.readiness_delay is not None:
+                    if self.readiness_delay < 0 or \
+                            self.readiness_delay > ByoSnap.MAX_READINESS_TIMEOUT:
+                        snapctl_error("Readiness delay should be between 0 "
+                                      f"and {ByoSnap.MAX_READINESS_TIMEOUT}", SNAPCTL_INPUT_ERROR)
                 # Check byosnap_profile path
                 self._validate_byosnap_profile()
 
@@ -495,7 +539,8 @@ class ByoSnap:
                         info('Unable to upload your swagger.json')
                 except RequestException as e:
                     info(
-                        f'Exception: Unable to find swagger.json at {self.path} {e}'
+                        f'Exception: Unable to find swagger.json at {
+                            self.path} {e}'
                     )
             else:
                 info(f'No swagger.json found at {self.path}'
@@ -561,7 +606,8 @@ class ByoSnap:
             if "api_error_code" in response_json and "message" in response_json:
                 if response_json['api_error_code'] == HTTP_ERROR_SERVICE_VERSION_EXISTS:
                     snapctl_error(
-                        f'BYOSnap {self.name} already exists. Please use a different name',
+                        f'BYOSnap {
+                            self.name} already exists. Please use a different name',
                         SNAPCTL_BYOSNAP_CREATE_DUPLICATE_NAME_ERROR,
                         progress
                     )
@@ -628,6 +674,10 @@ class ByoSnap:
                 "image_tag": self.input_tag,
                 "base_url": f"{self.prefix}/{self.sid}",
                 "http_port": self.http_port,
+                "readiness_probe_config": {
+                    "path": self.readiness_path,
+                    "initial_delay_seconds": self.readiness_delay
+                },
                 "dev_template": profile_data['dev_template'],
                 "stage_template": profile_data['stage_template'],
                 "prod_template": profile_data['prod_template']

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

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

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

@@ -149,7 +149,7 @@ SNAPEND_MANIFEST_TYPES: dict[str, dict[str, str]] = {
     },
 }
 
-SERVICE_IDS = [
+SERVICE_IDS: list[str] = [
     'analytics', 'auth', 'client-logs', 'events', 'experiments', 'gdpr', 'guilds', 'hades', 'iap',
     'inventory', 'leaderboards', 'matchmaking', 'notifications', 'parties', 'profiles', 'quests',
     'relay', 'remote-config', 'scheduler', 'sequencer', 'social-graph', 'statistics', 'storage',
@@ -159,6 +159,7 @@ SERVICE_IDS = [
 DEFAULT_BYOSNAP_DEV_TEMPLATE = {
     'cpu': 100,
     'memory': 0.125,
+    'min_replicas': 1,
     'cmd': '',
     'args': [],
     'env_params': [{'key': "SNAPSER_ENVIRONMENT", 'value': "DEVELOPMENT"}]
@@ -167,6 +168,7 @@ DEFAULT_BYOSNAP_DEV_TEMPLATE = {
 DEFAULT_BYOSNAP_STAGE_TEMPLATE = {
     'cpu': 100,
     'memory': 0.125,
+    'min_replicas': 1,
     'cmd': '',
     'args': [],
     'env_params': [{'key': "SNAPSER_ENVIRONMENT", 'value': "STAGING"}]
@@ -175,6 +177,7 @@ DEFAULT_BYOSNAP_STAGE_TEMPLATE = {
 DEFAULT_BYOSNAP_PROD_TEMPLATE = {
     'cpu': 100,
     'memory': 0.125,
+    'min_replicas': 2,
     'cmd': '',
     'args': [],
     'env_params': [{'key': "SNAPSER_ENVIRONMENT", 'value': "PRODUCTION"}]
@@ -185,3 +188,10 @@ BYOSNAP_TEMPLATE = {
     'stage_template': DEFAULT_BYOSNAP_STAGE_TEMPLATE,
     'prod_template': DEFAULT_BYOSNAP_PROD_TEMPLATE
 }
+
+ARCHITECTURE_MAPPING: dict[str, str] = {
+    'x86_64': 'amd64',
+    'arm64': 'arm64',
+    'aarch64': 'arm64',
+    'amd64': 'amd64'
+}

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

@@ -76,7 +76,8 @@ def extract_config(extract_key: str, profile: str | None = None) -> object:
             result['location'] = f'"{config_file_path}:profile {profile}"'
             config_profile = f'profile {profile}'
             info(
-                f'Trying to extract API KEY from "{config_file_path}:profile {profile}"'
+                f'Trying to extract API KEY from "{
+                    config_file_path}:profile {profile}"'
             )
         result['value'] = config.get(
             config_profile, extract_key, fallback=None, raw=True
@@ -338,7 +339,12 @@ def byosnap(
     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."
     ),
-
+    readiness_path: str = typer.Option(
+        None, "--readiness-path", help="(req: publish-version) Readiness path for your snap"
+    ),
+    readiness_delay: int = typer.Option(
+        None, "--readiness-delay", help="(req: publish-version) Delay before readiness check"
+    ),
     # overrides
     api_key: Union[str, None] = typer.Option(
         None, "--api-key", help="API Key override.", callback=api_key_context_callback
@@ -354,7 +360,8 @@ 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, skip_build
+        prefix, version, http_port, byosnap_profile, skip_build,
+        readiness_path, readiness_delay
     )
     getattr(byosnap_obj, subcommand.replace('-', '_'))()
     success(f"BYOSnap {subcommand} complete")

{snapctl-0.35.0 → snapctl-0.38.0}/snapctl/utils/echo.py

@@ -20,6 +20,13 @@ def error(msg: str, code: int = SNAPCTL_ERROR, data: object = None) -> None:
     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.

{snapctl-0.35.0 → snapctl-0.38.0}/snapctl/utils/helper.py

@@ -1,16 +1,18 @@
 """
 Helper functions for snapctl
 """
+import re
 import requests
 import typer
 from requests.exceptions import RequestException
 from rich.progress import Progress
 from snapctl.config.constants import HTTP_NOT_FOUND, HTTP_FORBIDDEN, HTTP_UNAUTHORIZED, \
     SERVER_CALL_TIMEOUT, SNAPCTL_CONFIGURATION_ERROR, SNAPCTL_SUCCESS
+from snapctl.config.hashes import ARCHITECTURE_MAPPING
 from snapctl.utils.echo import error, success
 
 
-def validate_api_key(base_url: str, api_key: str | None):
+def validate_api_key(base_url: str, api_key: str | None) -> bool:
     """
     This function validates the API Key
     """
@@ -74,6 +76,63 @@ def get_composite_token(base_url: str, api_key: str | None, action: str, params:
     return res.json()['token']
 
 
+def check_dockerfile_architecture(dockerfile_path: str, system_arch: str) -> dict[str, object]:
+    """
+    Check the Dockerfile for architecture specific commands
+    """
+    response = {
+        'error': False,
+        'message': ''
+    }
+    # Normalize system architecture
+    system_arch = ARCHITECTURE_MAPPING.get(system_arch, system_arch)
+    try:
+        lines = []
+        with open(dockerfile_path, 'r') as file:
+            lines = file.readlines()
+        for line_number, line in enumerate(lines, 1):
+            if line.startswith('#'):
+                continue
+            # Checking various build and run commands for architecture specifics
+            patterns = [
+                # FROM with platform
+                r'FROM --platform=linux/(\w+)',
+                # dotnet runtime
+                r'-r linux-(\w+)',
+                # Build args specifying arch
+                r'--build-arg ARCH=(\w+)',
+                # Environment variables setting arch
+                r'ENV ARCH=(\w+)',
+                # cmake specifying arch
+                r'cmake.*?-DARCH=(\w+)',
+                # make specifying arch
+                r'make.*?ARCH=(\w+)'
+            ]
+
+            for pattern in patterns:
+                match = re.search(pattern, line)
+                if match and ARCHITECTURE_MAPPING.get(match.group(1)) != system_arch:
+                    response['error'] = True
+                    response['message'] = (
+                        f'[Architecture Mismatch] Line {line_number}: "{
+                            line.strip()}" '
+                        f' of Dockerfile {dockerfile_path}'
+                        f' specifies architecture {
+                            match.group(1)}, which does not match the '
+                        f' systems ({system_arch}).'
+                    )
+                    return response
+    except FileNotFoundError:
+        response['error'] = True
+        response['message'] = f'Dockerfile not found at {dockerfile_path}'
+        return response
+    except Exception as e:
+        response['error'] = True
+        response['message'] = f'Exception {e}'
+        return response
+    return response
+
+
 def snapctl_success(message: str, progress: Progress | None = None, no_exit: bool = False):
     """
     This function exits the snapctl