Merge pull request #28 from jupyter-naas/27-vc-authentication-logic

Update authentication logic for SDK/CLI

Author: viniciusdc

naas_python/__init__.py

@@ -1,21 +1,5 @@
-from pathlib import Path
+from .domains.registry.handlers.PythonHandler import primaryAdaptor as registry
+from .domains.space.handlers.PythonHandler import primaryAdaptor as space
 from .utils.log import initialize_logging
 
 logger = initialize_logging()
-
-__ROOT_DIR__ = Path(__file__).parents[1].absolute()
-
-# If the package is run as a script, run the main function to load the CLI.
-if __name__ == "__main__":
-    from naas_python.main import main
-
-    main()
-else:
-    # Else use it as a library.
-    from .domains.space.handlers.PythonHandler import primaryAdaptor as __space
-
-    space = __space
-
-    from .domains.registry.handlers.PythonHandler import primaryAdaptor as __registry
-
-    registry = __registry

naas_python/cli.py

@@ -1,24 +1,28 @@
 import typer
-from os import getenv
-import sys
-from naas_python.domains.space.handlers.CLISpaceAdaptor import (
-    primaryAdaptor as spaceAdaptor,
-)
+
 from naas_python.domains.registry.handlers.CLIRegistryHandler import (
-    primaryAdaptor as registryAdaptor,
+    primaryAdaptor as typerRegistryAdaptor,
+)
+
+# from naas_python.domains import spaceCliAdaptor  # , registryCliAdaptor
+from naas_python.domains.space.handlers.CLISpaceHandler import (
+    primaryAdaptor as typerSpaceAdaptor,
 )
 
 
-# if getenv("NAAS_PYTHON_DEBUG", "False").lower() == "false":
-#     sys.tracebacklimit = 0  # Disable traceback
+def _create_cli_app():
+    app = typer.Typer(
+        epilog="Found a bug? Report it at https://github.com/jupyter-naas/naas-python/issues",
+        pretty_exceptions_show_locals=False,
+        pretty_exceptions_short=True,
+        # pretty_exceptions_enable=False,
+    )
 
-app = typer.Typer(
-    epilog="Found a bug? Report it at https://github.com/jupyter-naas/naas-python/issues ",
-    pretty_exceptions_show_locals=False,
-    pretty_exceptions_short=True,
-    # pretty_exceptions_enable=False,
-)
+    # Registry domain's related commands
+    app.add_typer(typerSpaceAdaptor.app, name="space")
+    app.add_typer(typerRegistryAdaptor.app, name="registry")
+
+    return app
 
-app.add_typer(spaceAdaptor.app, name="space")
 
-app.add_typer(registryAdaptor.app, name="registry")
+app = _create_cli_app()

naas_python/domains/registry/adaptors/secondary/NaasRegistryAPIAdaptor.py

@@ -1,5 +1,5 @@
 import json
-from os import getenv
+import logging
 
 import requests
 
@@ -15,39 +15,37 @@
 class NaasRegistryAPIAdaptor(BaseAPIAdaptor, IRegistryAdaptor):
     def __init__(self):
         super().__init__()
-        # TODO: proper authorization validation utility function
-        self._authorization_token = getenv("NAAS_PYTHON_API_TOKEN")
+        # self.authenticator = NaasSpaceAuthenticatorAdapter()
+        # self._authorization_token = self.authenticator.jwt_token
 
     @BaseAPIAdaptor.service_status_decorator
     def create_registry(self, name) -> dict:
         _url = f"{self.host}/registry/"
 
-        self.logger.debug(f"create request url: {_url}")
+        logging.debug(f"create request url: {_url}")
 
         api_response = self.make_api_request(
             requests.post,
             _url,
             payload=json.dumps({"name": name}),
-            token=self._authorization_token,
         )
 
