Merge pull request #22 from PEM-Humboldt/adjustmentAuthInCommands

Adjustment auth in commands

Author: denarch22

README.md

@@ -33,13 +33,16 @@ Este paquete corresponde a la herramienta para cargar, editar y eliminar colecci
 
 ## Configuración
 
-Antes de usar la herramienta segurese de realizar lo siguiente:
+Antes de usar la herramienta asegurese de realizar lo siguiente:
 
 1. Crear un archivo .env réplica de env.sample y actualizar los valores de la variables existentes.
    ```
    STAC_URL="" # URL del servidor del STAC
    ABS_STRING="" # Cadena de conexión a Azure Blob Storage
    ABS_CONTAINER="" # Nombre del contenedor en Azure Blob Storage
+   AUTH_URL="" # Path de la ruta de la url para autenticar, la cual seria "/auth/token"
+   USERNAME_AUTH:"" # Nombre de usuario para autenticación.
+   PASSWORD_AUTH:"" # Contraseña para autenticación.
    ```
    (Es posible que la variable de STAC_URL no reconozca la ruta: "localhost:8082", entonces se recomienda agregar la siguiente:STAC_URL="http://localhost:8082")
 
@@ -64,42 +67,86 @@ Para crear una colección siga los siguientes pasos:
 
 # Instrucciones de Uso
 
+## Autenticación Configurada en Variables de Ambiente
+
+La autenticación se realiza automáticamente utilizando las credenciales definidas en las variables de ambiente.
+
+---
+
 ## Cargar una Colección
 
 Para cargar una colección de capas, ejecuta el siguiente comando:
 
 ```
-python src/main.py create -f folder_name [-c collection_name] [-o]
+python src/main.py create -f folder_name [-c collection_name]
 ```
 
 ### Parámetros:
 - `-f, --folder` (obligatorio): Directorio con el archivo collection.json y las capas.
-- `-c, --collection` (opcional): Nombre de la colección. Si no se proporciona, se tomará el id del archivo collection.json.
+- `-c, --collection` (opcional): Nombre de la colección. Si no se proporciona, se tomará el `id` del archivo collection.json.
 
 ### Ejemplo:
 
-* Especificando un nombre de colección
+* Especificando un nombre de colección:
 ```
 python src/main.py create -f my_folder -c MyCollection
 
 o
 
 python src/main.py create --folder my_folder --collection MyCollection
-
 ```
 
-Este comando creará la colección `MyCollection` a partir de los archivos en el directorio `input/my_folder`
-
-* Usando el id del archivo collection.json:
+Este comando creará la colección `MyCollection` a partir de los archivos en el directorio `input/my_folder`.
 
+* Usando el `id` del archivo collection.json:
 ```
 python src/main.py create -f my_folder
 
 o
 
 python src/main.py create --folder my_folder
+```
+---
+## Sobrescribir una Colección Existente
+
+Para sobrescribir una colección existente, ejecuta el siguiente comando:
+
+python src/main.py create -f folder_name [-c collection_name] [-o]
+
+
+### Parámetros:
+- `-f, --folder` (obligatorio): Directorio con el archivo `collection.json` y las capas.
+- `-c, --collection` (opcional): Nombre de la colección. Si no se proporciona, se tomará el `id` del archivo `collection.json`.
+- `-o, --overwrite` (obligatorio): Permite sobrescribir una colección existente si ya existe. Si no se proporciona, la colección no será sobrescrita.
+
+### Ejemplo:
+
+* Sobrescribiendo una colección existente:
+
+```
+python src/main.py create -f my_folder -o
 
+o
+
+python src/main.py create --folder my_folder --overwrite
+```
+
+
+Este comando sobrescribirá la colección existente (si ya existe) usando los archivos en el directorio `input/my_folder`.
+
+* Especificando un nombre de colección para sobrescribir:
+
+```
+python src/main.py create -f my_folder -c MyCollection -o
+
+o
+
+python src/main.py create --folder my_folder --collection MyCollection --overwrite
 ```
+
+
+Este comando sobrescribirá la colección `MyCollection` si ya existe, usando los archivos en el directorio `input/my_folder`.
+
 ---
 
 ## Validar una Colección
@@ -112,17 +159,15 @@ python src/main.py validate -f folder_name [-c collection_name]
 
 ### Parámetros:
 - `-f, --folder` (obligatorio): Directorio que contiene los archivos de la colección.
-- `-c, --collection` (opcional): Nombre de la colección para validar. Si no se proporciona, se tomará el id del archivo collection.json.
+- `-c, --collection` (opcional): Nombre de la colección para validar. Si no se proporciona, se tomará el `id` del archivo collection.json.
 
 ### Ejemplo:
-
 ```
 python src/main.py validate -f my_folder
 
 o
 
 python src/main.py validate --folder my_folder
-
 ```
 
 Este comando validará los archivos de la colección en el directorio `input/my_folder` sin cargarlos.
@@ -138,18 +183,15 @@ python src/main.py remove --collection collection_name
 ```
 
 ### Parámetros:
-
 - `-c, --collection` (obligatorio): Nombre de la colección a eliminar.
 
 ### Ejemplo:
-
 ```
 python src/main.py remove -c my_collection
 
 o
 
 python src/main.py remove --collection my_collection
-
 ```
 
 Este comando eliminará la colección `my_collection` del sistema.
@@ -168,7 +210,6 @@ Para hacer formateo de estilos automático se utiliza el paquete black. Al ejecu
 
 ```
 black src
