orchestrator-core 3.1.1__tar.gz → 3.1.2__tar.gz

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 3.1.1
+current_version = 3.1.2
 commit = False
 tag = False
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(rc(?P<build>\d+))?

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/.github/workflows/run-codspeed-tests.yml

@@ -61,7 +61,7 @@ jobs:
 
       - uses: CodSpeedHQ/action@v3
         with:
-          run: CACHE_URI=redis://redis DATABASE_URI=postgresql+psycopg://$POSTGRES_USER:$POSTGRES_PASSWORD@$POSTGRES_HOST/$POSTGRES_DB pytest test/unit_tests --codspeed
+          run: CACHE_URI=redis://redis DATABASE_URI=postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@$POSTGRES_HOST/$POSTGRES_DB pytest test/unit_tests --codspeed
           token: ${{ secrets.CODSPEED_TOKEN }}
         env:
           POSTGRES_DB: orchestrator-core-test

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/.github/workflows/run-linting-tests.yml

@@ -5,9 +5,9 @@ name: Linting tests
 
 on:
   push:
-  pull_request:
-    branches: [master]
+    branches: [ main ]
   workflow_call:
+  pull_request:
 
 jobs:
   build:

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/.github/workflows/run-unit-tests.yml

@@ -1,7 +1,9 @@
 name: Unit tests
 on:
   push:
+    branches: [ main ]
   workflow_call:
+  pull_request:
 
 jobs:
   container_job:
@@ -51,7 +53,7 @@ jobs:
         env:
           FLIT_ROOT_INSTALL: 1
       - name: Run Unit tests
-        run: CACHE_URI=redis://redis DATABASE_URI=postgresql+psycopg://$POSTGRES_USER:$POSTGRES_PASSWORD@$POSTGRES_HOST/$POSTGRES_DB  pytest --cov-branch --cov=orchestrator --cov-report=xml --ignore=test --ignore=orchestrator/devtools --ignore=examples --ignore=docs --ignore=orchestrator/vendor
+        run: CACHE_URI=redis://redis DATABASE_URI=postgresql://$POSTGRES_USER:$POSTGRES_PASSWORD@$POSTGRES_HOST/$POSTGRES_DB  pytest --cov-branch --cov=orchestrator --cov-report=xml --ignore=test --ignore=orchestrator/devtools --ignore=examples --ignore=docs --ignore=orchestrator/vendor
         env:
           POSTGRES_DB: orchestrator-core-test
           POSTGRES_USER: nwa

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/.pre-commit-config.yaml

@@ -17,13 +17,12 @@ repos:
     rev: v0.9.6
     hooks:
       - id: ruff
-        args: [ --fix, --exit-non-zero-on-fix, --show-fixes ]
+        args: [--fix, --exit-non-zero-on-fix, --show-fixes]
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v5.0.0
     hooks:
       - id: trailing-whitespace
-        exclude:
-          .bumpversion.cfg
+        exclude: .bumpversion.cfg
         args: [--markdown-linebreak-ext=md]
       - id: end-of-file-fixer
       - id: check-docstring-first
@@ -62,7 +61,7 @@ repos:
         name: mypy
         language: system
         entry: "mypy"
-        types: [ python ]
+        types: [python]
         require_serial: true
         verbose: true
         args:

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orchestrator-core
-Version: 3.1.1
+Version: 3.1.2
 Summary: This is the orchestrator workflow engine.
 Requires-Python: >=3.11,<3.14
 Classifier: Intended Audience :: Information Technology
@@ -28,7 +28,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
 Classifier: Topic :: Internet :: WWW/HTTP
 License-File: LICENSE
-Requires-Dist: alembic==1.14.1
+Requires-Dist: alembic==1.15.2
 Requires-Dist: anyio>=3.7.0
 Requires-Dist: click==8.*
 Requires-Dist: deprecated
@@ -37,18 +37,18 @@ Requires-Dist: fastapi~=0.115.2
 Requires-Dist: fastapi-etag==0.4.0
 Requires-Dist: more-itertools~=10.6.0
 Requires-Dist: itsdangerous
-Requires-Dist: Jinja2==3.1.5
-Requires-Dist: orjson==3.10.15
-Requires-Dist: psycopg[binary]==3.2.5
-Requires-Dist: pydantic[email]~=2.10.6
+Requires-Dist: Jinja2==3.1.6
+Requires-Dist: orjson==3.10.16
+Requires-Dist: psycopg2-binary==2.9.10
+Requires-Dist: pydantic[email]~=2.8.2
 Requires-Dist: pydantic-settings~=2.8.0
 Requires-Dist: python-dateutil==2.8.2
 Requires-Dist: python-rapidjson>=1.18,<1.21
-Requires-Dist: pytz==2025.1
-Requires-Dist: redis==5.0.3
+Requires-Dist: pytz==2025.2
+Requires-Dist: redis==5.1.1
 Requires-Dist: schedule==1.1.0
-Requires-Dist: sentry-sdk[fastapi]~=2.22.0
-Requires-Dist: SQLAlchemy==2.0.38
+Requires-Dist: sentry-sdk[fastapi]~=2.25.1
+Requires-Dist: SQLAlchemy==2.0.40
 Requires-Dist: SQLAlchemy-Utils==0.41.2
 Requires-Dist: structlog
 Requires-Dist: typer==0.15.2

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/docs/getting-started/versions.md

@@ -5,7 +5,7 @@ The orchestrator backend has the following requirements
 For the backend you need the following packages:
 
 * Python >= 3.11
-* Postgres >= 14
+* Postgres >= 15
 
 ### Optional dependencies
 * Redis

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/docs/reference-docs/app/scaling.md

@@ -108,6 +108,112 @@ The code above sets our local Celery instance (which initializes the workflows)
 going to be used by the orchestrator-core. Without this code, the orchestrator-core would be only aware of a limited
 set of workflows that are part of orchestrator-core itself.
 
+### An example implementation
+
+When using Celery and Websockets you can use the following example and change it to your needs.
+
+```python
+"""This module contains functions and classes necessary for celery worker processes.
+
+When the orchestrator-core's thread process executor is specified as "celery", the `OrchestratorCore` FastAPI
+application registers celery-specific task functions and `start_process` and `resume_process` now defer to the
+celery task queue.
+
+Celery's task queue enables features like nightly validations by providing a task queue and workers to execute
+workflows that are all started in parallel, which would crash a single-threaded orchestrator-core.
+
+The application flow looks like this when "celery" is the executor (and websockets are enabled):
+
+- FastAPI application validates form input, and places a task on celery queue (create new process).
+  - If websockets are enabled, a connection should exist already b/t the client and backend.
+- FastAPI application begins watching redis pubsub channel for process updates from celery.
+- Celery worker picks up task from queue and begins executing.
+- On each step completion, it publishes state information to redis pubsub channel.
+- FastAPI application grabs this information and publishes it to the client websocket connection.
+
+A celery worker container will start by calling this module instead of `main.py` like so:
+```sh
+celery -A esnetorch.celery_worker worker -E -l INFO -Q new_tasks,resume_tasks,new_workflows,resume_workflows
+```
+
+* `-A` points to this module where the worker class is defined
+* `-E` sends task-related events (capturable and monitorable)
+* `-l` is the short flag for --loglevel
+* `-Q` specifies the queues which the worker should watch for new tasks
+
+See https://workfloworchestrator.org/orchestrator-core/reference-docs/app/scaling for more information.
+"""
+
+from uuid import UUID
+
+from celery import Celery
+from celery.signals import worker_shutting_down
+from orchestrator.db import init_database
+from orchestrator.domain import SUBSCRIPTION_MODEL_REGISTRY
+from orchestrator.services.tasks import initialise_celery
+from orchestrator.types import BroadcastFunc
+from orchestrator.websocket import broadcast_process_update_to_websocket, init_websocket_manager
+from orchestrator.websocket.websocket_manager import WebSocketManager
+from orchestrator.workflows import ALL_WORKFLOWS
+from structlog import get_logger
+
+from esnetorch.settings import app_settings
+
+
+logger = get_logger(__name__)
+
+
+def process_broadcast_fn(process_id: UUID) -> None:
+    # Catch all exceptions as broadcasting failure is noncritical to workflow completion
+    try:
+        broadcast_process_update_to_websocket(process_id)
+    except Exception as e:
+        logger.exception(e)
+
+
+class OrchestratorWorker(Celery):
+    websocket_manager: WebSocketManager
+    process_broadcast_fn: BroadcastFunc
+
+    def on_init(self) -> None:
+        init_database(app_settings)
+
+        # Prepare the wrapped_websocket_manager
+        # Note: cannot prepare the redis connections here as broadcasting is async
+        self.websocket_manager = init_websocket_manager(app_settings)
+        self.process_broadcast_fn = process_broadcast_fn
+
+        # Load the products and load the workflows
+        import esnetorch.products  # noqa: F401  Side-effects
+        import esnetorch.workflows  # noqa: F401  Side-effects
+
+        logger.info(
+            "Loaded the workflows and products",
+            workflows=len(ALL_WORKFLOWS.values()),
+            products=len(SUBSCRIPTION_MODEL_REGISTRY.values()),
+        )
+
+    def close(self) -> None:
+        super().close()
+
+
+celery = OrchestratorWorker(
+    f"{app_settings.SERVICE_NAME}-worker", broker=str(app_settings.CACHE_URI), include=["orchestrator.services.tasks"]
+)
+
+if app_settings.TESTING:
+    celery.conf.update(backend=str(app_settings.CACHE_URI), task_ignore_result=False)
+else:
+    celery.conf.update(task_ignore_result=True)
+
+celery.conf.update(
+    result_expires=3600,
+    worker_prefetch_multiplier=1,
+    worker_send_task_event=True,
+    task_send_sent_event=True,
+)
+```
+
 ### Running locally
 
 If you want to test your application locally you have to start both the orchestrator-api and one or more workers.

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/docs/reference-docs/workflows/callbacks.md

