feat(pipeline): add IASO widget implementation (#255)

* feat(pipeline): adds iaso widget

* linting

Author: nazarfil

examples/pipelines/iaso/pipeline.py

@@ -0,0 +1,32 @@
+"""Example pipeline to get data elements from IASO."""
+
+from openhexa.sdk import current_run, parameter, pipeline
+from openhexa.sdk.pipelines.parameter import IASOWidget
+from openhexa.sdk.workspaces.connection import IASOConnection
+
+
+@pipeline(name="IASO Data Elements")
+@parameter("iaso_con", type=IASOConnection, required=True)
+@parameter(
+    "forms",
+    type=str,
+    required=True,
+    widget=IASOWidget.FORMS,
+    multiple=True,
+    connection="iaso_con",
+)
+def iaso(iaso_con, forms):
+    """Get forms from IASO."""
+    print_forms(iaso_con, forms)
+
+
+@iaso.task
+def print_forms(iaso_con, forms):
+    """Print forms."""
+    current_run.log_info("Printing forms")
+
+    current_run.log_info(f"Forms: {forms}")
+
+
+if __name__ == "__main__":
+    iaso()

openhexa/sdk/__init__.py

@@ -2,7 +2,7 @@
 
 from .datasets import Dataset
 from .pipelines import current_run, parameter, pipeline
-from .pipelines.parameter import DHIS2Widget
+from .pipelines.parameter import DHIS2Widget, IASOWidget
 from .workspaces import workspace
 from .workspaces.connection import (
     CustomConnection,
@@ -21,6 +21,7 @@
     "DHIS2Connection",
     "DHIS2Widget",
     "IASOConnection",
+    "IASOWidget",
     "PostgreSQLConnection",
     "GCSConnection",
     "S3Connection",

openhexa/sdk/pipelines/parameter.py

@@ -359,6 +359,14 @@ def validate(self, value: typing.Any | None) -> Dataset:
 }
 
 
+class IASOWidget(StrEnum):
+    """Enum for IASO widgets."""
+
+    FORMS = "IASO_FORMS"
+    ORG_UNITS = "IASO_ORG_UNITS"
+    PROJECTS = "IASO_PROJECTS"
+
+
 class DHIS2Widget(StrEnum):
     """Enum for DHIS2 widgets."""
 
@@ -393,7 +401,7 @@ def __init__(
         choices: typing.Sequence | None = None,
         help: str | None = None,
         default: typing.Any | None = None,
-        widget: DHIS2Widget | None = None,
+        widget: DHIS2Widget | IASOWidget | None = None,
         connection: str | None = None,
         required: bool = True,
         multiple: bool = False,
@@ -531,18 +539,23 @@ def _validate_default(self, default: typing.Any, multiple: bool):
 
 def validate_parameters(parameters: list[Parameter]):
     """Validate the provided connection parameters if they relate to existing connection parameter."""
-    supported_connection_types = {DHIS2ConnectionType}
+    supported_connection_types = {DHIS2ConnectionType, IASOConnectionType}
     connection_parameters = {p.code for p in parameters if type(p.type) in supported_connection_types}
 
     for parameter in parameters:
         if parameter.connection and parameter.connection not in connection_parameters:
             raise InvalidParameterError(
                 f"Connection field '{parameter.code}' references a non-existing connection parameter '{parameter.connection}'"
             )
-        if parameter.widget and parameter.widget in DHIS2Widget and not parameter.connection:
+        if (
+            parameter.widget
+            and (parameter.widget in DHIS2Widget or parameter.widget in IASOWidget)
+            and not parameter.connection
+        ):
             raise InvalidParameterError(
-                f"DHIS2 widgets require a connection parameter. Please provide a connection parameter for {parameter.code}. "
-                f"Example: @parameter('{parameter.code}', type=str, widget=DHIS2Widget.{parameter.widget}, connection='my_connection')"
+                f"Widgets require a connection parameter. Please provide a connection parameter for {parameter.code}. "
+                f"Example: @parameter('my_connection', ...)"
+                f"Example: @parameter('{parameter.code}', widget = ..., connection='my_connection')"
             )
 
 
@@ -563,7 +576,7 @@ def parameter(
     name: str | None = None,
     choices: typing.Sequence | None = None,
     help: str | None = None,
-    widget: DHIS2Widget | None = None,
+    widget: DHIS2Widget | IASOWidget | None = None,
     connection: str | None = None,
     default: typing.Any | None = None,
     required: bool = True,
@@ -586,11 +599,10 @@ def parameter(
         interface)
     help : str, optional
         An optional help text to be displayed in the web interface
-    widget : DHIS2Widget, optional
-        An optional widget type for the parameter (only used if the parameter type is DHIS2Connection)
+    widget : DHIS2Widget|IASOWidget, optional
+        An optional widget type for the parameter (only used if the parameter type is DHIS2Connection, IASOConnection)
     connection : str, optional
-        An optional connection parameter that will be used to fetch the list of choices for the parameter (only used
-        if the parameter type is DHIS2Connection)
+        An optional connection parameter that will be used to link widget to the connection.
     default : any, optional
         An optional default value for the parameter (should be of the type defined by the type parameter)
     required : bool, default=True

openhexa/sdk/pipelines/runtime.py

@@ -17,6 +17,7 @@
 from openhexa.sdk.pipelines.parameter import (
     TYPES_BY_PYTHON_TYPE,
     DHIS2Widget,
+    IASOWidget,
     Parameter,
     validate_parameters,
 )
@@ -170,6 +171,8 @@ def _get_decorator_arg_value(decorator: ast.Call, arg: Argument, index: int) ->
             elif isinstance(keyword.value, ast.Attribute):
                 if keyword.value.attr in DHIS2Widget.__members__:
                     return getattr(DHIS2Widget, keyword.value.attr), True
+                elif keyword.value.attr in IASOWidget.__members__:
+                    return getattr(IASOWidget, keyword.value.attr), True
                 else:
                     raise ValueError(f"Unsupported widget: {keyword.value.attr}")
 

tests/test_ast.py

@@ -6,7 +6,7 @@
 from unittest.mock import patch
 
 from openhexa.sdk.pipelines.exceptions import InvalidParameterError, PipelineNotFound
-from openhexa.sdk.pipelines.parameter import DHIS2Widget
+from openhexa.sdk.pipelines.parameter import DHIS2Widget, IASOWidget
 from openhexa.sdk.pipelines.runtime import get_pipeline
 
 
@@ -428,7 +428,7 @@ def test_pipeline_with_unsupported_parameter(self):
             with self.assertRaises(InvalidParameterError):
                 get_pipeline(tmpdirname)
 
-    def test_pipeline_with_connection_parameter(self):
+    def test_pipeline_with_connection_parameter_for_dhis2(self):
         """The file contains a @pipeline decorator and a @parameter decorator with a connection type."""
         with tempfile.TemporaryDirectory() as tmpdirname:
             with open(f"{tmpdirname}/pipeline.py", "w") as f:
@@ -485,6 +485,63 @@ def test_pipeline_with_connection_parameter(self):
                 },
             )
 
+    def test_pipeline_with_connection_parameter_for_iaso(self):
+        """The file contains a @pipeline decorator and a @parameter decorator with a connection type."""
+        with tempfile.TemporaryDirectory() as tmpdirname:
+            with open(f"{tmpdirname}/pipeline.py", "w") as f:
+                f.write(
+                    "\n".join(
+                        [
+                            "from openhexa.sdk.pipelines import pipeline, parameter",
+                            "from openhexa.sdk.pipelines.widgets import IASOWidget",
+                            "",
+                            "@parameter('iaso_con', name='IASO Connection', type=IASOConnection, required=True)",
+                            "@parameter('forms', name='Forms', type=str, widget=IASOWidget.FORMS, connection='iaso_con', required=True)",
+                            "@pipeline('Test pipeline')",
+                            "def test_pipeline():",
+                            "    pass",
+                            "",
+                        ]
+                    )
+                )
+            pipeline = get_pipeline(tmpdirname)
+            self.maxDiff = None
+            self.assertEqual(
+                pipeline.to_dict(),
+                {
+                    "name": "Test pipeline",
+                    "function": None,
+                    "tasks": [],
+                    "parameters": [
+                        {
+                            "code": "iaso_con",
+                            "type": "iaso",
+                            "name": "IASO Connection",
+                            "default": None,
+                            "multiple": False,
+                            "choices": None,
+                            "widget": None,
+                            "connection": None,
+                            "help": None,
+                            "required": True,
+                        },
+                        {
+                            "code": "forms",
+                            "type": "str",
+                            "name": "Forms",
+                            "widget": IASOWidget.FORMS.value,
+                            "connection": "iaso_con",
+                            "default": None,
+                            "multiple": False,
+                            "choices": None,
+                            "help": None,
+                            "required": True,
+                        },
+                    ],
+                    "timeout": None,
+                },
+            )
+
     def test_pipeline_wit_wrong_connection_parameter(self):
         """The file contains a @pipeline decorator and a @parameter decorator with a non-existing connection type."""
         with tempfile.TemporaryDirectory() as tmpdirname: