Skip to content

[uss_qualifier] expand OIR implicit sub handling scenario #1026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 27, 2025
Merged

[uss_qualifier] expand OIR implicit sub handling scenario #1026

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
02f1eec
[uss_qualifier] expand OIR implicit sub handling scenario
Shastick May 19, 2025
bdb6d90
comments
Shastick May 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 115 additions & 0 deletions monitoring/uss_qualifier/scenarios/astm/utm/dss/fragments/oir/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
from typing import Optional

from uas_standards.astm.f3548.v21.api import EntityID, SubscriptionID

from monitoring.monitorlib.fetch import QueryError
from monitoring.uss_qualifier.resources.astm.f3548.v21.dss import DSSInstance
from monitoring.uss_qualifier.scenarios.scenario import TestScenarioType

# The InterUSS DSS implementation will set an OIR's subscription ID to 00000000-0000-4000-8000-000000000000
# when the OIR is not attached to any subscription, as the OpenAPI spec does not allow the value to be empty.
# Other implementations may use a different value. One way to check that an OIR is not attached to any subscription
# is to attempt to retrieve the subscription reportedly attached to it: if a 404 is returned then we may assume
# no subscription is attached.
# Note that this is only allowed for OIRs in the ACCEPTED state.
NULL_SUBSCRIPTION_ID = "00000000-0000-4000-8000-000000000000"


def step_oir_has_correct_subscription(
scenario: TestScenarioType,
dss: DSSInstance,
oir_id: EntityID,
expected_sub_id: Optional[SubscriptionID],
):
"""
Ensure that an OIR is currently attached to the specified subscription,
or not attached to any subscription if the passed subscription ID is None.

This fragment will fetch the OIR from the DSS.
"""

step_name = (
"OIR is not attached to any subscription"
if expected_sub_id is None
else "OIR is attached to expected subscription"
)
scenario.begin_test_step(step_name)
check_oir_has_correct_subscription(
scenario,
dss,
oir_id,
expected_sub_id,
)
scenario.end_test_step()


def check_oir_has_correct_subscription(
scenario: TestScenarioType,
dss: DSSInstance,
oir_id: EntityID,
expected_sub_id: Optional[SubscriptionID],
):
with scenario.check(
"Get operational intent reference by ID", dss.participant_id
) as check:
try:
oir, q = dss.get_op_intent_reference(oir_id)
scenario.record_query(q)
except QueryError as qe:
scenario.record_queries(qe.queries)
check.record_failed(
summary="Could not get OIR",
details=f"Failed to get OIR with error code {qe.cause_status_code}: {qe.msg}",
query_timestamps=qe.query_timestamps,
)

sub_is_as_expected = False
referenced_sub_was_found_when_non_expected = False
if expected_sub_id is None:
# See comment on NULL_SUBSCRIPTION_ID
# ASTM may at some point decide to tolerate accepting empty returned values here,
# but in the meantime we simply attempt to obtain the subscription and check that it does not exist
if oir.subscription_id == NULL_SUBSCRIPTION_ID:
# Sub ID explicitly set to the value representing the null subscription: all good
sub_is_as_expected = True
elif oir.subscription_id is None:
# Sub ID not set at all: not compliant with the spec, but not wrong with regard to which subscription should be attached to the OIR
sub_is_as_expected = True
else:
# If the subscription ID is defined and not set to the known 'null' value, we assume that the DSS used another
# placeholder for the non-existing subscription, and we check that it does not exist.
with scenario.check(
"Subscription referenced by the OIR does not exist"
) as check:
sub = dss.get_subscription(oir.subscription_id)
scenario.record_query(sub)
if sub.status_code not in [200, 404]:
check.record_failed(
summary="Failed to try to obtain the subscription referenced by the OIR",
details=f"Failed in an unexpected way while querying subscription with ID {oir.subscription_id}: expected a 404 or 200, but got {sub.status_code}",
query_timestamps=[sub.request.timestamp],
)
if sub.status_code == 200:
referenced_sub_was_found_when_non_expected = True
else:
sub_is_as_expected = oir.subscription_id == expected_sub_id