@@ -168,3 +168,11 @@ def create_l2vpn() -> StepList:
         >> set_status(SubscriptionLifecycle.ACTIVE)
     )
 ```
+
+## Callback progress during execution
+
+For long-running jobs, such as executing Terraform or Ansible playbooks, the Orchestrator allows callback jobs to send real-time progress updates which can be used to provide operators with feedback on the progress of the running task.
+
+Progress updates should be delivered to `{callback_route}/progress`, where `"/progress"` is a fixed endpoint appended to the callback URL.
+
+The remote service should send a JSON or plain string payload with each progress callback, this replaces the previous progress update and refreshes the UI. Once the final callback is triggered and the job completes, progress updates are removed, leaving only the callback result. Therefore, all troubleshooting or diagnostic information must be included in the final callback payload, as progress updates are not retained for debugging.

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/docs/workshops/beginner/macos.md

@@ -10,14 +10,14 @@ This installation instruction assumes the use of [Homebrew](https://brew.sh/).
 The following software dependencies need to be installed:
 
 * Python 3.11
-* PostgreSQL (version >=11)
+* Postgres >= 15
 * virtualenvwrapper (or use any other tool to create virtual Python
   environments)
 * Node.js (version 14)
 * yarn
 
 ``` shell
-brew install python@3.11 postgresql@13 virtualenvwrapper node@14 yarn
+brew install python@3.11 postgresql@15 virtualenvwrapper node@14 yarn
 ```
 
 ### Step 2 - Database setup
@@ -26,7 +26,7 @@ Start the database server and create the database with the following commands,
 use `nwa` as password:
 
 ``` shell
