Improve error message for object validate

Author: dgarros

infrahub_sdk/ctl/menu.py

@@ -7,6 +7,7 @@
 from ..async_typer import AsyncTyper
 from ..ctl.client import initialize_client
 from ..ctl.utils import catch_exception, init_logging
+from ..exceptions import ObjectValidationError
 from ..spec.menu import MenuFile
 from .parameters import CONFIG_PARAM
 from .utils import load_yamlfile_from_disk_and_exit
@@ -44,11 +45,16 @@ async def load(
         schema = await client.schema.get(kind=file.spec.kind, branch=branch)
 
         for idx, item in enumerate(file.spec.data):
-            await file.spec.create_node(
-                client=client,
-                schema=schema,
-                data=item,
-                branch=branch,
-                default_schema_kind=file.spec.kind,
-                context={"list_index": idx},
-            )
+            try:
+                await file.spec.create_node(
+                    client=client,
+                    schema=schema,
+                    position=[idx + 1],
+                    data=item,
+                    branch=branch,
+                    default_schema_kind=file.spec.kind,
+                    context={"list_index": idx},
+                )
+            except ObjectValidationError as exc:
+                console.print(f"[red] {exc!s}")
+                raise typer.Exit(1)

infrahub_sdk/ctl/object.py

@@ -7,10 +7,14 @@
 from ..async_typer import AsyncTyper
 from ..ctl.client import initialize_client
 from ..ctl.utils import catch_exception, init_logging
-from ..exceptions import ValidationError
+from ..exceptions import ObjectValidationError, ValidationError
 from ..spec.object import ObjectFile
 from .parameters import CONFIG_PARAM
-from .utils import load_yamlfile_from_disk_and_exit
+from .utils import (
+    display_object_validate_format_error,
+    display_object_validate_format_success,
+    load_yamlfile_from_disk_and_exit,
+)
 
 app = AsyncTyper()
 console = Console()
@@ -45,19 +49,22 @@ async def load(
     for file in files:
         try:
             await file.validate_format(client=client, branch=branch)
-        except ValidationError as e:
+        except ValidationError as exc:
             has_errors = True
-            if file.multiple_documents:
-                console.print(f"[red] File '{file.location}' [{file.document_position}] is not valid!")
-            else:
-                console.print(f"[red] File '{file.location}' is not valid!")
-            console.print(f"[red] {e.message}")
+            display_object_validate_format_error(file=file, error=exc, console=console)
 
     if has_errors:
         raise typer.Exit(1)
 
     for file in files:
-        await file.process(client=client, branch=branch)
+        try:
+            await file.process(client=client, branch=branch)
+        except ObjectValidationError as exc:
+            has_errors = True
+            console.print(f"[red] {exc!s}")
+
+    if has_errors:
+        raise typer.Exit(1)
 
 
 @app.command()
@@ -81,17 +88,10 @@ async def validate(
     for file in files:
         try:
             await file.validate_format(client=client, branch=branch)
-            if file.multiple_documents:
-                console.print(f"[green] File '{file.location}' [{file.document_position}] is Valid!")
-            else:
-                console.print(f"[green] File '{file.location}' is Valid!")
-        except ValidationError as e:
+            display_object_validate_format_success(file=file, console=console)
+        except ValidationError as exc:
             has_errors = True
-            if file.multiple_documents:
-                console.print(f"[red] File '{file.location}' [{file.document_position}] is not valid!")
-            else:
-                console.print(f"[red] File '{file.location}' is not valid!")
-            console.print(f"[red] {e.message}")
+            display_object_validate_format_error(file=file, error=exc, console=console)
 
     if has_errors:
         raise typer.Exit(1)

infrahub_sdk/ctl/utils.py

@@ -25,13 +25,15 @@
     SchemaNotFoundError,
     ServerNotReachableError,
     ServerNotResponsiveError,
+    ValidationError,
 )
 from ..yaml import YamlFile
 from .client import initialize_client_sync
 from .exceptions import QueryNotFoundError
 
 if TYPE_CHECKING:
     from ..schema.repository import InfrahubRepositoryConfig
+    from ..spec.object import ObjectFile
 
 YamlFileVar = TypeVar("YamlFileVar", bound=YamlFile)
 T = TypeVar("T")
@@ -199,3 +201,22 @@ def load_yamlfile_from_disk_and_exit(
         raise typer.Exit(1)
 
     return data_files
+
+
+def display_object_validate_format_success(file: ObjectFile, console: Console) -> None:
+    if file.multiple_documents:
+        console.print(f"[green] File '{file.location}' [{file.document_position}] is Valid!")
+    else:
+        console.print(f"[green] File '{file.location}' is Valid!")
+
+
+def display_object_validate_format_error(file: ObjectFile, error: ValidationError, console: Console) -> None:
+    if file.multiple_documents:
+        console.print(f"[red] File '{file.location}' [{file.document_position}] is not valid!")
+    else:
+        console.print(f"[red] File '{file.location}' is not valid!")
+    if error.messages:
+        for message in error.messages:
+            console.print(f"[red] {message}")
+    else:
+        console.print(f"[red] {error.message}")

infrahub_sdk/exceptions.py

@@ -113,12 +113,25 @@ def __init__(self, name: str, message: str | None = None):
 
 
 class ValidationError(Error):
-    def __init__(self, identifier: str, message: str):
+    def __init__(self, identifier: str, message: str | None = None, messages: list[str] | None = None):
         self.identifier = identifier
         self.message = message
+        self.messages = messages
+        if not messages and not message:
+            self.message = f"Validation Error for {self.identifier}"
         super().__init__(self.message)
 
 
+class ObjectValidationError(Error):
+    def __init__(self, position: list[int | str], message: str):
+        self.position = position
+        self.message = message
+        super().__init__(self.message)
+
+    def __str__(self) -> str:
+        return f"{'.'.join(map(str, self.position))}: {self.message}"
+
+
 class AuthenticationError(Error):
     def __init__(self, message: str | None = None):
         self.message = message or "Authentication Error, unable to execute the query."