[QMI-037] Addition of more functions and unit-tests #210
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: QMI Python CI runner on push | |
| # This runner runs on regular push to a branch. | |
| on: | |
| push: | |
| paths-ignore: | |
| - README.md | |
| - CHANGELOG.md | |
| - .gitignore | |
| - ACKNOWLEDGEMENTS.md | |
| - LICENSE.md | |
| - CONTRIBUTING.md | |
| - TESTING.md | |
| env: | |
| # minimum pylint code quality score (max. 10) | |
| PYLINT_MIN_SCORE: "9.00" | |
| # minimum code coverage (goal: 80%; max. 100%) | |
| COVERAGE_MIN_PERC: "68" | |
| # maximum code complexity (goal: <= 15; unbounded) | |
| COMPLEXITY_MAX_SCORE: "38" | |
| # minimum maintainability index (goal: >=20; max. 100) | |
| MAINTAINABILITY_MIN_INDEX: "10.62" | |
| # this should be a comma separated list of new line separated list | |
| SOURCE_DIRS: "qmi/" | |
| jobs: | |
| on_push: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Set up Python-latest | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.11" | |
| - name: Install dependencies | |
| run: | | |
| sudo apt-get update -qy | |
| sudo apt-get install -y bc | |
| python3 --version | |
| pip install --upgrade pip | |
| pip install -e '.[dev]' | |
| - name: pylint | |
| run: | | |
| pip install pylint | |
| chmod a+x scripts/run_analysis_pylint.sh | |
| SCORE=$( scripts/run_analysis_pylint.sh ) | |
| echo $SCORE $PYLINT_MIN_SCORE | |
| echo $SCORE > pylint_score | |
| # bc evaluates to `1` if relation is true | |
| exit $( echo "$SCORE < $PYLINT_MIN_SCORE" | bc ) | |
| - name: upload pylint test results | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: pylint-results | |
| path: pylint.log | |
| if: ${{ always() }} | |
| - name: mypy | |
| run: | | |
| pip install mypy | |
| mypy --namespace-packages $SOURCE_DIRS | tee mypy.log | |
| if [ -n "$( tail -n 1 mypy.log | grep -e '^Succes' )" ]; then RESULT="pass"; else RESULT="fail"; fi | |
| echo $RESULT | |
| - name: upload mypy test results | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: mypy-results | |
| path: mypy.log | |
| if: ${{ always() }} | |
| - name: radon-cc | |
| run: | | |
| pip install radon | |
| chmod a+x scripts/run_analysis_cc.sh | |
| MAX_SCORE=$( scripts/run_analysis_cc.sh $SOURCE_DIRS ) | |
| echo $MAX_SCORE $COMPLEXITY_MAX_SCORE | |
| echo $MAX_SCORE > cc_max_score | |
| # bc evaluates to `1` if relation is true | |
| exit $( echo "$MAX_SCORE > $COMPLEXITY_MAX_SCORE" | bc ) | |
| - name: upload radon-cc results | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: radon-cc-results | |
| path: radon-cc.log | |
| if: ${{ always() }} | |
| - name: radon-mi | |
| run: | | |
| pip install radon | |
| chmod a+x scripts/run_analysis_mi.sh | |
| MIN_INDEX=$( scripts/run_analysis_mi.sh $SOURCE_DIRS ) | |
| echo $MIN_INDEX $MAINTAINABILITY_MIN_INDEX | |
| echo $MIN_INDEX > mi_min_index | |
| exit $( echo "$MIN_INDEX < $MAINTAINABILITY_MIN_INDEX" | bc ) # bc evaluates to `1` if relation is true | |
| - name: upload radon-mi results | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: radon-mi-results | |
| path: radon-mi.log | |
| if: ${{ always() }} | |
| - name: coverage | |
| run: | | |
| pip install coverage | |
| coverage run --branch --source=$SOURCE_DIRS -m unittest discover --start-directory=tests --pattern="test_*.py" | |
| coverage report --show-missing --fail-under=$COVERAGE_MIN_PERC | tee coverage.log | |
| # coverage: '/^TOTAL.+?(\d+\%)$/' | |
| - name: upload coverage results | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: coverage-results | |
| path: coverage.log | |
| if: ${{ always() }} | |