orchestrator-core 2.10.0rc1__py3-none-any.whl → 3.0.0rc1__py3-none-any.whl

orchestrator/__init__.py

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

orchestrator/api/api_v1/api.py

@@ -19,12 +19,15 @@ from fastapi.routing import APIRouter
 from orchestrator.api.api_v1.endpoints import (
     health,
     processes,
+    product_blocks,
     products,
+    resource_types,
     settings,
     subscription_customer_descriptions,
     subscriptions,
     translations,
     user,
+    workflows,
     ws,
 )
 from orchestrator.security import authorize
@@ -34,14 +37,32 @@ api_router = APIRouter()
 api_router.include_router(
     processes.router, prefix="/processes", tags=["Core", "Processes"], dependencies=[Depends(authorize)]
 )
+api_router.include_router(
+    subscriptions.router,
+    prefix="/subscriptions",
+    tags=["Core", "Subscriptions"],
+    dependencies=[Depends(authorize)],
+)
 api_router.include_router(processes.ws_router, prefix="/processes", tags=["Core", "Processes"])
 api_router.include_router(
     products.router, prefix="/products", tags=["Core", "Product"], dependencies=[Depends(authorize)]
 )
 api_router.include_router(
-    subscriptions.router,
-    prefix="/subscriptions",
-    tags=["Core", "Subscriptions"],
+    product_blocks.router,
+    prefix="/product_blocks",
+    tags=["Core", "Product Blocks"],
+    dependencies=[Depends(authorize)],
+)
+api_router.include_router(
+    resource_types.router,
+    prefix="/resource_types",
+    tags=["Core", "Resource Types"],
+    dependencies=[Depends(authorize)],
+)
+api_router.include_router(
+    workflows.router,
+    prefix="/workflows",
+    tags=["Core", "Workflows"],
     dependencies=[Depends(authorize)],
 )
 api_router.include_router(

orchestrator/api/api_v1/endpoints/processes.py

@@ -61,7 +61,6 @@ from orchestrator.services.processes import (
 )
 from orchestrator.services.settings import get_engine_settings
 from orchestrator.settings import app_settings
-from orchestrator.types import JSON, State
 from orchestrator.utils.enrich_process import enrich_process
 from orchestrator.websocket import (
     WS_CHANNELS,
@@ -70,6 +69,7 @@ from orchestrator.websocket import (
     websocket_manager,
 )
 from orchestrator.workflow import ProcessStatus
+from pydantic_forms.types import JSON, State
 
 router = APIRouter()
 

orchestrator/api/api_v1/endpoints/product_blocks.py

@@ -0,0 +1,56 @@
+# Copyright 2019-2020 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 http import HTTPStatus
+from uuid import UUID
+
+from fastapi.param_functions import Body
+from fastapi.routing import APIRouter
+
+from orchestrator.api.error_handling import raise_status
+from orchestrator.db import db
+from orchestrator.db.models import ProductBlockTable
+from orchestrator.schemas.product_block import ProductBlockPatchSchema, ProductBlockSchema
+
+router = APIRouter()
+
+
+@router.get("/{product_block_id}", response_model=ProductBlockSchema)
+def get_product_block_description(product_block_id: UUID) -> str:
+    product_block = db.session.get(ProductBlockTable, product_block_id)
+    if product_block is None:
+        raise_status(HTTPStatus.NOT_FOUND)
+    return product_block
+
+
+@router.patch("/{product_block_id}", status_code=HTTPStatus.CREATED, response_model=ProductBlockSchema)
+async def patch_product_block_by_id(
+    product_block_id: UUID, data: ProductBlockPatchSchema = Body(...)
+) -> ProductBlockTable:
+    product_block = db.session.get(ProductBlockTable, product_block_id)
+    if not product_block:
+        raise_status(HTTPStatus.NOT_FOUND, f"Product_block id {product_block_id} not found")
+
+    return await _patch_product_block_description(data, product_block)
+
+
+async def _patch_product_block_description(
+    data: ProductBlockPatchSchema,
+    product_block: ProductBlockTable,
+) -> ProductBlockTable:
+
+    updated_properties = data.model_dump(exclude_unset=True)
+    description = updated_properties.get("description", product_block.description)
+    product_block.description = description
+    db.session.commit()
+    return product_block

orchestrator/api/api_v1/endpoints/products.py

@@ -14,6 +14,7 @@
 from http import HTTPStatus
 from uuid import UUID
 
+from fastapi.param_functions import Body
 from fastapi.routing import APIRouter
 from sqlalchemy import select
 from sqlalchemy.orm import joinedload, selectinload
@@ -21,6 +22,7 @@ from sqlalchemy.orm import joinedload, selectinload
 from orchestrator.api.error_handling import raise_status
 from orchestrator.db import ProductBlockTable, ProductTable, db
 from orchestrator.schemas import ProductSchema
+from orchestrator.schemas.product import ProductPatchSchema
 
 router = APIRouter()
 
@@ -48,6 +50,13 @@ def fetch(tag: str | None = None, product_type: str | None = None) -> list[Produ
     response_model=ProductSchema,
 )
 def product_by_id(product_id: UUID) -> ProductTable:
+    product = _product_by_id(product_id)
+    if not product:
+        raise_status(HTTPStatus.NOT_FOUND, f"Product id {product_id} not found")
+    return product
+
+
+def _product_by_id(product_id: UUID) -> ProductTable | None:
     stmt = (
         select(ProductTable)
         .options(
@@ -57,7 +66,25 @@ def product_by_id(product_id: UUID) -> ProductTable:
         )
         .filter(ProductTable.product_id == product_id)
     )
-    product = db.session.scalars(stmt).unique().one_or_none()
+    return db.session.scalars(stmt).unique().one_or_none()
+
+
+@router.patch("/{product_id}", status_code=HTTPStatus.CREATED, response_model=ProductSchema)
+async def patch_product_by_id(product_id: UUID, data: ProductPatchSchema = Body(...)) -> ProductTable:
+    product = _product_by_id(product_id)
     if not product:
         raise_status(HTTPStatus.NOT_FOUND, f"Product id {product_id} not found")
+
+    return await _patch_product_description(data, product)
+
+
+async def _patch_product_description(
+    data: ProductPatchSchema,
+    product: ProductTable,
+) -> ProductTable:
+
+    updated_properties = data.model_dump(exclude_unset=True)
+    description = updated_properties.get("description", product.description)
+    product.description = description
+    db.session.commit()
     return product

orchestrator/api/api_v1/endpoints/resource_types.py

@@ -0,0 +1,56 @@
+# Copyright 2019-2020 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 http import HTTPStatus
+from uuid import UUID
+
+from fastapi.param_functions import Body
+from fastapi.routing import APIRouter
+
+from orchestrator.api.error_handling import raise_status
+from orchestrator.db import db
+from orchestrator.db.models import ResourceTypeTable
+from orchestrator.schemas.resource_type import ResourceTypePatchSchema, ResourceTypeSchema
+
+router = APIRouter()
+
+
+@router.get("/{resource_type_id}", response_model=ResourceTypeSchema)
+def get_resource_type_description(resource_type_id: UUID) -> str:
+    resource_type = db.session.get(ResourceTypeTable, resource_type_id)
+    if resource_type is None:
+        raise_status(HTTPStatus.NOT_FOUND)
+    return resource_type
+
+
+@router.patch("/{resource_type_id}", status_code=HTTPStatus.CREATED, response_model=ResourceTypeSchema)
+async def patch_resource_type_by_id(
+    resource_type_id: UUID, data: ResourceTypePatchSchema = Body(...)
+) -> ResourceTypeTable:
+    resource_type = db.session.get(ResourceTypeTable, resource_type_id)
+    if not resource_type:
+        raise_status(HTTPStatus.NOT_FOUND, f"ResourceType id {resource_type_id} not found")
+
+    return await _patch_resource_type_description(data, resource_type)
+
+
+async def _patch_resource_type_description(
+    data: ResourceTypePatchSchema,
+    resource_type: ResourceTypeTable,
+) -> ResourceTypeTable:
+
+    updated_properties = data.model_dump(exclude_unset=True)
+    description = updated_properties.get("description", resource_type.description)
+    resource_type.description = description
+    db.session.commit()
+    return resource_type

orchestrator/api/api_v1/endpoints/workflows.py

@@ -0,0 +1,54 @@
+# Copyright 2019-2020 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 http import HTTPStatus
+from uuid import UUID
+
+from fastapi.param_functions import Body
+from fastapi.routing import APIRouter
+
+from orchestrator.api.error_handling import raise_status
+from orchestrator.db import db
+from orchestrator.db.models import WorkflowTable
+from orchestrator.schemas.workflow import WorkflowPatchSchema, WorkflowSchema
+
+router = APIRouter()
+
+
+@router.get("/{workflow_id}", response_model=WorkflowSchema)
+def get_workflow_description(workflow_id: UUID) -> str:
+    workflow = db.session.get(WorkflowTable, workflow_id)
+    if workflow is None:
+        raise_status(HTTPStatus.NOT_FOUND)
+    return workflow
+
+
+@router.patch("/{workflow_id}", status_code=HTTPStatus.CREATED, response_model=WorkflowSchema)
+async def patch_workflow_by_id(workflow_id: UUID, data: WorkflowPatchSchema = Body(...)) -> WorkflowTable:
+    workflow = db.session.get(WorkflowTable, workflow_id)
+    if not workflow:
+        raise_status(HTTPStatus.NOT_FOUND, f"Workflow id {workflow_id} not found")
+
+    return await _patch_workflow_description(data, workflow)
+
+
+async def _patch_workflow_description(
+    data: WorkflowPatchSchema,
+    workflow: WorkflowTable,
+) -> WorkflowTable:
+
+    updated_properties = data.model_dump(exclude_unset=True)
+    description = updated_properties.get("description", workflow.description)
+    workflow.description = description
+    db.session.commit()
+    return workflow

orchestrator/app.py

@@ -199,8 +199,9 @@ class OrchestratorCore(FastAPI):
 
     def register_graphql(
         self: "OrchestratorCore",
-        query: Any = Query,
-        mutation: Any = Mutation,
+        # mypy 1.9 cannot properly inspect these, fixed in 1.15
+        query: Any = Query,  # type: ignore
+        mutation: Any = Mutation,  # type: ignore
         register_models: bool = True,
         subscription_interface: Any = SubscriptionInterface,
         graphql_models: StrawberryModelType | None = None,

orchestrator/cli/generator/generator/product_block.py

@@ -11,7 +11,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import re
 from collections import ChainMap
 from collections.abc import Mapping
 from pathlib import Path
@@ -56,15 +55,8 @@ def get_product_block_path(product_block: dict) -> Path:
 
 
 def enrich_product_block(product_block: dict) -> dict:
-    def to_block_name() -> str:
-        """Separate block name into words."""
-        type = product_block["type"]
-        name = re.sub("(.)([A-Z][a-z]+)", r"\1 \2", type)
-        return re.sub("([a-z0-9])([A-Z])", r"\1 \2", name)
-
     fields = get_all_fields(product_block)
-    block_name = product_block.get("block_name", to_block_name())
-
+    block_name = product_block.get("block_name", product_block.get("type"))
     return product_block | {
         "fields": fields,
         "block_name": block_name,

orchestrator/cli/generator/templates/create_product.j2

@@ -7,11 +7,12 @@ from typing import Annotated
 
 import structlog
 from pydantic import AfterValidator, ConfigDict, model_validator
+from pydantic_forms.types import FormGenerator, State, UUIDstr
 
 from orchestrator.forms import FormPage
 from orchestrator.forms.validators import Divider, Label, CustomerId, MigrationSummary
 from orchestrator.targets import Target
-from orchestrator.types import FormGenerator, State, SubscriptionLifecycle, UUIDstr
+from orchestrator.types import SubscriptionLifecycle
 from orchestrator.workflow import StepList, begin, step
 from orchestrator.workflows.steps import store_process_subscription
 from orchestrator.workflows.utils import create_workflow

orchestrator/cli/generator/templates/modify_product.j2

@@ -6,11 +6,12 @@ from typing import Annotated
 
 import structlog
 from pydantic import AfterValidator, ConfigDict, model_validator
+from pydantic_forms.types import FormGenerator, State, UUIDstr
 from pydantic_forms.validators import ReadOnlyField
 
 from orchestrator.forms import FormPage
 from orchestrator.forms.validators import CustomerId, Divider
-from orchestrator.types import FormGenerator, State, SubscriptionLifecycle, UUIDstr
+from orchestrator.types import SubscriptionLifecycle
 from orchestrator.workflow import StepList, begin, step
 from orchestrator.workflows.steps import set_status
 from orchestrator.workflows.utils import modify_workflow

orchestrator/cli/generator/templates/shared_workflows.j2

@@ -1,4 +1,5 @@
-from typing import Generator, List, TypeAlias, cast
+from collections.abc import Generator
+from typing import List, TypeAlias, cast
 
 from pydantic import ConfigDict
 

orchestrator/cli/generator/templates/terminate_product.j2

@@ -2,10 +2,10 @@
 
 import structlog
 from pydantic import AfterValidator, ConfigDict, model_validator
+from pydantic_forms.types import InputForm, State, UUIDstr
 
 from orchestrator.forms import FormPage
 from orchestrator.forms.validators import DisplaySubscription
-from orchestrator.types import InputForm, State, UUIDstr
 from orchestrator.workflow import StepList, begin, step
 from orchestrator.workflows.utils import terminate_workflow
 

orchestrator/cli/generator/templates/test_create_workflow.j2

@@ -4,7 +4,6 @@ from orchestrator.db import ProductTable
 from orchestrator.forms import FormValidationError
 
 from test.unit_tests.workflows import assert_complete, extract_state, run_workflow
-
 from {{ product_types_module }}.{{ product.variable }} import {{ product.type }}
 
 

orchestrator/cli/generator/templates/test_modify_workflow.j2

@@ -1,9 +1,8 @@
 import pytest
 from orchestrator.forms import FormValidationError
-
 from orchestrator.types import SubscriptionLifecycle
-from test.unit_tests.workflows import assert_complete, extract_state, run_workflow
 
+from test.unit_tests.workflows import assert_complete, extract_state, run_workflow
 from {{ product_types_module }}.{{ product.variable }} import {{ product.type }}
 
 

orchestrator/cli/generator/templates/test_terminate_workflow.j2

@@ -4,8 +4,8 @@ import pytest
 from orchestrator.forms import FormValidationError
 {% endif %}
 from orchestrator.types import SubscriptionLifecycle
-from test.unit_tests.workflows import assert_complete, extract_state, run_workflow
 
+from test.unit_tests.workflows import assert_complete, extract_state, run_workflow
 from {{ product_types_module }}.{{ product.variable }} import {{ product.type }}
 
 

orchestrator/cli/generator/templates/validate_product.j2

@@ -3,9 +3,11 @@
 import structlog
 {% if product.nso_service_id_path %}
 from deepdiff import DeepDiff
+{% endif %}
+from pydantic_forms.types import State
+{% if product.nso_service_id_path %}
 from surf.products.services.nso.nso import build_payload
 {% endif %}
-from orchestrator.types import State
 from orchestrator.workflow import StepList, begin, step
 from orchestrator.workflows.utils import validate_workflow
 

orchestrator/cli/helpers/print_helpers.py

@@ -1,7 +1,7 @@
 from collections.abc import Callable, Iterable
 from typing import Any
 
-from orchestrator.types import strEnum
+from pydantic_forms.types import strEnum
 
 
 def _esc_str(i: int) -> str:

orchestrator/config/assignee.py

@@ -13,7 +13,7 @@
 
 import strawberry
 
-from orchestrator.types import strEnum
+from pydantic_forms.types import strEnum
 
 
 @strawberry.enum

orchestrator/devtools/populator.py

@@ -26,8 +26,8 @@ import structlog
 from more_itertools import first, first_true
 
 from nwastdlib.url import URL
-from orchestrator.types import State
 from pydantic_forms.types import InputForm as LegacyInputForm
+from pydantic_forms.types import State
 
 
 class JSONSubSchema(TypedDict, total=False):

orchestrator/devtools/scripts/migrate_20.py

@@ -6,61 +6,17 @@ Refer to the 2.0 migration guide documentation for background.
 import re
 import sys
 from pathlib import Path
-from subprocess import run
 from typing import Iterable
 
-
-def remove_imports(text: str, module: str, symbol: str) -> tuple[str, bool]:
-    """Find imports and remove them.
-
-    Assumes code is formatted through Black to keep the regex somewhat readable.
-    """
-    text_orig = text
-
-    # single import from module (may have a #comment) -> remove line
-    rgx = r"(from %s import \b%s\b(\s*#[^\n]*)*\n)" % (re.escape(module), symbol)
-    text = re.sub(rgx, "", text)
-
-    # middle or last of multiple imports from module -> strip symbol
-    rgx = r"(from %s import .+)(, \b%s\b)" % (re.escape(module), symbol)
-    text = re.sub(rgx, r"\1", text)
-
-    # first of multiple imports from same module -> strip symbol
-    rgx = r"(from %s import )\b%s\b, " % (re.escape(module), symbol)
-    text = re.sub(rgx, r"\1", text)
-
-    # multiline import -> remove line with symbol
-    rgx_verbose = r"""(?P<before>^from\s%s\simport\s*\([^\n]*\n(?:^[^\n]+,\n)*)
-                      (^\s*\b%s\b,[^\n]*\n)
-                      (?P<after>(?:^[^\n]+,\n)*\)[^\n]*$)"""
-    text = re.sub(rgx_verbose % (re.escape(module), symbol), r"\g<before>\g<after>", text, flags=re.M | re.X)
-    return text, text_orig != text
-
-
-def insert_import(text: str, import_stmt: str) -> str:
-    # Find the first import line and add our line above that
-    # Rely on ruff & black for formatting
-    return re.sub(r"(^(?:from .+|import .+)$)", f"{import_stmt}\n" + r"\1", text, count=1, flags=re.M)
-
-
-def find_and_remove_aliases(text: str, symbol: str) -> tuple[str, list[str]]:
-    """In the given text find aliases of the given symbol and remove them.
-
-    Return updated text and aliases removed.
-    """
-    rgx = r"(\b%s as (\w+))" % (symbol,)
-    aliases = [aliasgroup for fullgroup, aliasgroup in re.findall(rgx, text)]
-    newtext = re.sub(rgx, symbol, text)
-    return newtext, aliases
-
-
-def replace_words(text: str, words: list[str], replace: str) -> str:
-    rgx = r"\b(%s)\b" % ("|".join(words),)
-    return re.sub(rgx, replace, text)
-
-
-def has_word(text: str, word: str) -> bool:
-    return bool(re.search(r"\b%s\b" % (word,), text))
+from orchestrator.devtools.scripts.shared import (
+    find_and_remove_aliases,
+    has_word,
+    insert_import,
+    migrate,
+    move_import,
+    remove_imports,
+    replace_words,
+)
 
 
 def rewrite_subscription_instance_lists(f: Path) -> list[str]:
@@ -124,17 +80,6 @@ def rewrite_subscription_instance_lists(f: Path) -> list[str]:
     return names
 
 
-def move_import(f: Path, symbol: str, old_module: str, new_module: str) -> bool:
-    text = f.read_text()
-    text, changed = remove_imports(text, old_module, symbol)
-    if not changed:
-        return False
-    text = insert_import(text, f"from {new_module} import {symbol}")
-    with f.open(mode="w"):
-        f.write_text(text)
-    return True
-
-
 re_serializable_property = re.compile(r"^(\s+)(@serializable_property)([^\n]*)\n", flags=re.MULTILINE)
 
 
@@ -167,7 +112,7 @@ def replace_serializable_props(f: Path) -> bool:
     return True
 
 
-def migrate_file(f: Path) -> int:
+def migrate_file(f: Path) -> bool:
     imports = {
         "SI": move_import(f, "SI", "orchestrator.domain.base", "orchestrator.types"),
         "VlanRanges": move_import(f, "VlanRanges", "orchestrator.utils.vlans", "nwastdlib.vlans"),
@@ -189,46 +134,6 @@ def migrate_file(f: Path) -> int:
     return bool(lines)
 
 
-def run_tool(*args: str) -> bool:
-    cmd = " ".join(args)
-    try:
-        r = run(args, capture_output=True)  # noqa: S603
-        if r.returncode == 0:
-            return True
-        print(f"{cmd} failed:", r.stdout, r.stderr)
-    except FileNotFoundError:
-        print(f"{cmd }failed: could not find executable in the current venv")
-    return False
-
-
-def migrate(target_dir: Path) -> bool:
-    abs_path = str(target_dir.resolve())
-
-    def run_tools() -> bool:
-        return run_tool("ruff", "--fix", abs_path) and run_tool("black", "--quiet", abs_path)
-
-    print(f"\n### Verifing files in {abs_path}... ", end="")
-    if not run_tools():
-        print("Failed to verify files, aborting migration. Please resolve the errors.")
-        return False
-    print("Ok")
-
-    files_migrated = files_checked = 0
-    print(f"\n### Migrating files in {abs_path}")
-    try:
-        for f in target_dir.glob("**/*.py"):
-            if migrate_file(f):
-                files_migrated += 1
-            files_checked += 1
-    except KeyboardInterrupt:
-        print("Interrupted...")
-
-    print(f"\n### Migrated {files_migrated}/{files_checked} files in {abs_path}")
-
-    print(f"\n### Formatting files in {abs_path}")
-    return run_tools()
-
-
 if __name__ == "__main__":
     try:
         _target_dir = Path(sys.argv[1])
@@ -237,4 +142,4 @@ if __name__ == "__main__":
         print("Need a directory as parameter")
         sys.exit(1)
 
-    sys.exit(0 if migrate(_target_dir) else 1)
+    sys.exit(0 if migrate(_target_dir, migrate_file) else 1)