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

Jump to bottom

Include test plan #13

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Include test plan #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 0 additions & 1 deletion code/Test_definitions/README.md
View file
Open in desktop

This file was deleted.

258 changes: 258 additions & 0 deletions code/Test_definitions/most-frequent-location.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,258 @@
Feature: CAMARA Most Frequent Location API, v0.1.0
# Input to be provided by the implementation to the tester
#
# Implementation indications:
# * List of device identifier types which are not supported, among: phoneNumber, ipv4Address, ipv6Address.
# * List of application server ip formats which are not supported, among ipv4 and ipv6.
# For this version, CAMARA does not allow the use of networkAccessIdentifier, so it is considered by default as not supported.
#
# Testing assets:
# * A device object applicable for Most Frequent Location service.
# * A device object identifying a device commercialized by the implementation for which the service is not applicable, if any.


# References to OAS spec schemas refer to schemas specifies in most-frequent-location.yaml, version 0.1.0

Background: Common verifyFrequentLocation setup
Given an environment at "apiRoot"
And the resource "most-frequent-location/v0.1/verify"
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
# Properties not explicitly overwitten in the Scenarios can take any values compliant with the schema
And the request body is set by default to a request body compliant with the schema at "/components/schemas/VerifyFrequentLocationRequest"


# Success scenarios

@verifyFrequentLocation_01_generic_success_scenario
Scenario: Common validations for any success scenario
Given a valid testing device supported by the service, identified by the token or provided in the request body
And the request body property "$.geoReference" is set to a valid geographical reference
When the request "verifyFrequentLocation" is sent
Then the response status 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/VerifyFrequentLocationResponse"


# Scenarios testing specific situations

@verifyFrequentLocation_02_success_with_coverage_zone
Scenario: Successful response providing coverage zone
Given a valid testing device supported by the service, identified by the token or provided in the request body
And the request body property "$.geoReference.type" is set to "COVERAGE_ZONE"
And the request body property "$.geoReference.latitude" is set to a valid number between -90 and 90
And the request body property "$.geoReference.longitude" is set to a valid number between -180 and 180
When the request "verifyFrequentLocation" is sent
Then the response status code is 200
And the response contains the property "$.score" and its value represents the score of the location in the geoReference

@verifyFrequentLocation_03_success_with_postal_code
Scenario: Successful response providing postal code
Given a valid testing device supported by the service, identified by the token or provided in the request body
And the request body property "$.geoReference.type" is set to "POSTAL_CODE"
And the request body property "$.geoReference.postalCode" is set to a valid zip or postal code
When the request "verifyFrequentLocation" is sent
Then the response status code is 200
And the response contains the property "$.score" and its value represents the score of the location in the geoReference


# Errors 400

@verifyFrequentLocation_400.1_invalid_argument
Scenario: Invalid Argument. Generic Syntax Exception
Given the request body is set to any value which is not compliant with the schema at "/components/schemas/VerifyFrequentLocationRequest"
When the request "verifyFrequentLocation" 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

@verifyFrequentLocation_400.2_no_request_body
Scenario: Missing request body
Given the request body is not included
When the request "verifyFrequentLocation" 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

@verifyFrequentLocation_400.3_empty_request_body
Scenario: Empty object as request body
Given the request body is set to "{}"
When the request "verifyFrequentLocation" 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

@verifyFrequentLocation_400.4_empty_device
Scenario: Request body with empty device object
Given the request body property "$.geoReference" is set to a valid geographical reference
And the request body property "$.device" is set to "{}"
When the request "verifyFrequentLocation" 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

@verifyFrequentLocation_400.5_device_identifiers_schema_not_compliant
# Test every type of identifier even if not supported by the implementation
Scenario Outline: Some device identifier value does not comply with the schema
Given the request body property "<device_identifier>" does not comply with the OAS schema at "<oas_spec_schema>"
When the request "verifyFrequentLocation" 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.networkAccessIdentifier | /components/schemas/NetworkAccessIdentifier |

@verifyFrequentLocation_400.6_out_of_range
Scenario Outline: Out of Range
Given a valid testing device supported by the service, identified by the token or provided in the request body
And the request body property "$.geoReference" is set to a valid geographical reference
And the request body property "<property>" is set to a value that does not comply with the range defined in the OAS schema at "<oas_spec_schema>"
When the request "verifyFrequentLocation" is sent
Then the response status code is 400
And the response property "$.status" is 400
And the response property "$.code" is "OUT_OF_RANGE" or "INVALID_ARGUMENT"
And the response property "$.message" contains a user friendly text

