Skip to content

Feature/3 implement check logic without qualifiers support #16

Feature/3 implement check logic without qualifiers support

Feature/3 implement check logic without qualifiers support #16

Workflow file for this run

#
# Copyright 2024 ABSA Group Limited
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
name: Test
on:
pull_request:
branches:
- '**'
types: [ opened, synchronize, reopened ]
jobs:
static-code-analysis:
runs-on: ubuntu-latest
name: Pylint Static Code Analysis
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: 'pip'
- name: Install dependencies
run: |
pip install -r requirements.txt
- name: Analyze code with Pylint
id: analyze-code
run: |
pylint_score=$(pylint $(git ls-files '*.py')| grep 'rated at' | awk '{print $7}' | cut -d'/' -f1)
echo "PYLINT_SCORE=$pylint_score" >> $GITHUB_ENV
- name: Check Pylint score
run: |
if (( $(echo "$PYLINT_SCORE < 9.5" | bc -l) )); then
echo "Failure: Pylint score is below 9.5 (project score: $PYLINT_SCORE)."
exit 1
else
echo "Success: Pylint score is above 9.5 (project score: $PYLINT_SCORE)."
fi
code-format-check:
runs-on: ubuntu-latest
name: Black Format Check
steps:
- name: Checkout repository
uses: actions/[email protected]
with:
persist-credentials: false
- name: Set up Python
uses: actions/[email protected]
with:
python-version: '3.11'
cache: 'pip'
- name: Install dependencies
run: |
pip install -r requirements.txt
- name: Check code format with Black
id: check-format
run: |
black --check $(git ls-files '*.py')
unit-test:
name: Unit Tests
runs-on: ubuntu-latest
defaults:
run:
shell: bash
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
persist-credentials: false
- uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: 'pip'
- name: Install Python dependencies
run: |
pip install -r requirements.txt
- name: Set PYTHONPATH environment variable
run: echo "PYTHONPATH=${GITHUB_WORKSPACE}/version_tag_check/version_tag_check" >> $GITHUB_ENV
- name: Check code coverage with Pytest
run: pytest --cov=. -v tests/ --cov-fail-under=80
- name: Check overall coverage
run: |
coverage report --fail-under=80
coverage xml -o coverage_overall.xml
- name: Check changed files coverage
run: |
# Get the list of changed Python files
CHANGED_FILES=$(git diff --name-only --diff-filter=AMR ${{ github.event.pull_request.base.sha }} ${{ github.sha }} | grep '.py$' || true)
echo "Changed Python files: $CHANGED_FILES"
# If no Python files have changed, skip the coverage check
if [ -z "$CHANGED_FILES" ]; then
echo "No Python files have changed. Skipping coverage check for changed files."
exit 0
fi
# Convert list to comma-delimited string
CHANGED_FILES=$(echo "$CHANGED_FILES" | awk '{printf "%s,", $0} END {print ""}' | sed 's/,$//')
# Generate coverage report for changed files
coverage report --include="$CHANGED_FILES" > coverage_report.txt
echo -e "\nChanged Python files report:\n\n"
cat coverage_report.txt
# Fail if the coverage for changed files is below threshold
COVERAGE_TOTAL=$(awk '/TOTAL/ {print $4}' coverage_report.txt)
echo "Total coverage for changed files: $COVERAGE_TOTAL"
if (( $(echo "$COVERAGE_TOTAL < 80.0" | bc -l) )); then
echo "Coverage is below 80%"
exit 1
fi
- name: Upload coverage report
uses: actions/upload-artifact@v3
with:
name: coverage-report
path: coverage_overall.xml