orchestrator-core 2.9.1rc1__tar.gz → 2.9.2rc1__tar.gz

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/.bumpversion.cfg

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

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/.github/workflows/run-unit-tests.yml

@@ -62,5 +62,5 @@ jobs:
         uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}  # gives error 'Could not find a repository associated with upload token'
-          fail_ci_if_error: true
+          fail_ci_if_error: false
           files: ./coverage.xml

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/PKG-INFO

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

orchestrator_core-2.9.2rc1/docs/architecture/product_modelling/backfilling.md

@@ -0,0 +1,77 @@
+# Backfilling Existing Subscriptions
+When updating a product block that already exists in your orchestrator, it could be the case that new attributes are
+added or removed. When removing resource types from a `ProductBlock`, the `migrate-domain-models` command is able to
+pick up on this change, and generates a migration that removes these resource types from your database completely.
+
+However, when adding a new resource type to a `ProductBlock`, pre-existing product instances in the subscription
+database are not backfilled. For this, another SQL transaction must be added to the generated migration file.
+
+## Generating a Database Migration
+After the new resource type is added to the product block, the generated migration file should already contain at least the following two transactions:
+
+```python
+conn.execute(sa.text("""
+INSERT INTO resource_types (resource_type, description) VALUES ('site_contains_optical_equipment', 'Whether a site contains optical equipment') RETURNING resource_types.resource_type_id
+"""))
+
+conn.execute(sa.text("""
+INSERT INTO product_block_resource_types (product_block_id, resource_type_id) VALUES ((SELECT product_blocks.product_block_id FROM product_blocks WHERE product_blocks.name IN ('SiteBlock')), (SELECT resource_types.resource_type_id FROM resource_types WHERE resource_types.resource_type IN ('site_contains_optical_equipment')))
+"""))
+```
+
+Note that this will correctly add the new resource type to the database, but is missing a backfill for a default value.
+In the case of this example, a new resource type `site_contains_optical_equipment` is added. Assume that all
+subscriptions that already exist in the database already are sites that contain optical equipment. It would therefore
+make sense to backfill the value `True` into all subscriptions that already exist.
+
+## Adapting the Generated Database Migration
+To implement this backfilling mechanism, only one SQL statement needs to be added to the migration, given below.
+
+```python
+conn.execute(sa.text("""
+WITH rt_id AS (SELECT resource_type_id FROM resource_types WHERE resource_type = 'site_contains_optical_equipment') INSERT INTO subscription_instance_values (subscription_instance_id, resource_type_id, value) SELECT subscription_instance_id, rt_id.resource_type_id, 'True' FROM rt_id, subscription_instances WHERE product_block_id = (SELECT product_block_id FROM product_blocks WHERE name = 'SiteBlock');
+"""))
+```
+
+Adding this statement at the end of the `upgrade()` method in the generated migration file, will set the value of
+`site_contains_optical_equipment` in all existing Site subscriptions to `True`. A more formatted version of this SQL
+statement is given here. To adapt this example to your needs, update the resource type name, default value, and name of
+the product block where this resource type is added.
+
+```sql
+WITH rt_id AS (
+    SELECT
+        resource_type_id
+    FROM
+        resource_types
+    WHERE
+        -- The name of your new resource type
+        resource_type = 'site_contains_optical_equipment'
+)
+INSERT INTO
+    subscription_instance_values (
+        subscription_instance_id,
+        resource_type_id,
+        value
+    )
+SELECT
+    subscription_instance_id,
+    rt_id.resource_type_id,
+    'True'  -- The new value that is backfilled
+FROM
+    rt_id,
+    subscription_instances
+WHERE
+    product_block_id = (
+        SELECT
+            product_block_id
+        FROM
+            product_blocks
+        WHERE
+            -- The name of the product block where this value is backfilled
+            name = 'SiteBlock'
+    );
+```
+
+The `downgrade()` method of the generated migration does not need any modification to work. It simply removes the
+resource type from the subscription database altogether.

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/mkdocs.yml

@@ -145,6 +145,7 @@ nav:
                             - IP Static: architecture/product_modelling/ip_static.md
                       - Product Block Graph: architecture/product_modelling/product_block_graph.md
                       - Importing Existing Products: architecture/product_modelling/imports.md
+                      - Backfilling Existing Subscriptions: architecture/product_modelling/backfilling.md
     - Getting Started:
           - Prerequisites: getting-started/versions.md
           - Base Application:

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/__init__.py

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

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/api/api_v1/endpoints/processes.py

