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

snapctl/commands/byogs.py

@@ -25,14 +25,19 @@ class ByoGs:
         BYOGS CLI commands
     """
     ID_PREFIX = 'byogs-'
-    SUBCOMMANDS = ['create', 'publish-image', 'publish-version']
+    SUBCOMMANDS = [
+        'build', 'push',
+        'create', 'publish-image', 'publish-version',
+    ]
     PLATFORMS = ['linux/amd64']
     LANGUAGES = ['go', 'python', 'ruby', 'c#', 'c++', 'rust', 'java', 'node']
     DEFAULT_BUILD_PLATFORM = 'linux/amd64'
+    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], path: 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, version: Union[str, None], http_port: Union[int, None],
         debug_port: Union[int, None]
     ) -> None:
@@ -49,17 +54,19 @@ class ByoGs:
                 base_url, api_key, 'byogs', {'service_id': sid})
         else:
             self.token: Union[str, None] = None
-        self.token_parts: Union[list, None] = ByoGs.get_token_values(
+        self.token_parts: Union[list, None] = ByoGs._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.version: Union[str, None] = version
         self.http_port: Union[int, None] = http_port
         self.debug_port: Union[int, None] = debug_port
 
+    # Protected methods
+
     @staticmethod
-    def get_token_values(token: str) -> None | list:
+    def _get_token_values(token: str) -> None | list:
         """
             Get the token values
         """
@@ -80,6 +87,168 @@ class ByoGs:
             pass
         return None
 
+    def _check_dependencies(self) -> bool:
+        try:
+            # Check dependencies
+            with Progress(
+                SpinnerColumn(),
+                TextColumn("[progress.description]{task.description}"),
+                transient=True,
+            ) as progress:
+                progress.add_task(
+                    description='Checking dependencies...', total=None)
+                try:
+                    subprocess.run([
+                        "docker", "--version"
+                    ], stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
+                except subprocess.CalledProcessError:
+                    error('Docker not present')
+                    return False
+            success('Dependencies Verified')
+            return True
+        except subprocess.CalledProcessError:
+            error('CLI Error')
+            return False
+
+    def _docker_login(self) -> bool:
+        # Get the data
+        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(),
+                TextColumn("[progress.description]{task.description}"),
+                transient=True,
+            ) as progress:
+                progress.add_task(
+                    description='Logging into Snapser Image Registry...', total=None)
+                if platform == 'win32':
+                    response = subprocess.run([
+                        'docker', 'login', '--username', ecr_repo_username,
+                        '--password', ecr_repo_token, ecr_repo_url
+                    ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
+                else:
+                    response = subprocess.run([
+                        f'echo "{ecr_repo_token}" | docker login '
+                        f'--username {ecr_repo_username} --password-stdin {ecr_repo_url}'
+                    ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
+                if response.returncode:
+                    error(
+                        'Unable to connect to the Snapser Container Repository. '
+                        'Please confirm if docker is running or try restarting docker'
+                    )
+                    return False
+            success('Login Successful')
+            return True
+        except subprocess.CalledProcessError:
+            error('CLI Error')
+            return False
+
+    def _docker_build(self) -> bool:
+        # Get the data
+        image_tag = f'{self.sid}.{self.input_tag}'
+        build_platform = ByoGs.DEFAULT_BUILD_PLATFORM
+        if len(self.token_parts) == 4:
+            build_platform = self.token_parts[3]
+        try:
+            # Build your snap
+            with Progress(
+                SpinnerColumn(),
+                TextColumn("[progress.description]{task.description}"),
+                transient=True,
+            ) as progress:
+                progress.add_task(
+                    description='Building your snap...', total=None)
+                if platform == "win32":
+                    response = subprocess.run([
+                        # f"docker build --no-cache -t {tag} {path}"
+                        'docker', 'build', '--platform', build_platform, '-t', image_tag, self.path
+                    ], shell=True, check=False)
+                    # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+                else:
+                    response = subprocess.run([
+                        # f"docker build --no-cache -t {tag} {path}"
+                        f"docker build --platform {build_platform} -t {image_tag} {self.path}"
+                    ], shell=True, check=False)
+                    # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+                if response.returncode:
+                    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(),
+                TextColumn("[progress.description]{task.description}"),
+                transient=True,
+            ) as progress:
+                progress.add_task(
+                    description='Tagging your snap...', total=None)
+                if platform == "win32":
+                    response = subprocess.run([
+                        'docker', 'tag', image_tag, full_ecr_repo_url
+                    ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
+                else:
+                    response = subprocess.run([
+                        f"docker tag {image_tag} {full_ecr_repo_url}"
+                    ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
+                if response.returncode:
+                    error('Unable to tag your snap')
+                    return False
+            success('Tag Successful')
+            return True
+        except subprocess.CalledProcessError:
+            error('CLI Error')
+            return False
+
+    def _docker_push(self) -> bool:
+        try:
+            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}'
+
+            # Push the image
+            with Progress(
+                SpinnerColumn(),
+                TextColumn("[progress.description]{task.description}"),
+                transient=True,
+            ) as progress:
+                progress.add_task(
+                    description='Pushing your snap...', total=None)
+                if platform == "win32":
+                    response = subprocess.run([
+                        'docker', 'push', full_ecr_repo_url
+                    ], shell=True, check=False)
+                    # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+                else:
+                    response = subprocess.run([
+                        f"docker push {full_ecr_repo_url}"
+                    ], shell=True, check=False)
+                    # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+                if response.returncode:
+                    error('Unable to push your snap')
+                    return False
+            success('Snap Upload Successful')
+            return True
+        except subprocess.CalledProcessError:
+            error('CLI Error')
+            return False
+
+    # Public methods
+
+    # Validator
     def validate_input(self) -> ResponseType:
         """
           Validator
