[uss_qualifier] check that implicit SCD subscriptions are properly ma…

…naged

monitoring/monitorlib/fetch/scd.py

@@ -375,10 +375,17 @@ def constraints(
 class FetchedSubscription(fetch.Query):
     @property
     def success(self) -> bool:
+        """
+        Returns: True if the query was successful OR if it returned a 404.
+        """
         return not self.errors
 
     @property
     def errors(self) -> List[str]:
+        """
+        Returns: A list of messages describing the errors encountered during the query.
+        IMPORTANT: a 404 is not considered as an error for this query.
+        """
         if self.status_code == 404:
             return []
         if self.status_code != 200:

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

@@ -261,6 +261,7 @@ def put_op_intent(
         ovn: Optional[str] = None,
         subscription_id: Optional[str] = None,
         force_query_scopes: Optional[Scope] = None,
+        force_no_implicit_subscription: bool = False,
     ) -> Tuple[OperationalIntentReference, List[SubscriberToNotify], Query,]:
         """
         Create or update an operational intent.
@@ -272,6 +273,8 @@ def put_op_intent(
         Scenarios that wish to test the behavior of the DSS when an incorrect scope is used can force the scope
         to be with the 'force_query_scope' parameter.
 
+        If 'force_no_implicit_subscription' is True, no implicit subscription will be requested under any circumstance.
+
         Returns:
              the operational intent reference created or updated, the subscribers to notify, the query
         Raises:
@@ -313,7 +316,7 @@ def put_op_intent(
             uss_base_url=base_url,
             subscription_id=subscription_id,
             new_subscription=ImplicitSubscriptionParameters(uss_base_url=base_url)
-            if subscription_id is None
+            if subscription_id is None and force_no_implicit_subscription is False
             else None,
         )
         query = query_and_describe(
@@ -674,6 +677,7 @@ def get_subscription(self, sub_id: str) -> FetchedSubscription:
         """
         Retrieve a subscription from the DSS, using only its ID
         """
+        # TODO should be migrated to the pattern where failures raise a QueryError
         self._uses_scope(Scope.StrategicCoordination)
         return fetch.get_subscription(
             self.client,

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

@@ -34,6 +34,15 @@ class PlanningAreaSpecification(ImplicitDict):
     volume: Volume3D
     """3D volume of service area"""
 
+    def get_volume4d(
+        self, time_start: datetime.datetime, time_end: datetime.datetime
+    ) -> Volume4D:
+        return Volume4D(
+            volume=self.volume,
+            time_start=Time(time_start),
+            time_end=Time(time_end),
+        )
+
     def get_new_subscription_params(
         self,
         subscription_id: str,
@@ -83,13 +92,7 @@ def get_new_operational_intent_ref_params(
         Note that this method allows building inconsistent parameters:
         """
         return PutOperationalIntentReferenceParameters(
-            extents=[
-                Volume4D(
-                    volume=self.volume,
-                    time_start=Time(time_start),
-                    time_end=Time(time_end),
-                ).to_f3548v21()
-            ],
+            extents=[self.get_volume4d(time_start, time_end).to_f3548v21()],
             key=key,
             state=state,
             uss_base_url=uss_base_url,
@@ -115,13 +118,7 @@ def get_new_constraint_ref_params(
         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()
-            ],
+            extents=[self.get_volume4d(time_start, time_end).to_f3548v21()],
             uss_base_url=self.base_url,
         )
 

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

@@ -9,3 +9,4 @@
 from .op_intent_ref_simple import OIRSimple
 from .subscription_interactions import SubscriptionInteractions
 from .subscription_interactions_deletion import SubscriptionInteractionsDeletion
+from .oir_implicit_sub_handling import OIRImplicitSubHandling

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/sub/implicit_correct.md

@@ -0,0 +1,10 @@
+# Implicit subscription validity test step fragment
+
+This test step fragment validates the time-bounds of an implicit subscription
+
+## 🛑 Implicit subscription has correct temporal parameters check
+
+If the implicit subscription time boundaries do not match the OIR's, either one, or both, of the following are possible:
+
+The DSS is in violation of **[astm.f3548.v21.DSS0005,1](../../../../../../requirements/astm/f3548/v21.md)**, as the implicit subscription does not cover the OIR's time boundaries;
+Entities that should have been cleaned up earlier are still present in the DSS, and this scenario cannot proceed.

monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/sub/implicit_create.md

@@ -0,0 +1,16 @@
+# Implicit subscription creation test step fragment
+
+This test step fragment validates that implicit subscriptions are created and can be queried,
+and that they have the correct temporal parameters.
+
+## 🛑 An implicit subscription was created and can be queried check
+
+The creation of an operational intent which:
+ - requires an implicit subscription
+ - is within a geo-temporal volume for which the client has not yet established any subscription
+
+is expected to trigger the creation of a new implicit subscription.
+
+If the DSS does not create the implicit subscription, it is in violation of **[astm.f3548.v21.DSS0005,1](../../../../../../requirements/astm/f3548/v21.md)**.
+
+## [Correct temporal parameters](implicit_correct.md)

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

@@ -0,0 +1,190 @@
+# ASTM SCD DSS: Implicit Subscription handling test scenario
+
+## Overview
+
+Checks that implicit subscriptions are properly created, mutated and cleaned up.
+
+## Resources
+
+### dss
+
+[`DSSInstanceResource`](../../../../resources/astm/f3548/v21/dss.py) to be tested in this scenario.
+
+### id_generator
+
+[`IDGeneratorResource`](../../../../resources/interuss/id_generator.py) providing the Subscription IDs for this scenario.
+
+### planning_area
+
+[`PlanningAreaResource`](../../../../resources/astm/f3548/v21/planning_area.py) describes the 3D volume in which subscriptions will be created.
+
+### utm_client_identity
+
+[`ClientIdentityResource`](../../../../resources/communications/client_identity.py) provides the identity that will be used to interact with the DSS.
+
+## Setup test case
+
+### [Ensure clean workspace test step](clean_workspace.md)
+
+This step ensures that no OIRs with the known test IDs exists in the DSS.
+
+## Single OIR implicit subscription is removed upon OIR deletion test case
+
+### Create an OIR with implicit subscription test step
+
+This step creates an OIR with an implicit subscription and confirms that the subscription can be queried
+
+#### [Create OIR](./fragments/oir/crud/create_query.md)
+
+#### [Valid Implicit Subscription](./fragments/sub/implicit_create.md)
+
+### Delete the OIR with implicit subscription test step
+
+#### [Delete OIR](./fragments/oir/crud/delete.md)
+
+#### 🛑 The implicit subscription was removed check
+
+Upon deletion of an OIR that is associated to an implicit subscription, if the subscription has no other
+associated OIRs, the DSS is expected to remove it.
+
+If a query attempting to fetch the implicit subscription succeeds, it implies that the implicit subscription has not
+been removed, and the DSS is in violation of **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)**.
+
+#### 🛑 After removal of the only created OIR, subscriptions should be as before its creation check
+
+If, after the DSS is left in the same state as it was 'found' for an area, the subscriptions currently active do not correspond to the ones
+that were present when the test case started, the DSS may be failing to properly implement **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)**
+or **[astm.f3548.v21.DSS0005,5](../../../../requirements/astm/f3548/v21.md)**.
+
+## Implicit subscriptions always properly cover their OIR test case
+
+This test case verifies that implicit subscriptions belonging to OIRs that are created, updated and deleted
+are properly managed.
+
+In particular, the scenario verifies that:
+ - implicit subscriptions attached to an OIR always correctly cover the OIR after it was created or mutated;
+ - implicit subscriptions are properly removed when they are no longer necessary.
+
+### Create an OIR with implicit subscription test step
+
+Create an OIR with which interactions will be tested and request an implicit
+subscription to be created.
+
+#### [Create OIR](./fragments/oir/crud/create_query.md)
+
+#### [Valid Implicit Subscription](./fragments/sub/implicit_create.md)
+
+### Create an overlapping OIR without any subscription test step
+
+This step creates an OIR in the `ACCEPTED` state that overlaps with the previously created OIR:
+it does not request the creation of an implicit subscription and does not attach the OIR to any subscription explicitly.
+
+This step expects that the implicit subscription from the previously created OIR is mentioned in the response's notifications,
+and that no new implicit subscription is created.
+
+#### [Create OIR](./fragments/oir/crud/create_query.md)
+
+#### 🛑 New OIR creation response contains previous implicit subscription to notify check
+
+If the newly created OIR does not mention the implicit subscription from the previous OIR in its notifications,
+the DSS is either improperly managing implicit subscriptions, or failing to report the subscriptions relevant to an OIR,
+and therefore in violation of **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)** or **[astm.f3548.v21.DSS0005,5](../../../../requirements/astm/f3548/v21.md)** respectively.
+
+#### 🛑 No implicit subscription was attached check
+
+If the DSS attached an implicit subscription, by either creating or re-using an existing one, to the OIR that was created in this step,
+the DSS is in violation of **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)**.
+
+### Mutate OIR with implicit subscription to not overlap anymore test step
+
+This step mutates the first OIR, which has an implicit subscription, to no longer overlap with the second OIR.
+
+The mutation request does not specify an existing subscription, and provides the parameters required for the creation of an implicit subscription.
+
+#### [Mutate OIR](./fragments/oir/crud/update_correct.md)
+
+#### 🛑 The implicit subscription can be queried check
+
+The implicit subscription attached to the mutated OIR should be able to be queried.
+
+If it cannot, the DSS is either improperly managing implicit subscriptions for OIRs, or failing to report the subscriptions relevant to an OIR,
+in which case the DSS is in violation of **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)** or **[astm.f3548.v21.DSS0005,5](../../../../requirements/astm/f3548/v21.md)**, respectively.
+
+#### [Correct temporal bounds](fragments/sub/implicit_correct.md)
+
+#### 🛑 Non-mutated implicit subscription is deleted check
+
+If the DSS chose to create a new implicit subscription instead of updating the existing one, and the DSS did not remove the previous subscription,
+the DSS is in violation of either **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)** or **[astm.f3548.v21.DSS0005,5](../../../../requirements/astm/f3548/v21.md)**.
+
+### Create an OIR overlapping with the second OIR but not the first test step
+
+This step creates a new OIR that only overlaps the OIR that has no implicit subscription,
+and expects to not have to notify any subscription related to the OIRs created in this scenario.
+
+#### [Create OIR](./fragments/oir/crud/create_query.md)
+
+#### 🛑 Within a temporal frame not overlapping a newly created implicit subscription, subscriptions should be the same as at the start of the test case check
+
+Within a geotemporal area that does not intersect with any of the implicit subscriptions that are left within the DSS,
+the subscriptions returned for an OIR created within said area should correspond to the ones
+that were present when the test case started.
+
+Otherwise, the DSS may be failing to properly implement **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)**
+or **[astm.f3548.v21.DSS0005,5](../../../../requirements/astm/f3548/v21.md)**.
+
+#### 🛑 No implicit subscription was attached check
+
+If the DSS attached an implicit subscription, by either creating or re-using an existing one, to the OIR that was created in this step,
+the DSS is in violation of **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)**.
+
+## Implicit subscriptions are properly deleted when required by OIR mutation test case
+
+This test case verifies that implicit subscriptions are properly removed if they become unnecessary following the mutation of an OIR.
+
+### [Ensure clean workspace test step](clean_workspace.md)
+
+This test step resets the workspace for this test case.
+
+### Create two OIRs with implicit subscription test step
+
+Creates two OIRs with an implicit subscription, which will then be replaced by an explicitly created subscription
+and deleted by an update that requests no subscription, respectively.
+
+#### [Create OIR](./fragments/oir/crud/create_query.md)
+
+#### [Valid Implicit Subscription](./fragments/sub/implicit_create.md)
+
+### Create a subscription test step
+
+This test step creates a subscription that will be used to replace the implicit subscription that was created for an OIR.
+
+#### [Create subscription](./fragments/sub/crud/create_query.md)
+
+Check creation succeeds and response is correct.
+
+### Update OIR with implicit subscription to use explicit subscription test step
+
+This step updates the OIR to use the subscription that was created in the previous step,
+and expects the previous implicit subscription to be removed.
+
+#### [Mutate OIR](./fragments/oir/crud/update_query.md)
+
+#### 🛑 Previously attached implicit subscription was deleted check
+
+If the implicit subscription that was attached to the OIR is still present after the OIR is updated to use another subscription,
+the DSS is failing to properly manage implicit subscriptions for OIRs, and is therefore in violation of **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)**.
+
+### Update OIR with implicit subscription to use no subscription test step
+
+This step updates the OIR to not use any subscription, and expects the implicit subscription to be removed.
+
+#### [Mutate OIR](./fragments/oir/crud/update_query.md)
+
+#### 🛑 Previously attached implicit subscription was deleted check
+
+If the implicit subscription that was attached to the OIR is still present after the OIR is updated to use another subscription,
+the DSS is failing to properly manage implicit subscriptions for OIRs, and is therefore in violation of **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)**.
+
+
+## [Cleanup](./clean_workspace.md)