snapctl 0.22.0__py3-none-any.whl → 0.22.1__py3-none-any.whl

snapctl/commands/byosnap.py

@@ -14,7 +14,8 @@ from requests.exceptions import RequestException
 
 from rich.progress import Progress, SpinnerColumn, TextColumn
 from snapctl.config.constants import SERVER_CALL_TIMEOUT
-from snapctl.config.constants import ERROR_SERVICE_VERSION_EXISTS, ERROR_TAG_NOT_AVAILABLE, ERROR_ADD_ON_NOT_ENABLED
+from snapctl.config.constants import ERROR_SERVICE_VERSION_EXISTS, ERROR_TAG_NOT_AVAILABLE, \
+    ERROR_ADD_ON_NOT_ENABLED
 from snapctl.types.definitions import ResponseType
 from snapctl.utils.echo import error, success, info
 from snapctl.utils.helper import get_composite_token
@@ -25,14 +26,19 @@ class ByoSnap:
       CLI commands exposed for a BYOSnap
     """
     ID_PREFIX = 'byosnap-'
-    SUBCOMMANDS = ['create', 'publish-image', 'publish-version', 'upload-docs']
+    SUBCOMMANDS = [
+        'build', 'push', 'upload-docs',
+        'create', 'publish-image', 'publish-version',
+    ]
     PLATFORMS = ['linux/arm64', 'linux/amd64']
     LANGUAGES = ['go', 'python', 'ruby', 'c#', 'c++', 'rust', 'java', 'node']
     DEFAULT_BUILD_PLATFORM = 'linux/arm64'
+    SID_CHARACTER_LIMIT = 47
+    TAG_CHARACTER_LIMIT = 80
 
     def __init__(
-        self, subcommand: str, base_url: str, api_key: str, sid: str, name: str,
-        desc: str, platform_type: str, language: str, tag: Union[str, None],
+        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]
     ) -> None:
@@ -45,21 +51,24 @@ class ByoSnap:
         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})
+            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_parts: Union[list, None] = ByoSnap._get_token_values(
             self.token) if self.token is not None else None
-        self.tag: Union[str, None] = tag
+        self.input_tag: Union[str, None] = input_tag
         self.path: Union[str, None] = path
         self.dockerfile: str = dockerfile
         self.prefix: str = prefix
         self.version: Union[str, None] = version
         self.http_port: Union[int, None] = http_port
 
+    # Protected methods
     @staticmethod
-    def get_token_values(token: str) -> None | list:
+    def _get_token_values(token: str) -> None | list:
         """
           Method to break open the token
         """
@@ -80,152 +89,10 @@ class ByoSnap:
             pass
         return None
 
-    def validate_input(self) -> ResponseType:
+    def _check_dependencies(self) -> bool:
         """
