Skip to content
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

Common artifacts for testing error scenarios for device and phoneNumber #325

Merged
merged 5 commits into from
Dec 11, 2024
Merged

Common artifacts for testing error scenarios for device and phoneNumber #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
363eebe
Common artifacts for testing error scenarios for device and phoneNumber
jlurien Oct 24, 2024
a1bee21
Comments addressed
jlurien Nov 22, 2024
9f05b73
Extended clarifications
jlurien Dec 4, 2024
91183a5
Update artifacts/testing/C02-phoneNumber-errors.feature
jlurien Dec 5, 2024
be3f201
Update artifacts/testing/C01-device-errors.feature
jlurien Dec 5, 2024
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
118 changes: 118 additions & 0 deletions artifacts/testing/C01-device-errors.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
Feature: CAMARA Common Artifact C01 - Test scenarios for device errors

Common error scenarios for POST operations with device as input either in the request
body or implied from the access.

NOTES:
* This is not a complete feature but a collection of scenarios that can be applied with minor

modifications to test plans. Test plans would have to copy and adapt the scenarios as part of
their own feature files, along with other scenarios

* These scenarios assume that other properties not explicitly mentioned in the scenario
are set by default to a valid value. This can be specified in the feature Background.

* {{feature_identifier}} has to be substituted to the value corresponding to the feature file where
these scenarios are included.

# Error scenarios for management of input parameter device

@{{feature_identifier}}_C01.01_device_empty
Scenario: The device value is an empty object
Given the header "Authorization" is set to a valid access which does not identify a single device
And the request body property "$.device" 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


@{{feature_identifier}}_C01.02_device_identifiers_not_schema_compliant
Scenario Outline: Some device identifier value does not comply with the schema
Given the header "Authorization" is set to a valid access which does not identify a single device
And the request body property "<device_identifier>" does not comply with the OAS schema at "<oas_spec_schema>"
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

Examples:
| device_identifier | oas_spec_schema |
| $.device.phoneNumber | /components/schemas/PhoneNumber |
| $.device.ipv4Address | /components/schemas/DeviceIpv4Addr |
| $.device.ipv6Address | /components/schemas/DeviceIpv6Address |
| $.device.networkIdentifier | /components/schemas/NetworkAccessIdentifier |


# This scenario may happen e.g. with 2-legged access tokens, which do not identify a single device.
@{{feature_identifier}}_C01.03_device_not_found
Scenario: Some identifier cannot be matched to a device
Given the header "Authorization" is set to a valid access which does not identify a single device
And the request body property "$.device" is compliant with the schema but does not identify a valid device
When the HTTP "POST" request is sent
Then the response status code is 404
And the response property "$.status" is 404
And the response property "$.code" is "IDENTIFIER_NOT_FOUND"
And the response property "$.message" contains a user friendly text


@{{feature_identifier}}_C02.04_unnecessary_device
Scenario: Device not to be included when can be deducted from the access token
Given the header "Authorization" is set to a valid access token identifying a device
And the request body property "$.device" is set to a valid device
When the HTTP "POST" request is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "UNNECESSARY_IDENTIFIER"
And the response property "$.message" contains a user friendly text


@{{feature_identifier}}_C01.05_missing_device
Scenario: Device not included and cannot be deducted from the access token
Given the header "Authorization" is set to a valid access which does not identify a single device
And the request body property "$.device" is not included
When the HTTP "POST" request is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "MISSING_IDENTIFIER"
And the response property "$.message" contains a user friendly text


# For r1.x APIs, networkAccessIdentifier is never supported
@{{feature_identifier}}_C01.06_unsupported_device
Scenario: None of the provided device identifiers is supported by the implementation
Given that some type of device identifiers are not supported by the implementation
And the request body property "$.device" only includes device identifiers not supported by the implementation
When the HTTP "POST" request is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "UNSUPPORTED_IDENTIFIER"
And the response property "$.message" contains a user friendly text


# When the service is only offered to certain type of devices or subscriptions, e.g. IoT, , B2C, etc
@{{feature_identifier}}_C01.07_device_not_supported
Scenario: Service not available for the device
Given that the service is not available for all devices commercialized by the operator
And a valid device, identified by the token or provided in the request body, for which the service is not applicable
When the HTTP "POST" request is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "SERVICE_NOT_APPLICABLE"
And the response property "$.message" contains a user friendly text


# Several identifiers provided but they do not identify the same device
# This scenario is under discussion, as it may reveal undesired information or even substitute the Number Verification API functionality
@{{feature_identifier}}_C01.08_device_identifiers_mismatch
Scenario: Device identifiers mismatch
Given the header "Authorization" is set to a valid access which does not identify a single device
And at least 2 types of device identifiers are supported by the implementation
And the request body property "$.device" includes several identifiers, each of them identifying a valid but different device
When the HTTP "POST" request is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "IDENTIFIER_MISMATCH"
And the response property "$.message" contains a user friendly text
73 changes: 73 additions & 0 deletions artifacts/testing/C02-phoneNumber-errors.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
Feature: CAMARA Common Artifact C02 - Test scenarios for phoneNumber errors

Common error scenarios for POST operations with phoneNumber as input either in the request
body or implied from the access

NOTES:
* This is not a complete feature but a collection of scenarios that can be applied with minor

modifications to test plans. Test plans would have to copy and adapt the scenarios as part of
their own feature files, along with other scenarios

* These scenarios assume that other properties not explicitly mentioned in the scenario
are set by default to a valid value. This can be specified in the feature Background.

* {{feature_identifier}} has to be substituted to the value corresponding to the feature file where
these scenarios are included.

# Error scenarios for management of input parameter phoneNumber

@{{feature_identifier}}_C02.01_phone_number_not_schema_compliant
Scenario: Phone number value does not comply with the schema
Given the header "Authorization" is set to a valid access which does not identify a single phone number
And the request body property "$.phoneNumber" does not comply with the OAS schema at "/components/schemas/PhoneNumber"
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


@{{feature_identifier}}_C02.02_phone_number_not_found
Scenario: Phone number not found
Given the header "Authorization" is set to a valid access which does not identify a single phone number
And the request body property "$.phoneNumber" is compliant with the schema but does not identify a valid phone number
When the HTTP "POST" request is sent
Then the response status code is 404
And the response property "$.status" is 404
And the response property "$.code" is "IDENTIFIER_NOT_FOUND"
And the response property "$.message" contains a user friendly text


@{{feature_identifier}}_C02.03_unnecessary_phone_number
Scenario: Phone number not to included when can be deducted from the access token
Given the header "Authorization" is set to a valid access token identifying a phone number
And the request body property "$.phoneNumber" is set to a valid phone number
When the HTTP "POST" request is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "UNNECESSARY_IDENTIFIER"
And the response property "$.message" contains a user friendly text


@{{feature_identifier}}_C02.04_missing_phone_number
Scenario: Phone number not included and cannot be deducted from the access token
Given the header "Authorization" is set to a valid access which does not identify a single phone number
And the request body property "$.phoneNumber" is not included
When the HTTP "POST" request is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "MISSING_IDENTIFIER"
And the response property "$.message" contains a user friendly text


# When the service is only offered to certain type of subscriptions, e.g. IoT, , B2C, etc
@{{feature_identifier}}_C02.05_phone_number_not_supported
Scenario: Service not available for the phone number
Given that the service is not available for all phone numbers commercialized by the operator
And a valid phone number, identified by the token or provided in the request body, for which the service is not applicable
When the HTTP "POST" request is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "SERVICE_NOT_APPLICABLE"
And the response property "$.message" contains a user friendly text