-brew services start postgresql@13
+brew services start postgresql@15
 createuser -sP nwa
 createdb orchestrator-core -O nwa
 ```

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 SURF.
+# Copyright 2019-2025 SURF, GÉANT.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -13,7 +13,7 @@
 
 """This is the orchestrator workflow engine."""
 
-__version__ = "3.1.1"
+__version__ = "3.1.2"
 
 from orchestrator.app import OrchestratorCore
 from orchestrator.settings import app_settings

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/api/api_v1/api.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 SURF.
+# Copyright 2019-2020 SURF, GÉANT.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/api/api_v1/endpoints/processes.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 SURF.
+# Copyright 2019-2025 SURF, GÉANT, ESnet.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -40,13 +40,7 @@ from orchestrator.db.filters import Filter
 from orchestrator.db.filters.process import filter_processes
 from orchestrator.db.sorting import Sort, SortOrder
 from orchestrator.db.sorting.process import sort_processes
-from orchestrator.schemas import (
-    ProcessIdSchema,
-    ProcessResumeAllSchema,
-    ProcessSchema,
-    ProcessStatusCounts,
-    Reporter,
-)
+from orchestrator.schemas import ProcessIdSchema, ProcessResumeAllSchema, ProcessSchema, ProcessStatusCounts, Reporter
 from orchestrator.security import authenticate
 from orchestrator.services.process_broadcast_thread import api_broadcast_process_data
 from orchestrator.services.processes import (
@@ -58,6 +52,7 @@ from orchestrator.services.processes import (
     load_process,
     resume_process,
     start_process,
+    update_awaiting_process_progress,
 )
 from orchestrator.services.settings import get_engine_settings
 from orchestrator.settings import app_settings
@@ -138,9 +133,12 @@ async def new_process(
     request: Request,
     json_data: list[dict[str, Any]] | None = Body(...),
     user: str = Depends(user_name),
+    user_model: OIDCUserModel | None = Depends(authenticate),
 ) -> dict[str, UUID]:
     broadcast_func = api_broadcast_process_data(request)
-    process_id = start_process(workflow_key, user_inputs=json_data, user=user, broadcast_func=broadcast_func)
+    process_id = start_process(
+        workflow_key, user_inputs=json_data, user_model=user_model, user=user, broadcast_func=broadcast_func
+    )
 
     return {"id": process_id}
 
@@ -197,6 +195,28 @@ def continue_awaiting_process_endpoint(
         raise_status(HTTPStatus.NOT_FOUND, str(e))
 
 
+@router.post(
+    "/{process_id}/callback/{token}/progress",
+    response_model=None,
+    status_code=HTTPStatus.OK,
+    dependencies=[Depends(check_global_lock, use_cache=False)],
+)
+def update_progress_on_awaiting_process_endpoint(
+    process_id: UUID,
+    token: str,
+    data: str | State = Body(...),
+) -> None:
+    process = _get_process(process_id)
+
+    if process.last_status != ProcessStatus.AWAITING_CALLBACK:
+        raise_status(HTTPStatus.CONFLICT, "This process is not in an awaiting state.")
+
+    try:
+        update_awaiting_process_progress(process, token=token, data=data)
+    except AssertionError as exc:
+        raise_status(HTTPStatus.NOT_FOUND, str(exc))
+
+
 @router.put(
     "/resume-all", response_model=ProcessResumeAllSchema, dependencies=[Depends(check_global_lock, use_cache=False)]
 )

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/api/api_v1/endpoints/settings.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 SURF.
+# Copyright 2019-2020 SURF, GÉANT.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/api/api_v1/endpoints/subscriptions.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 SURF.
+# Copyright 2019-2020 SURF, GÉANT.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/app.py

@@ -5,7 +5,7 @@ This module contains the main `OrchestratorCore` class for the `FastAPI` backend
 provides the ability to run the CLI.
 """
 
-# Copyright 2019-2020 SURF, ESnet
+# Copyright 2019-2020 SURF, ESnet, GÉANT.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/cli/database.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 SURF, ESnet
+# Copyright 2019-2025 SURF, ESnet, GÉANT.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/cli/generator/generator/migration.py

@@ -31,16 +31,13 @@ from orchestrator.cli.generator.generator.helpers import (
     sort_product_blocks_by_dependencies,
 )
 from orchestrator.cli.generator.generator.settings import product_generator_settings as settings
-from orchestrator.settings import convert_database_uri
 
 logger = structlog.getLogger(__name__)
 
 
 def create_migration_file(message: str, head: str) -> Path | None:
-    if environ.get("DATABASE_URI"):
-        environ.update({"DATABASE_URI": convert_database_uri(environ["DATABASE_URI"])})
-    else:
-        environ.update({"DATABASE_URI": "postgresql+psycopg://nwa:nwa@localhost/orchestrator-core"})
+    if not environ.get("DATABASE_URI"):
+        environ.update({"DATABASE_URI": "postgresql://nwa:nwa@localhost/orchestrator-core"})
     if not environ.get("PYTHONPATH"):
         environ.update({"PYTHONPATH": "."})
     logger.info(

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/cli/migrate_tasks.py

@@ -1,3 +1,16 @@
+# Copyright 2019-2025 SURF, GÉANT.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 import itertools
 import operator
 from collections.abc import Iterable

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/config/assignee.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 SURF.
+# Copyright 2019-2025 SURF, GÉANT.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/db/__init__.py

@@ -19,6 +19,7 @@ from orchestrator.db.database import Database, transactional
 from orchestrator.db.models import (  # noqa: F401
     EngineSettingsTable,
     FixedInputTable,
+    InputStateTable,
     ProcessStepTable,
     ProcessSubscriptionTable,
     ProcessTable,
@@ -85,6 +86,7 @@ __all__ = [
     "SubscriptionMetadataTable",
     "ResourceTypeTable",
     "FixedInputTable",
+    "InputStateTable",
     "EngineSettingsTable",
     "WorkflowTable",
     "SubscriptionCustomerDescriptionTable",

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/db/models.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 SURF.
+# Copyright 2019-2020 SURF, GÉANT.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -92,7 +92,7 @@ class InputStateTable(BaseModel):
 
     input_state_id = mapped_column(UUIDType, primary_key=True, server_default=text("uuid_generate_v4()"), index=True)
     process_id = mapped_column("pid", UUIDType, ForeignKey("processes.pid"), nullable=False)
-    input_state = mapped_column(pg.JSONB(), nullable=False)  # type: ignore
+    input_state = mapped_column(pg.JSONB(), nullable=False)
     input_time = mapped_column(UtcTimestamp, server_default=text("current_timestamp()"), nullable=False)
     input_type = mapped_column(Enum(InputType), nullable=False)
 
@@ -137,7 +137,7 @@ class ProcessStepTable(BaseModel):
     )
     name = mapped_column(String(), nullable=False)
     status = mapped_column(String(50), nullable=False)
-    state = mapped_column(pg.JSONB(), nullable=False)  # type: ignore
+    state = mapped_column(pg.JSONB(), nullable=False)
     created_by = mapped_column(String(255), nullable=True)
     executed_at = mapped_column(UtcTimestamp, server_default=text("statement_timestamp()"), nullable=False)
     commit_hash = mapped_column(String(40), nullable=True, default=GIT_COMMIT_HASH)
@@ -642,7 +642,7 @@ class SubscriptionMetadataTable(BaseModel):
         primary_key=True,
         index=True,
     )
-    metadata_ = mapped_column("metadata", pg.JSONB(), nullable=False)  # type: ignore
+    metadata_ = mapped_column("metadata", pg.JSONB(), nullable=False)
 
     @staticmethod
     def find_by_subscription_id(subscription_id: str) -> SubscriptionMetadataTable | None:
@@ -651,6 +651,8 @@ class SubscriptionMetadataTable(BaseModel):
 
 class SubscriptionSearchView(BaseModel):
     __tablename__ = "subscriptions_search"
+    __table_args__ = {"info": {"materialized_view": True}}
+
     subscription_id = mapped_column(
         UUIDType, ForeignKey("subscriptions.subscription_id"), nullable=False, index=True, primary_key=True
     )

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/devtools/populator.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 SURF.
+# Copyright 2019-2020 SURF, GÉANT.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/domain/__init__.py

@@ -11,11 +11,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-
-from orchestrator.domain.base import SubscriptionModel
+from orchestrator.domain.base import SubscriptionModel, SubscriptionModelRegistry
 from orchestrator.utils.docs import make_product_type_index_doc
 
-SUBSCRIPTION_MODEL_REGISTRY: dict[str, type[SubscriptionModel]] = {}
+SUBSCRIPTION_MODEL_REGISTRY: SubscriptionModelRegistry = SubscriptionModelRegistry()
 
 __doc__ = make_product_type_index_doc(SUBSCRIPTION_MODEL_REGISTRY)
 

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/domain/base.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 SURF, ESnet.
+# Copyright 2019-2025 SURF, ESnet, GÉANT.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -12,14 +12,16 @@
 # limitations under the License.
 import itertools
 from collections import defaultdict
-from collections.abc import Callable, Iterable
 from datetime import datetime
-from inspect import get_annotations
+from inspect import get_annotations, isclass
 from itertools import groupby, zip_longest
 from operator import attrgetter
 from typing import (
     Any,
+    Callable,
     ClassVar,
+    Iterable,
+    Mapping,
     Optional,
     TypeVar,
     Union,
@@ -596,7 +598,9 @@ class ProductBlockModel(DomainModel):
         product_blocks_in_model = cls._get_depends_on_product_block_types()
         product_blocks_types_in_model = get_depends_on_product_block_type_list(product_blocks_in_model)
 
-        product_blocks_in_model = set(flatten(map(attrgetter("__names__"), product_blocks_types_in_model)))  # type: ignore
+        product_blocks_in_model = set(
+            flatten(map(attrgetter("__names__"), product_blocks_types_in_model))
+        )  # type: ignore
 
         missing_product_blocks_in_db = product_blocks_in_model - product_blocks_in_db  # type: ignore
         missing_product_blocks_in_model = product_blocks_in_db - product_blocks_in_model  # type: ignore
@@ -1051,7 +1055,9 @@ class SubscriptionModel(DomainModel):
         product_blocks_in_model = cls._get_depends_on_product_block_types()
         product_blocks_types_in_model = get_depends_on_product_block_type_list(product_blocks_in_model)
 
-        product_blocks_in_model = set(flatten(map(attrgetter("__names__"), product_blocks_types_in_model)))  # type: ignore
+        product_blocks_in_model = set(
+            flatten(map(attrgetter("__names__"), product_blocks_types_in_model))
+        )  # type: ignore
 
         missing_product_blocks_in_db = product_blocks_in_model - product_blocks_in_db  # type: ignore
         missing_product_blocks_in_model = product_blocks_in_db - product_blocks_in_model  # type: ignore
@@ -1402,6 +1408,69 @@ class SubscriptionModel(DomainModel):
         return self._db_model
 
 
+def validate_base_model(
+    name: str, cls: type[Any], base_model: type[BaseModel] = DomainModel, errors: list[str] | None = None
+) -> None:
+    """Validates that the given class is not Pydantic BaseModel or its direct subclass."""
+    # Instantiate errors list if not provided and avoid mutating default
+    if errors is None:
+        errors = []
+    # Return early when the node is not a class as there is nothing to be done
+    if not isclass(cls):
+        return
+    # Validate each field in the ProductBlockModel's field dictionaries
+    if issubclass(cls, ProductBlockModel) or issubclass(cls, SubscriptionModel):
+        for name, clz in cls._product_block_fields_.items():
+            validate_base_model(name, clz, ProductBlockModel, errors)
+        for name, clz in cls._non_product_block_fields_.items():
+            validate_base_model(name, clz, SubscriptionModel, errors)
+    # Generate error if node is Pydantic BaseModel or direct subclass
+    if issubclass(cls, BaseModel):
+        err_msg: str = (
+            f"If this field was intended to be a {base_model.__name__}, define {name}:{cls.__name__} with "
+            f"{base_model.__name__} as its superclass instead. e.g., class {cls.__name__}({base_model.__name__}):"
+        )
+        if cls is BaseModel:
+            errors.append(f"Field {name}: {cls.__name__} can not be {BaseModel.__name__}. " + err_msg)
+        if len(cls.__mro__) > 1 and cls.__mro__[1] is BaseModel:
+            errors.append(
+                f"Field {name}: {cls.__name__} can not be a direct subclass of {BaseModel.__name__}. " + err_msg
+            )
+    # Format all errors as one per line and raise a TypeError when they exist
+    if errors:
+        raise TypeError("\n".join(errors))
+
+
+class SubscriptionModelRegistry(dict[str, type[SubscriptionModel]]):
+    """A registry for all subscription models."""
+
+    def __setitem__(self, __key: str, __value: type[SubscriptionModel]) -> None:
+        """Set value for key in while validating against Pydantic BaseModel."""
+        validate_base_model(__key, __value)
+        super().__setitem__(__key, __value)
+
+    def update(
+        self,
+        m: Any = None,
+        /,
+        **kwargs: type[SubscriptionModel],
+    ) -> None:
+        """Update dictionary with mapping and/or kwargs using `__setitem__`."""
+        if m:
+            if isinstance(m, Mapping):
+                for key, value in m.items():
+                    self[key] = value
+            elif isinstance(m, Iterable):
+                for index, item in enumerate(m):
+                    try:
+                        key, value = item
+                    except ValueError:
+                        raise TypeError(f"dictionary update sequence element #{index} is not an iterable of length 2")
+                    self[key] = value
+        for key, value in kwargs.items():
+            self[key] = value
+
+
 def _validate_lifecycle_change_for_product_block(
     used_by: SubscriptionInstanceTable,
     product_block_model: ProductBlockModel,

{orchestrator_core-3.1.1 → orchestrator_core-3.1.2}/orchestrator/domain/lifecycle.py

@@ -1,4 +1,4 @@
-# Copyright 2019-2020 SURF.
+# Copyright 2019-2020 SURF, GÉANT.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at