@@ -133,7 +133,7 @@ def delete(process_id: UUID) -> None:
     status_code=HTTPStatus.CREATED,
     dependencies=[Depends(check_global_lock, use_cache=False)],
 )
-def new_process(
+async def new_process(
     workflow_key: str,
     request: Request,
     json_data: list[dict[str, Any]] | None = Body(...),

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/api/api_v1/endpoints/subscription_customer_descriptions.py

@@ -26,6 +26,8 @@ from orchestrator.domain.customer_description import (
     update_subscription_customer_description,
 )
 from orchestrator.schemas import SubscriptionDescriptionBaseSchema, SubscriptionDescriptionSchema
+from orchestrator.schemas.subscription_descriptions import UpdateSubscriptionDescriptionSchema
+from orchestrator.utils.errors import StaleDataError
 from orchestrator.utils.redis import delete_from_redis
 
 router = APIRouter()
@@ -37,10 +39,15 @@ async def save_subscription_customer_description_endpoint(data: SubscriptionDesc
 
 
 @router.put("/", response_model=None, status_code=HTTPStatus.NO_CONTENT)
-async def update_subscription_customer_description_endpoint(data: SubscriptionDescriptionSchema = Body(...)) -> None:
+async def update_subscription_customer_description_endpoint(
+    data: UpdateSubscriptionDescriptionSchema = Body(...),
+) -> None:
     description = get_customer_description_by_customer_subscription(data.customer_id, data.subscription_id)
     if description:
-        await update_subscription_customer_description(description, data.description, data.created_at)
+        try:
+            await update_subscription_customer_description(description, data.description, data.created_at, data.version)
+        except StaleDataError as error:
+            raise_status(HTTPStatus.BAD_REQUEST, str(error))
 
 
 @router.delete("/{_id}", response_model=None, status_code=HTTPStatus.NO_CONTENT)

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/db/models.py

@@ -554,6 +554,7 @@ class SubscriptionCustomerDescriptionTable(BaseModel):
     customer_id = mapped_column(String, nullable=False, index=True)
     description = mapped_column(Text(), nullable=False)
     created_at = mapped_column(UtcTimestamp, nullable=False, server_default=text("current_timestamp()"))
+    version = mapped_column(Integer, nullable=False, server_default="1")
 
     subscription = relationship("SubscriptionTable", back_populates="customer_descriptions")
 
@@ -572,6 +573,7 @@ class SubscriptionTable(BaseModel):
     start_date = mapped_column(UtcTimestamp, nullable=True)
     end_date = mapped_column(UtcTimestamp)
     note = mapped_column(Text())
+    version = mapped_column(Integer, nullable=False, server_default="1")
 
     product = relationship("ProductTable", foreign_keys=[product_id])
     instances = relationship(

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/devtools/populator.py

@@ -435,16 +435,29 @@ class Populator:
         self.log.info("Providing user input.")
 
         user_inputs: list[State] = [self.get_form_data(form)] if form else []
+        # Keep submitting the form until it has been successfully submitted
         while True:
             self.log.info("Submitting user input", data=user_inputs)
             response = self.session.request(method, url, json=user_inputs)
-            if not response.ok and "MigrationSummary" in response.text:
-                user_inputs[-1] = {}
-                continue
+            self.log.debug("Response", response=response.content)
+
+            # Return the response if the form has been successfully submitted
             if response.status_code != HTTPStatus.NOT_EXTENDED:
                 return response
-            input_fields = response.json()["form"]
-            user_inputs.append(self.get_form_data(input_fields))
+
+            response_json = response.json()
+            meta = response_json.get("meta", {}) or {}
+            no_next = meta.get("hasNext") is False
+            is_summary_form = response_json.get("form", {}).get("title", "").endswith("Summary")
+
+            # If there are no next pages and a summary form is expected then append an empty form/dict
+            if no_next and is_summary_form:
+                self.log.info("Append empty form", response=response_json)
+                user_inputs.append({})
+            # Otherwise resolve the values for the input fields on the form
+            else:
+                input_fields = response_json["form"]
+                user_inputs.append(self.get_form_data(input_fields))
 
     def reset(self) -> None:
         """Reset internal state."""

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/domain/base.py

@@ -1017,6 +1017,7 @@ class SubscriptionModel(DomainModel):
     start_date: datetime | None = None  # pragma: no mutate
     end_date: datetime | None = None  # pragma: no mutate
     note: str | None = None  # pragma: no mutate
+    version: int = 1  # pragma: no mutate
 
     def __new__(cls, *args: Any, status: SubscriptionLifecycle | None = None, **kwargs: Any) -> "SubscriptionModel":
         # status can be none if created during change_lifecycle
@@ -1108,6 +1109,7 @@ class SubscriptionModel(DomainModel):
         start_date: datetime | None = None,
         end_date: datetime | None = None,
         note: str | None = None,
+        version: int = 1,
     ) -> S:
         """Use product_id (and customer_id) to return required fields of a new empty subscription."""
         # Caller wants a new instance and provided a product_id and customer_id
@@ -1140,6 +1142,7 @@ class SubscriptionModel(DomainModel):
             start_date=start_date,
             end_date=end_date,
             note=note,
+            version=version,
         )
         db.session.add(subscription)
 
@@ -1156,6 +1159,7 @@ class SubscriptionModel(DomainModel):
             start_date=start_date,
             end_date=end_date,
             note=note,
+            version=version,
             **fixed_inputs,
             **instances,
         )
@@ -1270,6 +1274,7 @@ class SubscriptionModel(DomainModel):
                 start_date=subscription.start_date,
                 end_date=subscription.end_date,
                 note=subscription.note,
+                version=subscription.version,
                 **fixed_inputs,
                 **instances,
             )