Examples:
| property | oas_spec_schema |
| $.geoReference.latitude | /components/schemas/Latitude |
| $.geoReference.longitude | /components/schemas/Longitude |

@verifyFrequentLocation_400.7_postal_code_not_valid
Scenario: Postal Code not valid
Given a valid testing device supported by the service, identified by the token or provided in the request body
And the request body property "$.geoReference.postalCode" is set to a value that is compliant with the schema at "/components/schemas/PostalCode"
And this value is not valid or is unknown for the Operator
When the request "verifyFrequentLocation" is sent
Then the response status code is 400
And the response property "$.status" is 400
And the response property "$.code" is "MOST_FREQUENT_LOCATION.POSTAL_CODE_NOT_VALID"
And the response property "$.message" contains a user friendly text


# Generic 401 errors

@verifyFrequentLocation_401.1_no_authorization_header
Scenario: Error response for no header "Authorization"
Given the header "Authorization" is not sent
And the request body is set to a valid request body
When the request "verifyFrequentLocation" 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

@verifyFrequentLocation_401.2_expired_access_token
Scenario: Error response for expired access token
Given the header "Authorization" is set to an expired access token
And the request body is set to a valid request body
When the request "verifyFrequentLocation" is sent
Then the response status code is 401
And the response property "$.status" is 401
And the response property "$.code" is "UNAUTHENTICATED" or "AUTHENTICATION_REQUIRED"
And the response property "$.message" contains a user friendly text

@verifyFrequentLocation_401.3_invalid_access_token
Scenario: Error response for invalid access token
Given the header "Authorization" is set to an invalid access token
And the request body is set to a valid request body
When the request "verifyFrequentLocation" 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


# Errors 403

@verifyFrequentLocation_403.1_invalid_token_context
Scenario: Inconsistent access token context for the device
# To test this, a token have to be obtained for a different device
Given the request body property "$.device" is set to a valid testing device
And the header "Authorization" is set to a valid access token emitted for a different device
When the request "verifyFrequentLocation" 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


# Errors 404

@verifyFrequentLocation_404.1_device_not_found
# Typically with a 2-legged access token
Scenario: Device identifier not found
Given that the device cannot be identified from the access token
And the request body property "$.device" is compliant with the schema at "/components/schemas/Device" but does not identify a valid device
When the request "verifyFrequentLocation" is sent
Then the response status code is 404
And the response property "$.status" is 404
And the response property "$.code" is "DEVICE_NOT_FOUND"
And the response property "$.message" contains a user friendly text


@verifyFrequentLocation_404.2_information_not_available
Scenario: Device information is not available
Given a valid testing device supported by the service, identified by the token or provided in the request body
And the request body property "$.geoReference" is set to a valid geographical reference
And the geographical information of this device is not available or is not enough to calculate the score
When the request "verifyFrequentLocation" is sent
Then the response status code is 404
And the response property "$.status" is 404
And the response property "$.code" is "MOST_FREQUENT_LOCATION.INFORMATION_NOT_AVAILABLE"
And the response property "$.message" contains a user friendly text


# Errors 422

@verifyFrequentLocation_422.1_unsupported_device_identifier
Scenario: None of the provided device identifiers are 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 request "verifyFrequentLocation" is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "UNSUPPORTED_DEVICE_IDENTIFIERS"
And the response property "$.message" contains a user friendly text

@verifyFrequentLocation_422.2_device_identifiers_mismatch
Scenario: Inconsistency between device identifiers not pointing to the same device
Given that 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 request "verifyFrequentLocation" is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "DEVICE_IDENTIFIERS_MISMATCH"
And the response property "$.message" contains a user friendly text

@verifyFrequentLocation_422.3_device_not_applicable
Scenario: Service is not available for the provided device
Given that service is not supported for all devices commercialized by the operator
And the service is not applicable for the device identified by the token or provided in the request body
When the request "verifyFrequentLocation" is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "DEVICE_NOT_APPLICABLE"
And the response property "$.message" contains a user friendly text

@verifyFrequentLocation_422.4_unidentifiable_device
Scenario: The device identifier is not included in the request and the device information cannot be derived from the 3-legged access token
Given the header "Authorization" is set to a valid 3-legged access token which does not identifiy a single device
And the request body property "$.device" is not included
When the request "verifyFrequentLocation" is sent
Then the response status code is 422
And the response property "$.status" is 422
And the response property "$.code" is "UNIDENTIFIABLE_DEVICE"
And the response property "$.message" contains a user friendly text