[uss_qualifier] SCD DSS0210,A2-7-2 – OIR key validation when creating or updating an OIR

monitoring/prober/infrastructure.py

@@ -100,7 +100,7 @@ def wrapper_default_scope(*args, **kwargs):
 resource_type_code_descriptions: Dict[ResourceType, str] = {}
 
 
-# Next code: 381
+# Next code: 385
 def register_resource_type(code: int, description: str) -> ResourceType:
     """Register that the specified code refers to the described resource.
 

monitoring/uss_qualifier/configurations/dev/f3548_self_contained.yaml

@@ -14,6 +14,7 @@ v1:
         # Mapping of <resource name in test suite> to <resource name in resource pool>
         resources:
           id_generator: id_generator
+          utm_client_identity: utm_client_identity
           test_env_version_providers: test_env_version_providers
           prod_env_version_providers: prod_env_version_providers
           flight_planners: flight_planners

monitoring/uss_qualifier/configurations/dev/message_signing.yaml

@@ -59,6 +59,7 @@ v1:
           dss: scd_dss
           dss_instances: scd_dss_instances
           id_generator: id_generator
+          utm_client_identity: utm_client_identity
           second_utm_auth: second_utm_auth
           planning_area: che_planning_area
           problematically_big_area: che_problematically_big_area

monitoring/uss_qualifier/scenarios/astm/utm/dss/__init__.py

@@ -4,3 +4,4 @@
 from .op_intent_ref_access_control import OpIntentReferenceAccessControl
 from .dss_interoperability import DSSInteroperability
 from .report import Report
+from .op_intent_ref_key_validation import OIRKeyValidation

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/oir/crud/create_conflict.md

@@ -0,0 +1,23 @@
+# Conflict on operational intent reference creation test step fragment
+
+This test step fragment validates that requests for operational intent reference creation that
+don't show that they have been de-conflicted are rejected with the proper error.
+
+## 🛑 Create operational intent reference with missing OVN fails check
+
+If the DSS allows the creation of an operational intent reference that is missing the required OVNs for other entities that exist in its geo-temporal vicinity,
+it is in violation of **[astm.f3548.v21.DSS0005,1](../../../../../../../requirements/astm/f3548/v21.md)** and **[astm.f3548.v21.DSS0210,A2-7-2,2a](../../../../../../../requirements/astm/f3548/v21.md)**
+
+## 🛑 Failure response due to conflict has proper format check
+
+The DSS is expected to return a `HTTP 409` error response when the creation of an operational intent reference fails due to a conflict.
+This response is expected to conform to the OpenAPI spec that is part of **[astm.f3548.v21.DSS0005,1](../../../../../../../requirements/astm/f3548/v21.md)**.
+
+Should this not be the case, then the DSS is in violation of the aforementioned requirement.
+
+## 🛑 Failure response due to conflict contains conflicting OIRs check
+
+If the DSS returns a `HTTP 409` error response due to a conflict, and the response body contains a `missing_operational_intents` field,
+this field is expected to contain the conflicting OVNs.
+
+If the field exists but does not contain the conflicting OVNs, then the DSS is in violation of **[astm.f3548.v21.DSS0005,1](../../../../../../../requirements/astm/f3548/v21.md)**.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/oir/crud/update_conflict.md

@@ -0,0 +1,23 @@
+# Conflict on operational intent reference update test step fragment
+
+This test step fragment validates that requests for operational intent references updates that
+don't show that they have been de-conflicted are rejected with the proper error.
+
+## 🛑 Mutate operational intent reference with missing OVN fails check
+
+If the DSS allows the mutation of an operational intent reference that is missing the required OVNs for other entities that exist in its geo-temporal vicinity,
+it is in violation of **[astm.f3548.v21.DSS0005,1](../../../../../../../requirements/astm/f3548/v21.md)** and **[astm.f3548.v21.DSS0210,A2-7-2,2b](../../../../../../../requirements/astm/f3548/v21.md)**
+
+## 🛑 Failure response due to conflict has proper format check
+
+The DSS is expected to return a `HTTP 409` error response when the creation of an operational intent reference fails due to a conflict.
+This response is expected to conform to the OpenAPI spec that is part of **[astm.f3548.v21.DSS0005,1](../../../../../../../requirements/astm/f3548/v21.md)**.
+
+Should this not be the case, then the DSS is in violation of the aforementioned requirement.
+
+## 🛑 Failure response due to conflict contains conflicting OIRs check
+
+If the DSS returns a `HTTP 409` error response due to a conflict, and the response body contains a `missing_operational_intents` field,
+this field is expected to contain the conflicting OVNs.
+
+If the field exists but does not contain the conflicting OVNs, then the DSS is in violation of **[astm.f3548.v21.DSS0005,1](../../../../../../../requirements/astm/f3548/v21.md)**.

monitoring/uss_qualifier/scenarios/astm/utm/dss/op_intent_ref_key_validation.md

@@ -0,0 +1,144 @@
+# ASTM SCD DSS: Operational Intent Reference Key Validation test scenario
+
+## Overview
+
+Verifies that a DSS requires from a client creating or updating operational intent references that they
+provide all OVNs for all currently relevant entities.
+
+## Resources
+
+### dss
+
+[`DSSInstanceResource`](../../../../resources/astm/f3548/v21/dss.py) the DSS instance through which entities are created, modified and deleted.
+
+### id_generator
+
+[`IDGeneratorResource`](../../../../resources/interuss/id_generator.py) providing the base entity ID for this scenario.
+
+### client_identity
+
+[`ClientIdentityResource`](../../../../resources/communications/client_identity.py) the client identity that will be used to create and update operational intent references.
+
+### planning_area
+
+[`PlanningAreaResource`](../../../../resources/astm/f3548/v21/planning_area.py) describes the 3D volume in which operational intent references will be created.
+
+## Setup test case
+
+### [Ensure clean workspace test step](./clean_workspace.md)
+
+This step ensures that no entities with the known test IDs exists in the DSS.
+
+## Key validation on creation test case
+
+This test case will create multiple operational intent references and verify that the `key` field
+of the parameters to create or update an operational intent reference is properly validated.
+
+That is: the DSS should require that the client provides the OVNs for each entity that is in the vicinity,
+both geographically and temporally, of the client's operational intent reference.
+
+### Create first OIR test step
+
+This step creates one operational intent references. As no other operational intent reference is present,
+the `key` field may remain empty.
+
+#### 🛑 First operational intent reference in area creation query succeeds check
+
+With no potentially conflicting entity present, the DSS is expected to allow the creation of an operational intent without
+the client specifying any OVN in the `key` field.
+
+If the DSS rejects a well-formed request to create the operational intent reference, it is in violation of **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)**.
+
+### Create second non-overlapping OIR test step
+
+This step creates a second operational intent references that does not overlap in time with the first, and
+should therefore not require any entry in the `key` field.
+
+#### 🛑 Second, non-overlapping operational intent reference creation succeeds check
+
+With a single existing OIR in the area that is not overlapping in time, the DSS is expected to allow the creation of an operational intent without
+the client specifying any OVN in the `key` field.
+
+If the DSS rejects a well-formed request to create the operational intent reference, it is in violation of **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)**.
+
+### Attempt OIR creation overlapping with first OIR test step
+
+This test step will attempt to create an operational intent reference that intersects with the first of the previously created OIR,
+and expect the DSS to require its OVN to be provided in the `key` field.
+
+This step will validate the response body for the `HTTP 409` error response from the DSS when it contains the optional `missing_operational_intents` field.
+
+#### [Non de-conflicted request fails](fragments/oir/crud/create_conflict.md)
+
+Checks that an attempt to create an OIR without specifying the OVN of the already existing and overlapping OIR fails.
+
+### Attempt OIR creation overlapping with second OIR test step
+
+This test step will attempt to create an operational intent reference that intersects with the second of the previously created OIR,
+and expect the DSS to require its OVN to be provided in the `key` field.
+
+This step will validate the response body for the `HTTP 409` error response from the DSS when it contains the optional `missing_operational_intents` field.
+
+#### [Non de-conflicted request fails](fragments/oir/crud/create_conflict.md)
+
+Checks that an attempt to create an OIR without specifying the OVN of the already existing and overlapping OIR fails.
+
+### Attempt OIR creation overlapping with both OIRs test step
+
+This test step will attempt to create an operational intent reference that intersects with both of the previously created OIRs,
+and expect the DSS to require their OVNs to be provided in the `key` field.
+
+This step will validate the response body for the `HTTP 409` error response from the DSS when it contains the optional `missing_operational_intents` field.
+
+#### [Non de-conflicted creation request fails](fragments/oir/crud/create_conflict.md)
+
+Checks that an attempt to create an OIR without specifying the OVNs of the already existing and overlapping OIRs fails.
+
+### Attempt valid OIR creation overlapping with both OIRs test step
+
+This test step will attempt to create an operational intent reference that intersects with both of the previously created OIRs,
+while providing the required OVNs in the `key` field.
+
+After this test step succeeds, three OIRs are expected to exist in the DSS, with one intersecting with the two others.
+
+#### 🛑 Create operational intent reference with proper OVNs succeeds check
+
+If the DSS prevents the creation of an operational intent reference that is providing all required OVNs for other entities that exist in its geo-temporal vicinity,
+it is in violation of **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)**.
+
+## Key validation on mutation test case
+
+This test case will update multiple operational intent references and verify that the `key` field
+of the parameters to create or update an operational intent reference is properly validated.
+
+That is: the DSS should require that the client provides the OVNs for each entity that is in the vicinity,
+both geographically and temporally, of the client's operational intent reference.
+
+### Attempt mutation with both OVNs missing test step
+
+This test step will attempt to mutate the third previously created operational intent reference so that it keeps overlapping with the others,
+while omitting their OVNs in the `key` field.
+
+The expectation is that the DSS will require the two missing OVNs.
+
+#### [Non de-conflicted mutation request fails](fragments/oir/crud/update_conflict.md)
+
+### Attempt mutation with first OVN missing test step
+
+This test step will attempt to mutate the third previously created operational intent reference so that it keeps overlapping with the others,
+while omitting the first OVN in the `key` field.
+
+The expectation is that the DSS will require the missing OVN.
+
+#### [Non de-conflicted mutation request fails](fragments/oir/crud/update_conflict.md)
+
+### Attempt mutation to overlap with the first OIR test step
+
+This test step will attempt to mutate the third previously created operational intent reference so that it overlaps with the first one,
+while omitting the first OVN in the `key` field.
+
+The expectation is that the DSS will require the missing OVN.
+
+#### [Non de-conflicted mutation request fails](fragments/oir/crud/update_conflict.md)
+
+## [Cleanup](./clean_workspace.md)