feat: finish implementation and refactorings for entrypoint validation

Author: jkglasbrenner

src/dioptra/restapi/errors.py

@@ -348,11 +348,11 @@ def __init__(self):
         )
 
 
-class EntrypointWorkflowYamlValidationError(DioptraError):
-    """The entrypoint worklfow yaml is invalid."""
+class EntrypointValidationError(DioptraError):
+    """The proposed inputs for the entrypoint are invalid."""
 
     def __init__(self, issues: list[ValidationIssue]):
-        super().__init__("The entrypoint worklfow yaml is invalid.")
+        super().__init__("The proposed inputs for the entrypoint are invalid.")
         self.issues = issues
 
 
@@ -557,9 +557,9 @@ def handle_base_error(error: DioptraError):
         log.debug(error.to_message())
         return error_result(error, http.HTTPStatus.BAD_REQUEST, {})
 
-    @api.errorhandler(DioptraError)
+    @api.errorhandler(EntrypointValidationError)
     def handle_entrypoint_workflow_yaml_validation_error(
-        error: EntrypointWorkflowYamlValidationError,
+        error: EntrypointValidationError,
     ):
         log.debug(error.to_message())
         return error_result(
@@ -572,7 +572,7 @@ def handle_entrypoint_workflow_yaml_validation_error(
                         "severity": str(issue.severity),
                         "message": issue.message,
                     }
-                    for issue in error.args[0]
+                    for issue in error.issues
                 ]
             },
         )

src/dioptra/restapi/v1/shared/build_task_engine_dict.py

@@ -14,6 +14,7 @@
 #
 # ACCESS THE FULL CC BY 4.0 LICENSE HERE:
 # https://creativecommons.org/licenses/by/4.0/legalcode
+from collections.abc import Sequence
 from typing import Any, Protocol
 
 
@@ -24,43 +25,73 @@ class EntryPointParameterProtocol(Protocol):
 
 
 class EntryPointProtocol(Protocol):
-    task_graph: str
-    parameters: list[EntryPointParameterProtocol]
+    @property
+    def task_graph(self) -> str:  # fmt: skip
+        ...
+
+    @property
+    def parameters(self) -> Sequence[EntryPointParameterProtocol]:  # fmt: skip
+        ...
 
 
 class PluginTaskParameterTypeProtocol(Protocol):
-    name: str
-    structure: dict[str, Any] | None
+    @property
+    def name(self) -> str:  # fmt: skip
+        ...
+
+    @property
+    def structure(self) -> dict[str, Any] | None:  # fmt: skip
+        ...
 
 
 class PluginTaskInputParameterProtocol(Protocol):
     parameter_number: int
     name: str
     required: bool
-    parameter_type: PluginTaskParameterTypeProtocol
+
+    @property
+    def parameter_type(self) -> PluginTaskParameterTypeProtocol:  # fmt: skip
+        ...
 
 
 class PluginTaskOutputParameterProtocol(Protocol):
     parameter_number: int
     name: str
-    parameter_type: PluginTaskParameterTypeProtocol
+
+    @property
+    def parameter_type(self) -> PluginTaskParameterTypeProtocol:  # fmt: skip
+        ...
 
 
 class PluginTaskProtocol(Protocol):
     plugin_task_name: str
-    input_parameters: list[PluginTaskInputParameterProtocol]
-    output_parameters: list[PluginTaskOutputParameterProtocol]
+
+    @property
+    def input_parameters(self) -> Sequence[PluginTaskInputParameterProtocol]:  # noqa: B950; fmt: skip
+        ...
+
+    @property
+    def output_parameters(self) -> Sequence[PluginTaskOutputParameterProtocol]:  # noqa: B950; fmt: skip
+        ...
 
 
 class PluginFileProtocol(Protocol):
     filename: str
-    tasks: list[PluginTaskProtocol]
+
+    @property
+    def tasks(self) -> Sequence[PluginTaskProtocol]:  # fmt: skip
+        ...
 
 
 class PluginProtocol(Protocol):
     name: str
 
 
 class PluginPluginFileProtocol(Protocol):
-    plugin: PluginProtocol
-    plugin_file: PluginFileProtocol
+    @property
+    def plugin(self) -> PluginProtocol:  # fmt: skip
+        ...
+
+    @property
+    def plugin_file(self) -> PluginFileProtocol:  # fmt: skip
+        ...