snapctl 0.1.1__tar.gz → 0.2.0__tar.gz

{snapctl-0.1.1 → snapctl-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.1.1
+Version: 0.2.0
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -8,9 +8,15 @@ Requires-Python: >=3.10,<4.0
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: requests (>=2.28.2,<3.0.0)
 Requires-Dist: typer[all] (>=0.7.0,<0.8.0)
 Description-Content-Type: text/markdown
 
 # Snapser CLI Tool
 Snapser CLI Tool
 
+## Commands
+Run the following to see the list of commands Snapser supports
+```bash
+snapctl --help
+```

snapctl-0.2.0/README.md

@@ -0,0 +1,8 @@
+# Snapser CLI Tool
+Snapser CLI Tool
+
+## Commands
+Run the following to see the list of commands Snapser supports
+```bash
+snapctl --help
+```

{snapctl-0.1.1 → snapctl-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "snapctl"
-version = "0.1.1"
+version = "0.2.0"
 description = "Snapser CLI Tool"
 authors = ["Ajinkya Apte <aj@snapser.com>"]
 readme = "README.md"
@@ -12,6 +12,7 @@ snapctl = "snapctl.main:app"
 [tool.poetry.dependencies]
 python = "^3.10"
 typer = {extras = ["all"], version = "^0.7.0"}
+requests = "^2.28.2"
 
 
 [build-system]

snapctl-0.2.0/snapctl/commands/byosnap.py

@@ -0,0 +1,216 @@
+import base64
+import os
+import requests
+from rich.progress import Progress, SpinnerColumn, TextColumn
+import subprocess
+
+from snapctl.types.definitions import ResponseType
+from snapctl.utils.echo import error, success, info
+
+class ByoSnap:
+  COMMANDS = ['build', 'push', 'upload-docs', 'publish']
+
+  def __init__(self, command: str, path: str, tag: str, token: str, dockerfile: str = 'Dockerfile') -> None:
+    self.command: str = command
+    self.path: str = path
+    self.tag: str = tag
+    self.token: str = token
+    self.token_parts: list = ByoSnap.get_token_values(token)
+    self.dockerfile = dockerfile
+
+  @staticmethod
+  def get_token_values(token: str) -> None | list:
+    try:
+      input_token = base64.b64decode(token).decode('ascii')
+      token_parts = input_token.split('|')
+      # url|web_app_token|service_id|ecr_repo_url|ecr_repo_username|ecr_repo_token
+      # url = self.token_parts[0]
+      # web_app_token = self.token_parts[1]
+      # service_id = self.token_parts[2]
+      # ecr_repo_url = self.token_parts[3]
+      # ecr_repo_username = self.token_parts[4]
+      # ecr_repo_token = self.token_parts[5]
+      if len(token_parts) == 6:
+        return token_parts
+    except Exception:
+      pass
+    return None
+
+  def validate_input(self) -> ResponseType:
+    response: ResponseType = {
+      'error': True,
+      'msg': '',
+      'data': []
+    }
+    # Check command
+    if not self.command in ByoSnap.COMMANDS:
+      response['msg'] = f"Invalid command. Valid commands are {', '.join(ByoSnap.COMMANDS['byosnap'])}."
+      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
+    # Check tag
+    if len(self.tag.split()) > 1 or len(self.tag) > 25:
+      response['msg'] = f"Tag should be a single word with maximum of 25 characters"
+      return response
+    # Check the token
+    if self.token_parts is None:
+      response['msg'] = 'Invalid token. Please reach out to your support team.'
+      return response
+    # Send success
+    response['error'] = False
+    return response
+
+  def build(self) -> bool:
+    # Get the data
+    # url = self.token_parts[0]
+    # web_app_token = self.token_parts[1]
+    service_id = self.token_parts[2]
+    ecr_repo_url = self.token_parts[3]
+    ecr_repo_username = self.token_parts[4]
+    ecr_repo_token = self.token_parts[5]
+    try:
+      # Check dependencies
+      with Progress(
+        SpinnerColumn(),
+        TextColumn("[progress.description]{task.description}"),
+        transient=True,
+      ) as progress:
+        progress.add_task(description=f'Checking dependencies...', total=None)
+        try:
+          subprocess.run([
+            "docker", "--version"
+          ], stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+        except:
+          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=f'Logging into Snapser Image Registry...', total=None)
+        response = subprocess.run([
+          f'echo "{ecr_repo_token}" | docker login --username {ecr_repo_username} --password-stdin {ecr_repo_url}'
+        ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+        if response.returncode:
+          error('Unable to connect to the Snapser Container Repository. Please get the latest token from the Web app.')
+          return False
+      success('Login Successful')
+
+      # Build your snap
+      with Progress(
+        SpinnerColumn(),
+        TextColumn("[progress.description]{task.description}"),
+        transient=True,
+      ) as progress:
+        progress.add_task(description=f'Building your snap...', total=None)
+        response = subprocess.run([
+          #f"docker build --no-cache -t {tag} {path}"
+          f"docker build --platform linux/arm64 -t {service_id}.{self.tag} {self.path}"
+        ], shell=True, )#stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+        if response.returncode:
+          error('Unable to build docker.')
+          return False
+      success('Build Successfull')
+
+      # Tag the repo
+      with Progress(
+        SpinnerColumn(),
+        TextColumn("[progress.description]{task.description}"),
+        transient=True,
+      ) as progress:
+        progress.add_task(description=f'Tagging your snap...', total=None)
+        response = subprocess.run([
+          f"docker tag {service_id}.{self.tag} {ecr_repo_url}:{service_id}.{self.tag}"
+        ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+        if response.returncode:
+          error('Unable to tag your snap.')
+          return False
+      success('Tag Successfull')
+
+      return True
+    except:
+      error('CLI Error')
+      return False
+
+  def push(self) -> bool:
+    # url = self.token_parts[0]
+    # web_app_token = self.token_parts[1]
+    service_id = self.token_parts[2]
+    ecr_repo_url = self.token_parts[3]
+    # ecr_repo_username = self.token_parts[4]
+    # ecr_repo_token = self.token_parts[5]
+
+    # Push the image
+    with Progress(
+      SpinnerColumn(),
+      TextColumn("[progress.description]{task.description}"),
+      transient=True,
+    ) as progress:
+      progress.add_task(description=f'Pushing your snap...', total=None)
+      response = subprocess.run([
+        f"docker push {ecr_repo_url}:{service_id}.{self.tag}"
+      ], shell=True, )#stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
+      if response.returncode:
+        error('Unable to push your snap.')
+        return False
+    success('Snap Upload Successfull')
+    return True
+
+  def upload_docs(self) -> bool:
+    '''
+      Note this step is optional hence we always respond with a True
+    '''
+    url = self.token_parts[0]
+    web_app_token = self.token_parts[1]
+    service_id = self.token_parts[2]
+    ecr_repo_url = self.token_parts[3]
+    ecr_repo_username = self.token_parts[4]
+    ecr_repo_token = self.token_parts[5]
+
+    # 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:
+        dfile = open(f"{self.path}/swagger.json", "rb")
+        test_res = requests.post(f"{url}/{self.tag}/openapispec", files = {"attachment": dfile}, headers={'Token': web_app_token})
+        if test_res.ok:
+          success('Uploaded Swagger.json')
+        else:
+          error(test_res.status_code)
+          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:
+        dfile = open(f"{self.path}/README.md", "rb")
+        test_res = requests.post(f"{url}/{self.tag}/markdown", files = {"attachment": dfile}, headers={'Token': web_app_token})
+        if test_res.ok:
+          success('Uploaded README.md')
+        else:
+          error('Unable to upload your README.md')
+      except:
+        info('Unable to find README.md at ' + self.path)
+    return True
+
+  def publish(self) -> None:
+    if not self.build() or not self.push() or not self.upload_docs():
+      return False
+    return True

snapctl-0.2.0/snapctl/main.py

@@ -0,0 +1,43 @@
+import typer
+
+from snapctl.commands.byosnap import ByoSnap
+from snapctl.types.definitions import ResponseType
+from snapctl.utils.echo import error, success, info
+
+app = typer.Typer()
+
+# Commands
+@app.callback()
+def callback():
+  """
+  Snapser CLI Tool
+  """
+
+# command: Optional[str] = typer.Argument(None)
+@app.command()
+def byosnap(
+  command: str = typer.Argument(..., help="BYOSnap Commands: " + ", ".join(ByoSnap.COMMANDS) + "."),
+  path: str = typer.Argument(..., help="Path to your snap code"),
+  tag: str = typer.Argument(..., help="Tag for your snap"),
+  token: str = typer.Argument(..., help="Copy the token from the Web App"),
+  docker_file: str = typer.Option("Dockerfile", help="Dockerfile name to use")
+) -> None:
+  """
+    Bring your own Snap
+  """
+  byosnap: ByoSnap = ByoSnap(command, path, tag, token, docker_file)
+  validate_input_response: ResponseType = byosnap.validate_input()
+  if validate_input_response['error']:
+    return error(validate_input_response['msg'])
+  command_method = command.replace('-', '_')
+  method: function = getattr(byosnap, command_method)
+  if not method():
+    return
+  success(f"BYOSnap {command} complete :oncoming_fist:")
+
+# @app.command()
+# def byow():
+#   """
+#   Bring your own workstation
+#   """
+#   typer.echo("Connecting to your cluster")

snapctl-0.2.0/snapctl/types/definitions.py

@@ -0,0 +1,4 @@
+class ResponseType():
+  error: bool
+  msg: str
+  data: list

snapctl-0.1.1/README.md

@@ -1,2 +0,0 @@
-# Snapser CLI Tool
-Snapser CLI Tool

snapctl-0.1.1/snapctl/main.py

@@ -1,138 +0,0 @@
-import os
-import subprocess
-import typer
-from typing import Optional
-
-from snapctl.echo import error, success, info
-from snapctl.utils import get_token_values, check_docker
-from rich.progress import Progress, SpinnerColumn, TextColumn
-
-app = typer.Typer()
-
-# Constants
-VALID_COMMANDS = {
-  'byosnap': ['upload']
-}
-# TOKEN="eyJwYXlsb2FkIjoiZTQ0dEo2dDNnSGhaOVRlYThRcmFyWFhQdVZVMWhxTmpnS0tJcGdDNUMvR3JzNEZadkhhTC8vSmlDR2hSNlFrNzZ5d1JkVFhDRVAzTTJhK3dGYmp1VUJCNnJzWU91SVUrelhVOXdvdFF0dWlCZENnOXBLVHcySGt4ODlNUmlEUFhvaU9wN0lHaTlXcUtGUVl3YmovYTN4OXcvNUxJaDFUZzlTYnRtQ3BXeGlINDYyZUJHZzFTOHVranVSNlV4YTNtWWsrb3FBcTk0TmVHNUlxM1g3bTFBc2ovU1R4Wk5DTFI3OGpNRnhBZUFsTE5FYk45aTRIYnpSNk5Gdk56SDVrKytoVE1VNVNrbERvWlhFcVV2VzNhVTJ3L2JIRkd4d1Y0RG9PN2MrYUtWai9mNWlER2xLMkJkMG83VUxsVnBZcDYvQ3JON213RFN3b2phSFV4YTBZOEpJdHpHY3lCK1ZnRW9TTUdMaWc0bDIrMjVUVXpSK1pxVXBmeUhhTmV5L05ic1l3MUhya0h3Tko2ZzlIa1FNd1NXeDVYRmNnY3E1UmpKUjROQkJCWGFqRXdPMXQrMkphZjVxa0FieFdKckJ0TUxwcytGYll6Y3p2VS9iSDRQaTZIOGFzSGwrM0lGQzJ3R1ZpRDBwSkU4amhzRTRuakpmZjJVbnplUDAvRnVET2plMzNXOVpsK1kxRjdUWEJNZVRDRXVWendkVk9Vd3JNRDZ1L1ZqQVcyOWFZdXJSR3dHTHJnTzhTYzhteDY4WCs5b05leXljOW9JL2hNUnk4VG5DTHNZTk5xZG5CZnNRZW5MWEwyL20zS1BxMmZNaWJ4akF0bE9xTUpMK2Nxd2JrSHZhRUZtMnlNQTFOYnVtOTNUTHEwdFRRZkZBSGl1UXFvd0R5NittcHAvZmZLZXUzclEwRFE5UHZib3JUbDBlV2M2YmdxUXdRUU1HOFQvcnJMZXRUZW4zSnNucVpZWk1zQ1lqM3NSZ1F3ZG1LcjU5dUpyNmREOENKN0M2bUllTWRXajhHalhvVlFXcmViOU5jU0xwbVFsZyt3RUZQRXo2Zjlsd2h5WlNNRUFYUkVMbHRnNS9FTkkyajluYTJFQlJMUUhkcUp3K2QyM1NWRDNLWXJjWE41MzJjRjcrYUZhWndMNWhyV3JkRFdIbjZuOFlTSTNGYVNGb2haRmRzMXdTcW1DR1NIbTAvcEFld2toaGt4M2krTXA5aDk1UGtqaUZpUmtRQ21LSzBxQzh6NHZ6d0tvTnBEN1p1OXRvY296bExNL0E0ZDRYUzc1cmk4MThxeVRaS2d1ZHcyNnpMSTkwcUlPSFRRaGdOalNDeTI4elI0SUtqeGEzUE5LMFZrelAwYW5kcmRoVHV6M2VIbDlUNUE5VzExdEhnNlBzdzNPS0RlR2J6NmZnK0N5YStUNHlFOEFkYWphTTJRcDcrL2o5NUR4RXBxNVI0cmFyQ01RbzRBZjBBOG9xRnNwNko1ekRJU3ducXNXcy9TVGtQYkJ2ODBVUUMyTW51NVlJazRPYUZ5enZ1ZGdmaHNJWWNVMk04RWdoZkFEdjR3MTU4UWhiRjcvUHlEV3kwc3k4Q3luRm9mbldlWThnNEVaNkV4cEg0RUJYKzB4T2RyZG9YOHh3RVpXbG13dVcwa0pxdXpHdy9pZDlLd21UeFEyK3RFUHJ3dlVNQ1N4QjN1OWVFNVlzSWhXRCtSd25JTEE0Qkk5R3BySnpkcUhRcHNVaW1SRjluUWRTdTV1N0Zad2FUQmlUd0JHaXJDWXM0Szl3aklTeURxY090cDBWWHIzaFpkYlg5K0xsV3F3VXZseGNXWjFqWnFLRFlmemh2WEVOYmpkaXVYclJrRWo5bWNWMkhJRmtkSEJweS8wNzQ9IiwiZGF0YWtleSI6IkFRRUJBSGo2bGM0WElKdy83bG4wSGMwMERNZWs2R0V4SENiWTRSSXBUTUNJNThJblV3QUFBSDR3ZkFZSktvWklodmNOQVFjR29HOHdiUUlCQURCb0Jna3Foa2lHOXcwQkJ3RXdIZ1lKWUlaSUFXVURCQUV1TUJFRURJZjN6bERvelJEeVpScTYvUUlCRUlBN1ZsUURQbzBMaFUyU0dwREpSREFrdXg1L1pDWVE0RVVCMWVuV2M5cGtZdHF2R2J0cC9aTzFRY2kwNzBPSGpneWhDY0JCdzIwSGZZaW54Uk09IiwidmVyc2lvbiI6IjIiLCJ0eXBlIjoiREFUQV9LRVkiLCJleHBpcmF0aW9uIjoxNjc4NTAzMjc0fQ=="
-# BASE_REPO= '131164543756.dkr.ecr.us-west-2.amazonaws.com'
-# REPO_NAME="sandbox-multi-tools"
-# ECR_PATH=f"{BASE_REPO}/{REPO_NAME}"
-
-# Commands
-@app.callback()
-def callback():
-  """
-  Snapser CLI Tool
-  """
-
-# command: Optional[str] = typer.Argument(None)
-@app.command()
-def byosnap(
-  command: str = typer.Argument(..., help="Bring your own Commands: " + ", ".join(VALID_COMMANDS['byosnap']) + "."),
-  path: str = typer.Argument(..., help="Path to your snap code"),
-  tag: str = typer.Argument(..., help="Tag for your snap"),
-  token: str = typer.Argument(..., help="Copy the token from the Web App"),
-  docker_file: str = typer.Option("Dockerfile", help="Dockerfile name to use")
-):
-  """
-  Bring your own code
-  """
-  token_list = []
-  # Error checking
-  with Progress(
-    SpinnerColumn(),
-    TextColumn("[progress.description]{task.description}"),
-    transient=True,
-  ) as progress:
-    progress.add_task(description=f'Checking dependencies...', total=None)
-    if not check_docker():
-      return error('Docker not present')
-    if not command in VALID_COMMANDS['byosnap']:
-      error_message: str = 'Invalid command. Valid commands are ' + ', '.join(VALID_COMMANDS['byosnap']) + '.'
-      return error(error_message)
-    token_list = get_token_values(token)
-    if token_list is None:
-      error_message: str = 'Invalid token. Please reach out to your support team.'
-      return error(error_message)
-
-  success('Dependencies Verified')
-
-  # Extract details from the token
-  web_app_token = token_list[0]
-  service_id = token_list[1]
-  ecr_repo_url = token_list[2]
-  ecr_repo_username = token_list[3]
-  ecr_repo_token = token_list[4]
-
-  try:
-
-    # Login to Snapser Registry
-    with Progress(
-      SpinnerColumn(),
-      TextColumn("[progress.description]{task.description}"),
-      transient=True,
-    ) as progress:
-      progress.add_task(description=f'Logging into Snapser Image Registry...', total=None)
-      response = subprocess.run([
-        f'echo "{ecr_repo_token}" | docker login --username {ecr_repo_username} --password-stdin {ecr_repo_url}'
-      ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
-      if response.returncode:
-        return error('Unable to connect to the Snapser Container Repository. Please get the latest token from the Web app.')
-    success('Login Successful')
-
-    # Build your snap
-    with Progress(
-      SpinnerColumn(),
-      TextColumn("[progress.description]{task.description}"),
-      transient=True,
-    ) as progress:
-      progress.add_task(description=f'Building your snap...', total=None)
-      response = subprocess.run([
-        #f"docker build --no-cache -t {tag} {path}"
-        f"docker build -t {service_id}.{tag} {path}"
-      ], shell=True, )#stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
-      if response.returncode:
-        return error('Unable to build docker.')
-    success('Build Successfull')
-
-    # Tag the repo
-    with Progress(
-      SpinnerColumn(),
-      TextColumn("[progress.description]{task.description}"),
-      transient=True,
-    ) as progress:
-      progress.add_task(description=f'Tagging your snap...', total=None)
-      response = subprocess.run([
-        f"docker tag {service_id}.{tag} {ecr_repo_url}:{service_id}.{tag}"
-      ], shell=True, stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
-      if response.returncode:
-        return error('Unable to tag your snap.')
-    success('Tag Successfull')
-
-    # Push the image
-    with Progress(
-      SpinnerColumn(),
-      TextColumn("[progress.description]{task.description}"),
-      transient=True,
-    ) as progress:
-      progress.add_task(description=f'Pushing your snap...', total=None)
-      response = subprocess.run([
-        f"docker push {ecr_repo_url}:{service_id}.{tag}"
-      ], shell=True, )#stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
-      if response.returncode:
-        return error('Unable to push your snap.')
-    success('Snap Upload Successfull')
-
-  # white_check_mark thumbsup love-you_gesture
-
-  except Exception as e:
-    return error('CLI Error')
-  success(f"BYOSnap " + command + ' complete :oncoming_fist:')
-
-
-@app.command()
-def byow():
-  """
-  Bring your own workstation
-  """
-  typer.echo("Connecting to your cluster")

snapctl-0.1.1/snapctl/utils.py

@@ -1,38 +0,0 @@
-import base64
-import subprocess
-
-def check_docker() -> bool:
-  try:
-    subprocess.run([
-      "docker", "--version"
-    ], stdout=subprocess.DEVNULL, stderr=subprocess.STDOUT)
-    return True
-  except:
-    return False
-
-def get_token_values(token: str) -> None | list:
-  try:
-    input_token = base64.b64decode(token).decode('ascii')
-    token_parts = input_token.split('|')
-    # web_app_token|service_id|ecr_repo_url|ecr_repo_username|ecr_repo_token
-    if len(token_parts) == 5:
-      #token_parts[2] = 'http://131164543756.dkr.ecr.us-west-2.amazonaws.com/adhoc-c1a8eb1f-ee36-4313-bda5-046039ea06b3'
-      return token_parts
-    if len(token_parts) == 4:
-      #token_parts[1] = 'http://131164543756.dkr.ecr.us-west-2.amazonaws.com/adhoc-c1a8eb1f-ee36-4313-bda5-046039ea06b3'
-      token_parts.insert(0, '')
-      return token_parts
-  except Exception:
-    pass
-  return None
-
-# TOKEN_ENV_VAR_NAME = 'SNP_TOKEN'
-# def check_token_env_var() -> bool:
-#   if TOKEN_ENV_VAR_NAME in os.environ and os.environ[TOKEN_ENV_VAR_NAME] != '':
-#     return True
-#   return False
-
-# def get_token() -> str:
-#   if TOKEN_ENV_VAR_NAME in os.environ and os.environ[TOKEN_ENV_VAR_NAME] != '':
-#     return os.environ[TOKEN_ENV_VAR_NAME]
-#   return ''