Skip to content

Commit c25a262

Browse files
am-orkesam-orkes
authored
Merge pull request #305 from conductor-oss/code-coverage
Add code coverage
2 parents f616906 + 325a265 commit c25a262

5 files changed

Lines changed: 116 additions & 14 deletions

File tree

‎.coveragerc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[run]
2+
source = src/conductor
3+
omit =
4+
tests/*
5+
examples/*
6+
*/__init__.py
7+
8+
[report]
9+
exclude_lines =
10+
pragma: no cover
11+
def __repr__
12+
raise NotImplementedError
13+
if __name__ == .__main__.:
14+
pass
15+
raise ImportError
16+
except ImportError:
17+
if TYPE_CHECKING:

‎.github/workflows/pull_request.yml‎

Lines changed: 92 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,99 @@ name: Continuous Integration
22

33
on: [pull_request, workflow_dispatch]
44

5+
concurrency:
6+
group: ${{ github.workflow }}-${{ github.ref }}
7+
cancel-in-progress: true
8+
59
jobs:
610
unit-test:
711
runs-on: ubuntu-latest
12+
env:
13+
COVERAGE_FILE: coverage.xml
14+
COVERAGE_DIR: .coverage-reports
815
steps:
9-
- name: Checkout
10-
uses: actions/checkout@v3
11-
- name: Test
12-
run: >
13-
DOCKER_BUILDKIT=1 docker build .
14-
--progress=plain
15-
--build-arg CONDUCTOR_AUTH_KEY=${{ secrets.CONDUCTOR_AUTH_KEY }}
16-
--build-arg CONDUCTOR_AUTH_SECRET=${{ secrets.CONDUCTOR_AUTH_SECRET }}
17-
--build-arg CONDUCTOR_SERVER_URL=${{ secrets.CONDUCTOR_SERVER_URL }}
18-
--target=unit_test
16+
- name: Checkout code
17+
uses: actions/checkout@v4
18+
19+
- name: Build test image
20+
run: |
21+
DOCKER_BUILDKIT=1 docker build . \
22+
--target python_test_base \
23+
-t conductor-sdk-test:latest
24+
25+
- name: Prepare coverage directory
26+
run: |
27+
mkdir -p ${{ env.COVERAGE_DIR }}
28+
chmod 777 ${{ env.COVERAGE_DIR }}
29+
touch ${{ env.COVERAGE_FILE }}
30+
chmod 666 ${{ env.COVERAGE_FILE }}
31+
32+
- name: Run unit tests
33+
id: unit_tests
34+
continue-on-error: true
35+
run: |
36+
docker run --rm \
37+
-e CONDUCTOR_AUTH_KEY=${{ secrets.CONDUCTOR_AUTH_KEY }} \
38+
-e CONDUCTOR_AUTH_SECRET=${{ secrets.CONDUCTOR_AUTH_SECRET }} \
39+
-e CONDUCTOR_SERVER_URL=${{ secrets.CONDUCTOR_SERVER_URL }} \
40+
-v ${{ github.workspace }}/${{ env.COVERAGE_DIR }}:/package/${{ env.COVERAGE_DIR }}:rw \
41+
conductor-sdk-test:latest \
42+
/bin/sh -c "cd /package && COVERAGE_FILE=/package/${{ env.COVERAGE_DIR }}/.coverage.unit coverage run --source=src/conductor -m unittest discover --verbose --start-directory=./tests/unit"
43+
44+
- name: Run backward compatibility tests
45+
id: bc_tests
46+
continue-on-error: true
47+
run: |
48+
docker run --rm \
49+
-e CONDUCTOR_AUTH_KEY=${{ secrets.CONDUCTOR_AUTH_KEY }} \
50+
-e CONDUCTOR_AUTH_SECRET=${{ secrets.CONDUCTOR_AUTH_SECRET }} \
51+
-e CONDUCTOR_SERVER_URL=${{ secrets.CONDUCTOR_SERVER_URL }} \
52+
-v ${{ github.workspace }}/${{ env.COVERAGE_DIR }}:/package/${{ env.COVERAGE_DIR }}:rw \
53+
conductor-sdk-test:latest \
54+
/bin/sh -c "cd /package && COVERAGE_FILE=/package/${{ env.COVERAGE_DIR }}/.coverage.bc coverage run --source=src/conductor -m unittest discover --verbose --start-directory=./tests/backwardcompatibility"
55+
56+
- name: Run serdeser tests
57+
id: serdeser_tests
58+
continue-on-error: true
59+
run: |
60+
docker run --rm \
61+
-e CONDUCTOR_AUTH_KEY=${{ secrets.CONDUCTOR_AUTH_KEY }} \
62+
-e CONDUCTOR_AUTH_SECRET=${{ secrets.CONDUCTOR_AUTH_SECRET }} \
63+
-e CONDUCTOR_SERVER_URL=${{ secrets.CONDUCTOR_SERVER_URL }} \
64+
-v ${{ github.workspace }}/${{ env.COVERAGE_DIR }}:/package/${{ env.COVERAGE_DIR }}:rw \
65+
conductor-sdk-test:latest \
66+
/bin/sh -c "cd /package && COVERAGE_FILE=/package/${{ env.COVERAGE_DIR }}/.coverage.serdeser coverage run --source=src/conductor -m unittest discover --verbose --start-directory=./tests/serdesertest"
67+
68+
- name: Generate coverage report
69+
id: coverage_report
70+
continue-on-error: true
71+
run: |
72+
docker run --rm \
73+
-v ${{ github.workspace }}/${{ env.COVERAGE_DIR }}:/package/${{ env.COVERAGE_DIR }}:rw \
74+
-v ${{ github.workspace }}/${{ env.COVERAGE_FILE }}:/package/${{ env.COVERAGE_FILE }}:rw \
75+
conductor-sdk-test:latest \
76+
/bin/sh -c "cd /package && coverage combine /package/${{ env.COVERAGE_DIR }}/.coverage.* && coverage report && coverage xml"
77+
78+
- name: Verify coverage file
79+
id: verify_coverage
80+
if: always()
81+
continue-on-error: true
82+
run: |
83+
if [ ! -s "${{ env.COVERAGE_FILE }}" ]; then
84+
echo "Coverage file is empty or does not exist"
85+
ls -la ${{ env.COVERAGE_FILE }} ${{ env.COVERAGE_DIR }}
86+
exit 1
87+
fi
88+
echo "Coverage file exists and is not empty"
89+
90+
- name: Upload coverage to Codecov
91+
if: always() && steps.verify_coverage.outcome == 'success'
92+
continue-on-error: true
93+
uses: codecov/codecov-action@v3
94+
with:
95+
token: ${{ secrets.CODECOV_TOKEN }}
96+
file: ${{ env.COVERAGE_FILE }}
97+
98+
- name: Check test results
99+
if: steps.unit_tests.outcome == 'failure' || steps.bc_tests.outcome == 'failure' || steps.serdeser_tests.outcome == 'failure'
100+
run: exit 1