attached_check_name = (
"OIR is not attached to a subscription"
if expected_sub_id is None
else f"OIR is attached to expected subscription"
)

with scenario.check(attached_check_name, dss.participant_id) as check:
if referenced_sub_was_found_when_non_expected:
check.record_failed(
summary="OIR is attached to a subscription although it should not be",
details=f"Expected OIR to not be attached to any subscription, but the referenced subscription {oir.subscription_id} does exist.",
query_timestamps=[sub.request.timestamp],
)
if not sub_is_as_expected:
check.record_failed(
summary="OIR is not attached to the correct subscription",
details=f"Expected OIR to be attached to subscription {expected_sub_id}, but it is attached to {oir.subscription_id}",
query_timestamps=[q.request.timestamp],
)
84 changes: 8 additions & 76 deletions monitoring/uss_qualifier/scenarios/astm/utm/dss/oir_explicit_sub_handling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,15 @@
from monitoring.uss_qualifier.scenarios.astm.utm.dss.fragments.oir import (
crud as oir_fragments,
)
from monitoring.uss_qualifier.scenarios.astm.utm.dss.fragments.oir import (
step_oir_has_correct_subscription,
)
from monitoring.uss_qualifier.scenarios.astm.utm.dss.fragments.sub import (
crud as sub_fragments,
)
from monitoring.uss_qualifier.scenarios.scenario import TestScenario
from monitoring.uss_qualifier.suites.suite import ExecutionContext

# The InterUSS DSS implementation will set an OIR's subscription ID to 00000000-0000-4000-8000-000000000000
# when the OIR is not attached to any subscription, as the OpenAPI spec does not allow the value to be empty.
# Other implementations may use a different value. One way to check that an OIR is not attached to any subscription
# is to attempt to retrieve the subscription reportedly attached to it: if a 404 is returned then we may assume
# no subscription is attached.
# Note that this is only allowed for OIRs in the ACCEPTED state.
NULL_SUBSCRIPTION_ID = "00000000-0000-4000-8000-000000000000"


class OIRExplicitSubHandling(TestScenario):
OIR_TYPE = register_resource_type(401, "Operational Intent Reference")
Expand Down Expand Up @@ -377,76 +372,13 @@ def _step_update_oir_with_sufficient_explicit_sub(self, is_replacement: bool):
def _step_oir_has_correct_subscription(
self, expected_sub_id: Optional[SubscriptionID]
):
step_check_name = (
"OIR is not attached to any subscription"
if expected_sub_id is None
else "OIR is attached to expected subscription"
)
self.begin_test_step(step_check_name)
with self.check("Get operational intent reference by ID", self._pid) as check:
try:
oir, q = self._dss.get_op_intent_reference(self._oir_id)
self.record_query(q)
except QueryError as qe:
self.record_queries(qe.queries)
check.record_failed(
summary="Could not get OIR",
details=f"Failed to get OIR with error code {qe.cause_status_code}: {qe.msg}",
query_timestamps=qe.query_timestamps,
)

sub_is_as_expected = False
referenced_sub_was_found_when_non_expected = False
if expected_sub_id is None:
# See comment on NULL_SUBSCRIPTION_ID
# ASTM may at some point decide to tolerate accepting empty returned values here,
# but in the meantime we simply attempt to obtain the subscription and check that it does not exist
if oir.subscription_id == NULL_SUBSCRIPTION_ID:
# Sub ID explicitly set to the value representing the null subscription: all good
sub_is_as_expected = True
elif oir.subscription_id is None:
# Sub ID not set at all: not compliant with the spec, but not wrong with regard to which subscription should be attached to the OIR
sub_is_as_expected = True
else:
# If the subscription ID is defined and not set to the known 'null' value, we assume that the DSS used another
# placeholder for the non-existing subscription, and we check that it does not exist.
with self.check(
"Subscription referenced by the OIR does not exist"
) as check:
sub = self._dss.get_subscription(oir.subscription_id)
self.record_query(sub)
if sub.status_code not in [200, 404]:
check.record_failed(
summary="Failed to try to obtain the subscription referenced by the OIR",
details=f"Failed in an unexpected way while querying subscription with ID {oir.subscription_id}: expected a 404 or 200, but got {sub.status_code}",
query_timestamps=[sub.request.timestamp],
)
if sub.status_code == 200:
referenced_sub_was_found_when_non_expected = True
else:
sub_is_as_expected = oir.subscription_id == expected_sub_id