@@ -89,6 +258,10 @@ class ByoGs:
             '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 ByoGs.SUBCOMMANDS:
             response['msg'] = f"Invalid command. Valid commands are {', '.join(ByoGs.SUBCOMMANDS)}."
@@ -100,6 +273,12 @@ class ByoGs:
                 f"with {ByoGs.ID_PREFIX}."
             )
             return response
+        if len(self.sid) > ByoGs.SID_CHARACTER_LIMIT:
+            response['msg'] = (
+                "Invalid Game Server ID. "
+                f"Game Server ID should be less than {ByoGs.SID_CHARACTER_LIMIT} characters"
+            )
+            return response
         # Validation for subcommands
         if self.subcommand == 'create':
             if self.name == '':
@@ -122,23 +301,34 @@ class ByoGs:
                 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"
+            if self.input_tag is None or len(self.input_tag.split()) > 1 or \
+                    len(self.input_tag) > ByoGs.TAG_CHARACTER_LIMIT:
+                response['msg'] = (
+                    "Tag should be a single word with maximum of "
+                    f"{ByoGs.TAG_CHARACTER_LIMIT} characters"
+                )
                 return response
-            if self.subcommand == 'publish-image':
+            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 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 == 'publish-version':
                 if not self.version:
-                    response['msg'] = "Missing version"
+                    response['msg'] = "Missing required parameter:  version"
                     return response
                 if not self.http_port:
-                    response['msg'] = "Missing Ingress HTTP Port"
+                    response['msg'] = "Missing required parameter:  Ingress HTTP Port"
                     return response
                 pattern = r'^v\d+\.\d+\.\d+$'
                 if not re.match(pattern, self.version):
@@ -154,6 +344,33 @@ class ByoGs:
         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
