snapctl 0.42.1__py3-none-any.whl → 0.43.1__py3-none-any.whl

snapctl/commands/byosnap.py

@@ -27,8 +27,8 @@ from snapctl.config.constants import HTTP_ERROR_SERVICE_VERSION_EXISTS, \
     SNAPCTL_BYOSNAP_PUBLISH_VERSION_ERROR, HTTP_ERROR_SERVICE_IN_USE, \
     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
-from snapctl.utils.echo import info, warning
+    HTTP_ERROR_RESOURCE_NOT_FOUND, SNAPCTL_BYOSNAP_PUBLISH_ERROR
+from snapctl.utils.echo import info, warning, success
 from snapctl.utils.helper import get_composite_token, snapctl_error, snapctl_success, \
     check_dockerfile_architecture
 
@@ -40,10 +40,12 @@ class ByoSnap:
     ID_PREFIX = 'byosnap-'
     SUBCOMMANDS = [
         'create', 'publish-image', 'publish-version', 'upload-docs', 'update-version',
-        'sync'
+        'publish', 'sync'
     ]
+    PROFILE_NAME = 'snapser-byosnap-profile.json'
     PLATFORMS = ['linux/arm64', 'linux/amd64']
-    LANGUAGES = ['go', 'python', 'ruby', 'c#', 'c++', 'rust', 'java', 'node']
+    LANGUAGES = ['go', 'node', 'python', 'java', 'csharp', 'cpp', 'rust',
+                 'ruby', 'php', 'perl', 'clojure', 'lua', 'ts', 'js', 'kotlin', 'c']
     DEFAULT_BUILD_PLATFORM = 'linux/arm64'
     SID_CHARACTER_LIMIT = 47
     TAG_CHARACTER_LIMIT = 80
@@ -57,43 +59,43 @@ class ByoSnap:
         name: Union[str, None] = None, desc: Union[str, None] = None,
         platform_type: Union[str, None] = None, language: Union[str, None] = None,
         tag: Union[str, None] = None, path: Union[str, None] = None,
-        resources_path: Union[str, None] = None,  dockerfile: Union[str, None] = None,
-        prefix: Union[str, None] = None, version: Union[str, None] = None,
-        http_port: Union[int, None] = None,
-        byosnap_profile: Union[str, None] = None, skip_build: bool = False,
-        readiness_path: Union[str, None] = None, readiness_delay: Union[int, None] = None,
-        snapend_id: Union[str, None] = None, blocking: bool = False
+        resources_path: Union[str, None] = None,  docker_file: Union[str, None] = None,
+        version: Union[str, None] = None, skip_build: bool = False,
+        snapend_id: Union[str, None] = None, blocking: bool = False,
+        byosnap_profile_file: Union[str, None] = None
     ) -> None:
+        # Set the BASE variables
         self.subcommand: str = subcommand
         self.base_url: str = base_url
         self.api_key: Union[str, None] = api_key
         self.sid: str = sid
-        self.name: str = name
-        self.desc: str = desc
-        self.platform_type: str = platform_type
-        self.language: str = language
-        if subcommand != 'create':
-            self.token: Union[str, None] = get_composite_token(
-                base_url, api_key,
-                'byosnap', {'service_id': sid}
-            )
-        else:
-            self.token: Union[str, None] = None
-        self.token_parts: Union[list, None] = ByoSnap._get_token_values(
-            self.token) if self.token is not None else None
+        self.token: Union[str, None] = None
+        self.token_parts: Union[list, None] = None
+        self.byosnap_profile: Union[str, None] = None
+        if subcommand not in ['create', 'publish']:
+            # Create does not need the token
+            # Publish handles this in the publish-image subcommand
+            self._setup_token_and_token_parts(base_url, api_key, sid)
         self.tag: Union[str, None] = tag
         self.path: Union[str, None] = path
         self.resources_path: Union[str, None] = resources_path
-        self.dockerfile: str = dockerfile
-        self.prefix: str = prefix
+        self.docker_file: str = docker_file
+        self.byosnap_profile_file: Union[str, None] = byosnap_profile_file
         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
-        self.readiness_path: Union[str, None] = readiness_path
-        self.readiness_delay: Union[int, None] = readiness_delay
+        self.name: Union[str, None] = name
+        self.desc: Union[str, None] = desc
+        self.platform_type: Union[str, None] = platform_type
+        self.language: Union[str, None] = language
         self.snapend_id: Union[str, None] = snapend_id
+        self.skip_build: bool = skip_build
         self.blocking: bool = blocking
+        # Override
+        self.prefix: Union[str, None] = None
+        self.http_port: Union[int, None] = None
+        self.readiness_path: Union[str, None] = None
+        self.readiness_delay: Union[str, None] = None
+        if self.subcommand in ['publish', 'publish-version']:
+            self._validate_and_override_properties_from_profile()
         # Validate the input
         self.validate_input()
 
@@ -120,6 +122,150 @@ class ByoSnap:
             pass
         return None
 
