[Github] Add coverage

.dockerignore

@@ -1 +1,3 @@
 venv
+*.coverage
+coverage_reports

.github/workflows/push-dev.yml

@@ -0,0 +1,90 @@
+name: Dev Changes
+
+on:
+  push:
+    branches:
+      - development
+
+jobs:
+  test:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+          cache: pip
+      - name: Install dependencies
+        run: make dev-env
+      - name: Run unit tests
+        run: make test-coverage
+      # In order to get unique identifier we use github.run_id with artifact name.
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage_unit_tests_report-${{ github.run_id }}
+          path: coverage_reports/unit_tests.coverage
+          retention-days: 90
+
+  integration:
+    name: Integration tests
+    runs-on: [ self-hosted, Linux ]
+    container:
+      image: python:3.9.18
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install dependencies
+        run: make dev-env
+
+      - name: Run integration tests
+        env:
+          V3IO_API: ${{ secrets.V3IO_API }}
+          V3IO_ACCESS_KEY: ${{ secrets.V3IO_ACCESS_KEY }}
+          V3IO_FRAMESD: ${{ secrets.V3IO_FRAMESD }}
+        run: make integration-coverage
+        # In order to get unique identifier we use github.run_id with artifact name.
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage_integration_report-${{ github.run_id }}
+          path: coverage_reports/integration.coverage
+          retention-days: 90
+
+  coverage:
+    name: Full coverage
+    runs-on: ubuntu-latest
+    needs: [test, integration]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.9
+          cache: pip
+      - name: Install dependencies
+        run: make dev-env
+      # File name is not effected by the artifact name (=identifier only)
+      - name: Download unit tests coverage report
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage_unit_tests_report-${{ github.run_id }}
+          # Where to download. file downloaded by name.
+          path: coverage_reports/
+      - name: Download integration coverage report
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage_integration_report-${{ github.run_id }}
+          # Where to download. file downloaded by name.
+          path: coverage_reports/
+      - name: Combine coverage
+        run: make coverage-combine
+
+      # In order to be able to download it from the github run:
+      - name: Upload coverage combined report
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage_combined_report-${{ github.run_id }}
+          path: coverage_reports/combined.coverage
+          retention-days: 90

.gitignore.template

@@ -1,3 +1,5 @@
 .gitignore
 .idea
 venv
+*.coverage
+coverage_reports

Makefile

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
+.NOTPARALLEL:
+
 .PHONY: all
 all:
 	$(error please pick a target)
@@ -50,22 +52,39 @@ flake8:
 	@echo "Running flake8 lint..."
 	@python -m flake8 $(FLAKE8_OPTIONS) $(CHECKED_IN_PYTHON_FILES)
 
-.PHONY: test
-test:
+.PHONY: clean
+clean:
 	find storey -name '*.pyc' -exec rm {} \;
 	find tests -name '*.pyc' -exec rm {} \;
+	find integration -name '*.pyc' -exec rm {} \;
+
+.PHONY: test
+test: clean
 	python -m pytest --ignore=integration -rf -v .
 
+.PHONY: test-coverage
+test-coverage: clean
+	rm -f coverage_reports/unit_tests.coverage
+	COVERAGE_FILE=coverage_reports/unit_tests.coverage coverage run --rcfile=tests.coveragerc -m pytest --ignore=integration -rf -v .
+	@echo "Unit test coverage report:"
+	COVERAGE_FILE=coverage_reports/unit_tests.coverage coverage report --rcfile=tests.coveragerc
+
 .PHONY: bench
 bench:
 	find bench -name '*.pyc' -exec rm {} \;
 	python -m pytest --benchmark-json bench-results.json -rf -v bench/*.py
 
 .PHONY: integration
-integration:
-	find integration -name '*.pyc' -exec rm {} \;
+integration: clean
 	python -m pytest -rf -v integration
 
+.PHONY: integration-coverage
+integration-coverage: clean
+	rm -f coverage_reports/integration.coverage
+	COVERAGE_FILE=coverage_reports/integration.coverage coverage run --rcfile=tests.coveragerc -m pytest -rf -v integration
+	@echo "Integration test coverage report:"
+	COVERAGE_FILE=coverage_reports/integration.coverage coverage report --rcfile=tests.coveragerc
+
 .PHONY: env
 env:
 	python -m pip install -r requirements.txt
@@ -90,3 +109,13 @@ set-version:
 docs: # Build html docs
 	rm -f docs/external/*.md
 	cd docs && make html
+
+.PHONY: coverage-combine
+coverage-combine:
+	rm -f coverage_reports/combined.coverage
+	COVERAGE_FILE=coverage_reports/combined.coverage coverage combine --keep coverage_reports/integration.coverage coverage_reports/unit_tests.coverage
+	@echo "Full coverage report:"
+	COVERAGE_FILE=coverage_reports/combined.coverage coverage report --rcfile=tests.coveragerc -i
+
+.PHONY: coverage
+coverage: test-coverage integration-coverage coverage-combine

dev-requirements.txt

@@ -4,6 +4,7 @@ flake8~=5.0
 flake8-bugbear~=22.9
 isort~=5.7
 pytest~=5.4.3
+coverage~=7.5
 pytest-benchmark~=3.2.3
 lupa~=1.13
 fakeredis~=1.9

tests.coveragerc

@@ -0,0 +1,10 @@
+[run]
+
+source=./storey
+
+omit =
+    */tests/*
+    */integration/*
+    test_*
+
+relative_files = True