orchestrator-core 2.9.2rc1__py3-none-any.whl → 2.9.2rc2__py3-none-any.whl

orchestrator/__init__.py

@@ -13,7 +13,7 @@
 
 """This is the orchestrator workflow engine."""
 
-__version__ = "2.9.2rc1"
+__version__ = "2.9.2rc2"
 
 from orchestrator.app import OrchestratorCore
 from orchestrator.settings import app_settings

orchestrator/db/filters/subscription.py

@@ -24,6 +24,7 @@ logger = structlog.get_logger(__name__)
 SUBSCRIPTION_TABLE_COLUMN_CLAUSES = default_inferred_column_clauses(SubscriptionTable) | {
     "product": inferred_filter(ProductTable.name),
     "tag": filter_exact(ProductTable.tag),
+    "type": filter_exact(ProductTable.product_type),
 }
 
 subscription_filter_fields = create_memoized_field_list(SUBSCRIPTION_TABLE_COLUMN_CLAUSES)

orchestrator/migrations/versions/schema/2025-10-19_4fjdn13f83ga_add_validate_product_type_task.py

@@ -0,0 +1,41 @@
+"""Validate Product Type.
+
+Revision ID: 4fjdn13f83ga
+Revises: 2c7e8a43d4f9
+Create Date: 2025-10-13 16:21:43.956814
+
+"""
+
+from uuid import uuid4
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "4fjdn13f83ga"
+down_revision = "4c5859620539"
+branch_labels = None
+depends_on = None
+
+
+workflow = {
+    "name": "task_validate_product_type",
+    "target": "SYSTEM",
+    "description": "Validate all subscriptions of Product Type",
+    "workflow_id": uuid4(),
+}
+
+
+def upgrade() -> None:
+    conn = op.get_bind()
+    conn.execute(
+        sa.text(
+            "INSERT INTO workflows VALUES (:workflow_id, :name, :target, :description, now()) ON CONFLICT DO NOTHING"
+        ),
+        workflow,
+    )
+
+
+def downgrade() -> None:
+    conn = op.get_bind()
+    conn.execute(sa.text("DELETE FROM workflows WHERE name = :name"), {"name": workflow["name"]})

orchestrator/schedules/validate_subscriptions.py

@@ -15,14 +15,17 @@
 from threading import BoundedSemaphore
 
 import structlog
-from sqlalchemy import select
 
-from orchestrator.db import ProductTable, SubscriptionTable, db
 from orchestrator.schedules.scheduling import scheduler
-from orchestrator.services.processes import get_execution_context
-from orchestrator.services.subscriptions import TARGET_DEFAULT_USABLE_MAP, WF_USABLE_MAP
+from orchestrator.services.subscriptions import (
+    get_subscriptions_on_product_table,
+    get_subscriptions_on_product_table_in_sync,
+)
+from orchestrator.services.workflows import (
+    get_system_product_workflows_for_subscription,
+    start_validation_workflow_for_workflows,
+)
 from orchestrator.settings import app_settings
-from orchestrator.targets import Target
 
 logger = structlog.get_logger(__name__)
 
@@ -34,29 +37,19 @@ task_semaphore = BoundedSemaphore(value=2)
 def validate_subscriptions() -> None:
     if app_settings.VALIDATE_OUT_OF_SYNC_SUBSCRIPTIONS:
         # Automatically re-validate out-of-sync subscriptions. This is not recommended for production.
-        select_query = select(SubscriptionTable).join(ProductTable)
+        subscriptions = get_subscriptions_on_product_table()
     else:
-        select_query = select(SubscriptionTable).join(ProductTable).filter(SubscriptionTable.insync.is_(True))
-    subscriptions = db.session.scalars(select_query)
-    for subscription in subscriptions:
-        validation_workflow = None
-
-        for workflow in subscription.product.workflows:
-            if workflow.target == Target.SYSTEM:
-                validation_workflow = workflow.name
-
-        if validation_workflow:
-            default = TARGET_DEFAULT_USABLE_MAP[Target.SYSTEM]
-            usable_when = WF_USABLE_MAP.get(validation_workflow, default)
+        subscriptions = get_subscriptions_on_product_table_in_sync()
 