+
+    # Upper echelon commands
     def create(self) -> bool:
         """
             Create a new game server
@@ -196,191 +413,18 @@ class ByoGs:
                 error(f"Exception: Unable to create your game server {e}")
             return False
 
-    def build(self) -> bool:
-        """
-            Build your game server 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 = ByoGs.DEFAULT_BUILD_PLATFORM
-        if len(self.token_parts) == 4:
-            build_platform = self.token_parts[3]
-        try:
-            # Check dependencies
-            with Progress(
-                SpinnerColumn(),
-                TextColumn("[progress.description]{task.description}"),
-                transient=True,
-            ) as progress:
-                progress.add_task(
-                    description='Checking dependencies...', total=None)
-                try:
-                    subprocess.run([
-                        "docker", "--version"
-                    ], stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
-                except subprocess.CalledProcessError:
-                    error('Docker not present')
-                    return False
-            success('Dependencies Verified')
-
-            # Login to Snapser Registry
-            with Progress(
-                SpinnerColumn(),
-                TextColumn("[progress.description]{task.description}"),
-                transient=True,
-            ) as progress:
-                progress.add_task(
-                    description='Logging into Snapser Image Registry...', total=None)
-                if platform == 'win32':
-                    response = subprocess.run([
-                        'docker', 'login', '--username', ecr_repo_username,
-                        '--password', ecr_repo_token, ecr_repo_url
-                    ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
-                else:
-                    response = subprocess.run([
-                        f'echo "{ecr_repo_token}" | docker login '
-                        f'--username {ecr_repo_username} --password-stdin {ecr_repo_url}'
-                    ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
-                if response.returncode:
-                    error(
-                        'Unable to connect to the Snapser Container Repository. '
-                        'Please confirm if docker is running or try restarting docker'
-                    )
-                    return False
-            success('Login Successful')
-
-            # Build your snap
-            with Progress(
-                SpinnerColumn(),
-                TextColumn("[progress.description]{task.description}"),
-                transient=True,
-            ) as progress:
-                progress.add_task(
-                    description='Building your snap...', total=None)
-                if platform == "win32":
-                    response = subprocess.run([
-                        # f"docker build --no-cache -t {tag} {path}"
-                        'docker', 'build', '--platform', build_platform, '-t', image_tag, self.path
-                    ], shell=True, check=False)
-                    # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
-                else:
-                    response = subprocess.run([
-                        # f"docker build --no-cache -t {tag} {path}"
-                        f"docker build --platform {build_platform} -t {image_tag} {self.path}"
-                    ], shell=True, check=False)
-                    # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
-                if response.returncode:
-                    error('Unable to build docker')
-                    return False
-            success('Build Successful')
-
-            # Tag the repo
-            with Progress(
-                SpinnerColumn(),
-                TextColumn("[progress.description]{task.description}"),
-                transient=True,
-            ) as progress:
-                progress.add_task(
-                    description='Tagging your snap...', total=None)
-                if platform == "win32":
-                    response = subprocess.run([
-                        'docker', 'tag', image_tag, full_ecr_repo_url
-                    ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
-                else:
-                    response = subprocess.run([
-                        f"docker tag {image_tag} {full_ecr_repo_url}"
-                    ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT, check=False)
-                if response.returncode:
-                    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:
-        """
-            Push your game server image
-        """
-        ecr_repo_url = self.token_parts[0]
-        image_tag = f'{self.sid}.{self.tag}'
-        full_ecr_repo_url = f'{ecr_repo_url}:{image_tag}'
-
-        # Push the image
-        with Progress(
-            SpinnerColumn(),
-            TextColumn("[progress.description]{task.description}"),
-            transient=True,
-        ) as progress:
-            progress.add_task(description='Pushing your snap...', total=None)
-            if platform == "win32":
-                response = subprocess.run([
-                    'docker', 'push', full_ecr_repo_url
-                ], shell=True, check=False)
-                # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
-            else:
-                response = subprocess.run([
-                    f"docker push {full_ecr_repo_url}"
-                ], shell=True, check=False)
-                # stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
-            if response.returncode:
-                error('Unable to push your snap')
-                return False
-        success('Snap Upload Successful')
-        return True
-
-    # def upload_docs(self) -> bool:
-    #   '''
-    #     Note this step is optional hence we always respond with a True
-    #   '''
-    #   # Push the swagger.json
-    #   with Progress(
-    #     SpinnerColumn(),
-    #     TextColumn("[progress.description]{task.description}"),
-    #     transient=True,
-    #   ) as progress:
-    #     progress.add_task(description=f'Uploading your API Json...', total=None)
-    #     try:
-    #       attachment_file = open(f"{self.path}/swagger.json", "rb")
-    #       test_res = requests.post(f"{self.base_url}/v1/snapser-api/byogs/{self.sid}/upload/{self.tag}/openapispec", files = {"attachment": attachment_file}, headers={'api-key': self.api_key})
-    #       if test_res.ok:
-    #         success('Uploaded Swagger.json')
-    #       else:
-    #         response_json = test_res.json()
-    #         error(response_json['details'][0])
-    #     except Exception as e:
-    #       info('Unable to find swagger.json at ' + self.path + str(e))
-
-    #   # Push the README.md
-    #   with Progress(
-    #     SpinnerColumn(),
-    #     TextColumn("[progress.description]{task.description}"),
-    #     transient=True,
-    #   ) as progress:
-    #     progress.add_task(description=f'Uploading your README...', total=None)
-    #     try:
-    #       attachment_file = open(f"{self.path}/README.md", "rb")
-    #       test_res = requests.post(f"{self.base_url}/v1/snapser-api/byogs/{self.sid}/upload/{self.tag}/markdown", files = {"attachment": attachment_file}, headers={'api-key': self.api_key})
-    #       if test_res.ok:
-    #         success('Uploaded README.md')
-    #       else:
-    #         error('Unable to upload your README.md')
-    #     except Exception as e:
-    #       info('Unable to find README.md at ' + self.path + str(e))
-    #   return True
-
     def publish_image(self) -> bool:
         """
-            Publish your game server image
+          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.build() or not self.push():
+        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():
             return False
         return True
 
@@ -398,7 +442,7 @@ class ByoGs:
             try:
                 payload = {
                     "version": self.version,
-                    "image_tag": self.tag,
+                    "image_tag": self.input_tag,
                     "http_port": self.http_port,
                 }
                 if self.debug_port: