Skip to content

Basic test specifications for both Device Data Volume and Its Subscription #13

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
sachinvodafone merged 9 commits into from
Mar 24, 2025
Merged

Basic test specifications for both Device Data Volume and Its Subscription #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a41ab48
Add files via upload
sachinvodafone Dec 19, 2024
1e884f5
Merge pull request #1 from sachinvodafone/sachinvodafone-patch-1
sachinvodafone Dec 19, 2024
573b0a6
Update and rename deive-data-volume-subscriptions.feature to device-d…
sachinvodafone Jan 16, 2025
eb86f8a
Update and rename device-data-volume.feature to device-data-volume.fe…
sachinvodafone Jan 16, 2025
7c14b27
Update code/Test_definitions/device-data-volume-subscriptions.feature
sachinvodafone Jan 16, 2025
0c7267d
Update code/Test_definitions/device-data-volume.feature
sachinvodafone Jan 16, 2025
9116036
Update code/Test_definitions/device-data-volume.feature
sachinvodafone Jan 16, 2025
a3e88e7
Merge branch 'camaraproject:main' into main
sachinvodafone Jan 16, 2025
e26e16d
Update code/Test_definitions/device-data-volume.feature
sachinvodafone Feb 10, 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
200 changes: 200 additions & 0 deletions code/Test_definitions/device-data-volume-subscriptions.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,200 @@

@DeviceDataVolumeSubscription
Feature: Device Data Volume Subscriptions API, vwip - Operation createDeviceDataVolumeSubscription

# Input to be provided by the implementation to the tests
# References to OAS spec schemas refer to schemas specified in device-data-volume-subscriptions.yaml, version vwip

Background: Common Device Data Volume setup
Given the resource "{apiroot}/device-data-volume-subscriptions/vwip" as base-url
And the header "Authorization" is set to a valid access token
And the header "x-correlator" is set to a UUID value

######### Happy Path Scenarios #################################

@device_data_volume_subscriptions_01_create_subscription_synchronously
Scenario: Create device data volume subscription synchronously
Given that subscriptions are created synchronously
And a valid subscription request body
When the request "createDeviceDataVolumeSubscription" is sent
Then the response code is 201
And the response header "Content-Type" is "application/json"
And the response header "x-correlator" has same value as the request header "x-correlator"
And the response body complies with the OAS schema at "/components/schemas/Subscription"

@device_data_volume_subscriptions_02_create_subscription_asynchronously
Scenario: Create device data volume subscription asynchronously
Given that subscriptions are created asynchronously
And a valid subscription request body
When the request "createDeviceDataVolumeSubscription" is sent
Then the response code is 202
And the response header "Content-Type" is "application/json"
And the response header "x-correlator" has same value as the request header "x-correlator"
And the response body complies with the OAS schema at "/components/schemas/SubscriptionAsync"

@device_data_volume_subscriptions_03_Operation_to_retrieve_list_of_subscriptions_when_no_records
Scenario: Get a list of subscriptions when no subscriptions
Given a client without subscriptions created
When the request "retrieveSubscriptionList" is sent
Then the response code is 200
And the response header "Content-Type" is "application/json"
And the response header "x-correlator" has same value as the request header "x-correlator"
And the response body is an empty array

@device_data_volume_subscriptions_04_Operation_to_retrieve_list_of_subscriptions
Scenario: Get a list of subscriptions.
Given a client with subscriptions created
When the request "retrieveSubscriptionList" is sent
Then the response code is 200
And the response header "Content-Type" is "application/json"
And the response header "x-correlator" has same value as the request header "x-correlator"
And the response body has an array of items and each item complies with the OAS schema at "/components/schemas/Subscription"

@device_data_volume_subscriptions_05_Operation_to_retrieve_subscription_based_on_an_existing_subscription-id
Scenario: Get a subscription based on existing subscription-id.
Given the path parameter "subscriptionId" is set to the identifier of an existing subscription
When the request "retrieveSubscription" is sent
Then the response code is 200
And the response header "Content-Type" is "application/json"
And the response header "x-correlator" has same value as the request header "x-correlator"
And the response body complies with the OAS schema at "/components/schemas/Subscription"

@device_data_volume_subscriptions_06_Operation_to_delete_subscription_based_on_an_existing_subscription-id
Scenario: Delete a subscription based on existing subscription-id.
Given the path parameter "subscriptionId" is set to the identifier of an existing subscription
When the request "deleteSubscription" is sent
Then the response code is 202 or 204
And the response header "x-correlator" has same value as the request header "x-correlator"
And if the response property $.status is 204 then response body is not available
And if the response property $.status is 202 then response body complies with the OAS schema at "/components/schemas/SubscriptionAsync"