-          Validator
+          Check application dependencies
         """
-        response: ResponseType = {
-            'error': True,
-            'msg': '',
-            'data': []
-        }
-        # Check subcommand
-        if not self.subcommand in ByoSnap.SUBCOMMANDS:
-            response['msg'] = (
-                "Invalid command. Valid commands ",
-                f"are {', '.join(ByoSnap.SUBCOMMANDS)}."
-            )
-            return response
-        # Validate the SID
-        if not self.sid.startswith(ByoSnap.ID_PREFIX):
-            response['msg'] = f"Invalid Snap ID. Valid Snap IDs start with {ByoSnap.ID_PREFIX}."
-            return response
-        # Validation for subcommands
-        if self.subcommand == 'create':
-            if self.name == '':
-                response['msg'] = "Missing name"
-                return response
-            if self.language not in ByoSnap.LANGUAGES:
-                response['msg'] = (
-                    "Invalid language. Valid languages are "
-                    f"{', '.join(ByoSnap.LANGUAGES)}."
-                )
-                return response
-            if self.platform_type not in ByoSnap.PLATFORMS:
-                response['msg'] = (
-                    "Invalid platform. Valid platforms are "
-                    f"{', '.join(ByoSnap.PLATFORMS)}."
-                )
-                return response
-        else:
-            # Check the token
-            if self.token_parts is None:
-                response['msg'] = 'Invalid token. Please reach out to your support team.'
-                return response
-            # Check tag
-            if self.tag is None or len(self.tag.split()) > 1 or len(self.tag) > 25:
-                response['msg'] = "Tag should be a single word with maximum of 25 characters"
-                return response
-            if self.subcommand == 'publish-image':
-                if not self.path:
-                    response['msg'] = "Missing required parameter: path"
-                    return response
-                # Check path
-                if not os.path.isfile(f"{self.path}/{self.dockerfile}"):
-                    response['msg'] = f"Unable to find {self.dockerfile} at path {self.path}"
-                    return response
-            elif self.subcommand == 'upload-docs':
-                if self.path is None:
-                    response['msg'] = "Missing required parameter: path"
-                    return response
-            elif self.subcommand == 'publish-version':
-                if not self.prefix:
-                    response['msg'] = "Missing prefix"
-                    return response
-                if not self.version:
-                    response['msg'] = "Missing version"
-                    return response
-                if not self.http_port:
-                    response['msg'] = "Missing Ingress HTTP Port"
-                    return response
-                if not self.prefix.startswith('/'):
-                    response['msg'] = "Prefix should start with a forward slash (/)"
-                    return response
-                if self.prefix.endswith('/'):
-                    response['msg'] = "Prefix should not end with a forward slash (/)"
-                    return response
-                pattern = r'^v\d+\.\d+\.\d+$'
-                if not re.match(pattern, self.version):
-                    response['msg'] = "Version should be in the format vX.X.X"
-                    return response
-                if not self.http_port.isdigit():
-                    response['msg'] = "Ingress HTTP Port should be a number"
-                    return response
-        # Send success
-        response['error'] = False
-        return response
-
-    def create(self) -> bool:
-        """
-          Creating a new snap
-        """
-        with Progress(
-            SpinnerColumn(),
-            TextColumn("[progress.description]{task.description}"),
-            transient=True,
-        ) as progress:
-            progress.add_task(description='Creating your snap...', total=None)
-            try:
-                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:
-                    return True
-                response_json = res.json()
-                info(response_json)
-                if "api_error_code" in response_json and "message" in response_json:
-                    if response_json['api_error_code'] == ERROR_SERVICE_VERSION_EXISTS:
-                        error(
-                            'Version already exists. Please update your version and try again'
-                        )
-                    elif response_json['api_error_code'] == ERROR_TAG_NOT_AVAILABLE:
-                        error('Invalid tag. Please use the correct tag')
-                    elif response_json['api_error_code'] == ERROR_ADD_ON_NOT_ENABLED:
-                        error(
-                            'Missing Add-on. Please enable the add-on via the Snapser Web app.'
-                        )
-                    else:
-                        error(f'Server error: {response_json["message"]}')
-                else:
-                    error(
-                        f'Server error: {json.dumps(response_json, indent=2)}'
-                    )
-            except RequestException as e:
-                error(f"Exception: Unable to create your snap {e}")
-            return False
-
-    def build(self) -> bool:
-        """
-          Build the Snap image
-        """
-        # Get the data
-        ecr_repo_url = self.token_parts[0]
-        ecr_repo_username = self.token_parts[1]
-        ecr_repo_token = self.token_parts[2]
-        image_tag = f'{self.sid}.{self.tag}'
-        full_ecr_repo_url = f'{ecr_repo_url}:{image_tag}'
-        build_platform = ByoSnap.DEFAULT_BUILD_PLATFORM
-        if len(self.token_parts) == 4:
-            build_platform = self.token_parts[3]
         try:
             # Check dependencies
             with Progress(
@@ -243,7 +110,19 @@ class ByoSnap:
                     error('Docker not present')
                     return False
             success('Dependencies Verified')
+            return True
+        except subprocess.CalledProcessError:
+            error('Unable to initialize docker')
+            return False
 
+    def _docker_login(self) -> bool:
+        """
+          Docker Login
+        """
+        ecr_repo_url = self.token_parts[0]
+        ecr_repo_username = self.token_parts[1]
+        ecr_repo_token = self.token_parts[2]
+        try:
             # Login to Snapser Registry
             with Progress(
                 SpinnerColumn(),
@@ -270,7 +149,18 @@ class ByoSnap:
                     )
                     return False
             success('Login Successful')
+            return True
+        except subprocess.CalledProcessError:
+            error('Unable to initialize docker')
+            return False
 
+    def _docker_build(self) -> bool:
+        # Get the data
+        image_tag = f'{self.sid}.{self.input_tag}'
+        build_platform = ByoSnap.DEFAULT_BUILD_PLATFORM
+        if len(self.token_parts) == 4:
+            build_platform = self.token_parts[3]
+        try:
             # Build your snap
             with Progress(
                 SpinnerColumn(),
@@ -295,7 +185,17 @@ class ByoSnap:
                     error('Unable to build docker')
                     return False
             success('Build Successful')
+            return True
+        except subprocess.CalledProcessError:
+            error('CLI Error')
+            return False
 
+    def _docker_tag(self) -> bool:
+        # Get the data
+        ecr_repo_url = self.token_parts[0]
+        image_tag = f'{self.sid}.{self.input_tag}'
+        full_ecr_repo_url = f'{ecr_repo_url}:{image_tag}'
+        try:
             # Tag the repo
             with Progress(
                 SpinnerColumn(),
@@ -316,18 +216,17 @@ class ByoSnap:
                     error('Unable to tag your snap')
                     return False
             success('Tag Successful')
-
             return True
         except subprocess.CalledProcessError:
             error('CLI Error')
             return False
 
-    def push(self) -> bool:
+    def _docker_push(self) -> bool:
         """
           Push the Snap image
         """
         ecr_repo_url = self.token_parts[0]
-        image_tag = f'{self.sid}.{self.tag}'
+        image_tag = f'{self.sid}.{self.input_tag}'
         full_ecr_repo_url = f'{ecr_repo_url}:{image_tag}'
 
         # Push the image
@@ -353,6 +252,141 @@ class ByoSnap:
         success('Snap Upload Successful')
         return True
 
+    # Public methods
+
+    # Validator
+    def validate_input(self) -> ResponseType:
+        """
+          Validator
+        """
+        response: ResponseType = {
+            'error': True,
+            'msg': '',
+            'data': []
+        }
+        # Check API Key and Base URL
+        if not self.api_key or self.base_url == '':
+            response['msg'] = "Missing API Key."
+            return response
+        # Check subcommand
+        if not self.subcommand in ByoSnap.SUBCOMMANDS:
+            response['msg'] = (
+                "Invalid command. Valid commands ",
+                f"are {', '.join(ByoSnap.SUBCOMMANDS)}."
+            )
+            return response
+        # Validate the SID
+        if not self.sid.startswith(ByoSnap.ID_PREFIX):
+            response['msg'] = f"Invalid Snap ID. Valid Snap IDs start with {ByoSnap.ID_PREFIX}."
+            return response
+        if len(self.sid) > ByoSnap.SID_CHARACTER_LIMIT:
+            response['msg'] = (
+                "Invalid Snap ID. "
+                f"Snap ID should be less than {ByoSnap.SID_CHARACTER_LIMIT} characters"
+            )
+            return response
+        # Validation for subcommands
+        if self.subcommand == 'create':
+            if self.name == '':
+                response['msg'] = "Missing name"
+                return response
+            if self.language not in ByoSnap.LANGUAGES:
+                response['msg'] = (
+                    "Invalid language. Valid languages are "
+                    f"{', '.join(ByoSnap.LANGUAGES)}."
+                )
+                return response
+            if self.platform_type not in ByoSnap.PLATFORMS:
+                response['msg'] = (
+                    "Invalid platform. Valid platforms are "
+                    f"{', '.join(ByoSnap.PLATFORMS)}."
+                )
+                return response
+        else:
+            # Check the token
+            if self.token_parts is None:
+                response['msg'] = 'Invalid token. Please reach out to your support team.'
+                return response
+            # Check tag
+            if self.input_tag is None or len(self.input_tag.split()) > 1 or \
+                    len(self.input_tag) > ByoSnap.TAG_CHARACTER_LIMIT:
+                response['msg'] = (
+                    "Tag should be a single word with maximum of "
+                    f"{ByoSnap.TAG_CHARACTER_LIMIT} characters"
+                )
+                return response
+            if self.subcommand == 'build' or self.subcommand == 'publish-image':
+                if not self.input_tag:
+                    response['msg'] = "Missing required parameter: tag"
+                    return response
+                if not self.path:
+                    response['msg'] = "Missing required parameter: path"
+                    return response
+                # Check path
+                if not os.path.isfile(f"{self.path}/{self.dockerfile}"):
+                    response['msg'] = f"Unable to find {self.dockerfile} at path {self.path}"
+                    return response
+            elif self.subcommand == 'push':
+                if not self.input_tag:
+                    response['msg'] = "Missing required parameter: tag"
+                    return response
+            elif self.subcommand == 'upload-docs':
+                if self.path is None:
+                    response['msg'] = "Missing required parameter: path"
+                    return response
+            elif self.subcommand == 'publish-version':
+                if not self.prefix:
+                    response['msg'] = "Missing prefix"
+                    return response
+                if not self.version:
+                    response['msg'] = "Missing version"
+                    return response
+                if not self.http_port:
+                    response['msg'] = "Missing Ingress HTTP Port"
+                    return response
+                if not self.prefix.startswith('/'):
+                    response['msg'] = "Prefix should start with a forward slash (/)"
+                    return response
+                if self.prefix.endswith('/'):
+                    response['msg'] = "Prefix should not end with a forward slash (/)"
+                    return response
+                pattern = r'^v\d+\.\d+\.\d+$'
+                if not re.match(pattern, self.version):
+                    response['msg'] = "Version should be in the format vX.X.X"
+                    return response
+                if not self.http_port.isdigit():
+                    response['msg'] = "Ingress HTTP Port should be a number"
+                    return response
+        # Send success
+        response['error'] = False
+        return response
+
+    # CRUD methods
+    def build(self) -> bool:
+        """
+          Build the image
+          1. Check Dependencies
+          2. Login to Snapser Registry
+          3. Build your snap
+        """
+        if not self._check_dependencies() or not self._docker_login() or \
+                not self._docker_build():
+            return False
+        return True
+
+    def push(self) -> bool:
+        """
+          Tag the image
+          1. Check Dependencies
+          2. Login to Snapser Registry
+          3. Tag the snap
+          4. Push your snap
+        """
+        if not self._check_dependencies() or not self._docker_login() or \
+                not self._docker_tag() or not self._docker_push():
+            return False
+        return True
+
     def upload_docs(self) -> bool:
         '''
           Note this step is optional hence we always respond with a True
@@ -372,7 +406,7 @@ class ByoSnap:
                     attachment_file = open(swagger_file, "rb")
                     url = (
                         f"{self.base_url}/v1/snapser-api/byosnaps/"
-                        f"{self.sid}/docs/{self.tag}/openapispec"
+                        f"{self.sid}/docs/{self.input_tag}/openapispec"
                     )
                     test_res = requests.post(
                         url, files={"attachment": attachment_file},
@@ -405,7 +439,7 @@ class ByoSnap:
                     attachment_file = open(readme_file, "rb")
                     url = (
                         f"{self.base_url}/v1/snapser-api/byosnaps/"
-                        f"{self.sid}/docs/{self.tag}/markdown"
+                        f"{self.sid}/docs/{self.input_tag}/markdown"
                     )
                     test_res = requests.post(
                         url, files={"attachment": attachment_file},
@@ -426,11 +460,68 @@ class ByoSnap:
             )
         return True
 
+    # Upper echelon commands
+    def create(self) -> bool:
+        """
+          Creating a new snap
+        """
+        with Progress(
+            SpinnerColumn(),
+            TextColumn("[progress.description]{task.description}"),
+            transient=True,
+        ) as progress:
+            progress.add_task(description='Creating your snap...', total=None)
+            try:
+                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:
+                    return True
+                response_json = res.json()
+                info(response_json)
+                if "api_error_code" in response_json and "message" in response_json:
+                    if response_json['api_error_code'] == ERROR_SERVICE_VERSION_EXISTS:
+                        error(
+                            'Version already exists. Please update your version and try again'
+                        )
+                    elif response_json['api_error_code'] == ERROR_TAG_NOT_AVAILABLE:
+                        error('Invalid tag. Please use the correct tag')
+                    elif response_json['api_error_code'] == ERROR_ADD_ON_NOT_ENABLED:
+                        error(
+                            'Missing Add-on. Please enable the add-on via the Snapser Web app.'
+                        )
+                    else:
+                        error(f'Server error: {response_json["message"]}')
+                else:
+                    error(
+                        f'Server error: {json.dumps(response_json, indent=2)}'
+                    )
+            except RequestException as e:
+                error(f"Exception: Unable to create your snap {e}")
+            return False
+
     def publish_image(self) -> bool:
         """
           Publish the image
