Open-Model-Initiative / OMI-Data-Pipeline

Apache License 2.0
32 stars 3 forks source link

Add smoke tests for services #3

Closed fearnworks closed 2 weeks ago

fearnworks commented 1 month ago

Description: We need to implement smoke tests to verify that our core services are up and running after deployment. This will help ensure the reliability of our deployments and quickly identify any issues.

Tasks:

  1. Create a smoke test for the API server
    • Implement a simple health check endpoint in the API
    • Write a test that calls this endpoint and verifies the response
    • Connect to a taskfile
  2. Create a smoke test for the Postgres database
    • Implement a basic database connection check
    • Write a test that attempts to connect to the database and perform a simple query
    • Connect to a taskfile

There should be a command that runs both integration smoke tests

Things to consider in the future: Integrate these tests into our deployment pipeline

PrateekKumar1709 commented 3 weeks ago

Hi @fearnworks, I would like to work on this issue. Here’s how I plan to address the issue:

API Health Check:

Postgres Database Connection Test:

Taskfile Integration:

Please let me know if I can proceed with this implementation.

fearnworks commented 3 weeks ago

@PrateekKumar1709 : This sounds like a good approach. Feel free to reach out if you have any issues!

aryam-juneja commented 2 weeks ago

@PrateekKumar1709 Hi, I am new to Open Source, and would like to get started. Would you mind if we could work on this issue together?

PrateekKumar1709 commented 2 weeks ago
  • Add a combined task in the root Taskfile.yml to execute both tests with a single command: task smoke_tests.

@aryam-juneja Unfortunately I have finished most of the work on this. But happy to tag team on another issue if you want. Thanks.

aryam-juneja commented 2 weeks ago
  • Add a combined task in the root Taskfile.yml to execute both tests with a single command: task smoke_tests.

@aryam-juneja Unfortunately I have finished most of the work on this. But happy to tag team on another issue if you want. Thanks.

Okay, Lets connect in future for tag team on other issues.