[uss_qualifier] Constraint reference synchronization scenario

monitoring/prober/infrastructure.py

@@ -100,7 +100,7 @@ def wrapper_default_scope(*args, **kwargs):
 resource_type_code_descriptions: Dict[ResourceType, str] = {}
 
 
-# Next code: 390
+# Next code: 391
 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

@@ -66,6 +66,7 @@ v1:
               # ASTM F3548-21 USS emulation roles
               - utm.strategic_coordination
               - utm.availability_arbitration
+              - utm.constraint_management
               # For authentication test purposes.
               # Remove if the authentication provider pointed to by AUTH_SPEC does not support it.
               - ""

monitoring/uss_qualifier/configurations/dev/library/environment_containers.yaml

@@ -27,6 +27,7 @@ utm_auth:
       - utm.strategic_coordination
       - utm.conformance_monitoring_sa
       - utm.availability_arbitration
+      - utm.constraint_management
       # InterUSS versioning automated testing
       - interuss.versioning.read_system_versions
       - interuss.geospatial_map.query

monitoring/uss_qualifier/configurations/dev/library/environment_localhost.yaml

@@ -27,6 +27,7 @@ utm_auth:
       - utm.strategic_coordination
       - utm.conformance_monitoring_sa
       - utm.availability_arbitration
+      - utm.constraint_management
       # InterUSS versioning automated testing
       - interuss.versioning.read_system_versions
       - interuss.geospatial_map.query

monitoring/uss_qualifier/resources/astm/f3548/v21/dss.py

@@ -33,6 +33,11 @@
     ExchangeRecord,
     ErrorReport,
     AirspaceConflictResponse,
+    PutConstraintReferenceParameters,
+    ChangeConstraintReferenceResponse,
+    ConstraintReference,
+    QueryConstraintReferenceParameters,
+    QueryConstraintReferencesResponse,
 )
 from uas_standards.astm.f3548.v21.constants import Scope
 