+          1. Check Dependencies
+          2. Login to Snapser Registry
+          3. Build your snap
+          4. Tag the repo
+          5. Push the image
+          6. Upload swagger.json
         """
-        if not self.build() or not self.push() or not self.upload_docs():
+        if not self._check_dependencies() or not self._docker_login() or \
+            not self._docker_build() or not self._docker_tag() or not self._docker_push() or \
+                not self.upload_docs():
             return False
         return True
 
@@ -448,7 +539,7 @@ class ByoSnap:
             try:
                 payload = {
                     "version": self.version,
-                    "image_tag": self.tag,
+                    "image_tag": self.input_tag,
                     "base_url": f"{self.prefix}/{self.sid}",
                     "http_port": self.http_port,
                 }

snapctl/commands/snapend.py

@@ -30,7 +30,7 @@ class Snapend:
     MAX_BLOCKING_RETRIES = 24
 
     def __init__(
-        self, subcommand: str, base_url: str, api_key: str, snapend_id: str, category: str,
+        self, subcommand: str, base_url: str, api_key: str | None, snapend_id: str, category: str,
         platform_type: str, auth_type: str,  path: Union[str, None], snaps: Union[str, None],
         byosnaps: Union[str, None], byogs: Union[str, None], blocking: bool = False
     ) -> None:
@@ -131,6 +131,10 @@ class Snapend:
             'msg': '',
             'data': []
         }
+        # Check API Key and Base URL
+        if not self.api_key or self.base_url == '':
+            response['msg'] = "Missing API Key."
+            return response
         # Check subcommand
         if not self.subcommand in Snapend.SUBCOMMANDS:
             response['msg'] = \

snapctl/config/constants.py

@@ -1,7 +1,7 @@
 """
 Constants used by snapctl
 """
-VERSION = '0.22.0'
+VERSION = '0.22.1'
 CONFIG_FILE_MAC = '~/.snapser/config'
 CONFIG_FILE_WIN = '%homepath%\.snapser\config'
 DEFAULT_PROFILE = 'default'