guibranco / guibranco/gstraccini-bot-handler

[CHORE] Add smoke test in deploy workflow for health check endpoint

Open
#20 2 comments 1 reaction 0 assignees View on GitHub
:octocat: github-actions ⚙️ CI/CD 👷🏼 infrastructure 🕒 low effort enhancement gitauto good first issue hacktoberfest help wanted 🧑‍💻 tech-debit 🧪 tests
Dominant language
Shell
Stars
1
Forks
0
Avg merge
1m
Merged PRs (30d)
2

Description

Add a smoke test in the deploy workflow/pipeline that sends an HTTP request to the health check endpoint created in #19 and #18. This will ensure the health check functionality is working as expected after each deployment.

#### Requirements
- Execute an HTTP request to the health check endpoint (`/health`) as part of the deploy workflow.
- Verify the health check response to confirm that the API functions correctly.
- Ensure the smoke test is part of the CI/CD pipeline and is triggered after deployment.
- Failure to deploy if the health check endpoint does not return a successful status code (e.g., HTTP 200 OK).

#### Acceptance Criteria
- [ ] Smoke test is added to the deploy pipeline and executed after deployment.
- [ ] The HTTP request checks the `/health` endpoint and verifies the response status.
- [ ] If the health check fails, the pipeline deployment should be marked as failed.
- [ ] Documentation is updated to reflect the changes to the deploy workflow.

#### Notes
- This assumes the health check functionality is already implemented in #19 and #18 .
- Consider adding an alert or notification in case of a health check failure during deployment.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.