Update build workflow

.github/workflows/build.yml

@@ -40,4 +40,4 @@ jobs:
  run: |
  pip install pytest
  pip install pytest-cov
- pytest tests.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
+ pytest tests/ --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml:coverage.xml --cov-report=html

.github/workflows/pytest-coverage-comment.yml

@@ -0,0 +1,38 @@
+name: Update Coverage on Readme
+on:
+ push:
+ branches: [ "master" ]
+ pull_request:
+ branches: [ "master" ]
+jobs:
+ update-coverage-on-readme:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ with:
+ persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token
+ fetch-depth: 0 # otherwise, you will failed to push refs to dest repo
+
+ - name: Extract branch name
+ run: echo "##[set-output name=branch;]$(echo ${GITHUB_REF#refs/heads/})"
+ id: extract_branch
+
+ - name: Pytest coverage comment
+ if: ${{ github.ref == 'refs/heads/main' }}
+ id: coverageComment
+ uses: MishaKav/pytest-coverage-comment@main
+ with:
+ hide-comment: true
+ pytest-coverage-path: ./data/pytest-coverage_4.txt
+
+ - name: Update Readme with Coverage Html
+ if: ${{ github.ref == 'refs/heads/main' }}
+ run: |
+ sed -i '/<!-- Pytest Coverage Comment:Begin -->/,/<!-- Pytest Coverage Comment:End -->/c\<!-- Pytest Coverage Comment:Begin -->\n\${{ steps.coverageComment.outputs.coverageHtml }}\n${{ steps.coverageComment.outputs.summaryReport }}\n<!-- Pytest Coverage Comment:End -->' ./README.md
+
+ - name: Commit & Push changes to Readme
+ if: ${{ github.ref == 'refs/heads/main' }}
+ uses: actions-js/push@master
+ with:
+ message: Update coverage on Readme
+ github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pytest-coverage.yml

@@ -0,0 +1,34 @@
+name: Pytest coverage comment
+
+on:
+ push:
+ branches: [ "master" ]
+ pull_request:
+ branches: [ "master" ]
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+
+ - name: Set up Python 3.6
+ uses: actions/setup-python@v2
+ with:
+ python-version: 3.6
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install flake8 pytest pytest-cov
+ if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+
+ - name: Build coverage file
+ run: |
+ pytest --junitxml=pytest.xml --cov-report=term-missing:skip-covered --cov=app tests/ | tee pytest-coverage.txt
+
+ - name: Pytest coverage comment
+ uses: MishaKav/pytest-coverage-comment@main
+ with:
+ pytest-coverage-path: ./pytest-coverage.txt
+ junitxml-path: ./pytest.xml

README.md

@@ -2,6 +2,9 @@
 
 ![Build](https://github.com/Total-RD/pymgrid/workflows/Build/badge.svg)
 
+<!-- Pytest Coverage Comment:Begin -->
+<!-- Pytest Coverage Comment:End -->
+
 pymgrid (PYthon MicroGRID) is a python library to generate and simulate a large number of microgrids.
 
 For more context, please see the [presentation](https://www.climatechange.ai/papers/neurips2020/3) done at Climate Change AI.