@@ -1320,6 +1325,7 @@ class SubscriptionModel(DomainModel):
                 start_date=subscription.start_date,
                 end_date=subscription.end_date,
                 note=subscription.note,
+                version=subscription.version,
                 **fixed_inputs,
                 **instances,
             )

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/domain/customer_description.py

@@ -20,7 +20,9 @@ from sqlalchemy import select
 
 from orchestrator.api.models import delete
 from orchestrator.db import SubscriptionCustomerDescriptionTable, db
+from orchestrator.utils.errors import StaleDataError
 from orchestrator.utils.redis import delete_subscription_from_redis
+from orchestrator.utils.validate_data_version import validate_data_version
 from orchestrator.websocket import invalidate_subscription_cache
 
 router = APIRouter()
@@ -53,8 +55,14 @@ async def create_subscription_customer_description(
 
 @delete_subscription_from_redis()
 async def update_subscription_customer_description(
-    customer_description: SubscriptionCustomerDescriptionTable, description: str, created_at: datetime | None = None
+    customer_description: SubscriptionCustomerDescriptionTable,
+    description: str,
+    created_at: datetime | None = None,
+    version: int | None = None,
 ) -> SubscriptionCustomerDescriptionTable:
+    if not validate_data_version(customer_description.version, version):
+        raise StaleDataError(customer_description.version, version)
+
     customer_description.description = description
     customer_description.created_at = created_at if created_at else datetime.now(tz=timezone("UTC"))
     db.session.commit()

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/graphql/mutations/customer_description.py

@@ -25,25 +25,28 @@ from orchestrator.domain.customer_description import (
 )
 from orchestrator.graphql.schemas.customer_description import CustomerDescription
 from orchestrator.graphql.types import MutationError, NotFoundError
+from orchestrator.utils.errors import StaleDataError
 
 logger = structlog.get_logger(__name__)
 
 
 async def upsert_customer_description(
-    customer_id: str, subscription_id: UUID, description: str
+    customer_id: str, subscription_id: UUID, description: str, version: int | None
 ) -> SubscriptionCustomerDescriptionTable | NotFoundError:
     current_description = get_customer_description_by_customer_subscription(customer_id, subscription_id)
 
     if current_description:
-        return await update_subscription_customer_description(current_description, description)
+        return await update_subscription_customer_description(current_description, description, version=version)
     return await create_subscription_customer_description(customer_id, subscription_id, description)
 
 
 async def resolve_upsert_customer_description(
-    customer_id: str, subscription_id: UUID, description: str
+    customer_id: str, subscription_id: UUID, description: str, version: int | None = None
 ) -> CustomerDescription | NotFoundError | MutationError:
     try:
-        customer_description = await upsert_customer_description(customer_id, subscription_id, description)
+        customer_description = await upsert_customer_description(customer_id, subscription_id, description, version)
+    except StaleDataError as error:
+        return MutationError(message=str(error))
     except Exception:
         return NotFoundError(message="Subscription not found")
     return CustomerDescription.from_pydantic(customer_description)  # type: ignore

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/graphql/schemas/subscription.py

@@ -77,6 +77,7 @@ class SubscriptionInterface:
     status: SubscriptionLifecycle
     insync: bool
     note: str | None
+    version: int
 
     @strawberry.field(description="Product information")  # type: ignore
     async def product(self) -> ProductModelGraphql:

orchestrator_core-2.9.2rc1/orchestrator/migrations/versions/schema/2025-01-08_4c5859620539_add_version_column_to_subscription.py

@@ -0,0 +1,64 @@
+"""Add version column to subscription and subscription customer descriptions.
+
+Revision ID: 4c5859620539
+Revises: 460ec6748e37
+Create Date: 2025-01-08 15:07:41.957937
+
+"""
+
+import sqlalchemy as sa
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision = "4c5859620539"
+down_revision = "460ec6748e37"
+branch_labels = None
+depends_on = None
+
+
+def upgrade() -> None:
+    conn = op.get_bind()
+    op.add_column(
+        "subscription_customer_descriptions", sa.Column("version", sa.Integer(), server_default="1", nullable=False)
+    )
+    op.add_column("subscriptions", sa.Column("version", sa.Integer(), server_default="1", nullable=False))
+
+    conn.execute(
+        sa.text(
+            """
+CREATE OR REPLACE FUNCTION increment_version()
+RETURNS TRIGGER AS $$
+BEGIN
+    NEW.version := OLD.version + 1;
+    RETURN NEW;
+END;
+$$ LANGUAGE plpgsql;
+
+CREATE TRIGGER subscriptions_increment_version_trigger
+BEFORE UPDATE ON subscriptions
+FOR EACH ROW
+EXECUTE FUNCTION increment_version();
+
+CREATE TRIGGER subscription_customer_descriptions_increment_version_trigger
+BEFORE UPDATE ON subscription_customer_descriptions
+FOR EACH ROW
+EXECUTE FUNCTION increment_version();
+    """
+        )
+    )
+
+
+def downgrade() -> None:
+    conn = op.get_bind()
+    op.drop_column("subscriptions", "version")
+    op.drop_column("subscription_customer_descriptions", "version")
+
+    conn.execute(
+        sa.text(
+            """
+DROP TRIGGER IF EXISTS subscriptions_increment_version_trigger on subscriptions;
+DROP TRIGGER IF EXISTS subscription_customer_descriptions_increment_version_trigger on subscription_customer_descriptions;
+DROP FUNCTION IF EXISTS increment_version;
+"""
+        )
+    )

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/schemas/subscription.py

@@ -84,6 +84,7 @@ class SubscriptionSchema(SubscriptionBaseSchema):
     product: ProductBaseSchema | None = None
     customer_descriptions: list[SubscriptionDescriptionSchema] | None = None
     tag: str | None = None
+    version: int
     model_config = ConfigDict(from_attributes=True)
 
 

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/schemas/subscription_descriptions.py

@@ -28,4 +28,12 @@ class SubscriptionDescriptionBaseSchema(OrchestratorBaseModel):
 class SubscriptionDescriptionSchema(SubscriptionDescriptionBaseSchema):
     id: UUID
     created_at: datetime | None = None
+    version: int
+    model_config = ConfigDict(from_attributes=True)
+
+
+class UpdateSubscriptionDescriptionSchema(SubscriptionDescriptionBaseSchema):
+    id: UUID
+    created_at: datetime | None = None
+    version: int | None = None
     model_config = ConfigDict(from_attributes=True)

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/utils/enrich_process.py

@@ -33,6 +33,7 @@ def format_subscription(subscription: SubscriptionTable) -> dict:
         "note": subscription.note,
         "start_date": subscription.start_date if subscription.start_date else None,
         "end_date": subscription.end_date if subscription.end_date else None,
+        "version": subscription.version,
         "product": {
             "product_id": prod.product_id,
             "description": prod.description,

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/utils/errors.py

@@ -74,6 +74,14 @@ class InconsistentDataError(ProcessFailureError):
     pass
 
 
+class StaleDataError(ValueError):
+    """The version of the update payload does not match the version in the database."""
+
+    def __init__(self, current_version: int, new_version: int | None = None) -> None:
+        message = f"Stale data: given version ({new_version}) does not match the current version ({current_version})"
+        super().__init__(message)
+
+
 def is_api_exception(ex: Exception) -> bool:
     """Test for swagger-codegen ApiException.
 

orchestrator_core-2.9.2rc1/orchestrator/utils/validate_data_version.py

@@ -0,0 +1,2 @@
+def validate_data_version(current_version: int, new_version: int | None = None) -> bool:
+    return (new_version is not None and new_version == current_version) or new_version is None

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/workflows/translations/en-GB.json

@@ -4,6 +4,7 @@
             "note": "Notes",
             "note_info": "Notes, reminders and feedback about this description.",
             "subscription_id": "Subscription",
+            "version": "Version",
             "subscription_id_info": "The subscription for this action"
         }
     },

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/orchestrator/workflows/utils.py

@@ -13,11 +13,11 @@
 
 from collections.abc import Callable
 from inspect import isgeneratorfunction
-from typing import cast
+from typing import Self, cast
 from uuid import UUID
 
 from more_itertools import first_true
-from pydantic import field_validator
+from pydantic import field_validator, model_validator
 from sqlalchemy import select
 
 from orchestrator.db import ProductTable, SubscriptionTable, db
@@ -26,8 +26,10 @@ from orchestrator.services import subscriptions
 from orchestrator.settings import app_settings
 from orchestrator.targets import Target
 from orchestrator.types import State, SubscriptionLifecycle
+from orchestrator.utils.errors import StaleDataError
 from orchestrator.utils.redis import caching_models_enabled
 from orchestrator.utils.state import form_inject_args
+from orchestrator.utils.validate_data_version import validate_data_version
 from orchestrator.workflow import StepList, Workflow, conditional, done, init, make_workflow, step
 from orchestrator.workflows.steps import (
     cache_domain_models,
@@ -116,6 +118,7 @@ def _generate_modify_form(workflow_target: str, workflow_name: str) -> InputForm
         # We use UUID instead of SubscriptionId here because we don't want the allowed_status check and
         # we do our own validation here.
         subscription_id: UUID
+        version: int | None = None
 
         @field_validator("subscription_id")
         @classmethod
@@ -140,6 +143,15 @@ def _generate_modify_form(workflow_target: str, workflow_name: str) -> InputForm
 
             return subscription_id
 
+        @model_validator(mode="after")
+        def version_validator(self) -> Self:
+            current_version = db.session.scalars(
+                select(SubscriptionTable.version).where(SubscriptionTable.subscription_id == self.subscription_id)
+            ).one()
+            if not validate_data_version(current_version, self.version):
+                raise StaleDataError(current_version, self.version)
+            return self
+
     return ModifySubscriptionPage
 
 
@@ -157,11 +169,11 @@ def wrap_modify_initial_input_form(initial_input_form: InputStepFunc | None) ->
         user_input = yield _generate_modify_form(workflow_target, workflow_name)
 
         subscription = SubscriptionTable.query.get(user_input.subscription_id)
-
         begin_state = {
             "subscription_id": str(subscription.subscription_id),
             "product": str(subscription.product_id),
             "customer_id": subscription.customer_id,
+            "version": subscription.version,
         }
 
         if initial_input_form is None:

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/test/unit_tests/api/test_processes.py

@@ -531,3 +531,51 @@ def test_create_process_reporter(test_client, fastapi_app, oidc_user, reporter,
     assert response.status_code == 201, response.text
     mock_start_process.assert_called()
     assert mock_start_process.mock_calls[0].kwargs["user"] == expected_user
+
+
+def test_new_process_without_version(test_client, generic_subscription_1):
+
+    response = test_client.post(
+        "/api/processes/modify_note",
+        json=[{"subscription_id": generic_subscription_1}, {"note": "test note"}],
+    )
+    assert HTTPStatus.CREATED == response.status_code
+    new_version = db.session.get(SubscriptionTable, generic_subscription_1).version
+    assert new_version == 3
+
+
+def test_new_process_version_check(test_client, generic_subscription_1):
+    version = 2
+
+    response = test_client.post(
+        "/api/processes/modify_note",
+        json=[{"subscription_id": generic_subscription_1, "version": version}, {"note": "test note"}],
+    )
+    assert HTTPStatus.CREATED == response.status_code
+    new_version = db.session.get(SubscriptionTable, generic_subscription_1).version
+    assert new_version == version + 1
+
+
+def test_new_process_lower_version_invalid(test_client, generic_subscription_1):
+    response = test_client.post(
+        "/api/processes/modify_note",
+        json=[{"subscription_id": generic_subscription_1, "version": 0}, {"note": "test note"}],
+    )
+    assert HTTPStatus.BAD_REQUEST == response.status_code
+    payload = response.json()
+    assert (
+        payload["validation_errors"][0]["msg"] == "Stale data: given version (0) does not match the current version (2)"
+    )
+
+
+def test_new_process_higher_version_invalid(test_client, generic_subscription_1):
+    response = test_client.post(
+        "/api/processes/modify_note",
+        json=[{"subscription_id": generic_subscription_1, "version": 10}, {"note": "test note"}],
+    )
+    assert HTTPStatus.BAD_REQUEST == response.status_code
+    payload = response.json()
+    assert (
+        payload["validation_errors"][0]["msg"]
+        == "Stale data: given version (10) does not match the current version (2)"
+    )

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/test/unit_tests/api/test_subscription_customer_descriptions.py

@@ -27,6 +27,7 @@ def seed():
                 id=SUBSCRIPTION_CUSTOMER_DESCRIPTION_ID, customer_id=CUSTOMER_ID, description="customer other alias"
             )
         ],
+        version=1,
     )
 
     db.session.add(product)
@@ -81,6 +82,60 @@ def test_update(seed, test_client):
 
     customer_description = db.session.query(SubscriptionCustomerDescriptionTable).first()
     assert new_desc == customer_description.description
+    assert 2 == customer_description.version
+
+
+def test_update_with_version(seed, test_client):
+    new_desc = "Updated specific alias"
+    version = 1
+    body = {
+        "id": SUBSCRIPTION_CUSTOMER_DESCRIPTION_ID,
+        "subscription_id": SUBSCRIPTION_ID,
+        "customer_id": CUSTOMER_ID,
+        "description": new_desc,
+        "version": version,
+    }
+    response = test_client.put("/api/subscription_customer_descriptions/", json=body)
+    assert HTTPStatus.NO_CONTENT == response.status_code
+
+    count = db.session.query(SubscriptionCustomerDescriptionTable).count()
+    assert 1 == count
+
+    customer_description = db.session.query(SubscriptionCustomerDescriptionTable).first()
+    assert new_desc == customer_description.description
+    assert version + 1 == customer_description.version
+
+
+def test_update_with_lower_version_invalid(seed, test_client):
+    new_desc = "Updated specific alias"
+    body = {
+        "id": SUBSCRIPTION_CUSTOMER_DESCRIPTION_ID,
+        "subscription_id": SUBSCRIPTION_ID,
+        "customer_id": CUSTOMER_ID,
+        "description": new_desc,
+        "version": 0,
+    }
+    response = test_client.put("/api/subscription_customer_descriptions/", json=body)
+    assert HTTPStatus.BAD_REQUEST == response.status_code
+
+    data = response.json()
+    assert "Stale data: given version (0) does not match the current version (1)" == data["detail"]
+
+
+def test_update_with_higher_version_invalid(seed, test_client):
+    new_desc = "Updated specific alias"
+    body = {
+        "id": SUBSCRIPTION_CUSTOMER_DESCRIPTION_ID,
+        "subscription_id": SUBSCRIPTION_ID,
+        "customer_id": CUSTOMER_ID,
+        "description": new_desc,
+        "version": 10,
+    }
+    response = test_client.put("/api/subscription_customer_descriptions/", json=body)
+    assert HTTPStatus.BAD_REQUEST == response.status_code
+
+    data = response.json()
+    assert "Stale data: given version (10) does not match the current version (1)" == data["detail"]
 
 
 def test_delete(seed, test_client):

{orchestrator_core-2.9.1rc1 → orchestrator_core-2.9.2rc1}/test/unit_tests/api/test_subscriptions.py

@@ -817,6 +817,7 @@ def test_subscription_detail_special_fields(mock_from_redis, test_client):
         "status": "active",
         "customer_id": "f711c6fe-6de3-40bd-a4e7-9ac9d183a788",
         "insync": True,
+        "version": 1,
         "product": {
             "name": "fake name",
             "description": "fake description",
@@ -854,6 +855,7 @@ def test_subscription_detail_special_fields(mock_from_redis, test_client):
         },
         "customer_descriptions": [],
         "tag": None,
+        "version": 1,
         "ip_address": "127.0.0.1",
     }