Chore/upgrade cli to v0.5.0 (#245)

chore: update cli to odtp version v0.5.0

CLI commands are improved in regards to validation and output so that cli validation matches gui validation.

Co-authored-by: sabinem <[email protected]>

Author: sabinem

odtp/cli/new.py

@@ -5,6 +5,8 @@
 from typing_extensions import Annotated
 import logging
 import requests
+from rich.console import Console
+from rich.markdown import Markdown
 import odtp.mongodb.db as db
 import odtp.mongodb.utils as mongodb_utils
 import odtp.helpers.parse as odtp_parse
@@ -13,6 +15,7 @@
 import traceback
 
 app = typer.Typer()
+console = Console()
 
 log = logging.getLogger(__name__)
 
@@ -23,8 +26,31 @@ def user_entry(
     github: str = typer.Option(..., "--github", help="Specify the github"),
 ):
     """Add new user in the MongoDB"""
-    user_id = db.add_user(name=name, github=github, email=email)
-    log.info(f"A user has been added {user_id}")
+    try:
+        if name is None or email is None or github is None:
+            console.print("[bold red]❌ ERROR:[/bold red] Please provide either --name or --email and --github")
+            raise typer.Exit(code=1)
+
+        if not validation_helpers.validate_user_name_unique(name):
+            console.print("[bold red]❌ ERROR:[/bold red] --name must be unique.")
+            raise typer.Exit(code=1)
+
+        if not validation_helpers.validate_github_user_name(github):
+            console.print("[bold red]❌ ERROR:[/bold red] --github must be a valid github user name.")
+            raise typer.Exit(code=1)
+
+        user_id = db.add_user(name=name, github=github, email=email)
+
+    except typer.Exit:
+        pass
+
+    except Exception as e:
+        log.exception("Unexpected error in user_entry")
+        console.print(f"[bold red]❌ ERROR:[/bold red] Failed to add user. Details: {str(e)}")
+        raise typer.Exit(code=1)
+    else:
+        success_message = f"[bold green]✅ SUCCESS: User with User Id {user_id} has been added![/bold green]"
+        console.print(success_message)
 
 
 @app.command()
@@ -53,28 +79,28 @@ def odtp_component_entry(
 
     except git_helpers.OdtpGithubException as e:
         typer.echo(f"Error: An error occurred while fetching information from GitHub: {e}")
-        raise typer.Exit(code=2)
+        raise typer.Exit(code=1)
 
     except mongodb_utils.OdtpDbMongoDBValidationException as e:
         typer.echo(f"Error: Component version could not be added: {e}")
-        raise typer.Exit(code=3)
+        raise typer.Exit(code=1)
 
     except validation_helpers.OdtpYmlException as e:
         log.error(f"Validation error occurred when parsing odtp.yml")
         typer.echo(f"Error: Validation of odtp.yml failed: {e}")
-        raise typer.Exit(code=4)
+        raise typer.Exit(code=1)
 
     except requests.RequestException as e:
         log.error(f"Network error: {e}")
         typer.echo(f"Error: A network error occurred while communicating with GitHub.: {e}")
-        raise typer.Exit(code=5)
+        raise typer.Exit(code=1)
 
     except Exception as e:
         error_message = f"Error: An unexpected error occurred: {e}"
         if debug:
             error_message += f"\n{traceback.format_exc()}"
         typer.echo(error_message, err=True)
-        raise typer.Exit(code=99)
+        raise typer.Exit(code=1)
 
     else:
         if component_id and version_id:
@@ -94,14 +120,39 @@ def digital_twin_entry(
     user_email: str = typer.Option(None, "--user-email", help="Specify the email"),
     name: str = typer.Option(..., "--name", help="Specify the digital twin name"),
 ):
-    if user_id is None and user_email is None:
-        raise typer.Exit("Please provide either --user-id or --user-email")
+    try:
+        if user_id is None and user_email is None:
+            console.print("[bold red]❌ ERROR:[/bold red] Please provide either --user-id or --user-email")
+            raise typer.Exit(code=1)
+
+        if user_email:
+            user_id = db.get_document_id_by_field_value("email", user_email, "users")
+
+        if not user_id:
+            console.print("[bold red]❌ ERROR:[/bold red] User does not exist. Please add the user first.")
+            raise typer.Exit(code=1)
+
+        if not validation_helpers.validate_digital_twin_name_unique(digital_twin_name=name, user_id=user_id):
+            console.print("[bold red]❌ ERROR:[/bold red] Digital Twin name must be unique and 6 characters long. Choose a different name.")
+            raise typer.Exit(code=1)
+
+        dt_id = db.add_digital_twin(userRef=user_id, name=name)
 
-    if user_email:
-        user_id = db.get_document_id_by_field_value("email", user_email, "users")
+        if not dt_id:
+            console.print("[bold red]❌ ERROR:[/bold red] Failed to create Digital Twin due to a database issue.")
+            raise typer.Exit(code=1)
 
-    dt_id = db.add_digital_twin(userRef=user_id, name=name)
-    log.info(f"Digital Twin added with ID {dt_id}")
+    except typer.Exit:
+        pass
+
+    except Exception as e:
+        console.print(f"[bold red]❌ ERROR:[/bold red] An unexpected error occurred: {str(e)}")
+        log.exception("Unexpected error in digital_twin_entry")
+        raise typer.Exit(code=1)
+
+    else:
+        success_message = f"[bold green]✅ SUCCESS: Digital Twin with id {dt_id} has been added![/bold green]"
+        console.print(success_message)
 
 
 @app.command()
@@ -116,7 +167,8 @@ def workflow_entry(
 ):
     try:
         if component_tags is None and component_versions is None:
-            raise typer.Exit("Please provide either --component-tags or --component-versions")
+            console.print("[bold red]❌ ERROR:[/bold red] Please provide either --component-tags or --component-versions")
+            raise typer.Exit(code=1)
         if component_tags:
             component_versions = ",".join(odtp_parse.parse_component_tags(component_tags))
         versions = odtp_parse.parse_versions(component_versions)
@@ -125,14 +177,14 @@ def workflow_entry(
             workflow=versions,
         )
     except Exception as e:
-        log.error(f"ERROR: {e}")
-        traceback.print_exc()
+        console.print(f"[bold red]❌ ERROR:[/bold red] An unexpected error occurred: {str(e)}")
+        log.exception("Unexpected error in workflow_entry")
+        raise typer.Exit(code=1)
     success_message = (
         f"SUCCESS: Workflow has been added:\n"
         f" - Workflow ID: {workflow_id}\n"
     )
-    log.info(success_message)
-    typer.echo(f"✅ {success_message}")
+    console.print(f"✅ {success_message}")
 
 
 @app.command()
@@ -141,6 +193,9 @@ def execution_entry(
     wf_id: str = typer.Option(
         None, "--workflow-id", help="Specify the workflow ID"
     ),
+    wf_name: str = typer.Option(
+        None, "--workflow-name", help="Specify the workflow name"
+    ),
     component_tags: str = typer.Option(
         None, "--component-tags", help="Specify the components-tags (component-name:version) separated by commas"
     ),
@@ -157,11 +212,11 @@ def execution_entry(
 ):
     try:
         if dt_name is None and dt_id is None:
-            raise typer.Exit("Please provide either --digital-twin-name or --digital-twin-id")
-
+            print("Please provide either --digital-twin-name or --digital-twin-id")
+            raise typer.Exit(code=1)
         if wf_id is None and component_tags is None:
-            raise typer.Exit("Please provide either --workflow-id or --component-tags")
-
+            print("Please provide either --workflow-id or --component-tags")
+            raise typer.Exit(code=1)
         if dt_name:
             dt_id = db.get_document_id_by_field_value("name", dt_name, "digitalTwins")
 
@@ -171,7 +226,7 @@ def execution_entry(
         if component_tags:
             component_versions = ",".join(odtp_parse.parse_component_tags(component_tags))
             versions = odtp_parse.parse_versions(component_versions)
-            workflow = db.get_or_create_workflow_by_versions(execution_name, versions)
+            workflow = db.get_workflow_or_create_by_versions(execution_name, versions)
         step_count = len(workflow.get("versions"))
         if parameter_files is None:
             parameters = db.get_default_parameters_for_workflow(workflow["versions"])
@@ -195,13 +250,14 @@ def execution_entry(
     except Exception as e:
         log.error(f"ERROR: {e}")
         traceback.print_exc()
-    success_message = (
-        f"SUCCESS: execution has been added: see above for the details.\n"
-        f" - execution id: {execution_id}\n"
-        f" - step_ids: {step_ids}\n"
-    )
-    log.info(success_message)
-    typer.echo(f"✅ {success_message}")
+    else:
+        success_message = (
+            f"SUCCESS: execution has been added: see above for the details.\n"
+            f" - execution id: {execution_id}\n"
+            f" - step_ids: {step_ids}\n"
+        )
+        log.info(success_message)
+        typer.echo(f"✅ {success_message}")
 
 
 if __name__ == "__main__":

odtp/dashboard/page_digital_twins/add.py

@@ -2,7 +2,7 @@
 from nicegui import ui
 import odtp.mongodb.db as db
 import odtp.dashboard.page_digital_twins.storage as storage
-import odtp.dashboard.page_digital_twins.validation as validation
+import odtp.helpers.validation as validation
 
 
 class DigitalTwinAddForm:

odtp/dashboard/page_digital_twins/validation.py

@@ -3,7 +3,7 @@
 import odtp.mongodb.db as db
 from odtp.helpers.settings import ODTP_SECRETS_DIR
 import odtp.dashboard.utils.helpers as helpers
-import odtp.dashboard.page_executions.validation as validation
+import odtp.helpers.validation as validation
 import odtp.dashboard.utils.ui_theme as ui_theme
 
 

odtp/dashboard/page_executions/add.py

@@ -3,7 +3,7 @@
 import odtp.mongodb.db as db
 import odtp.dashboard.page_users.workdir as workdir
 import odtp.dashboard.page_users.storage as storage
-import odtp.dashboard.page_users.validation as validation
+import odtp.helpers.validation as validation
 
 
 log = logging.getLogger("__name__")

odtp/dashboard/page_executions/validation.py

@@ -13,6 +13,10 @@ class OdtpLocalEnvironmentException(Exception):
 
 
 def check_project_folder_empty(project_folder):
+    if not os.path.exists(project_folder):
+        raise OdtpLocalEnvironmentException(
+            f"project folder {project_folder} does not exist. Please create it first."
+        )
     if not project_folder_is_empty(project_folder):
         raise OdtpLocalEnvironmentException(
             f"project folder {project_folder} was not empty"
@@ -22,7 +26,7 @@ def check_project_folder_empty(project_folder):
 def check_directory_folder_matches_execution(execution_id, project_folder):
     if not directory_folder_matches_execution(execution_id, project_folder):
         raise OdtpLocalEnvironmentException(
-            f"""project folder {project_folder} does not match execution. 
+            f"""project folder {project_folder} does not match execution.
             First run 'prepare' on an empty folder to prepare for the run of the execution"""
         )
 

odtp/dashboard/page_users/add.py

@@ -1,5 +1,10 @@
 from odtp.helpers.models import OdtpDotYamlSchema
 from pydantic import ValidationError
+import requests
+import odtp.mongodb.db as db
+from odtp.helpers.settings import GITHUB_TOKEN
+
+GITHUB_API_REPOS_URL = "https://api.github.com/users"
 
 
 class OdtpYmlException(Exception):
@@ -22,3 +27,43 @@ def validate_odtp_yml_file(yaml_data):
         raise OdtpYmlException(f"Validation failed for odtp.yml:\n{error_details}")
     except Exception as e:
         raise OdtpYmlException(f"Unexpected error during odtp.yml validation: {e}")
+
+
+import odtp.mongodb.db as db
+
+
+def validate_digital_twin_name_unique(digital_twin_name, user_id):
+    if len(digital_twin_name) < 6:
+        return False
+    digital_twins = db.get_collection(db.collection_digital_twins, query={"userRef": user_id})
+    digital_twin_names = {digital_twin.get("name") for digital_twin in digital_twins}
+    if digital_twin_name in digital_twin_names:
+        return False
+    return True
+
+
+def validate_github_user_name(github_user_name):
+    headers = {"Authorization": "token " + GITHUB_TOKEN}
+    git_api_user_url = f"{GITHUB_API_REPOS_URL}/{github_user_name}"
+    response = requests.get(git_api_user_url, headers=headers)
+    if not response.status_code == 200:
+        return False
+    return True
+
+
+def validate_user_name_unique(user_name):
+    users = db.get_collection(db.collection_users)
+    user_names = {user.get("displayName") for user in users}
+    if user_name in user_names:
+        return False
+    return True
+
+
+def validate_execution_name_unique(execution_name, digital_twin_id):
+    if len(execution_name) < 6:
+        return False
+    executions = db.get_collection(db.collection_executions, query={"digitalTwinRef": ObjectId(digital_twin_id)})
+    execution_names = {execution.get("title") for execution in executions}
+    if execution_name in execution_names:
+        return False
+    return True