‎Dockerfile‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,8 @@ WORKDIR /package
1010
RUN pwd
1111
RUN ls -ltr
1212
ENV PYTHONPATH /package/src:/package/tests
13-
RUN python3 -m pip install pylint
14-
#RUN python3 -m pylint --disable=all ./src
15-
RUN python3 -m pip install coverage
16-
RUN python3 -m pip install -r ./requirements.txt
13+
RUN python3 -m pip install -r ./requirements.txt && \
14+
python3 -m pip install -r ./requirements.dev.txt
1715

1816
FROM python_test_base as unit_test
1917
ARG CONDUCTOR_AUTH_KEY

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# Conductor OSS Python SDK
2+
[![CI Status](https://github.com/conductor-oss/python-sdk/actions/workflows/pull_request.yml/badge.svg)](https://github.com/conductor-oss/python-sdk/actions/workflows/pull_request.yml)
3+
[![codecov](https://codecov.io/gh/conductor-oss/python-sdk/branch/main/graph/badge.svg?token=K10D161X4R)](https://codecov.io/gh/conductor-oss/python-sdk)
24

35
Python SDK for working with https://github.com/conductor-oss/conductor.
46

‎requirements.dev.txt‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
pylint >= 2.17.5
2+
coverage >= 7.2.7
3+
pytest-cov >= 4.1.0

0 commit comments

Comments
 (0)