@@ -457,6 +462,139 @@ def set_uss_availability(
             result = query.parse_json_result(UssAvailabilityStatusResponse)
             return result.version, query
 
+    def put_constraint_ref(
+        self,
+        cr_id: str,
+        extents: List[Volume4D],
+        uss_base_url: UssBaseURL,
+        ovn: Optional[str] = None,
+    ) -> Tuple[ConstraintReference, List[SubscriberToNotify], Query]:
+        """
+        Create or update a constraint reference.
+        Returns:
+            the constraint reference created or updated, the subscribers to notify, the query
+        Raises:
+            * QueryError if request failed, if HTTP status code is different than 200 or 201, or if the parsing of the response failed.
+        """
+        self._uses_scope(Scope.ConstraintManagement)
+        create = ovn is None
+        if create:
+            op = OPERATIONS[OperationID.CreateConstraintReference]
+            url = op.path.format(entityid=cr_id)
+            query_type = QueryType.F3548v21DSSCreateConstraintReference
+        else:
+            op = OPERATIONS[OperationID.UpdateConstraintReference]
+            url = op.path.format(entityid=cr_id, ovn=ovn)
+            query_type = QueryType.F3548v21DSSUpdateConstraintReference
+
+        req = PutConstraintReferenceParameters(
+            extents=extents,
+            uss_base_url=uss_base_url,
+        )
+        query = query_and_describe(
+            self.client,
+            op.verb,
+            url,
+            query_type,
+            self.participant_id,
+            scope=Scope.ConstraintManagement,
+            json=req,
+        )
+        if (create and query.status_code == 201) or (
+            not create and query.status_code == 200
+        ):
+            result = query.parse_json_result(ChangeConstraintReferenceResponse)
+            return result.constraint_reference, result.subscribers, query
+        else:
+            err_msg = query.error_message if query.error_message is not None else ""
+            raise QueryError(
+                f"Received code {query.status_code} when attempting to {'create' if create else 'update'} constraint reference with ID {cr_id}; error message: `{err_msg}`",
+                query,
+            )
+
+    def get_constraint_ref(self, id: str) -> Tuple[ConstraintReference, Query]:
+        """
+        Retrieve a constraint reference from the DSS, using only its ID
+        Raises:
+            * QueryError: if request failed, if HTTP status code is different than 200, or if the parsing of the response failed.
+        """
+        self._uses_scope(Scope.ConstraintManagement)
+        op = OPERATIONS[OperationID.GetConstraintReference]
+        query = query_and_describe(
+            self.client,
+            op.verb,
+            op.path.format(entityid=id),
+            QueryType.F3548v21DSSGetConstraintReference,
+            self.participant_id,
+            scope=Scope.ConstraintManagement,
+        )
+        if query.status_code != 200:
+            raise QueryError(
+                f"Received code {query.status_code} when attempting to retrieve constraint reference {id}{f'; error message: `{query.error_message}`' if query.error_message is not None else ''}",
+                query,
+            )
+        else:
+            result = query.parse_json_result(ChangeConstraintReferenceResponse)
+            return result.constraint_reference, query
+
+    def find_constraint_ref(
+        self, extent: Volume4D
+    ) -> Tuple[List[ConstraintReference], Query]:
+        """
+        Find constraint references overlapping with a given volume 4D.
+        Raises:
+            * QueryError: if request failed, if HTTP status code is different than 200, or if the parsing of the response failed.
+        """
+        self._uses_scope(Scope.ConstraintManagement)
+        op = OPERATIONS[OperationID.QueryConstraintReferences]
+        req = QueryConstraintReferenceParameters(area_of_interest=extent)
+        query = query_and_describe(
+            self.client,
+            op.verb,
+            op.path,
+            QueryType.F3548v21DSSQueryConstraintReferences,
+            self.participant_id,
+            scope=Scope.ConstraintManagement,
+            json=req,
+        )
+        if query.status_code != 200:
+            raise QueryError(
+                f"Received code {query.status_code} when attempting to find operational intents in {extent}{f'; error message: `{query.error_message}`' if query.error_message is not None else ''}",
+                query,
+            )
+        else:
+            result = query.parse_json_result(QueryConstraintReferencesResponse)
+            return result.constraint_references, query
+
+    def delete_constraint_ref(
+        self,
+        id: str,
+        ovn: str,
+    ) -> Tuple[ConstraintReference, List[SubscriberToNotify], Query]:
+        """
+        Delete a constraint reference.
+        Raises:
+            * QueryError: if request failed, if HTTP status code is different than 200, or if the parsing of the response failed.
+        """
+        self._uses_scope(Scope.ConstraintManagement)
+        op = OPERATIONS[OperationID.DeleteConstraintReference]
+        query = query_and_describe(
+            self.client,
+            op.verb,
+            op.path.format(entityid=id, ovn=ovn),
+            QueryType.F3548v21DSSDeleteConstraintReference,
+            self.participant_id,
+            scope=Scope.ConstraintManagement,
+        )
+        if query.status_code != 200:
+            raise QueryError(
+                f"Received code {query.status_code} when attempting to delete constraint reference {id}{f'; error message: `{query.error_message}`' if query.error_message is not None else ''}",
+                query,
+            )
+        else:
+            result = query.parse_json_result(ChangeConstraintReferenceResponse)
+            return result.constraint_reference, result.subscribers, query
+
     def make_report(
         self,
         exchange: ExchangeRecord,

monitoring/uss_qualifier/resources/astm/f3548/v21/planning_area.py

@@ -9,6 +9,7 @@
     EntityID,
     PutOperationalIntentReferenceParameters,
     ImplicitSubscriptionParameters,
+    PutConstraintReferenceParameters,
 )
 
 from monitoring.monitorlib.geo import make_latlng_rect, Volume3D
@@ -101,6 +102,29 @@ def get_new_operational_intent_ref_params(
             else None,
         )
 
+    def get_new_constraint_ref_params(
+        self,
+        time_start: datetime.datetime,
+        time_end: datetime.datetime,
+    ) -> PutConstraintReferenceParameters:
+        """
+        Builds a PutConstraintReferenceParameters object that can be used against the DSS OCR API.
+
+        The extents contained in these parameters contain a single 4DVolume, which may not be entirely realistic,
+        but is sufficient in situations where the content of the CR is irrelevant as long as it is valid, such
+        as for testing authentication or parameter validation.
+        """
+        return PutConstraintReferenceParameters(
+            extents=[
+                Volume4D(
+                    volume=self.volume,
+                    time_start=Time(time_start),
+                    time_end=Time(time_end),
+                ).to_f3548v21()
+            ],
+            uss_base_url=self.base_url,
+        )
+
 
 class PlanningAreaResource(Resource[PlanningAreaSpecification]):
     specification: PlanningAreaSpecification

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

@@ -28,3 +28,18 @@ If the DSS cannot be queried for the existing test ID, the DSS is likely not imp
 ## 🛑 Subscription can be deleted check
 
 **[astm.f3548.v21.DSS0005,5](../../../../requirements/astm/f3548/v21.md)** requires the implementation of the DSS endpoint to allow callers to delete subscriptions they created.
+
+## 🛑 Constraint references can be queried by ID check
+
+If an existing constraint reference cannot directly be queried by its ID, or if for a non-existing one the DSS replies with a status code different than 404,
+the DSS implementation is in violation of **[astm.f3548.v21.DSS0005,3](../../../../requirements/astm/f3548/v21.md)**.
+
+## 🛑 Constraint references can be searched for check
+
+A client with valid credentials should be allowed to search for constraint references in a given area.
+Otherwise, the DSS is not in compliance with **[astm.f3548.v21.DSS0005,4](../../../../requirements/astm/f3548/v21.md)**.
+
+## 🛑 Constraint reference removed check
+
+If an existing constraint cannot be deleted by its manager when providing the proper ID and OVN, the DSS implementation is in violation of
+**[astm.f3548.v21.DSS0005,3](../../../../requirements/astm/f3548/v21.md)**.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/cr/crud/create_correct.md

@@ -0,0 +1,21 @@
+# Create constraint reference test step fragment
+
+This test step fragment validates that:
+ - a query to create a constraint reference with valid parameters succeeds
+ - the response to the query conforms to the OpenAPI specification
+ - the content of the response reflects the created constraint reference
+
+## [Query Success](./create_query.md)
+
+Check query succeeds
+
+## [Response Format](./create_format.md)
+
+Check response format
+
+## 🛑 Create constraint reference response content is correct check
+
+A successful constraint reference creation query is expected to return a body, the content of which reflects the created constraint reference.
+If the content of the response does not correspond to what was requested, the DSS is failing to implement **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.
+
+This check will usually be performing a series of sub-checks from the [validate](../validate) fragments.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/cr/crud/create_format.md

@@ -0,0 +1,9 @@
+# Create constraint reference response format test step fragment
+
+This test step fragment validates that a constraint references creation returns a body in the correct format.
+
+## 🛑 Create constraint reference response format conforms to spec check
+
+The response to a successful constraint reference creation query is expected to conform to the format defined by the OpenAPI specification under the `A3.1` Annex of ASTM F3548−21.
+
+If it does not, the DSS is failing to implement **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/cr/crud/create_query.md

@@ -0,0 +1,8 @@
+# Create constraint reference test step fragment
+
+This test step fragment validates that a query to create a constraint reference with valid parameters succeeds
+
+## 🛑 Create constraint reference query succeeds check
+
+As per **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**, the DSS API must allow callers to create a constraint reference with either one or both of the
+start and end time missing, provided all the required parameters are valid.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/cr/crud/delete.md

@@ -0,0 +1,20 @@
+# Delete constraint reference test step fragment
+
+This test step fragment validates that constraint references can be deleted
+
+## 🛑 Delete constraint reference query succeeds check
+
+A query to delete a constraint reference, by its owner and when the correct OVN is provided, should succeed, otherwise the DSS is in violation of **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.
+
+## 🛑 Delete constraint reference response format conforms to spec check
+
+The response to a successful constraint reference deletion query is expected to conform to the format defined by the OpenAPI specification under the `A3.1` Annex of ASTM F3548−21.
+
+If it does not, the DSS is failing to implement **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.
+
+## 🛑 Delete constraint reference response content is correct check
+
+A successful constraint reference deletion query is expected to return a body, the content of which reflects the constraint reference at the moment of deletion.
+If the content of the response does not correspond to what was requested, the DSS is failing to implement **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.
+
+This check will usually be performing a series of sub-checks from the [validate](../validate) fragments.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/cr/crud/read_correct.md

@@ -0,0 +1,20 @@
+# Read constraint reference test step fragment
+
+This test step fragment validates that constraint references can be read
+
+## [Read query succeeds](./read_query.md)
+
+Check query succeeds.
+
+## 🛑 Get constraint reference response format conforms to spec check
+
+The response to a successful get constraint reference query is expected to conform to the format defined by the OpenAPI specification under the `A3.1` Annex of ASTM F3548−21.
+
+If it does not, the DSS is failing to implement **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.
+
+## 🛑 Get constraint reference response content is correct check
+
+A successful constraint reference creation query is expected to return a body, the content of which reflects a constraint reference that was created earlier.
+If the content of the response does not correspond to what was requested, the DSS is failing to implement **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.
+
+This check will usually be performing a series of sub-checks from the [validate](../validate) fragments.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/cr/crud/read_query.md

@@ -0,0 +1,7 @@
+# Read constraint reference query test step fragment
+
+This test step fragment validates that a query to retrieve a constraint reference with valid parameters succeeds.
+
+## 🛑 Get constraint reference by ID check
+
+If a constraint reference cannot be queried using its ID, the DSS is failing to meet **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/cr/crud/search_correct.md

@@ -0,0 +1,17 @@
+# Search constraint reference test step fragment
+
+This test step fragment validates that constraint references can be searched for
+
+## [Search query succeeds](./search_query.md)
+
+Check query succeeds.
+
+## 🛑 Search constraint reference response format conforms to spec check
+
+The response to a successful constraint reference search query is expected to conform to the format defined by the OpenAPI specification under the `A3.1` Annex of ASTM F3548−21.
+
+If it does not, the DSS is failing to implement **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.
+
+## 🛑 Created constraint reference is in search results check
+
+If the existing constraint reference is not returned in a search that covers the area it was created for, the DSS is not properly implementing **[astm.f3548.v21.DSS0005,2](../../../../../../../requirements/astm/f3548/v21.md)**.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/cr/crud/search_query.md

@@ -0,0 +1,7 @@
+# Search constraint reference query test step fragment
+
+This test step fragment validates that a query to search for constraint references with valid parameters succeeds.
+
+## 🛑 Successful constraint reference search query check
+
+If the DSS fails to let us search in the area for which the CR was created, it is failing to meet **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/cr/crud/update_correct.md

@@ -0,0 +1,18 @@
+# Update constraint reference test step fragment
+
+This test step fragment validates that constraint references can be updated.
+
+## [Update query succeeds](./update_query.md)
+
+Check query succeeds.
+
+## [Response Format](./update_format.md)
+
+Check response format
+
+## 🛑 Mutate constraint reference response content is correct check
+
+A successful constraint reference mutation query is expected to return a well-defined body, the content of which reflects the updated constraint reference.
+If the content of the response does not correspond to what was requested, the DSS is failing to implement **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.
+
+This check will usually be performing a series of sub-checks from the [validate](../validate) fragments.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/cr/crud/update_format.md

@@ -0,0 +1,9 @@
+# Update constraint reference response format test step fragment
+
+This test step fragment validates that updates to constraint references return a body in the correct format.
+
+## 🛑 Mutate constraint reference response format conforms to spec check
+
+The response to a successful constraint reference mutation query is expected to conform to the format defined by the OpenAPI specification under the `A3.1` Annex of ASTM F3548−21.
+
+If it does not, the DSS is failing to implement **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/cr/crud/update_query.md

@@ -0,0 +1,7 @@
+# Update constraint reference test step fragment
+
+This test step fragment validates that a query to update a constraint reference with valid parameters succeeds.
+
+## 🛑 Mutate constraint reference query succeeds check
+
+As per **[astm.f3548.v21.DSS0005,3](../../../../../../../requirements/astm/f3548/v21.md)**, the DSS API must allow callers to mutate a constraint reference.