Github actions to run tests on push and update coverage badge on merge to main

[paigewilliams]

asana task

Includes:

• Github Action to run tests on push and opening a pull request. Testing running with a failing tests and the action returns as failed. Currently, if the action fails the user who authored the commit will get an email of the failure. Would we like to add more alerting? Perhaps sent to a slack channel?
• Github Action to run coverage and update a gist that contains a json for the coverage stats. The json is used by https://shields.io/ to dynamically update the badge. I thought that update should only occur on pushing to main to have the badge reflect the coverage on the main branch.

Added this page to the wiki as part of this work: https://github.com/Ecotrust/TEKDB/wiki/Running-tests

[Copilot]

Pull Request Overview

This PR adds a GitHub Actions workflow to automatically run tests on push and pull request events. The workflow sets up a PostgreSQL/PostGIS database service and Django test environment to execute the project's test suite.

• Adds automated CI/CD testing with PostgreSQL database service
• Configures Django environment variables for testing
• Installs required system and Python dependencies before running tests

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[paigewilliams]

I tried running sudo apt-get install gcc make uwsgi uwsgi-plugin-python3 gdal-bin python3-gdal python3-dev build-essential -y and determined only gdal is necessary.

[paigewilliams]

Looks like with [push, pull_request], the action runs twice when pushing to a branch with an open pull request. This seems redundant. My preference is to have the tests run on push so that pushes to branches that we aren't ready to open a PR for yet runs the tests, with the goal of the developer fixing any tests before they open the PR. What do you all think?

[paigewilliams]

I chose the image version from what is in docker-compose.yml. Happy to adjust if folks prefer a different version.

[rhodges]

Is there a postgis/postgis:14-3.2-alpine?

Looking at our demo server, we have PostgreSQL 14 with PostGIS 3.2.0.

[paigewilliams]

Good call on having the tests run using the same db version as the demo server! I updated to use the image for that version.

[paigewilliams]

also, the asana github action worked since I linked an asana ticket in the description 🎉

[paigewilliams]

🚧 I'm going to attempt to get a badge running with the test coverage, so i'll convert this branch to draft 🚧

[rhodges]

Looks like with [push, pull_request], the action runs twice when pushing to a branch with an open pull request. This seems redundant. My preference is to have the tests run on push so that pushes to branches that we aren't ready to open a PR for yet runs the tests, with the goal of the developer fixing any tests before they open the PR. What do you all think?

It is possible to submit a PR to a branch that has commits/code that are not available on the 'pushing' branch, so the tests would not be redundant in that case. I would want to know that the tests pass before accepting a PR. I recommend leaving both in place.

[rhodges]

LGTM - I recommend seeing if we can explicitly run the tests withn PostGIS 3.2, but I'm happy enough with what's here.

[paigewilliams]

got a lot of inspiration on how to make and update the coverage badge from this article