-
 ```
 
 ## Documentación

env.sample

@@ -1,3 +1,6 @@
 STAC_URL=""
 ABS_STRING=""
 ABS_CONTAINER=""
+AUTH_URL=""
+USERNAME_AUTH=""
+PASSWORD_AUTH=""

src/collection.py

@@ -95,9 +95,7 @@ def create_collection(self, collection_name, collection_data):
             extent=pystac.Extent(
                 spatial=spatial_extent, temporal=temporal_extent
             ),
-            extra_fields={
-                "metadata": collection_data["metadata"]
-            },
+            extra_fields={"metadata": collection_data["metadata"]},
         )
 
         self.stac_collection.validate()
@@ -156,13 +154,13 @@ def remove_collection(self, collection_name=None):
         logger.info(f"Attempting to remove collection {collection_id}")
 
         try:
-            items_collection = stac_rest.get(f"{collection_url}/items").json()
-            for item in items_collection["features"]:
+            items_response = stac_rest.get(f"{collection_url}/items")
+            items = items_response.json().get("features", [])
+
+            for item in items:
                 for asset_key, asset_value in item["assets"].items():
                     url = asset_value["href"]
-                    logger.info(
-                        f"Deleting file: {url} from Azure Blob Storage"
-                    )
+                    logger.info(f"Deleting file {url} from Azure Blob Storage")
                     self.storage.remove_file(url)
 
             stac_rest.delete(collection_url)
@@ -201,6 +199,7 @@ def upload_collection(self):
                 logger.info(
                     f"Item upload response: {item_response.status_code}"
                 )
+
         except Exception as e:
             logger.error(f"Error uploading collection: {e}")
             raise RuntimeError(f"Error uploading collection: {e}")

src/config.py

@@ -6,9 +6,16 @@ class Settings(BaseSettings):
     stac_url: str = "http://localhost:8082"
     abs_string: str = ""
     abs_container: str = "cog-test"
+    auth_url: str = "/auth/token"
+    username_auth: str = "admin"
+    password_auth: str = "admin"
+    token: str = ""
 
     model_config = SettingsConfigDict(env_file=".env")
 
+    def set_token(self, token: str):
+        self.token = token
+
 
 @lru_cache
 def get_settings():

src/main.py

@@ -2,6 +2,7 @@
 
 from utils.logging_config import logger
 from utils import spec
+from utils.auth import authenticate
 from collection import Collection
 from json import load
 from sys import exit as sysexit
@@ -28,12 +29,8 @@ def create_collection_local(collection, input_folder, collection_name):
 
 
 def main():
-    """
-    Read arguments and start data validation.
-    """
-
-    parser = ArgumentParser()
-    sub_parsers = parser.add_subparsers(dest="command")
+    parser = ArgumentParser(description="STAC Collection Manager")
+    sub_parsers = parser.add_subparsers(dest="command", help="Commands")
 
     create_parser = sub_parsers.add_parser(
         "create", help="Create a new collection"
@@ -92,38 +89,37 @@ def main():
 
     args = parser.parse_args()
 
+    authenticate()
+    collection = Collection()
+
     if args.command == "create":
-        collection = Collection()
         input_folder = f"input/{args.folder}"
         create_collection_local(collection, input_folder, args.collection)
 
         if collection.check_collection(args.overwrite):
             collection.remove_collection()
-            sysexit("Previous collection removed successfully.")
+            logger.info("Previous collection removed.")
 
         output_dir = f"{getcwd()}/output/{args.folder}"
         collection.convert_layers(input_folder, output_dir)
         logger.info("Layers converted successfully.")
 
         collection.upload_layers(output_dir)
         logger.info("Layers uploaded successfully.")
-
         collection.upload_collection()
         logger.info("Collection uploaded successfully.")
 
         sysexit("Process completed successfully.")
 
     elif args.command == "validate":
-        collection = Collection()
         create_collection_local(
             collection, f"input/{args.folder}", args.collection
         )
         sysexit("Validation successful.")
 
     elif args.command == "remove":
-        collection = Collection()
         collection.remove_collection(args.collection)
-        sysexit("Collection successfully removed.")
+        sysexit("Collection removed successfully.")
 
     else:
         sysexit("No command used. Type -h for help")

src/utils/auth.py

@@ -0,0 +1,59 @@
+import requests
+from utils.logging_config import logger
+from sys import exit as sysexit
+from config import get_settings
+
+from utils.url import build_url
+
+
+settings = get_settings()
+
+
+def authenticate():
+    """
+    Authenticate against the authentication service and retrieve a token.
+    """
+    try:
+        username = settings.username_auth
+        password = settings.password_auth
+        stac_url = settings.stac_url
+        auth_url = settings.auth_url
+
+        auth_data = {"username": username, "password": password}
+
+        url = build_url(stac_url, auth_url, args_dict={})
+        response = requests.post(url, data=auth_data)
+        response.raise_for_status()
+
+        new_token = response.json().get("access_token")
+
+        if new_token:
+            settings.set_token(new_token)
+            logger.info("Token updated successfully.")
+        else:
+            logger.error("Authentication failed: No token received.")
+            sysexit("Authentication failed: No token received.")
+
+    except requests.HTTPError as http_err:
+        error_detail = None
+
+        status_code = (
+            response.status_code if response is not None else "Unknown"
+        )
+
+        if (
+            response is not None
+            and response.headers.get("Content-Type") == "application/json"
+        ):
+            try:
+                error_response = response.json()
+                error_detail = error_response.get("description", str(http_err))
+
+            except ValueError:
+                error_detail = str(http_err)
+
+        error_message = f"HTTP {status_code}: {error_detail or str(http_err)}"
+        sysexit(f"Authentication error: {error_message}")
+
+    except requests.RequestException as req_err:
+        sysexit(f"Request error: {req_err}")