attached_check_name = (
"OIR is not attached to a subscription"
if expected_sub_id is None
else f"OIR is attached to expected subscription"
step_oir_has_correct_subscription(
self,
self._dss,
self._oir_id,
expected_sub_id,
)

with self.check(attached_check_name, self._pid) as check:
if referenced_sub_was_found_when_non_expected:
check.record_failed(
summary="OIR is attached to a subscription although it should not be",
details=f"Expected OIR to not be attached to any subscription, but the referenced subscription {oir.subscription_id} does exist.",
query_timestamps=[sub.request.timestamp],
)
if not sub_is_as_expected:
check.record_failed(
summary="OIR is not attached to the correct subscription",
details=f"Expected OIR to be attached to subscription {expected_sub_id}, but it is attached to {oir.subscription_id}",
query_timestamps=[q.request.timestamp],
)
self.end_test_step()

def _delete_subscription(self, sub_id: EntityID, sub_version: str):
with self.check("Subscription can be deleted", self._pid) as check:
sub = self._dss.delete_subscription(sub_id, sub_version)
Expand Down
47 changes: 36 additions & 11 deletions monitoring/uss_qualifier/scenarios/astm/utm/dss/oir_implicit_sub_handling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,10 +92,7 @@ If the newly created OIR does not mention the implicit subscription from the pre
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)**.
#### [No implicit subscription was attached](./fragments/oir/oir_has_no_subscription.md)

### Mutate OIR with implicit subscription to not overlap anymore test step

Expand Down Expand Up @@ -135,10 +132,7 @@ 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)**.
#### [No implicit subscription was attached](./fragments/oir/oir_has_no_subscription.md)

## Implicit subscriptions are properly deleted when required by OIR mutation test case

Expand Down Expand Up @@ -271,10 +265,41 @@ Replace the first OIR's explicit subscription with the implicit one created in t

Confirm that the query to replace the second OIR's explicit subscription with the second OIR's implicit subscription succeeds.

#### 🛑 The first OIR is now attached to the specified implicit subscription check
#### [First OIR is now attached to the specified implicit subscription](fragments/oir/oir_has_expected_subscription.md)

## Existing implicit subscription can be attached to OIR without subscription test case

This test case verifies that an implicit subscription can be attached to an OIR that is not currently attached to any subscription.

### Ensure clean workspace test step

Reset the workspace for this test case.

#### [Clean any existing OIRs with known test IDs](clean_workspace_op_intents.md)

#### [Clean any existing subscriptions with known test IDs](clean_workspace_subs.md)

### [Create OIR with no subscription test step](./fragments/oir/crud/create_query.md)

#### [OIR is not attached to an implicit subscription](./fragments/oir/oir_has_no_subscription.md)

### [Create second OIR with an implicit subscription test step](./fragments/oir/crud/create_query.md)

#### [An implicit subscription was created](./fragments/sub/implicit_create.md)

### Attach OIR without subscription to implicit subscription test step

Attach the first OIR to the implicit subscription created with the second OIR.

#### [Attach OIR to implicit subscription](./fragments/oir/crud/update_query.md)

### Confirm OIR is now attached to implicit subscription test step

Confirms that the DSS properly attached the first OIR to the implicit subscription created with the second OIR.

#### [Get OIR query](./fragments/oir/crud/read_query.md)

If the OIR is not attached to the implicit subscription specified in a successful mutation query,
the DSS is in violation of **[astm.f3548.v21.DSS0005,1](../../../../requirements/astm/f3548/v21.md)**.
#### [First OIR is now attached to the specified implicit subscription](fragments/oir/oir_has_expected_subscription.md)

## Cleanup

Expand Down
Loading
Loading