feat: add newman integration tests and reporting #45
Conversation
This file contains hidden or 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
- Introduced a GitHub Actions workflow to run Newman integration tests on pushes and pull requests to the main and dev branches. - Added a new script in `package.json` to execute Newman tests, which compiles TypeScript and runs the tests defined in `newmanApiTest.js`. - Created the `newmanApiTest.ts` file to define the Newman test suite, including setup for test reports and environment variables. - Added environment configuration in `environment.ts` for the Newman tests. - Included a comprehensive Postman collection in `postman-test-1.ts` to validate various API endpoints and their responses. - Implemented HTML report generation for test results, stored in `telex-api-report.html`, to facilitate easy review of test outcomes. - Updated `.vscode/settings.json` to include new words for spell checking related to the new tests. - Enhanced `package.json` with new dependencies for Newman and its HTML reporter. This commit establishes a robust testing framework for the Telex API, ensuring better reliability and maintainability of the integration code.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
package.jsonto execute Newman tests, which compiles TypeScript and runs the tests defined innewmanApiTest.js.newmanApiTest.tsfile to define the Newman test suite, including setup for test reports and environment variables.environment.tsfor the Newman tests.postman-test-1.tsto validate various API endpoints and their responses.telex-api-report.html, to facilitate easy review of test outcomes..vscode/settings.jsonto include new words for spell checking related to the new tests.package.jsonwith new dependencies for Newman and its HTML reporter.This commit establishes a robust testing framework for the Telex API, ensuring better reliability and maintainability of the integration code.