@device_data_volume_subscriptions_07_Receive_notification_when_device_data_volume_changed_to_50_percent
Scenario: Receive notification for data-50-percent event
Given that subscriptions are created synchronously
And a valid subscription request body
And the request body property "$.type" is " data-50-percent"
When the request "createDeviceDataVolumeSubscription" is sent
Then the response code is 201
And if the device data volume reach to 50 percent
Then event notification "data-50-percent" is received on callback-url
And sink credentials are received as expected
And notification body complies with the OAS schema at "##/components/schemas/EventDataUsage50Percent"
And type="org.camaraproject.device-data-volume-subscriptions.v0.data-50-percen"


@device_data_volume_subscriptions_08_subscription_expiry
Scenario: Receive notification for subscription-ends event on expiry
Given that subscriptions are created synchronously
And a valid subscription request body
And the request body property "$.subscriptionExpireTime" is set to a value in the near future
When the request "createDeviceDataVolumeSubscription" is sent
Then the response code is 201
And the subscription is expired
And event notification "subscription-ends" is received on callback-url
And notification body complies with the OAS schema at "##/components/schemas/EventSubscriptionEnds"
And type="org.camaraproject.device-data-volume-subscriptions.v0.subscription-ends"
And the response property "$.terminationReason" is "SUBSCRIPTION_EXPIRED"

@device_data_volume_status_subscriptions_09_subscription_ends_when_max_events_reached
Scenario: Receive notification for subscription-ends event on max events reached
Given that subscriptions are created synchronously
And a valid subscription request body
And the request body property "$.type" is "data_50_percent"
And the request body property "$.subscriptionMaxEvents" is set to 1
When the request "createDeviceDataVolumeSubscription" is sent
Then the response code is 201
Then event notification "data_50_percent" is received on callback-url
Then event notification "subscription-ends" is received on callback-url
And notification body complies with the OAS schema at "##/components/schemas/EventSubscriptionEnds"
And type="org.camaraproject.device-data-volume-subscriptions.v0.subscription-ends"
And the response property "$.terminationReason" is "MAX_EVENTS_REACHED"

@device_data_volume_subscriptions_10_subscription_delete_event_validation
Scenario: Receive notification for subscription-ends event on deletion
Given that subscriptions are created synchronously
And a valid subscription request body
When the request "createDeviceDataVolumeSubscription" is sent
Then the response code is 201
When the request "deleteSubscription" is sent
Then the response code is 202 or 204
Then event notification "subscription-ends" is received on callback-url
And notification body complies with the OAS schema at "##/components/schemas/EventSubscriptionEnds"
And type="org.camaraproject.device-data-volume-subscriptions.v0.subscription-ends"
And the response property "$.terminationReason" is "SUBSCRIPTION_DELETED"


############### Error response scenarios ###########################

@device_data_volume_subscriptions_11_Create_device_data_volume_subscription_with_invalid_parameter
Scenario: Create subscription with invalid parameter
Given the request body is not compliant with the schema "/components/schemas/SubscriptionRequest"
When the request "createDeviceDataVolumeSubscription" is sent
Then the response code is 400
And the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text

@device_data_volume_subscriptions_12_creation_of_subscription_with_expiry_time_in_past
Scenario: Expiry time in past
Given a valid subscription request body
And request body property "$.subscriptionExpireTime" in past
When the request "createDeviceDataVolumeSubscription" is sent
Then the response code is 400
And the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text

@device_data_volume_subscription_13_invalid_protocol
Scenario: subscription creation with invalid protocol
Given a valid subscription request body
And the request property "$.protocol" is not "HTTP"
When the request "createDeviceDataVolumeSubscription" is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_PROTOCOL"
And the response property "$.message" contains a user friendly text

@device_data_volume_subscription_14_invalid_credential_type
Scenario: subscription creation with invalid credential type
Given a valid subscription request body
And the request property "$.credentialType" is not "ACCESSTOKEN"
When the request "createDeviceDataVolumeSubscription" is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_CREDENTIAL"
And the response property "$.message" contains a user friendly text

@device_data_volume_subscription_15_invalid_access_token_type
Scenario: subscription creation with invalid access token type
Given a valid subscription request body
And the request property "$.accessTokenType" is not "bearer"
When the request "createDeviceDataVolumeSubscription" is sent
Then the response property "$.status" is 400
And the response property "$.code" is "INVALID_TOKEN" or "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text

@device_data_volume_subscription_16_invalid_credentials
Scenario: subscription creation with invalid credentials
Given a valid subscription request body
And header "Authorization" token is set to invalid credentials
When the request "createDeviceDataVolumeSubscription" is sent
Then the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text

@device_data_volume_subscription_17_invalid_inconsistent_access_token
Scenario: subscription creation with inconsistent access token for requested events subscription
# To test this, a token have to be obtained for a different device
Given a valid subscription request body
And the request body property "$.device" is set to a valid testing device supported by the service
And header "Authorization" set to access token referring different device
When the request "createDeviceDataVolumeSubscription" is sent
Then the response property "$.status" is 403
And the response property "$.code" is "SUBSCRIPTION_MISMATCH"
And the response property "$.message" contains a user friendly text

@device_data_volume_subscription_18_unknown_subscription_id
Scenario: Get subscription when subscription-id is unknown to the system
Given the path parameter property "$.subscriptionId" is unknown to the system
When the request "retrieveSubscription" is sent
Then the response property "$.status" is 404
And the response property "$.code" is "NOT_FOUND"
And the response property "$.message" contains a user friendly text
126 changes: 126 additions & 0 deletions code/Test_definitions/device-data-volume.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@

@Device_Data_Volume
Feature: CAMARA Device Data Volume API - Operation getDeviceDataVolumeStatus

# Input to be provided by the implementation to the tests
# References to OAS spec schemas refer to schemas specifies in device-data-volume.yaml

Background: Common getDeviceDataVolumeStatus setup
Given an environment at "apiRoot"
And the resource "/device-data-volume/vwip/retrieve"
And the header "Content-Type" is set to "application/json"
And the header "Authorization" is set to a valid access token
And the header "x-correlator" is set to a UUID value
And the request body is compliant with the schema RequestDeviceDataVolume at "/components/schemas/RequestDeviceDataVolume"

#############Happy Path Scenarios##################

@device_data_volume_getDeviceDataVolumeStatus_200.01_retrieve_success_scenario
Scenario: Retrieve the estimated remaining data volume for a device
Given the request body property "$.device" is set to identify a valid testing device supported by the service
When the HTTPS "POST" request getDeviceDataVolumeStatus is sent
Then the response code is 200
And the response header "Content-Type" is "application/json"
And the response header "x-correlator" has same value as the request header "x-correlator"
And the response body property "$.dataVolumeCategory" is present and has value "<200MiB", "<1GiB", "<5GiB", or ">=5GiB"


@device_data_volume_02_check_status_success
Scenario: Check if the remaining data volume for a device is above a given threshold
Given a valid devicestatus request body
And the request body property "$.device" is set to a valid testing device and supported by the service
When the HTTPS "POST" request is sent
Then the response code is 200
And the response header "Content-Type" is "application/json"
And the response header "x-correlator" has same value as the request header "x-correlator"
And the response body complies with Boolean value
And the response property "$.status" is 200
And the response property "$.code" is "OK"
And the response property "$.message" contains a user friendly text


#############Error Response Scenarios##################

@device_data_volume_03_retrieve_status_with_invalid_parameter
Scenario: retrieve status request with invalid parameter
Given the request body is not compliant with the schema "/components/schemas/CheckRequest"
When the request "retrieve" is sent
Then Response code is 400
And the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text

@device_data_volume_04_expired_access_token
Scenario: Expired access token
Given a valid CheckRequest request body
And header "Authorization" is set to expired token
When the request "retrieve" is sent
Then the response status code is 401
And the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text

@device_data_volume_05_no_authorization_header
Scenario: No Authorization header
Given a valid CheckRequest request body
And header "Authorization" is not available
When the request "CheckRequest " is sent
Then the response status code is 401
And the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text

@device_data_volume_06_invalid_access_token
Scenario: Invalid access token
Given a valid CheckRequest request body
And header "Authorization" set to an invalid access token
Then the response status code is 401
And the response header "Content-Type" is "application/json"
And the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED"
And the response property "$.message" contains a user friendly text

@device_data_volume_07_retrieve_status_inconsistent_access_token
Scenario: Inconsistent access token context for the device
# To test this, a token has to be obtained for a different device
Given a valid CheckRequest request body
And the request body property "$.device" is set to a valid testing device supported by the service
And header "Authorization" set to access token referring different device
When the request "retrieve" is sent
Then the response status code is 403
And the response property "$.status" is 403
And the response property "$.code" is "INVALID_TOKEN_CONTEXT"
And the response property "$.message" contains a user friendly text


# Generic 400 errors

@device_data_volume_08_retrieve_status_no_request_body
Scenario: Missing request body
Given the request body is not included
When the HTTP "POST" request is sent
Then the response status code is 400
And the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text

@device_data_volume_09_retrieve_status_400_empty_request_body
Scenario: Empty object as request body
Given the request body is set to "{}"
When the HTTP "POST" request is sent
Then the response status code is 400
And the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text


@device_data_volume_10_retrieve_status_required_device_identifier_missing
Scenario: Required device identifier is missing
Given the request body property "$.device" is not included
When the HTTP "POST" request is sent
Then the response status code is 400
And the response property "$.status" is 400
And the response property "$.code" is "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text