Dockerfile Smoke Tests

[cbrinson-rise8]

Description

Create a new CI workflow that runs a smoke test job when a PR is open.

Related Issues

closes #103

Additional Notes

The smoke test should roughly do the following, but more steps can be added if identified during the development process

• start up a database
• build the Dockerfile
• run the RL service on the docker container
• send a series (~4 or so) of curl requests to the /link endpoint, and verify results

<--------------------- REMOVE THE LINES BELOW BEFORE MERGING --------------------->

Checklist

Please review and complete the following checklist before submitting your pull request:

• I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
• I have reviewed my changes to ensure they are clear, concise, and well-documented.
• I have updated the documentation, if applicable.
• I have added or updated test cases to cover my changes, if applicable.
• I have minimized the number of reviewers to include only those essential for the review.

Checklist for Reviewers

Please review and complete the following checklist during the review process:

• The code follows best practices and conventions.
• The changes implement the desired functionality or fix the reported issue.
• The tests cover the new changes and pass successfully.
• Any potential edge cases or error scenarios have been considered.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.17%. Comparing base (f0944e3) to head (abd70ac).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #116   +/-   ##
=======================================
  Coverage   95.17%   95.17%           
=======================================
  Files          26       26           
  Lines        1284     1284           
=======================================
  Hits         1222     1222           
  Misses         62       62           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ericbuckley]

The compose.yml file is currently configured for development use, the main differences being it will run jaeger by default and override the default CMD to wrap the web server in an opentelemetry call. Neither of these will likely be used in production environments. Did you consider just using docker on its own to run the API? The only dependency would be a database like postgres.

[cbrinson-rise8]

Yeah I could definitly change it to use that. No real reason I did it this way other than it was the first thing I thought of. I'll take a look at just using the dockerfile instead

[ericbuckley]

Cool use of grep. I believe jq is also available by default on ubuntu-latest if you wanted to use that.