-        self.logger.debug(
+        logging.debug(
             f"Request URL: {api_response.url} :: status_code: {api_response.status_code}"
         )
         return self._handle_create_response(api_response)
 
     @BaseAPIAdaptor.service_status_decorator
     def get_registry_by_name(self, name) -> dict:
         _url = f"{self.host}/registry/{name}"
-        self.logger.debug(f"get request url: {_url}")
+        logging.debug(f"get request url: {_url}")
 
         api_response = self.make_api_request(
             requests.get,
             f"{self.host}/registry/{name}",
-            token=self._authorization_token,
         )
 
-        self.logger.debug(
+        logging.debug(
             f"Request URL: {api_response.url} :: status_code: {api_response.status_code}"
         )
 
@@ -57,30 +55,28 @@ def get_registry_by_name(self, name) -> dict:
     def list_registries(self, page_size, page_number) -> dict:
         _url = f"{self.host}/registry/?page_size={page_size}&page_number={page_number}"
 
-        self.logger.debug(f"list request url: {_url}")
+        logging.debug(f"list request url: {_url}")
 
         api_response = self.make_api_request(
             requests.get,
             _url,
-            token=self._authorization_token,
         )
-        self.logger.debug(
+        logging.debug(
             f"Request URL: {api_response.url} :: status_code: {api_response.status_code}"
         )
         return self._handle_list_response(api_response)
 
     @BaseAPIAdaptor.service_status_decorator
     def delete_registry(self, name) -> dict:
         _url = f"{self.host}/registry/{name}"
-        self.logger.debug(f"delete request url: {_url}")
+        logging.debug(f"delete request url: {_url}")
 
         api_response = self.make_api_request(
             requests.delete,
             _url,
-            token=self._authorization_token,
         )
 
-        self.logger.debug(
+        logging.debug(
             f"Request URL: {api_response.url} :: status_code: {api_response.status_code}"
         )
 
@@ -90,15 +86,14 @@ def delete_registry(self, name) -> dict:
     def get_registry_credentials(self, name) -> dict:
         _url = f"{self.host}/registry/{name}/credentials"
 
-        self.logger.debug(f"get credentials request url: {_url}")
+        logging.debug(f"get credentials request url: {_url}")
 
         api_response = self.make_api_request(
             requests.get,
             _url,
-            token=self._authorization_token,
         )
 
-        self.logger.debug(
+        logging.debug(
             f"Request URL: {api_response.url} :: status_code: {api_response.status_code}"
         )
 

naas_python/domains/space/adaptors/primary/SDKSpaceAdaptor.py

@@ -101,9 +101,7 @@ def add(
         # Step 1: Create a new Registry on space.naas.ai if requested
 
         if not skip_registry:
-            self.console.print(
-                f"[cyan]Creating Docker Registry '{registry_name}'...[/cyan]"
-            )
+            print(f"Creating Docker Registry '{registry_name}'...")
             from naas_python.domains.registry.handlers.PythonHandler import (
                 primaryAdaptor as RegistryHandler,
             )
@@ -112,41 +110,37 @@ def add(
             try:
                 registry = RegistryHandler.create(name=registry_name)
             except RegistryConflictError:
-                self.console.print(
-                    f"[yellow]A registry with the name '{registry_name}' already exists. Proceeding with existing registry.[/yellow]"
+                print(
+                    f"A registry with the name '{registry_name}' already exists. Proceeding with existing registry."
                 )
                 registry = RegistryHandler.get(name=registry_name)
 
             # Get credentials for the registry (will create a credentials file if it doesn't exist)
             # and set up docker login for the registry (if type is docker)
             if space_type == "docker":
-                self.console.print(
-                    f"[cyan]Retrieving credentials for Docker Registry...[/cyan]"
-                )
+                print(f"Retrieving credentials for Docker Registry...")
                 RegistryHandler.get_credentials(name=registry_name)
 
         # Step 2.a: Build and push image to registry container if requested:
         if space_type == "docker":
-            self.console.print(
-                f"[cyan]Building Docker Image for '{space_name}'...[/cyan]"
-            )
+            print(f"Building Docker Image for '{space_name}'...")
             os.system(
-                f"docker build -t {registry.uri}:latest -f {dockerfile_path} {docker_context}"
+                f"docker build -t {registry.registry.uri}:latest -f {dockerfile_path} {docker_context}"
             )
 
-            self.console.print("[cyan]Pushing Docker Image...")
-            os.system(f"docker push {registry.uri}:latest")
+            print("Pushing Docker Image...")
+            os.system(f"docker push {registry.registry.uri}:latest")
 
         # Step 2.b: Create a new space on space.naas.ai
-        self.console.print(f"[cyan]Creating Naas Space '{space_name}'...[/cyan]")
+        print(f"Creating Naas Space '{space_name}'...")
         try:
             self.domain.create(
                 name=space_name,
                 domain=f"{space_name}.naas.ai",
                 containers=[
                     {
                         "name": space_name,
-                        "image": image if image else f"{registry.uri}:latest",
+                        "image": image if image else f"{registry.registry.uri}:latest",
                         "env": {},
                         "cpu": cpu,
                         "memory": memory,
@@ -155,8 +149,8 @@ def add(
                 ],
             )
         except SpaceConflictError as e:
-            self.console.print(
-                f"[yellow]A space with the name '{space_name}' already exists. Proceeding with existing space.[/yellow]"
+            print(
+                f"A space with the name '{space_name}' already exists. Proceeding with existing space."
             )
             self.domain.get(name=space_name)
 
@@ -207,7 +201,7 @@ def add(
                 )
 
                 try:
-                    _build_command = f"  docker build -t {registry.uri}:latest -f {dockerfile_path} {docker_context}"
+                    _build_command = f"  docker build -t {registry.registry.uri}:latest -f {dockerfile_path} {docker_context}"
                 except ValueError as e:
                     raise ValueError(
                         "When space_type is 'docker', dockerfile_path and docker_context must be provided. Please provide these values and try again"
@@ -218,11 +212,11 @@ def add(
                     f'if: ${{ github.event_name == "push" }}',
                     "run: |",
                     _build_command,
-                    f"  docker push { registry.uri }:latest",
+                    f"  docker push { registry.registry.uri }:latest",
                 ]
                 pipeline.add_job("Build and Push Docker Image", docker_steps)
 
             # Render the CI/CD configuration
             pipeline.render()
 
-            self.console.print("[green]Generated CI/CD configuration.[/green]")
+            print("Generated CI/CD configuration.")

naas_python/domains/space/adaptors/secondary/NaasSpaceAPIAdaptor.py

@@ -1,60 +1,51 @@
 import json
 import os
-from logging import getLogger
 from os import getenv
+import logging
 
 import requests
 from requests.exceptions import ConnectionError
 
 from naas_python.domains.space.SpaceSchema import (
     ISpaceAdaptor,
-    SpaceValidationError,
     SpaceConflictError,
     SpaceNotFound,
+    SpaceValidationError,
 )
-
-logger = getLogger(__name__)
 from naas_python.utils.domains_base.secondary.BaseAPIAdaptor import BaseAPIAdaptor
 
 
 class NaasSpaceAPIAdaptor(BaseAPIAdaptor, ISpaceAdaptor):
     def __init__(self):
         super().__init__()
-        # TODO: proper authorization validation utility function
-        self._authorization_token = getenv("NAAS_PYTHON_API_TOKEN")
 
     @BaseAPIAdaptor.service_status_decorator
     def create_space(self, name, domain, containers) -> dict:
         _url = f"{self.host}/space/"
 
-        self.logger.debug(f"create request url: {_url}")
+        logging.debug(f"create request url: {_url}")
 
         api_response = self.make_api_request(
             requests.post,
             _url,
             payload=json.dumps(
                 {"name": name, "domain": domain, "containers": containers}
             ),
-            token=self._authorization_token,
         )
 
-        self.logger.debug(
+        logging.debug(
             f"Request URL: {api_response.url} :: status_code: {api_response.status_code}"
         )
         return self._handle_create_response(api_response)
 
     @BaseAPIAdaptor.service_status_decorator
     def get_space_by_name(self, name):
         _url = f"{self.host}/space/{name}"
-        self.logger.debug(f"get request url: {_url}")
+        logging.debug(f"get request url: {_url}")
 
-        api_response = self.make_api_request(
-            requests.get,
-            f"{self.host}/space/{name}",
-            token=self._authorization_token,
-        )
+        api_response = self.make_api_request(requests.get, f"{self.host}/space/{name}")
 
-        self.logger.debug(
+        logging.debug(
             f"Request URL: {api_response.url} :: status_code: {api_response.status_code}"
         )
 
@@ -64,14 +55,13 @@ def get_space_by_name(self, name):
     def list_spaces(self, page_size, page_number) -> dict:
         _url = f"{self.host}/space/?page_size={page_size}&page_number={page_number}"
 
-        self.logger.debug(f"list request url: {_url}")
+        logging.debug(f"list request url: {_url}")
 
         api_response = self.make_api_request(
             requests.get,
             _url,
-            token=self._authorization_token,
         )
-        self.logger.debug(
+        logging.debug(
             f"Request URL: {api_response.url} :: status_code: {api_response.status_code}"
         )
         return self._handle_list_response(api_response)
@@ -87,32 +77,30 @@ def update_space(self, name, domain, containers) -> dict:
 
         _url = f"{self.host}/space/{name}"
 
-        self.logger.debug(f"update request url: {_url}")
+        logging.debug(f"update request url: {_url}")
 
         api_response = self.make_api_request(
             requests.put,
             _url,
             payload=json.dumps(payload),
-            token=self._authorization_token,
         )
 
-        self.logger.debug(
+        logging.debug(
             f"Request URL: {api_response.url} :: status_code: {api_response.status_code}"
         )
         return self._handle_get_response(api_response)
 
     @BaseAPIAdaptor.service_status_decorator
     def delete_space(self, name) -> dict:
         _url = f"{self.host}/space/{name}"
-        self.logger.debug(f"delete request url: {_url}")
+        logging.debug(f"delete request url: {_url}")
 
         api_response = self.make_api_request(
             requests.delete,
             _url,
-            token=self._authorization_token,
         )
 
-        self.logger.debug(
+        logging.debug(
             f"Request URL: {api_response.url} :: status_code: {api_response.status_code}"
         )
         return self._handle_delete_response(api_response)