workflows in one place working

dev-requirements.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.11
+# This file is autogenerated by pip-compile with Python 3.10
 # by the following command:
 #
 #    pip-compile --constraint=requirements.txt --extra=dev --output-file=dev-requirements.txt pyproject.toml
@@ -63,6 +63,8 @@ colorama==0.4.6
     #   omotes-rest (pyproject.toml)
 coverage[toml]==7.4.4
     # via pytest-cov
+exceptiongroup==1.2.1
+    # via pytest
 flake8==6.0.0
     # via
     #   flake8-docstrings
@@ -254,15 +256,25 @@ structlog==23.1.0
     # via
     #   -c requirements.txt
     #   omotes-rest (pyproject.toml)
+toml==0.10.2
+    # via setuptools-git-versioning
 tomli==2.0.1
-    # via black
+    # via
+    #   black
+    #   build
+    #   coverage
+    #   flake8-pyproject
+    #   mypy
+    #   pyproject-hooks
+    #   pytest
 types-flask-cors==4.0.0.20240405
     # via omotes-rest (pyproject.toml)
 types-protobuf==4.24.0.20240311
     # via omotes-rest (pyproject.toml)
 typing-extensions==4.7.1
     # via
     #   -c requirements.txt
+    #   marshmallow-dataclass
     #   mypy
     #   sqlalchemy
     #   typing-inspect

docker-compose.yml

@@ -17,7 +17,7 @@ services:
 
   omotes-rest:
 #    build: .
-    image: ghcr.io/project-omotes/omotes_rest:0.0.8
+    image: ghcr.io/project-omotes/omotes_rest:0.0.9
     networks:
       - omotes
       - mapeditor-net

requirements.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.11
+# This file is autogenerated by pip-compile with Python 3.10
 # by the following command:
 #
 #    pip-compile --output-file=requirements.txt pyproject.toml
@@ -116,6 +116,7 @@ structlog==23.1.0
     # via omotes-rest (pyproject.toml)
 typing-extensions==4.7.1
     # via
+    #   marshmallow-dataclass
     #   sqlalchemy
     #   typing-inspect
 typing-inspect==0.9.0

src/omotes_rest/__init__.py

@@ -44,8 +44,10 @@ def create_app(object_name: str) -> Flask:
 
     # Register blueprints.
     from omotes_rest.apis.job import api as job_api
+    from omotes_rest.apis.workflow import api as workflow_api
 
     api.register_blueprint(job_api)
+    api.register_blueprint(workflow_api)
 
     CORS(app, resources={r"/*": {"origins": "*"}})
 

src/omotes_rest/apis/api_dataclasses.py

@@ -8,6 +8,18 @@
 from marshmallow_dataclass import add_schema, dataclass
 
 
+@add_schema
+@dataclass
+class WorkflowResponse:
+    """Response with available workflows."""
+
+    Schema: ClassVar[Type[Schema]] = Schema
+
+    workflow_type_name: str
+    workflow_type_description_name: str
+    workflow_parameters: dict[str, Any] | None
+
+
 class JobRestStatus(Enum):
     """Possible job status."""
 

src/omotes_rest/apis/workflow.py

@@ -0,0 +1,26 @@
+import logging
+
+from flask_smorest import Blueprint
+from flask.views import MethodView
+from flask import jsonify, Response
+
+from omotes_rest.typed_app import current_app
+
+
+logger = logging.getLogger("omotes_rest")
+
+api = Blueprint(
+    "Workflow",
+    "Workflow",
+    url_prefix="/workflow",
+    description="Omotes workflows: retrieve the available workflow and their properties",
+)
+
+
+@api.route("/")
+class JobAPI(MethodView):
+    """Requests."""
+
+    def get(self) -> Response:
+        """Return a summary of all jobs."""
+        return jsonify(current_app.rest_if.get_available_workflows_dict())

src/omotes_rest/config.py

@@ -1,7 +1,7 @@
 import os
 
 
-class POSTGRESConfig:
+class PostgresConfig:
     """Retrieve POSTGRES configuration from environment variables."""
 
     host: str

src/omotes_rest/main.py

@@ -12,7 +12,6 @@
 from omotes_rest import create_app
 from omotes_rest.rest_interface import RestInterface
 from omotes_rest.settings import EnvSettings
-from omotes_rest.workflows import WORKFLOW_TYPE_MANAGER
 from omotes_rest.typed_app import current_app
 
 
@@ -87,7 +86,7 @@ def post_fork(_: Arbiter, __: SyncWorker) -> None:
     with app.app_context():
         """current_app is only within the app context"""
 
-        current_app.rest_if = RestInterface(WORKFLOW_TYPE_MANAGER)
+        current_app.rest_if = RestInterface()
         """Interface for this Omotes Rest service."""
 
         current_app.rest_if.start()

src/omotes_rest/postgres_interface.py

@@ -11,7 +11,7 @@
 import logging
 from omotes_rest.apis.api_dataclasses import JobRestStatus, JobInput
 from omotes_rest.db_models.job_rest import JobRest
-from omotes_rest.config import POSTGRESConfig
+from omotes_rest.config import PostgresConfig
 
 logger = logging.getLogger("omotes_rest")
 
@@ -60,7 +60,7 @@ def session_scope(do_expunge: bool = False) -> Generator[SQLSession, None, None]
         Session.remove()
 
 