-            if subscription.status in usable_when:
-                json = [{"subscription_id": str(subscription.subscription_id)}]
+    for subscription in subscriptions:
+        system_product_workflows = get_system_product_workflows_for_subscription(subscription)
 
-                validate_func = get_execution_context()["validate"]
-                validate_func(validation_workflow, json=json)
-        else:
+        if not system_product_workflows:
             logger.warning(
                 "SubscriptionTable has no validation workflow",
                 subscription=subscription,
                 product=subscription.product.name,
             )
+            break
+
+        start_validation_workflow_for_workflows(subscription=subscription, workflows=system_product_workflows)

orchestrator/services/subscriptions.py

@@ -670,3 +670,13 @@ def format_extended_domain_model(subscription: dict, filter_owner_relations: boo
         filter_instance_ids_on_subscription()
 
     return subscription
+
+
+def get_subscriptions_on_product_table() -> list[SubscriptionTable]:
+    select_query = select(SubscriptionTable).join(ProductTable)
+    return list(db.session.scalars(select_query))
+
+
+def get_subscriptions_on_product_table_in_sync(in_sync: bool = True) -> list[SubscriptionTable]:
+    select_query = select(SubscriptionTable).join(ProductTable).filter(SubscriptionTable.insync.is_(in_sync))
+    return list(db.session.scalars(select_query))

orchestrator/services/workflows.py

@@ -2,8 +2,14 @@ from collections.abc import Iterable
 
 from sqlalchemy import Select, select
 
-from orchestrator.db import WorkflowTable, db
+from orchestrator.db import (
+    SubscriptionTable,
+    WorkflowTable,
+    db,
+)
 from orchestrator.schemas import StepSchema, WorkflowSchema
+from orchestrator.services.subscriptions import TARGET_DEFAULT_USABLE_MAP, WF_USABLE_MAP
+from orchestrator.targets import Target
 from orchestrator.workflows import get_workflow
 
 
@@ -42,3 +48,43 @@ def get_workflows(
 
 def get_workflow_by_name(workflow_name: str) -> WorkflowTable | None:
     return db.session.scalar(select(WorkflowTable).where(WorkflowTable.name == workflow_name))
+
+
+def get_system_product_workflows_for_subscription(
+    subscription: SubscriptionTable,
+) -> list:
+    return [workflow.name for workflow in subscription.product.workflows if workflow.target == Target.SYSTEM]
+
+
+def start_validation_workflow_for_workflows(
+    subscription: SubscriptionTable,
+    workflows: list,
+    product_type_filter: str | None = None,
+) -> list:
+    """Start validation workflows for a subscription."""
+    result = []
+
+    for workflow_name in workflows:
+        default = TARGET_DEFAULT_USABLE_MAP[Target.SYSTEM]
+        usable_when = WF_USABLE_MAP.get(workflow_name, default)
+
+        if subscription.status in usable_when and (
+            product_type_filter is None or subscription.product.product_type == product_type_filter
+        ):
+            json = [{"subscription_id": str(subscription.subscription_id)}]
+
+            # against circular import
+            from orchestrator.services.processes import get_execution_context
+
+            validate_func = get_execution_context()["validate"]
+            validate_func(workflow_name, json=json)
+
+            result.append(
+                {
+                    "workflow_name": workflow_name,
+                    "subscription_id": subscription.subscription_id,
+                    "product_type": subscription.product.product_type,
+                }
+            )
+
+    return result

orchestrator/workflows/__init__.py

@@ -110,5 +110,6 @@ LazyWorkflowInstance(".modify_note", "modify_note")
 LazyWorkflowInstance(".tasks.cleanup_tasks_log", "task_clean_up_tasks")
 LazyWorkflowInstance(".tasks.resume_workflows", "task_resume_workflows")
 LazyWorkflowInstance(".tasks.validate_products", "task_validate_products")
+LazyWorkflowInstance(".tasks.validate_product_type", "task_validate_product_type")
 
 __doc__ = make_workflow_index_doc(ALL_WORKFLOWS)

orchestrator/workflows/tasks/validate_product_type.py

@@ -0,0 +1,92 @@
+# Copyright 2019-2024 SURF.
+# 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.
+from functools import cache
+from typing import Any
+
+import structlog
+
+from orchestrator.db import ProductTable
+from orchestrator.forms import FormPage
+from orchestrator.forms.validators import Choice
+from orchestrator.services.subscriptions import (
+    get_subscriptions_on_product_table_in_sync,
+)
+from orchestrator.services.workflows import (
+    get_system_product_workflows_for_subscription,
+    start_validation_workflow_for_workflows,
+)
+from orchestrator.targets import Target
+from orchestrator.types import FormGenerator, State
+from orchestrator.workflow import StepList, done, init, step, workflow
+
+logger = structlog.get_logger(__name__)
+
+
+def create_select_product_type_form() -> type[FormPage]:
+    """Get and create the choices form for the product type."""
+
+    @cache
+    def get_product_type_choices() -> dict[Any, Any]:
+        return {product.product_type: product.product_type for product in ProductTable.query.all()}
+
+    ProductTypeChoices = Choice.__call__("Product Type", get_product_type_choices())
+
+    class SelectProductTypeForm(FormPage):
+        product_type: ProductTypeChoices  # type: ignore
+
+    return SelectProductTypeForm
+
+
+def initial_input_form_generator() -> FormGenerator:
+    """Generate the form."""
+
+    init_input = yield create_select_product_type_form()
+    user_input_data = init_input.model_dump()
+
+    return user_input_data
+
+
+@step("Validate Product Type")
+def validate_product_type(product_type: str) -> State:
+    result = []
+    subscriptions = get_subscriptions_on_product_table_in_sync()
+
+    for subscription in subscriptions:
+        system_product_workflows = get_system_product_workflows_for_subscription(
+            subscription=subscription,
+        )
+
+        if not system_product_workflows:
+            logger.warning(
+                "SubscriptionTable has no validation workflow",
+                subscription=subscription,
+                product=subscription.product.name,
+            )
+            continue
+
+        validation_result = start_validation_workflow_for_workflows(
+            subscription=subscription,
+            workflows=system_product_workflows,
+            product_type_filter=product_type,
+        )
+        if len(validation_result) > 0:
+            result.append({"total_workflows_validated": len(validation_result), "workflows": validation_result})
+
+    return {"result": result}
+
+
+@workflow(
+    "Validate all subscriptions of Product Type", target=Target.SYSTEM, initial_input_form=initial_input_form_generator
+)
+def task_validate_product_type() -> StepList:
+    return init >> validate_product_type >> done

orchestrator/workflows/translations/en-GB.json

@@ -5,7 +5,8 @@
             "note_info": "Notes, reminders and feedback about this description.",
             "subscription_id": "Subscription",
             "version": "Version",
-            "subscription_id_info": "The subscription for this action"
+            "subscription_id_info": "The subscription for this action",
+            "product_type": "Product Type"
         }
     },
     "workflow": {
@@ -13,6 +14,7 @@
         "task_clean_up_tasks": "Clean up old tasks",
         "task_resume_workflows": "Resume all workflows that are stuck on tasks with the status 'waiting'",
         "task_validate_products": "Validate Products and Subscriptions",
+        "task_validate_product_type": "Validate all subscriptions of Product Type",
         "reset_subscription_description": "Reset description of a subscription to default"
     }
 }

