├── .gitignore ├── Dockerfile ├── LICENSE ├── README.md ├── action.yml └── entrypoint.sh /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM python:3.8.1-slim 2 | 3 | LABEL "com.github.actions.name"="Django Coverage Action for Python" 4 | LABEL "com.github.actions.description"="Python Django Coverage GitHub Action" 5 | LABEL "com.github.actions.icon"="code" 6 | LABEL "com.github.actions.color"="black" 7 | 8 | # manual postgres fixes 9 | RUN set -eux; \ 10 | groupadd -r postgres --gid=999; \ 11 | # https://salsa.debian.org/postgresql/postgresql-common/blob/997d842ee744687d99a2b2d95c1083a2615c79e8/debian/postgresql-common.postinst#L32-35 12 | useradd -r -g postgres --uid=999 --home-dir=/var/lib/postgresql --shell=/bin/bash postgres; \ 13 | # also create the postgres user's home directory with appropriate permissions 14 | # see https://github.com/docker-library/postgres/issues/274 15 | mkdir -p /var/lib/postgresql; \ 16 | chown -R postgres:postgres /var/lib/postgresql 17 | RUN mkdir -p /var/run/postgresql && chown -R postgres:postgres /var/run/postgresql && chmod 2777 /var/run/postgresql 18 | 19 | 20 | RUN apt-get update \ 21 | && apt-get install -y --no-install-recommends git gcc libc-dev python3-dev build-essential libpq-dev postgresql-11 postgresql-client-11 \ 22 | && apt-get purge -y --auto-remove \ 23 | && rm -rf /var/lib/apt/lists/* 24 | 25 | RUN pip install --upgrade pip virtualenv 26 | 27 | # setup postgresql database and user. 28 | # We don't expose the port, but allow all incomming connections 29 | USER postgres 30 | # configure the user for later. the service will be started in the entrypoint 31 | RUN service postgresql start \ 32 | && psql -c "CREATE USER ctest WITH SUPERUSER PASSWORD 'coveragetest123';ALTER USER ctest CREATEDB;" 33 | USER root 34 | 35 | 36 | COPY entrypoint.sh / 37 | RUN chmod +x /entrypoint.sh 38 | ENTRYPOINT ["/entrypoint.sh"] 39 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2020 Capital Technologies and Emilio Moretti 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Python Django coverage.py GitHub Action 2 | 3 | Github Action to integrate Coverage.py with Django on every pull request. It comes with a bundled PostgreSQL DB to run the test against. 4 | 5 | ## Inputs 6 | 7 | ### `django-app` 8 | 9 | The name of the Django app. 10 | Default: 11 | 12 | ### `minimum-coverage` 13 | 14 | Percentage of required coverage to consider it a valid commit. 15 | Default: `10` 16 | 17 | ## Outputs 18 | 19 | ### `success` 20 | 21 | Boolean value that indicates that the test run and coverage was successful. 22 | 23 | ## Example usage 24 | steps: 25 | - name: Checkout action 26 | uses: actions/checkout@v2 27 | - name: Django Coverage action 28 | uses: dc740/django-coveragepy-github-action@0.9 29 | with: 30 | django-app: 'sample_app' 31 | minimum-coverage: '86' 32 | -------------------------------------------------------------------------------- /action.yml: -------------------------------------------------------------------------------- 1 | name: Python Django Coverage GitHub Action 2 | inputs: 3 | django-app: 4 | description: "Application" 5 | required: false 6 | default: "" 7 | minimum-coverage: 8 | description: "Minimum allowed code coverage" 9 | required: false 10 | default: "10" 11 | description: 'Github Action to run tests and get coverage with Django on a Python Docker image' 12 | branding: 13 | icon: box 14 | color: gray-dark 15 | runs-on: ubuntu-latest 16 | runs: 17 | using: 'docker' 18 | image: 'Dockerfile' 19 | args: 20 | - ${{ inputs.django-app }} 21 | - ${{ inputs.minimum-coverage }} 22 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | set -e 3 | 4 | echo "#################################################" 5 | echo "Starting ${GITHUB_WORKFLOW}:${GITHUB_ACTION}" 6 | 7 | 8 | APP=$1 9 | MIN_COVERAGE=$2 10 | 11 | # start PostgreSQL 12 | service postgresql start 13 | 14 | # setup run settings 15 | if [ -z "${APP}" ]; then 16 | # coverage on everything when app is empty 17 | APP_LOCATION="." 18 | VENV_NAME="virtenv1" 19 | else 20 | APP_LOCATION=$APP 21 | VENV_NAME=virtenv_$APP 22 | fi 23 | 24 | # init virtual environment 25 | if ! [ -e "${GITHUB_WORKSPACE}/${VENV_NAME}" ]; then 26 | python3 -m venv "${GITHUB_WORKSPACE}/${VENV_NAME}" 27 | fi 28 | 29 | source "${GITHUB_WORKSPACE}/${VENV_NAME}/bin/activate" 30 | 31 | pip install -r requirements.txt 32 | 33 | echo "Base setup complete. Setting up a sample DB url and running..." 34 | export DATABASE_URL='postgresql://ctest:coveragetest123@127.0.0.1:5432/demo' 35 | 36 | # This will automatically fail (set -e is set by default) if the tests fail, which is OK. 37 | coverage run --source "${APP_LOCATION}" manage.py test "${APP}" 38 | 39 | # Now get the coverage 40 | COVERAGE_RESULT=`coverage report | grep TOTAL | awk 'N=1 {print $NF}' | sed 's/%//g'` 41 | if [[ $COVERAGE_RESULT -gt $MIN_COVERAGE ]]; then 42 | echo ::set-output name=coverage_result::$COVERAGE_RESULT 43 | else 44 | echo "#################################################" 45 | echo "Code coverage below allowed threshold ($COVERAGE_RESULT<$MIN_COVERAGE)" 46 | exit 1 47 | fi 48 | 49 | echo "#################################################" 50 | echo "Completed ${GITHUB_WORKFLOW}:${GITHUB_ACTION}" 51 | --------------------------------------------------------------------------------