-def initialize_db(application_name: str, config: POSTGRESConfig) -> Engine:
+def initialize_db(application_name: str, config: PostgresConfig) -> Engine:
     """Initialize the database connection by creating the engine.
 
     Also configure the default session maker.
@@ -112,12 +112,12 @@ class PostgresInterface:
     in this interface must set up a Session (scope) separately.
     """
 
-    db_config: POSTGRESConfig
+    db_config: PostgresConfig
     """Configuration on how to connect to the database."""
     engine: Engine
     """Engine for starting connections to the database."""
 
-    def __init__(self, postgres_config: POSTGRESConfig) -> None:
+    def __init__(self, postgres_config: PostgresConfig) -> None:
         """Create the PostgreSQL interface."""
         self.db_config = postgres_config
 

src/omotes_rest/rest_interface.py

@@ -9,12 +9,13 @@
     JobResult,
     JobProgressUpdate,
     JobStatusUpdate,
+    AvailableWorkflows,
 )
 from omotes_sdk.workflow_type import WorkflowTypeManager
 
 import logging
 from omotes_rest.postgres_interface import PostgresInterface
-from omotes_rest.config import POSTGRESConfig
+from omotes_rest.config import PostgresConfig
 from omotes_rest.apis.api_dataclasses import JobInput, JobStatusResponse
 from omotes_rest.db_models.job_rest import JobRestStatus, JobRest
 from omotes_rest.workflows import FRONTEND_NAME_TO_OMOTES_WORKFLOW_NAME
@@ -32,14 +33,15 @@ class RestInterface:
     workflow_type_manager: WorkflowTypeManager
     """Interface to Omotes."""
 
-    def __init__(self, workflow_type_manager: WorkflowTypeManager):
-        """Create the omotes rest interface.
-
-        :param workflow_type_manager: All available OMOTES workflow types.
-        """
-        self.omotes_if = OmotesInterface(EnvRabbitMQConfig(), workflow_type_manager)
-        self.postgres_if = PostgresInterface(POSTGRESConfig())
-        self.workflow_type_manager = workflow_type_manager
+    def __init__(
+        self,
+    ) -> None:
+        """Create the omotes rest interface."""
+        self.omotes_if = OmotesInterface(
+            EnvRabbitMQConfig(),
+            callback_on_available_workflows_update=self.handle_on_available_workflows_update,
+        )
+        self.postgres_if = PostgresInterface(PostgresConfig())
 
     def start(self) -> None:
         """Start the omotes rest interface."""
@@ -50,6 +52,16 @@ def stop(self) -> None:
         """Stop the omotes rest interface."""
         self.omotes_if.stop()
 
+    def handle_on_available_workflows_update(
+        self, available_workflows_pb: AvailableWorkflows
+    ) -> None:
+        """When the available workflows are updated.
+
+        :param available_workflows_pb: AvailableWorkflows protobuf message.
+        """
+        self.workflow_type_manager = WorkflowTypeManager.from_pb_message(available_workflows_pb)
+        logger.info("Updated the available workflows to: \n%s", self.workflow_type_manager)
+
     def handle_on_job_finished(self, job: Job, result: JobResult) -> None:
         """When a job is finished.
 
@@ -108,6 +120,13 @@ def handle_on_job_progress_update(self, job: Job, progress_update: JobProgressUp
             progress_message=progress_update.message,
         )
 
+    def get_available_workflows_dict(self) -> dict:
+        """Get the available workflows represented as dictionary.
+
+        :return: dictionary response.
+        """
+        return self.workflow_type_manager.to_dict()
+
     def submit_job(self, job_input: JobInput) -> JobStatusResponse:
         """When a job has a progress update.
 

src/omotes_rest/workflows.py

@@ -1,30 +1,3 @@
-from omotes_sdk.workflow_type import WorkflowTypeManager, WorkflowType
-
-# TODO to be retrieved via de omotes_sdk in the future
-WORKFLOW_TYPE_MANAGER = WorkflowTypeManager(
-    possible_workflows=[
-        WorkflowType(
-            workflow_type_name="grow_optimizer_default",
-            workflow_type_description_name="Grow Optimizer",
-        ),
-        WorkflowType(
-            workflow_type_name="grow_simulator", workflow_type_description_name="Grow Simulator"
-        ),
-        WorkflowType(
-            workflow_type_name="grow_optimizer_no_heat_losses",
-            workflow_type_description_name="Grow Optimizer without heat losses",
-        ),
-        WorkflowType(
-            workflow_type_name="grow_optimizer_with_pressure",
-            workflow_type_description_name="Grow Optimizer with pressure drops",
-        ),
-        WorkflowType(
-            workflow_type_name="simulator",
-            workflow_type_description_name="High fidelity simulator",
-        ),
-    ]
-)
-
 FRONTEND_NAME_TO_OMOTES_WORKFLOW_NAME = {
     "Draft Design - Quickscan Validation": "grow_optimizer_no_heat_losses",
     "Draft Design - Optimization": "grow_optimizer_default",

unit_test/test_main.py

@@ -1,13 +1,13 @@
 import unittest
-from omotes_rest.config import POSTGRESConfig
+from omotes_rest.config import PostgresConfig
 
 
 class MyTest(unittest.TestCase):
     def test__construct_postgres_config__no_exception(self) -> None:
         # Arrange
 
         # Act
-        result = POSTGRESConfig()
+        result = PostgresConfig()
 
         # Assert
         self.assertIsNotNone(result)