Create Gherkin tests for Population Density Data #44
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,277 @@ | ||
| Feature: CAMARA Population Density Data API, v0.1.1 | ||
| # Input to be provided by the implementation to the tester | ||
| # | ||
| # Implementation indications: | ||
| # * Geohash precisions allowed | ||
| # * Min start and end dates allowed | ||
| # * Max requested time period allowed | ||
| # * Max size of the response(Combination of area, startDate, endDate an precision requested) supported for a sync response | ||
| # * Max size of the response(Combination of area, startDate, endDate an precision requested) supported for an async response | ||
| # * Limitations about max complexity of requested area allowed | ||
| # | ||
| # Testing assets: | ||
| # * An Area within the supported region | ||
| # * An Area partially within the supported region | ||
| # * An Area outside the supported region | ||
| # | ||
| # References to OAS spec schemas refer to schemas specifies in population-density-data.yaml, version 0.1.1 | ||
|
|
||
| Background: Common retrievePopulationDensity setup | ||
| Given an environment at "apiRoot" | ||
| And the resource "/population-density-data/v1/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 set by default to a request body compliant with the schema | ||
|
|
||
| # Happy path scenarios | ||
|
|
||
| @population_density_data_01_supported_area_success_scenario | ||
| Scenario: Validate success response for a supported area request | ||
| Given the request body property "$.area" is set to a valid testing area within supported regions | ||
| And the request body property "$.startDate" is set to a valid testing future date | ||
| And the request body property "$.endDate" is set to a valid testing future date later than body property "$.startDate" | ||
| When the request "retrievePopulationDensity" 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/PopulationDensityResponse" | ||
| And the response property "$.status" value is "SUPPORTED_AREA" | ||
| And the response property "$.timedPopulationDensityData[*].startTime" is equal to or later than request body property "$.startDate" | ||
| And the response property "$.timedPopulationDensityData[*].endTime" is equal to or earlier than request body property "$.endDate" | ||
| And the response property "$.timedPopulationDensityData[*].cellPopulationDensityData[*].populationDensityData.dataType.datatype" is equal to "LOW_DENSITY" or "DENSITY_ESTIMATION" | ||
|
There was a problem hiding this comment. duplicate There was a problem hiding this comment. to be solved There was a problem hiding this comment. should we add that There was a problem hiding this comment. to be solved |
||
|
|
||
| @population_density_data_02_partial_area_success_scenario | ||
| Scenario: Validate success response for a partial supported area request | ||
| Given the request body property "$.area" is set to a valid testing area partially within supported regions | ||
| And the request body property "$.startDate" is set to a valid testing future date | ||
| And the request body property "$.endDate" is set to a valid testing future date later than body property "$.startDate" | ||
| When the request "retrievePopulationDensity" 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/PopulationDensityResponse" | ||
| And the response property "$.status" value is "PART_OF_AREA_NOT_SUPPORTED" | ||
| And the response property "$.timedPopulationDensityData[*].startTime" is equal to or later than request body property "$.startDate" | ||
| And the response property "$.timedPopulationDensityData[*].endTime" is equal to or earlier than request body property "$.startDate" | ||
| And there is at least one item in response property "$.timedPopulationDensityData[*].cellPopulationDensityData[*].datatype" equal to "NO_DATA" | ||
|
There was a problem hiding this comment. and add: There was a problem hiding this comment. to be solved There was a problem hiding this comment. @jgarciahospital : is it solved ? There was a problem hiding this comment. Thanks ludovic, solved then. |
||
|
|
||
| @population_density_data_03_not_supported_area_success_scenario | ||
| Scenario: Validate success response for unsupported area request | ||
| Given the request body property "$.area" is set to a valid testing area outside supported regions | ||
| And the request body property "$.startDate" is set to a valid testing future date | ||
| And the request body property "$.endDate" is set to a valid testing future date later than body property "$.startDate" | ||
| When the request "retrievePopulationDensity" 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/PopulationDensityResponse" | ||
| And the response property "$.status" value is "AREA_NOT_SUPPORTED" | ||
| And the response property "$.timedPopulationDensityData" is an empty array | ||
|
|
||
| @population_density_data_04_webhook_success_scenario | ||
|
There was a problem hiding this comment. I have an issue on this one because we are not aligned with commonalities for the webjook. It should be sink & sinkCredential. See commonalities or carrier billing API where the pattern has been aligned. I will post an issue. If you consider that it's tool ate to align not sure keeping the test worthwhile. There was a problem hiding this comment. and here we have the tricky one. This also requires changes in the API yaml, but APi is now in the public release phase. @bigludo7 let me propose something, please confirm:
There was a problem hiding this comment. Hello @jgarciahospital There was a problem hiding this comment. @rartych any proposal about this? Just to ensure that we close it before review. No problem with any of the options, I think we can provide both code proposals now. There was a problem hiding this comment. I would stay with the current definition and discuss changes for version 0.2 of the API. In fact we don't have here Event Notification defined in https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#12-subscription-notification--event , but asynchronous response. There are also no explicit guidelines for that scenario in Commonalities. There was a problem hiding this comment. Ok, let me then update gherkin with only the rest of small comments coming from @bigludo7, and also main yaml with some only editorials, and we are ready for closing the release. Please @sachinvodafone confirm after that review for been able to merge the test plan. There was a problem hiding this comment. Sorry, making one additional review we find that QoD API suffered similar issue and finally they made the alignement (this Issue & PR summarizes). So, just for aligning with https://github.com/camaraproject/Commonalities/blob/main/documentation/API-design-guidelines.md#instance-based-implicit-subscription, let me propose to roll back to initial plan and:
|
||
| Scenario: Validate success response for a request specifying a webhook | ||
| Given the request body property "$.area" is set to a valid testing area within supported regions | ||
| And the request body property "$.startDate" is set to a valid testing future date | ||
| And the request body property "$.endDate" is set to a valid testing future date later than body property "$.startDate" | ||
| And the request body property "$.webhook.notificationUrl" is set to a valid https callback address | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status 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 request with the response body will be received in "$.webhook.notificationUrl" value | ||
| And the request body revieved in the webhook complies with the OAS schema at "/components/schemas/PopulationDensityResponse" | ||
|
|
||
| @population_density_data_05_custom_precision_success_scenario | ||
| Scenario: Validate success response for a request specifying the precision of the geohashes | ||
| Given the request body property "$.area" is set to a valid testing area within supported regions | ||
| And the request body property "$.startDate" is set to a valid testing future date | ||
| And the request body property "$.endDate" is set to a valid testing future date later than body property "$.startDate" | ||
| And the request body property "$.precision" is set to a valid precision for the geohash response cells | ||
| When the request "retrievePopulationDensity" 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/PopulationDensityResponse" | ||
|
|
||
| # Generic errors | ||
|
|
||
| @population_density_data_06_missing_required_property | ||
| Scenario Outline: Error response for missing required property in request body | ||
| Given the request body property "<required_property>" is not included | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| 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: | ||
| | required_property | | ||
| | $.area | | ||
| | $.startDate | | ||
| | $.endDate | | ||
|
|
||
| @population_density_data_07_invalid_date_format | ||
| Scenario Outline: Error 400 when the datetime format is not RFC-3339 | ||
| Given the request body property "<date_property>" is not set to a valid RFC-3339 date-time | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| 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: | ||
| | date_property | | ||
| | $.startDate | | ||
| | $.endDate | | ||
|
|
||
| @population_density_data_08_invalid_precision | ||
| Scenario: Error 400 when precision is not a number between 1 and 12 | ||
| Given the request body property "$.precision" is not set to a number between 1 and 12 | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| 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 | ||
|
|
||
|
|
||
| @population_density_data_09_empty_webhook | ||
| Scenario: Error response for empty webhook in request body | ||
| Given the request body property "$.webhook" is set to "{}" | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| 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 | ||
|
|
||
| @population_density_data_10_expired_access_token | ||
| Scenario: Error response for expired access token | ||
| Given an expired access token | ||
| And the request body is set to a valid request body | ||
| When the request "retrievePopulationDensity" is sent | ||
| 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 | ||
|
|
||
| @population_density_data_11_invalid_access_token | ||
| Scenario: Error response for invalid access token | ||
| Given an invalid access token | ||
| And the request body is set to a valid request body | ||
| When the request "retrievePopulationDensity" is sent | ||
| 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 | ||
|
|
||
| @population_density_data_12_missing_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 "retrievePopulationDensity" is sent | ||
| 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 | ||
|
|
||
|
|
||
| # API Specific Errors | ||
|
|
||
| # An area that does not form a polygon is a straight line or a set of points with same coordinates. | ||
| @population_density_data_13_non_polygonal_area | ||
| Scenario: Error 400 when the requested area is not a polygon | ||
| Given the request body property "$.area.boundry" is set to an array of coordinates that does not form a polygon | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| And the response property "$.status" is 400 | ||
| And the response property "$.code" is "POPULATION_DENSITY_DATA.INVALID_AREA" | ||
| And the response property "$.message" contains a user friendly text | ||
|
|
||
| @population_density_data_14_too_complex_area | ||
| Scenario: Error 400 when the requested area is too complex | ||
| Given the request body property "$.area.boundary" is set to an array of coordinates that form a too complex area | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| And the response property "$.status" is 400 | ||
| And the response property "$.code" is "POPULATION_DENSITY_DATA.INVALID_AREA" | ||
| And the response property "$.message" contains a user friendly text | ||
|
|
||
| @population_density_data_15_min_start_date_exceeded | ||
| Scenario: Error 400 when startDate is set to a date earlier than the minimum allowed | ||
| Given the request body property "$.startDate" is set to a date earlier than the minimum allowed | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| And the response property "$.status" is 400 | ||
| And the response property "$.code" is "POPULATION_DENSITY_DATA.MIN_STARTDATE_EXCEEDED" | ||
| And the response property "$.message" contains a user friendly text | ||
|
|
||
| @population_density_data_16_max_start_date_exceeded | ||
| Scenario: Error 400 when startDate is set to a date later than the maximum allowed | ||
| Given the request body property "$.startDate" is set to a date later than the maximum allowed | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| And the response property "$.status" is 400 | ||
| And the response property "$.code" is "POPULATION_DENSITY_DATA.MAX_STARTDATE_EXCEEDED" | ||
| And the response property "$.message" contains a user friendly text | ||
|
|
||
| @population_density_data_17_invalid_end_date | ||
| Scenario: Error 400 when endDate is set to a date earlier than startDate | ||
| Given the request body property "$.endDate" is set to a date earlier than request body property "$.startDate" | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| And the response property "$.status" is 400 | ||
| And the response property "$.code" is "POPULATION_DENSITY_DATA.INVALID_END_DATE" | ||
| And the response property "$.message" contains a user friendly text | ||
|
|
||
| @population_density_data_18_max_time_period_exceeded | ||
| Scenario: Error 400 when indicated time period is greater than the maximum allowed | ||
| Given the request body property "$.startDate" is set to a valid testing future | ||
| And the request body property "$.endDate" is set to a future date that exceeds the supported duration from the start date. | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| And the response property "$.status" is 400 | ||
| And the response property "$.code" is "POPULATION_DENSITY_DATA.MAX_TIME_PERIOD_EXCEEDED" | ||
| And the response property "$.message" contains a user friendly text | ||
|
|
||
| @population_density_data_19_unsupported_precision | ||
| Scenario: Error 400 when precision is set to a valid but not supported value | ||
| Given the request body property "$.precision" is set to a valid but not supported value | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| And the response property "$.status" is 400 | ||
| And the response property "$.code" is "POPULATION_DENSITY_DATA.UNSUPPORTED_PRECISION" | ||
| And the response property "$.message" contains a user friendly text | ||
|
|
||
| @population_density_data_20_too_big_synchronous_response | ||
| Scenario: Error 400 when the response is too big for a sync response | ||
| Given the request body properties "$.area.boundry", "$.startDate", "$.endDate" and "$.precision" are set to valid values but generate a response too big for a synchronous response | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| And the response property "$.status" is 400 | ||
| And the response property "$.code" is "POPULATION_DENSITY_DATA.UNSUPPORTED_SYNC_RESPONSE" | ||
| And the response property "$.message" contains a user friendly text | ||
|
|
||
| @population_density_data_21_too_big_request | ||
| Scenario: Error 400 when the response is too big for a sync adn async response | ||
| Given the request body properties "$.area.boundry", "$.startDate", "$.endDate" and "$.precision" are set to valid values but generate a response too big for a synchronous and asynchronous response | ||
| When the request "retrievePopulationDensity" is sent | ||
| Then the response status code is 400 | ||
| And the response header "Content-Type" is "application/json" | ||
| And the response property "$.status" is 400 | ||
| And the response property "$.code" is "POPULATION_DENSITY_DATA.UNSUPPPORTED_REQUEST" | ||
| And the response property "$.message" contains a user friendly text | ||
|
There was a problem hiding this comment. Recommendation: The filename should be population-density-data-API-Readiness-Checklist.md There was a problem hiding this comment. Solved, to be spotted in #45 to ensure it is maintained when merging. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should be v0.1 in the url
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed