tweak actions and add coverage (#23)

* tweak actions and add coverage
* add coverage badge

Author: rossengeorgiev

.coveragerc

@@ -0,0 +1,9 @@
+
+# Docs:  https://coverage.readthedocs.org/en/latest/config.html
+
+[run]
+branch = False
+
+# If True, stores relative file paths in data file (needed for Github Actions).
+# Using this parameter requires coverage>=5.0
+relative_files = True

.github/workflows/testing.yml

@@ -32,16 +32,36 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python Env
-        uses: actions/setup-python@v2.1.4 # FIXME: Use "v2" tag once https://github.com/actions/setup-python/issues/171 is resolved.
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
       - name: Display Python version
         run: python -c "import sys; print(sys.version)"
       - name: Install dependencies
         run: |
-          pip install pytest==3.2.1 pytest-cov==2.5.1
+          make init
       - name: Run Tests
+        run: |
+          make test
+      - name: Upload to Coveralls
         env:
-          PYTHONHASHSEED: "0"
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COVERALLS_PARALLEL: true
+          COVERALLS_FLAG_NAME: "${{ matrix.os }}_${{ matrix.python-version }}"
         run: |
-          pytest --cov=vpk tests
+          coveralls --service=github
+
+  coveralls:
+    name: Finish Coveralls
+    needs: test
+    runs-on: ubuntu-latest
+    container: python:3-slim
+    steps:
+    - name: Install coveralls
+      run: |
+        pip3 install --upgrade coveralls
+    - name: Send coverage finish to coveralls.io
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: |
+        coveralls --finish

Makefile

@@ -16,11 +16,11 @@ help:
 	@echo "$$HELPBODY"
 
 init:
-	pip install pytest==3.2.1 pytest-cov==2.5.1
+	pip install -r requirements.txt
 
 test:
 	rm -f .coverage vpk/*.pyc tests/*.pyc
-	PYTHONHASHSEED=0 pytest --cov=vpk tests
+	PYTHONHASHSEED=0 pytest --tb=short --cov-config .coveragerc --cov=vpk tests
 
 pylint:
 	pylint -r n -f colorized vpk || true

README.rst

@@ -1,4 +1,4 @@
-| |pypi| |license| |master_build|
+| |pypi| |license| |coverage| |master_build|
 | |sonar_maintainability| |sonar_reliability| |sonar_security|
 
 VPK is Valve's file format for storing game assets.
@@ -124,6 +124,10 @@ Check out https://github.com/SteamDatabase/ValveResourceFormat/
     :target: https://pypi.python.org/pypi/vpk
     :alt: MIT License
 
+.. |coverage| image:: https://img.shields.io/coveralls/ValvePython/vpk/master.svg?style=flat
+    :target: https://coveralls.io/r/ValvePython/vpk?branch=master
+    :alt: Test coverage
+
 .. |master_build| image:: https://github.com/ValvePython/vpk/workflows/Tests/badge.svg?branch=master
     :target: https://github.com/ValvePython/vpk/actions?query=workflow%3A%22Tests%22+branch%3Amaster
     :alt: Build status of master branch

requirements.txt

@@ -0,0 +1,7 @@
+
+coverage>=5.0; python_version == '2.7' or python_version >= '3.5'
+pytest-cov>=2.7.0; python_version == '2.7' or python_version >= '3.5'
+
+# coveralls 2.0 has removed support for Python 2.7 and 3.4
+git+https://github.com/andy-maier/coveralls-python.git@andy/add-py27#egg=coveralls; python_version == '2.7'
+coveralls>=2.1.2; python_version >= '3.5'