Tracking Pipeline for API Development and API Test Activities
- Satyajit Suri
- Dominika Bieńkowska (Deactivated)
- Wes Brown
This page is outdated and shows only the steps of creating test configuration. The table with statuses across BBs can be found in this page API Testing - status across BBs.
# | Task | Output | Digital Registries BB | Identity BB | IM BB | Consent BB | Payments BB | Messaging BB | Workflow BB | Registration BB | Scheduler BB | Remarks |
1 | Identify focused resource to work on the API specs and API testing | BB lead to appoint a focused person/ nodal point for the API spec and testing effort. | Oct 18, 2022 Tambet Artma Done | @ Jaume with Vishwa (MOSIP) + SolDevelo team | @Aleksander Reitsakas & Tõnis Pihlakas | @Benjamin Balder Bach | SolDevelo team to assist the API development | @Rainer Turner & SolDevelo team | @ Farai | @ Tambet Artma | @Ramkumar @Sreepathy |
|
2 | Complete the OpenAPI specifications for each BB (openapi.json) | Swagger version of the API specs | Oct 18, 2022 Done | First candidate released (October 14th) | @Aleksander Reitsakas in progress | Done | Work in progress. Few API specs G2P payments and Voucher payments. However for G2P payments this will take some time. Hard to give a specific date. (Mid-Nov for P2G) |
|
| Oct 29, 2022 Done | Already done |
|
3 | Take a subset of the APIs for testing | BB lead to help in identifying the most important APIs that need to be tested first. | Oct 19, 2022 Data create, read. Done | Start on October 21st | We’ll use full set | Done | Started at start of October. Focusing on P2G payment APIs |
|
| Dec 20, 2022 | Pending a use case (not a priority) |
|
4 | Develop Gherkin features/ scenarios specification file for the identified subset of APIs | Gherkin file with features, scenarios for testing APIs | Nov 30, 2022 In Progress |
| not started yet | In Progress | Started developing Cucumber Gherkin scripts for G2P payments |
|
| Dec 31, 2022 |
| FewCucumber Gherkin scripts. |
5 | Testing API endpoints using Cucumber scripts | Implementation of runner class for Gherkin spec and Cucumber scripts to test candidate APIs | Nov 30, 2022 |
| not started yet | In Progress |
|
|
| Feb 1, 2023 |
|
|
6 | Develop mock example for testing (this is the step where we test the API MOCK) | Build an application that takes an openAPI spec as an INPUT and provides a REST API as an OUTPUT. This should be based on the mock application template developed by Taylor Downs and Benjamin Bach. (Paste the
| Dec 13, 2022 |
| n/a | In Progress |
|
|
|
|
|
|
7 | Add candidate products as examples for testing the APIs. | Examples of candidate products meeting the Govstack BB specs | Nov 1, 2022 UNCTAD’s eRegistrations. Done |
| x-road | BLOCKED We may currently be in a situation where there are no products satisfying the spec. |
|
|
|
|
|
|
8 | Integration with IM | Based on demo sandbox for example implementation |
|
| n/a | Not started |
|
|
|
|
|
|
9 | Deploy the example application(s) | Docker or Docker compose scripts to containerize and deploy the example/ mock example application. |
|
| not done yet | In Progress |
|
|
|
|
|
|
10 | Deployment, and API testing. Add .circleci/config.yml to BB repo. Generate test reports. | .circleCI config file to automate process of deploying environment and testing the APIs for compatibility with GovStack specs. Generate test reports. |
|
| not done yet | Not started |
|
|
|
|
|
|