{orchestrator_core-2.9.2rc1.dist-info → orchestrator_core-2.9.2rc2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: orchestrator-core
-Version: 2.9.2rc1
+Version: 2.9.2rc2
 Summary: This is the orchestrator workflow engine.
 Requires-Python: >=3.11,<3.14
 Classifier: Intended Audience :: Information Technology

{orchestrator_core-2.9.2rc1.dist-info → orchestrator_core-2.9.2rc2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-orchestrator/__init__.py,sha256=uaK-K8eDckfC2-j5UCP7FLkLp1C-yjYFRIzbLwrrUak,1058
+orchestrator/__init__.py,sha256=Si6jkyprNLow9W0WKRVqn6elJdlthYCP0gV7K5RQXvw,1058
 orchestrator/app.py,sha256=_2e3JMYgH_egOScokFVpFuTlJWGGwH0KYgZajDdm--0,11563
 orchestrator/exception_handlers.py,sha256=UsW3dw8q0QQlNLcV359bIotah8DYjMsj2Ts1LfX4ClY,1268
 orchestrator/log_config.py,sha256=1tPRX5q65e57a6a_zEii_PFK8SzWT0mnA5w2sKg4hh8,1853
@@ -109,7 +109,7 @@ orchestrator/db/filters/process.py,sha256=xvGhyfo_MZ1xhLvFC6yULjcT4mJk0fKc1glJIY
 orchestrator/db/filters/product.py,sha256=ZsoZZ8ExpmP22T_8Zg1ZVxs3DbC2_n4-dBgIlxrw_Q0,899
 orchestrator/db/filters/product_block.py,sha256=CYym-QIkkgJ2rEsUPVoe-lcEphHb0xFBbA2cOCF2eLU,1089
 orchestrator/db/filters/resource_type.py,sha256=7aH4_n8vPpsySFnnN8SefN8h964glmEiw_SYip1lc8I,889
-orchestrator/db/filters/subscription.py,sha256=6IA_X-nXFU_VRsEQlRdg_aVq_7vJoVfZ7V-FpsPFIZ8,1466
+orchestrator/db/filters/subscription.py,sha256=IV7ur7yyKFNUQRx0gZPelcMLHjuUPU0Rx4oZ6Shbn6A,1519
 orchestrator/db/filters/workflow.py,sha256=osyyEmOFuev6q5lizHeUvgxf1Nji3fZtlbf2_lzSNao,1276
 orchestrator/db/filters/search_filters/__init__.py,sha256=a7yfEAA-qpD_PHZH5LeqSjrLeGAvQrDsJp7mzVwDMwo,562
 orchestrator/db/filters/search_filters/inferred_filter.py,sha256=B3WuA6yi3AFhkgbr8yK0UnqiZNUZ1h1aNFQCtNqaP7I,5591
@@ -215,12 +215,13 @@ orchestrator/migrations/versions/schema/2023-12-06_048219045729_add_workflow_id_
 orchestrator/migrations/versions/schema/2024-09-27_460ec6748e37_add_uuid_search_workaround.py,sha256=GzHBzOwOc6FaO1kYwoSNIhb8sKstXo8Cfxdqy3Rmeg4,972
 orchestrator/migrations/versions/schema/2024-09-27_460ec6748e37_add_uuid_search_workaround.sql,sha256=mhPnqjG5H3W8_BD7w5tYzXUQSxFOM7Rahn_MudEPTIE,5383
 orchestrator/migrations/versions/schema/2025-01-08_4c5859620539_add_version_column_to_subscription.py,sha256=xAhe74U0ZiVRo9Z8Uq7491RBbATMMUnYpTBjbG-BYL0,1690
+orchestrator/migrations/versions/schema/2025-10-19_4fjdn13f83ga_add_validate_product_type_task.py,sha256=O0GfCISIDnyohGf3Ot_2HKedGRbMqLVox6t7Wd3PMvo,894
 orchestrator/schedules/__init__.py,sha256=JnnaglfK1qYUBKI6Dd9taV-tCZIPlAdAkHtnkJDMXxY,1066
 orchestrator/schedules/resume_workflows.py,sha256=kSotzTAXjX7p9fpSYiGOpuxuTQfv54eRFAe0YSG0DHc,832
 orchestrator/schedules/scheduling.py,sha256=ehtwgpbvMOk1jhn-hHgVzg_9wLJkI6l3mRY3DcO9ZVY,1526
 orchestrator/schedules/task_vacuum.py,sha256=eovnuKimU8SFRw1IF62MsAVFSdgeeV1u57kapUbz8As,821
 orchestrator/schedules/validate_products.py,sha256=YMr7ASSqdXM6pd6oZu0kr8mfmH8If16MzprrsHdN_ZU,1234
-orchestrator/schedules/validate_subscriptions.py,sha256=MI6Ci26t1fvcs5yC2Bwo2xZK2ycF9-TMMw8R0CRLWvI,2501
+orchestrator/schedules/validate_subscriptions.py,sha256=YYcU2iGf8Ga_s577kgpKdhQV4p7wCEHGYvUf8FCvBvQ,2022
 orchestrator/schemas/__init__.py,sha256=YDyZ0YBvzB4ML9oDBCBPGnBvf680zFFgUzg7X0tYBRY,2326
 orchestrator/schemas/base.py,sha256=Vc444LetsINLRhG2SxW9Bq01hOzChPOhQWCImQTr-As,930
 orchestrator/schemas/engine_settings.py,sha256=BOyFNOn7AqHVdUxXyqmPk5aVdFY5A0cCOZ4bAwxQsgo,1286
@@ -242,10 +243,10 @@ orchestrator/services/products.py,sha256=5lKxnfDw80YkF3jOvV1v8c8FtR6allVk3MwpRSD
 orchestrator/services/resource_types.py,sha256=_QBy_JOW_X3aSTqH0CuLrq4zBJL0p7Q-UDJUcuK2_qc,884
 orchestrator/services/settings.py,sha256=u-834F4KWloXS8zi7R9mp-D3cjl-rbVjKJRU35IqhXo,2723
 orchestrator/services/subscription_relations.py,sha256=9C126TUfFvyBe7y4x007kH_dvxJ9pZ1zSnaWeH6HC5k,12261
-orchestrator/services/subscriptions.py,sha256=5SfaruUje2WuAvp2t7KRa-UHEqIU6jvcd_hFWSdxiwA,25733
+orchestrator/services/subscriptions.py,sha256=AEuh0p2pmVLDXWE-ylJMD32NQUuqw1_jbaPAYvx_wvA,26177
 orchestrator/services/tasks.py,sha256=f3045Hn9uWIXcRvIPN6qdznH_0u-rsIGM9hHalc_BvE,6286
 orchestrator/services/translations.py,sha256=GyP8soUFGej8AS8uulBsk10CCK6Kwfjv9AHMFm3ElQY,1713
-orchestrator/services/workflows.py,sha256=mxXQk2ETNF0LhhsUBU5OumfjVPOjAaO-JsZmWmEB4NQ,1638
+orchestrator/services/workflows.py,sha256=DStBiQQdPV3zEg1EgPDlk85T6kkBc9AKbiEpxrQG6dI,3170
 orchestrator/utils/__init__.py,sha256=GyHNfEFCGKQwRiN6rQmvSRH2iYX7npjMZn97n8XzmLU,571
 orchestrator/utils/crypt.py,sha256=18eNamYWMllPkxyRtWIde3FDr3rSF74R5SAL6WsCj9Y,5584
 orchestrator/utils/datetime.py,sha256=a1WQ_yvu7MA0TiaRpC5avwbOSFdrj4eMrV4a7I2sD5Q,1477
@@ -268,7 +269,7 @@ orchestrator/websocket/__init__.py,sha256=V79jskk1z3uPIYgu0Gt6JLzuqr7NGfNeAZ-hbB
 orchestrator/websocket/websocket_manager.py,sha256=Vw5GW67rP_RYoPUhfPp9Fi8_M9E9SoHOHmCQVibkSWc,2755
 orchestrator/websocket/managers/broadcast_websocket_manager.py,sha256=fwoSgTjkHJ2GmsLTU9dqQpAA9i8b1McPu7gLNzxtfG4,5401
 orchestrator/websocket/managers/memory_websocket_manager.py,sha256=lF5EEx1iFMCGEkTbItTDr88NENMSaSeG1QrJ7teoPkY,3324
-orchestrator/workflows/__init__.py,sha256=TOZ7Q5_DolCsW6dl5RRndbNFkBHLeGk_R5c4W7pIK8k,4048
+orchestrator/workflows/__init__.py,sha256=NzIGGI-8SNAwCk2YqH6sHhEWbgAY457ntDwjO15N8v4,4131
 orchestrator/workflows/modify_note.py,sha256=OkouKVZDinjWSN3J3_0gbvOMScvcKlWvPCkban45HxE,2438
 orchestrator/workflows/removed_workflow.py,sha256=V0Da5TEdfLdZZKD38ig-MTp3_IuE7VGqzHHzvPYQmLI,909
 orchestrator/workflows/steps.py,sha256=8dnB4HlqBWZ4JlP1eQVnHdinzoM0ZlgFL0KYn_3k8x4,9762
@@ -276,9 +277,10 @@ orchestrator/workflows/utils.py,sha256=inWbR-44B0jj8YZMFBxndpcsfk5IC0MnlCnGB2dy5
 orchestrator/workflows/tasks/__init__.py,sha256=GyHNfEFCGKQwRiN6rQmvSRH2iYX7npjMZn97n8XzmLU,571
 orchestrator/workflows/tasks/cleanup_tasks_log.py,sha256=JNx2lCIxdhTPD33EgwQUsQjoLeyKH2RKZR_e5eh80Ls,1614
 orchestrator/workflows/tasks/resume_workflows.py,sha256=wZGNHHQYL7wociSTmoNdDdh5CJkVOkvu3kCUg9uY_88,2349
+orchestrator/workflows/tasks/validate_product_type.py,sha256=kVuN94hGWcmBNphgpAlGTSiyO2dEhFwgIq87SYjArns,3174
 orchestrator/workflows/tasks/validate_products.py,sha256=j_aOyxcH8DymlGupSS6XRwQdWx2Ab-c8f8iUvAXBTes,8511
-orchestrator/workflows/translations/en-GB.json,sha256=e6uKt70KLSCmCSWQF9HpmVTLQM4YYO-9xFaMYcc58Ic,718
-orchestrator_core-2.9.2rc1.dist-info/LICENSE,sha256=b-aA5OZQuuBATmLKo_mln8CQrDPPhg3ghLzjPjLn4Tg,11409
-orchestrator_core-2.9.2rc1.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
-orchestrator_core-2.9.2rc1.dist-info/METADATA,sha256=zUOL3E-Vk0quv01_5iO6Z4AAEgmeXIwFLvadLsXK_kY,4924
-orchestrator_core-2.9.2rc1.dist-info/RECORD,,
+orchestrator/workflows/translations/en-GB.json,sha256=ST53HxkphFLTMjFHonykDBOZ7-P_KxksktZU3GbxLt0,846
+orchestrator_core-2.9.2rc2.dist-info/LICENSE,sha256=b-aA5OZQuuBATmLKo_mln8CQrDPPhg3ghLzjPjLn4Tg,11409
+orchestrator_core-2.9.2rc2.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+orchestrator_core-2.9.2rc2.dist-info/METADATA,sha256=s7QCKcWwbLKBl9Wbb_HTUXhEwVoN3ZaQyFyFKbwThgU,4924
+orchestrator_core-2.9.2rc2.dist-info/RECORD,,