+    def _setup_token_and_token_parts(self, base_url, api_key, sid) -> None:
+        '''
+        Setup the token and token parts for publishing and syncing
+        '''
+        self.token: Union[str, None] = get_composite_token(
+            base_url, api_key,
+            'byosnap', {'service_id': sid}
+        )
+        self.token_parts: Union[list, None] = ByoSnap._get_token_values(
+            self.token) if self.token is not None else None
+
+    def _check_and_get_byosnap_profile(self) -> object:
+        """
+          Validate the BYOSnap profile
+        """
+        profile_data = None
+        with open(self.byosnap_profile, 'rb') as file:
+            try:
+                profile_data = json.load(file)
+            except json.JSONDecodeError:
+                pass
+        if not profile_data:
+            snapctl_error(
+                message='Invalid BYOSnap profile JSON. Please check the JSON structure',
+                code=SNAPCTL_INPUT_ERROR
+            )
+        if 'dev_template' not in profile_data or \
+            'stage_template' not in profile_data or \
+                'prod_template' not in profile_data:
+            snapctl_error(
+                message='Invalid BYOSnap profile JSON. Please check the JSON structure',
+                code=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 \
+                    'args' not in profile_data[profile] or \
+                    'env_params' not in profile_data[profile]:
+                snapctl_error(
+                    message='Invalid BYOSnap profile JSON. Please check the JSON structure',
+                    code=SNAPCTL_INPUT_ERROR
+                )
+            if profile_data[profile]['cpu'] not in ByoSnap.VALID_CPU_MARKS:
+                snapctl_error(
+                    message='Invalid CPU value in BYOSnap profile. Valid values are' +
+                    f'{", ".join(map(str, ByoSnap.VALID_CPU_MARKS))}',
+                    code=SNAPCTL_INPUT_ERROR
+                )
+            if profile_data[profile]['memory'] not in ByoSnap.VALID_MEMORY_MARKS:
+                snapctl_error(
+                    message='Invalid Memory value in BYOSnap profile. Valid values are ' +
+                    f'{", ".join(map(str, ByoSnap.VALID_MEMORY_MARKS))}',
+                    code=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(
+                    message='Invalid Min Replicas value in BYOSnap profile. ' +
+                    'Minimum replicas should be between 0 and ' +
+                    f'{ByoSnap.MAX_MIN_REPLICAS}',
+                    code=SNAPCTL_INPUT_ERROR
+                )
+        if 'name' not in profile_data or 'description' not in profile_data or \
+            'platform' not in profile_data or 'language' not in profile_data or \
+                'prefix' not in profile_data or 'http_port' not in profile_data or \
+            'readiness_probe_config' not in profile_data or \
+                'initial_delay_seconds' not in profile_data['readiness_probe_config'] or \
+                'path' not in profile_data['readiness_probe_config']:
+            snapctl_error(
+                message='BYOSnap profile now requires name, description, platform, ' +
+                'language, prefix http_port, and readiness_probe_config fields. Please use ' +
+                'the following command: ' +
+                '`snapctl generate profile --category byosnap --out-path $output_path` ' +
+                'to generate a new profile',
+                code=SNAPCTL_INPUT_ERROR
+            )
+        return profile_data
+
+    def _validate_and_override_properties_from_profile(self) -> None:
+        # Build your snap
+        if self.resources_path:
+            base_path = self.resources_path
+        else:
+            base_path = self.path
+        if not self.byosnap_profile_file:
+            self.byosnap_profile_file = ByoSnap.PROFILE_NAME
+        self.byosnap_profile = os.path.join(
+            base_path, self.byosnap_profile_file)
+        if not os.path.isfile(self.byosnap_profile):
+            snapctl_error(
+                "Unable to find " +
+                f"{self.byosnap_profile_file} at path {base_path}",
+                SNAPCTL_INPUT_ERROR)
+        info('Extracting information from BYOSnap profile at path ' +
+             f'{self.byosnap_profile}')
+        profile_data = self._check_and_get_byosnap_profile()
+        self.name = profile_data['name']
+        self.desc = profile_data['description']
+        self.platform_type = profile_data['platform']
+        self.language = profile_data['language']
+        self.prefix = profile_data['prefix']
+        self.http_port = profile_data['http_port']
+        self.readiness_path = profile_data['readiness_probe_config']['path']
+        self.readiness_delay = \
+            profile_data['readiness_probe_config']['initial_delay_seconds']
+        # Validate
+        if not self.prefix or self.prefix == '':
+            snapctl_error("Missing prefix", SNAPCTL_INPUT_ERROR)
+        if not self.prefix.startswith('/'):
+            snapctl_error("Prefix should start with a forward slash (/)",
+                          SNAPCTL_INPUT_ERROR)
+        if self.prefix.endswith('/'):
+            snapctl_error("Prefix should not end with a forward slash (/)",
+                          SNAPCTL_INPUT_ERROR)
+        if not self.version:
+            snapctl_error("Missing version", SNAPCTL_INPUT_ERROR)
+        pattern = r'^v\d+\.\d+\.\d+$'
+        if not re.match(pattern, self.version):
+            snapctl_error("Version should be in the format vX.X.X",
+                          SNAPCTL_INPUT_ERROR)
+        if not self.http_port:
+            snapctl_error("Missing Ingress HTTP Port",
+                          SNAPCTL_INPUT_ERROR)
+        if not isinstance(self.http_port, int):
+            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)
+
     def _check_dependencies(self) -> None:
         """
           Check application dependencies
@@ -212,7 +358,7 @@ class ByoSnap:
                 base_path = self.resources_path
             else:
                 base_path = self.path
-            docker_file_path = os.path.join(base_path, self.dockerfile)
+            docker_file_path = os.path.join(base_path, self.docker_file)
 
             # Warning check for architecture specific commands
             info(f'Building on system architecture {sys_platform.machine()}')
@@ -324,71 +470,6 @@ class ByoSnap:
             message='BYOSnap upload failure. Duplicate image error.',
             code=SNAPCTL_BYOSNAP_PUBLISH_IMAGE_DUPLICATE_TAG_ERROR, progress=progress)
 
-    def _validate_byosnap_profile(self) -> None:
-        """
-          Validate the BYOSnap profile
-        """
-        if not self.byosnap_profile:
-            snapctl_error(
-                message="Missing BYOSnap profile path", code=SNAPCTL_INPUT_ERROR)
-        if not os.path.isfile(self.byosnap_profile):
-            snapctl_error(
-                message="Unable to find BYOSnap profile " +
-                f"JSON at path {self.byosnap_profile}",
-                code=SNAPCTL_INPUT_ERROR
-            )
-        profile_data = None
-        with open(self.byosnap_profile, 'rb') as file:
-            try:
-                profile_data = json.load(file)
-            except json.JSONDecodeError:
-                pass
-        if not profile_data:
-            snapctl_error(
-                message='Invalid BYOSnap profile JSON. Please check the JSON structure',
-                code=SNAPCTL_INPUT_ERROR
-            )
-        if 'dev_template' not in profile_data or \
-            'stage_template' not in profile_data or \
-                'prod_template' not in profile_data:
-            snapctl_error(
-                message='Invalid BYOSnap profile JSON. Please check the JSON structure',
-                code=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 \
-                    'args' not in profile_data[profile] or \
-                    'env_params' not in profile_data[profile]:
-                snapctl_error(
-                    message='Invalid BYOSnap profile JSON. Please check the JSON structure',
-                    code=SNAPCTL_INPUT_ERROR
-                )
-            if profile_data[profile]['cpu'] not in ByoSnap.VALID_CPU_MARKS:
-                snapctl_error(
-                    message='Invalid CPU value in BYOSnap profile. Valid values are' +
-                    f'{", ".join(map(str, ByoSnap.VALID_CPU_MARKS))}',
-                    code=SNAPCTL_INPUT_ERROR
-                )
-            if profile_data[profile]['memory'] not in ByoSnap.VALID_MEMORY_MARKS:
-                snapctl_error(
-                    message='Invalid Memory value in BYOSnap profile. Valid values are ' +
-                    f'{", ".join(map(str, ByoSnap.VALID_MEMORY_MARKS))}',
-                    code=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(
-                    message='Invalid Min Replicas value in BYOSnap profile. ' +
-                    'Minimum replicas should be between 0 and ' +
-                    f'{ByoSnap.MAX_MIN_REPLICAS}',
-                    code=SNAPCTL_INPUT_ERROR
-                )
-
     def _clean_slate(self) -> None:
         progress = Progress(
             SpinnerColumn(),
@@ -467,12 +548,10 @@ class ByoSnap:
                     f"{', '.join(ByoSnap.PLATFORMS)}.",
                     code=SNAPCTL_INPUT_ERROR
                 )
-            return
-        # Now validate all other commands Check the token
-        if self.token_parts is None:
-            snapctl_error('Invalid token. Please reach out to your support team.',
-                          SNAPCTL_INPUT_ERROR)
-        if self.subcommand in ['publish-image']:
+        elif self.subcommand == 'publish-image':
+            if self.token_parts is None:
+                snapctl_error('Invalid token. Please reach out to your support team.',
+                              SNAPCTL_INPUT_ERROR)
             if not self.tag:
                 snapctl_error(
                     "Missing required parameter: tag", SNAPCTL_INPUT_ERROR)
@@ -489,23 +568,25 @@ class ByoSnap:
             # Check path
             if self.resources_path:
                 docker_file_path = \
-                    f"{self.resources_path}/{self.dockerfile}"
+                    f"{self.resources_path}/{self.docker_file}"
             else:
-                docker_file_path = f"{self.path}/{self.dockerfile}"
+                docker_file_path = f"{self.path}/{self.docker_file}"
             if not self.skip_build and not os.path.isfile(docker_file_path):
                 snapctl_error(
                     "Unable to find " +
-                    f"{self.dockerfile} at path {docker_file_path}",
+                    f"{self.docker_file} at path {docker_file_path}",
                     SNAPCTL_INPUT_ERROR)
-        # elif self.subcommand == 'push':
-        #     if not self.tag:
-        #         error("Missing required parameter: tag", SNAPCTL_INPUT_ERROR)
-        #         raise typer.Exit(code=SNAPCTL_INPUT_ERROR)
         elif self.subcommand == 'upload-docs':
+            if self.token_parts is None:
+                snapctl_error('Invalid token. Please reach out to your support team.',
+                              SNAPCTL_INPUT_ERROR)
             if self.path is None and self.resources_path is None:
                 snapctl_error(
                     "Missing one of: path or resources-path parameter", SNAPCTL_INPUT_ERROR)
         elif self.subcommand == 'publish-version':
+            if self.token_parts is None:
+                snapctl_error('Invalid token. Please reach out to your support team.',
+                              SNAPCTL_INPUT_ERROR)
             if not self.tag:
                 snapctl_error(
                     "Missing required parameter: tag", SNAPCTL_INPUT_ERROR)
@@ -516,42 +597,10 @@ class ByoSnap:
                     f"{ByoSnap.TAG_CHARACTER_LIMIT} characters",
                     SNAPCTL_INPUT_ERROR
                 )
-            if not self.prefix or self.prefix == '':
-                snapctl_error("Missing prefix", SNAPCTL_INPUT_ERROR)
-            if not self.prefix.startswith('/'):
-                snapctl_error("Prefix should start with a forward slash (/)",
-                              SNAPCTL_INPUT_ERROR)
-            if self.prefix.endswith('/'):
-                snapctl_error("Prefix should not end with a forward slash (/)",
-                              SNAPCTL_INPUT_ERROR)
-            if not self.version:
-                snapctl_error("Missing version", SNAPCTL_INPUT_ERROR)
-            pattern = r'^v\d+\.\d+\.\d+$'
-            if not re.match(pattern, self.version):
-                snapctl_error("Version should be in the format vX.X.X",
-                              SNAPCTL_INPUT_ERROR)
-            if not self.http_port:
-                snapctl_error("Missing Ingress HTTP Port",
-                              SNAPCTL_INPUT_ERROR)
-            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()
         elif self.subcommand == 'update-version':
+            if self.token_parts is None:
+                snapctl_error('Invalid token. Please reach out to your support team.',
+                              SNAPCTL_INPUT_ERROR)
             if not self.version:
                 snapctl_error(message="Missing version",
                               code=SNAPCTL_INPUT_ERROR)
@@ -571,23 +620,39 @@ class ByoSnap:
                     code=SNAPCTL_INPUT_ERROR
                 )
         elif self.subcommand == 'sync':
+            if self.token_parts is None:
+                snapctl_error('Invalid token. Please reach out to your support team.',
+                              SNAPCTL_INPUT_ERROR)
             if not self.version:
-                snapctl_error(message="Missing version",
+                snapctl_error(message="Missing version. Version should be in the format vX.X.X",
                               code=SNAPCTL_INPUT_ERROR)
             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)
-            if not self.tag:
+            if not self.skip_build and not self.path:
                 snapctl_error(
-                    message="Missing required parameter: tag", code=SNAPCTL_INPUT_ERROR)
-            if len(self.tag.split()) > 1 or \
-                    len(self.tag) > ByoSnap.TAG_CHARACTER_LIMIT:
+                    message="Missing required parameter: path",
+                    code=SNAPCTL_INPUT_ERROR)
+            # Check path
+            if self.resources_path:
+                docker_file_path = \
+                    f"{self.resources_path}/{self.docker_file}"
+            else:
+                docker_file_path = f"{self.path}/{self.docker_file}"
+            if not self.skip_build and not os.path.isfile(docker_file_path):
                 snapctl_error(
-                    message="Tag should be a single word with maximum of " +
-                    f"{ByoSnap.TAG_CHARACTER_LIMIT} characters",
-                    code=SNAPCTL_INPUT_ERROR
-                )
+                    message="Unable to find " +
+                    f"{self.docker_file} at path {docker_file_path}",
+                    code=SNAPCTL_INPUT_ERROR)
+        elif self.subcommand == 'publish':
+            if not self.version:
+                snapctl_error(message="Missing version. Version should be in the format vX.X.X",
+                              code=SNAPCTL_INPUT_ERROR)
+            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)
             if not self.skip_build and not self.path:
                 snapctl_error(
                     message="Missing required parameter: path",
@@ -595,15 +660,16 @@ class ByoSnap:
             # Check path
             if self.resources_path:
                 docker_file_path = \
-                    f"{self.resources_path}/{self.dockerfile}"
+                    f"{self.resources_path}/{self.docker_file}"
             else:
-                docker_file_path = f"{self.path}/{self.dockerfile}"
+                docker_file_path = f"{self.path}/{self.docker_file}"
             if not self.skip_build and not os.path.isfile(docker_file_path):
                 snapctl_error(
                     message="Unable to find " +
-                    f"{self.dockerfile} at path {docker_file_path}",
+                    f"{self.docker_file} at path {docker_file_path}",
                     code=SNAPCTL_INPUT_ERROR)
-    # CRUD methods
+
+    # Basic methods
 
     def build(self) -> None:
         """
@@ -629,7 +695,7 @@ class ByoSnap:
         self._docker_login()
         self._docker_push()
 
-    # Upper echelon commands
+    # Crud methods
     def upload_docs(self, no_exit: bool = False) -> None:
         '''
         Note this step is optional hence we do not raise a typer.Exit
@@ -959,12 +1025,57 @@ class ByoSnap:
             message='Failed to update version',
             code=SNAPCTL_BYOSNAP_UPDATE_VERSION_ERROR, progress=progress)
 
+    # Upper echelon methods
+    def publish(self) -> None:
+        '''
+        Sync the snap
+        '''
+        try:
+            # Attempt to create a BYOSnap but no worries if it fails
+            payload = {
+                "service_id": self.sid,
+                "name": self.name,
+                "description": self.desc,
+                "platform": self.platform_type,
+                "language": self.language,
+            }
+            res = requests.post(
+                f"{self.base_url}/v1/snapser-api/byosnaps",
+                json=payload, headers={'api-key': self.api_key},
+                timeout=SERVER_CALL_TIMEOUT
+            )
+            if res.ok:
+                success('BYOSnap created successfully')
+            else:
+                response_json = res.json()
+                if "api_error_code" in response_json and "message" in response_json:
+                    if response_json['api_error_code'] == HTTP_ERROR_SERVICE_VERSION_EXISTS:
+                        info(
+                            msg=f'BYOSnap {self.name} present. ' +
+                            'Lets proceed',
+                        )
+            # Make the tag same as version
+            self.tag = self.version
+            # Setup the token and token parts
+            self._setup_token_and_token_parts(
+                self.base_url, self.api_key, self.sid)
+            # Now publish the image
+            self.publish_image(no_exit=True)
+            # Now publish the version
+            self.publish_version(no_exit=True)
+            return snapctl_success(message='BYOSNAP published successfully')
+        except RequestException as e:
+            snapctl_error(
+                message='Exception: Unable to publish a ' +
+                f' version for your Byosnap. Exception: {e}',
+                code=SNAPCTL_BYOSNAP_PUBLISH_ERROR)
+
     def sync(self) -> None:
         '''
         Sync the snap
         '''
         try:
-            self.tag = f'{self.tag}-{int(time.time())}'
+            self.tag = f'{self.version}-{int(time.time())}'
             self.publish_image(no_exit=True)
             self.update_version(no_exit=True)
             byosnap_list: str = f"{self.sid}:{self.version}"

snapctl/config/constants.py

@@ -2,7 +2,7 @@
 Constants used by snapctl
 """
 COMPANY_NAME = 'Snapser'
-VERSION = '0.42.1'
+VERSION = '0.43.1'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\\.snapser\\config'
 
@@ -69,6 +69,7 @@ SNAPCTL_BYOSNAP_UPDATE_VERSION_ERROR = 45
 SNAPCTL_BYOSNAP_UPDATE_VERSION_SERVICE_IN_USE_ERROR = 46
 SNAPCTL_BYOSNAP_UPDATE_VERSION_TAG_ERROR = 47
 SNAPCTL_BYOSNAP_UPDATE_VERSION_INVALID_VERSION_ERROR = 48
+SNAPCTL_BYOSNAP_PUBLISH_ERROR = 49
 
 # Game Errors
 SNAPCTL_GAME_NOT_FOUND = SNAPCTL_RESOURCE_NOT_FOUND

snapctl/config/hashes.py

@@ -188,6 +188,16 @@ DEFAULT_BYOSNAP_PROD_TEMPLATE: Dict[str, object] = {
 }
 
 BYOSNAP_TEMPLATE: Dict[str, Dict[str, object]] = {
+    "name": "TODO: Add your BYOSnap name here. Name has to start with byosnap-. This is to ensure we avoid any collisions.",
+    'description': "TODO: Add your BYOSnap description here",
+    'platform': "TODO: Add your platform here. Options are 'linux/arm64' or 'linux/amd64'",
+    'language': "TODO: Add your language here. Options are 'go', 'node', 'python', 'java', 'csharp', 'cpp', 'rust', 'ruby', 'php', 'perl', 'clojure', 'lua', 'ts', 'js', 'kotlin', 'c'",
+    'prefix': "TODO: Add your prefix here. Prefix should start with /. Eg: '/v1'",
+    'http_port': 'TODO: Add your HTTP Port. Eg: 8080',
+    'readiness_probe_config': {
+        'initial_delay_seconds': "TODO: Add your readiness delay in seconds here. Eg: 5 or use null",
+        'path': "TODO: Add your readiness path here. Eg: '/health' or use null",
+    },
     'dev_template': DEFAULT_BYOSNAP_DEV_TEMPLATE,
     'stage_template': DEFAULT_BYOSNAP_STAGE_TEMPLATE,
     'prod_template': DEFAULT_BYOSNAP_PROD_TEMPLATE

snapctl/main.py

@@ -317,6 +317,30 @@ def byosnap(
         ..., help="BYOSnap Subcommands: " + ", ".join(ByoSnap.SUBCOMMANDS) + "."
     ),
     sid: str = typer.Argument(..., help="Snap Id. Should start with byosnap-"),
+    # publish
+    path: Union[str, None] = typer.Option(
+        None, "--path", help="(req: publish, sync, publish-image, publish-version) Path to your snap code"
+    ),
+    resources_path: Union[str, None] = typer.Option(
+        None, "--resources-path", help="(optional: publish, sync, publish-image, publish-version; req: upload-docs) Path to resources such as your Dockerfile, snapser-byosnap-profile.json, snapser-tool-*.json, swagger.json or README.md"
+    ),
+    # publish, sync and publish-version
+    version: Union[str, None] = typer.Option(
+        None, "--version",
+        help="(req: publish, sync, publish-version) Snap version. Should start with v. Example vX.X.X"
+    ),
+    # sync
+    snapend_id: str = typer.Option(
+        None, "--snapend-id",
+        help=("(req: sync) Snapend Id. NOTE: Development Snapends only.")
+    ),
+    blocking: bool = typer.Option(
+        False, "--blocking",
+        help=(
+            "(optional: sync) Set to true if you want to wait for the update to complete "
+            "before returning."
+        )
+    ),
     # create
     name: str = typer.Option(
         None, "--name", help="(req: create) Name for your snap."
@@ -337,62 +361,24 @@ def byosnap(
     # publish-image and publish-version
     tag: str = typer.Option(
         None, "--tag", help=(
-            "(req: publish-image, publish-version, sync) Tag for your snap"
-        )
-    ),
-    # publish-image
-    path: Union[str, None] = typer.Option(
-        None, "--path", help="(req: publish-image, sync) Path to your snap code"
-    ),
-    resources_path: Union[str, None] = typer.Option(
-        None, "--resources-path", help="(optional: publish-image, sync; req: upload-docs) Path to resources such as your Dockerfile, swagger.json or README.md"
-    ),
-    docker_file: str = typer.Option(
-        "Dockerfile", help="(optional: publish) Dockerfile name to use"
-    ),
-    # publish-version
-    prefix: str = typer.Option(
-        '/v1', "--prefix", help="(req: publish-version) URL Prefix for your snap"
-    ),
-    version: Union[str, None] = typer.Option(
-        None, "--version",
-        help="(req: publish-version) Snap version. Should start with v. Example vX.X.X"
-    ),
-    http_port: Union[str, None] = typer.Option(
-        None, "--http-port", help="(req: publish-version) Ingress HTTP port version"
-    ),
-    byosnap_profile: Union[str, None] = typer.Option(
-        None, "--byosnap-profile", help=(
-            "(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."
+            "(req: publish-image, publish-version) 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."
     ),
-    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"
-    ),
-    # sync
-    snapend_id: str = typer.Option(
-        None, "--snapend-id",
-        help=("(req: sync) Snapend Id. NOTE: Development Snapends only.")
+    docker_file: str = typer.Option(
+        "Dockerfile", help="(optional override: publish, sync) Dockerfile name to use"
     ),
-    blocking: bool = typer.Option(
-        False, "--blocking",
-        help=(
-            "(optional: sync) Set to true if you want to wait for the update to complete "
-            "before returning."
-        )
+    byosnap_profile_file: str = typer.Option(
+        "snapser-byosnap-profile.json", "--byosnap-profile-file", help="(optional override: publish, publish-version) BYOSnap Profile file name to use"
     ),
-    # overrides
     api_key: Union[str, None] = typer.Option(
-        None, "--api-key", help="API Key override.", callback=api_key_context_callback
+        None, "--api-key", help="(optional override) API Key override.", callback=api_key_context_callback
     ),
     profile: Union[str, None] = typer.Option(
-        None, "--profile", help="Profile to use.", callback=profile_context_callback
+        None, "--profile", help="(optional override) Profile to use.", callback=profile_context_callback
     ),
 ) -> None:
     """
@@ -411,16 +397,12 @@ def byosnap(
         tag=tag,
         path=path,
         resources_path=resources_path,
-        dockerfile=docker_file,
-        prefix=prefix,
+        docker_file=docker_file,
         version=version,
-        http_port=http_port,
-        byosnap_profile=byosnap_profile,
         skip_build=skip_build,
-        readiness_path=readiness_path,
-        readiness_delay=readiness_delay,
         snapend_id=snapend_id,
-        blocking=blocking
+        blocking=blocking,
+        byosnap_profile_file=byosnap_profile_file
     )
     getattr(byosnap_obj, subcommand.replace('-', '_'))()
     success(f"BYOSnap {subcommand} complete")

snapctl/utils/helper.py

@@ -71,7 +71,7 @@ def get_composite_token(base_url: str, api_key: Union[str, None], action: str, p
         else:
             error(f'Failed to validate API Key. Error: {res.text}')
         raise typer.Exit(code=SNAPCTL_CONFIGURATION_ERROR)
-    success('API Key validated')
+    success('Generate snapctl transaction token')
     return res.json()['token']
 
 

{snapctl-0.42.1.dist-info → snapctl-0.43.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.42.1
+Version: 0.43.1
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -189,14 +189,68 @@ Snapctl commands for your custom code
 
 #### 1. byosnap help
 
-See all the supported commands
+See all the supported commands. You should mainly need the `publish` and `sync` commands.
+All the others are for CRUD operations.
 
 ```
 # Help for the byosnap command
 snapctl byosnap --help
 ```
+#### 2. publish
+
+This command allows you to create and publish your BYOSnap. Running this command will first create a BYOSnap namespace on Snapser if not present. Then it will build and publish your code to your own
+private ECR repo on Snapser. Finally it will assign a version to your BYOSnap so that you
+can deploy it.
+
+**Requirements**:
+- This command needs docker.
+- 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`.
+
+```
+# Help for the byosnap command
+snapctl byosnap publish --help
+
+# Create and publish your BYOSnap
+# $byosnap_sid = Snap ID for your snap
+# $version = Semantic version for your snap Eg: v0.0.1
+# $code_root_path = Local code path where your Dockerfile is present
+# $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, snapser-byosnap-profile.json, swagger.json and README.md at the root directory of your Snap.
+# $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 tag using the --tag you pass to the publish-image command for this to work. Make sure the tag matches the version number you are passing.
+# Example:
+snapctl byosnap publish byosnap-jinks-flask --version "v0.0.1" --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap publish $byosnap_sid --version $version --path $code_root_path
+```
+
+#### 3. byosnap sync
+
+This command is for development purposes. It allows developers to rapidly build, update and push their BYOSnap to a dev Snapend. Simply, make changes to your code locally, and then run this command to deploy your BYOSnap straight to your development Snapend.
+
+**Requirements**:
+- This command needs docker.
+
+**IMPORTANT**: This command will only work for Dev Snapends. Additionally if the version you are using in this command happens to be used by a staging or a production snapend then `sync` will not work. We do this to ensure that your staging and production BYOSnap images do not get impacted.
+
+```
+# Help for the byosnap command
+snapctl byosnap sync --help
+
+# Deploy local code straight to your Snapend
+# $byosnap_sid = Snap ID for your snap
+# $code_root_path = Local code path where your Dockerfile is present
+# $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, swagger.json and README.md in the root directory of your Snap.
+# $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.
+# $tag = Semantic version for your snap Eg: v0.0.1
+# $version =
+# $snapend_id = Dev Snapend Id
+# Example:
+snapctl byosnap sync byosnap-jinks-flask --path /Users/DevName/Development/SnapserEngine/jinks_flask --version "v0.0.11" --snapend-id "jxmmfryo"
+snapctl byosnap sync $byosnap_sid --path $code_root_path --version $version --snapend-id $snapend_id
+```
 
-#### 2. byosnap create
+#### 4. byosnap create
 
 Create a custom snap. Note that you will have to build, push and publish your snap image, for it to be useable
 in a Snapend.
@@ -217,7 +271,7 @@ snapctl byosnap create --help
 snapctl byosnap create $byosnap_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
 ```
 
-#### 3. byosnap build
+#### 5. byosnap build
 
 Build your snap image
 
@@ -236,7 +290,7 @@ snapctl byosnap build $byosnap_sid --tag $image_tag --path $code_root_path
 snapctl byosnap build $byosnap_sid --tag $image_tag --path $code_root_path --resources-path $resources_path
 ```
 
-#### 4. byosnap push
+#### 6. byosnap push
 
 Push your snap image to Snapser
 
@@ -252,7 +306,7 @@ snapctl byosnap push --help
 snapctl byosnap push $byosnap_sid --tag $image_tag
 ```
 
-#### 5. byosnap upload-docs
+#### 7. byosnap upload-docs
 
 Upload swagger.json and README.md for you Snap
 
@@ -269,7 +323,7 @@ snapctl byosnap upload-docs --help
 snapctl byosnap upload-docs $byosnap_sid --tag $image_tag --resources-path $resources_path
 ```
 
-#### 6. byosnap publish-image
+#### 8. byosnap publish-image
 
 Publish a custom snap code image. This command executes, `build`, `push` and `upload-docs` one
 after the other.
@@ -295,7 +349,7 @@ snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_pa
 snapctl byosnap publish-image $byosnap_sid --tag $image_tag --skip-build
 ```
 
-#### 7. byosnap publish-version
+#### 9. byosnap publish-version
 
 Publish a new version for your Snap. Only after your Snap version is published, you will be able
 to use your snap in your Snapend. This command should be run after `push` or `publish-image` commands.
@@ -310,40 +364,11 @@ snapctl byosnap publish-version --help
 # Publish a new image
 # $byosnap_sid = Snap ID for your snap
 # $image_tag = An image tag for your snap
-# $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 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
-```
-
-#### 8. byosnap sync
-
-This command is for development purposes. It allows developers to rapidly build, update and push their
-BYOSnap to a dev Snapend. Simply, make changes to your code locally, and then run this command to deploy
-your BYOSnap straight to your development Snapend.
-
-IMPORTANT: This command will only work for Dev Snapends. Additionally if the tag you are using in this
-command happens to be used by a staging or a production snapend then `sync` will not work. We do this to
-ensure that your staging and production BYOSnap images do not get impacted.
-
-```
-# Help for the byosnap command
-snapctl byosnap sync --help
-
-# Publish a new image
-# $byosnap_sid = Snap ID for your snap
-# $code_root_path = Local code path where your Dockerfile is present
-# $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, swagger.json and README.md in the root directory of your Snap.
-# $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.
-# $image_tag = An image tag for your snap. Note snapctl adds a timestamp, allowing you to use the same command.
-# $version = Semantic version for your snap Eg: v0.0.1
-# $snapend_id = Dev Snapend Id
+# $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
 # Example:
-snapctl byosnap sync byosnap-jinks-flask --path /Users/DevName/Development/SnapserEngine/jinks_flask --tag my-first-image --version "v0.0.11" --snapend-id "jxmmfryo"
-snapctl byosnap sync $byosnap_sid --path $code_root_path --tag $image_tag --version $version --snapend-id $snapend_id
+# snapctl byosnap publish-version byosnap-jinks-flask --tag my-first-image --version v0.0.1 --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap publish-version $byosnap_sid --tag $image_tag --version $version --path $path
 ```
 
 ### BYO Game Server - Bring your own Game Server

{snapctl-0.42.1.dist-info → snapctl-0.43.1.dist-info}/RECORD

@@ -2,22 +2,22 @@ snapctl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/__main__.py,sha256=43jKoTk8b85hk_MT6499N3ruHdEfM8WBImd_-3VzjI8,116
 snapctl/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/commands/byogs.py,sha256=IE4E2Vpy6yJGtuS1M1mTdDF7wHw3pPPW6NkEeyPQt9w,18203
-snapctl/commands/byosnap.py,sha256=h9O8Tz9Fx19xcGVREw-Q5PK8bNqHmTI8EaG-7q38jpI,43354
+snapctl/commands/byosnap.py,sha256=bYuebT8dFD6tmY1jWMMOs4rodOpcXQ1RYryCAeAwJG8,48689
 snapctl/commands/game.py,sha256=nCXtEXAJkvOw26c_OBGr7Pz4hwu-5FXHyBR2kkXhLCM,5247
 snapctl/commands/generate.py,sha256=isiTl3SE1G7wqEWjdYPKDtlBR-HE2-iNdZK_pKgiKvY,8398
 snapctl/commands/snapend.py,sha256=Zq9lNp1NO5fHzlv2S4TrzBZUIxssOu4_ZEQFMO2Tfbc,34677
 snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/config/constants.py,sha256=6bmM6WBhrDEIsGQ2YTCsx2fvEDBGa9XiqWUO8LYJr64,3274
+snapctl/config/constants.py,sha256=4FIn-Yd1HSuSQHbxjYsXEMnGqnWsY3C6HF-5s-msmuE,3309
 snapctl/config/endpoints.py,sha256=9kllA79xn9G_aBLp1rohURZi93pwYzTEWZ8ObtZ6crw,338
-snapctl/config/hashes.py,sha256=V5nvBB4beDFIRjhfcPu6eoljNj4JwNKCPku5dJWfF_Q,4220
-snapctl/main.py,sha256=-Mg95GBT4fiN3j_HFUCWRYZNhlcbDun-pLYBJd2EhKI,22055
+snapctl/config/hashes.py,sha256=0Mtbv1J-RWxIkONguZbNOGuu431zElt0JHvxIes4eA4,5044
+snapctl/main.py,sha256=LgVXkCqDpmDZY9NJ0XoYq16-uV5-NKhu8x2wZ_Vqe_8,21450
 snapctl/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/types/definitions.py,sha256=EQzLeiXkJ8ISRlCqHMviNVsWWpmhWjpKaOBLdlvOTmY,644
 snapctl/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 snapctl/utils/echo.py,sha256=V0qgjqqGXRiueMkq31enmNmdqciC8S90qGRcK8UupXA,1090
-snapctl/utils/helper.py,sha256=xUOpAoMyIObhdI-9APcXwaQdZJgHSLv-g4QqwkTjR7Y,5402
-snapctl-0.42.1.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
-snapctl-0.42.1.dist-info/METADATA,sha256=zH9dFNeatVAxP_2QWesHegBftcsLMLbDPxc7721HsM4,27276
-snapctl-0.42.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-snapctl-0.42.1.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-0.42.1.dist-info/RECORD,,
+snapctl/utils/helper.py,sha256=8HrLqX9RINJdadR7YI8epOXIfXOBDusXqvoR0kq6zok,5419
+snapctl-0.43.1.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
+snapctl-0.43.1.dist-info/METADATA,sha256=bWrjuKrzXIFomh8PVkEFg9bBaboQnCz3CBWlbY7dYpc,28838
+snapctl-0.43.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+snapctl-0.43.1.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-0.43.1.dist-info/RECORD,,