Bring python packages into the mbed-os source #461
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
# This workflow performs the checks like license check, | |
# doxygen, unit tests etc. | |
name: Basic Checks | |
on: | |
pull_request: | |
workflow_dispatch: | |
push: | |
branches: | |
- master | |
jobs: | |
license-check: | |
runs-on: ubuntu-latest | |
container: | |
image: ghcr.io/armmbed/mbed-os-env:master-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- | |
name: install dependencies | |
shell: bash | |
run: | | |
pip install -U scancode-toolkit "click>=7,<8" | |
- | |
name: license check | |
run: | | |
set -x | |
mkdir -p SCANCODE | |
git config --global --add safe.directory "$GITHUB_WORKSPACE" | |
git diff --name-only --diff-filter=d origin/${GITHUB_BASE_REF} \ | |
| ( grep '.\(c\|cpp\|h\|hpp\|py\)$' || true ) | |
echo $? | |
git diff --name-only --diff-filter=d origin/${GITHUB_BASE_REF} \ | |
| ( grep '.\(c\|cpp\|h\|hpp\|py\)$' || true ) \ | |
| ( grep -v '^tools/test/toolchains/api_test.py' || true ) \ | |
| while read file; do cp --parents "${file}" SCANCODE; done | |
ls SCANCODE | |
scancode -l --json-pp scancode.json SCANCODE | |
cd tools/python | |
python -m scancode_evaluate.scancode_evaluate ../../scancode.json || true | |
cat scancode-evaluate.log | |
COUNT=$(cat scancode_evaluate.log | grep 'File:' | grep -v 'SPDX' | wc -l) || true | |
if [ $COUNT = 0 ]; then | |
echo "License check OK"; | |
true; | |
else | |
echo "License check failed, please review license issues found in files"; | |
false; | |
fi | |
include-check: | |
runs-on: ubuntu-latest | |
container: | |
image: ghcr.io/armmbed/mbed-os-env:master-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- | |
name: include check | |
run: | | |
git config --global --add safe.directory "$GITHUB_WORKSPACE" | |
# checks mbed.h is not included in MbedOS files except in tests | |
! git grep '^#include\s["'"']mbed.h['"'"]$' -- '*.c' '*.h' '*.cpp' '*.hpp' \ | |
':!*platform_mbed.h' ':!*TESTS/*' ':!TEST_APPS/' ':!UNITTESTS/' \ | |
':!*tests/*' ':!*targets/*' ':!*TARGET_*' ':!*unsupported/*' \ | |
':!*events/tests/*' ':!*drivers/tests/*' | |
style-check: | |
runs-on: ubuntu-latest | |
container: | |
image: ghcr.io/armmbed/mbed-os-env:master-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- | |
name: UTF-8 Check | |
run: | | |
git config --global --add safe.directory "$GITHUB_WORKSPACE" | |
# Make sure we're not introducing any text which is not UTF-8 encoded | |
git diff origin/${GITHUB_BASE_REF} -U0 | ( grep -a '^+' || true ) | ( ! grep -axv '.*' ) | |
- | |
name: astyle checks | |
run: | | |
set -x | |
git config --global --add safe.directory "$GITHUB_WORKSPACE" | |
git diff --name-only --diff-filter=d origin/${GITHUB_BASE_REF} \ | |
| ( grep '.*\.\(c\|cpp\|h\|hpp\)$' || true ) \ | |
| ( grep -v -f .codecheckignore || true ) \ | |
| while read file; do astyle -n --options=.astylerc "${file}"; done | |
git diff --exit-code --diff-filter=d --color | |
- name: Spell Checks | |
run: | | |
set -x | |
./tools/test/ci/doxy-spellchecker/spell.sh drivers .codecheckignore | |
./tools/test/ci/doxy-spellchecker/spell.sh platform .codecheckignore | |
./tools/test/ci/doxy-spellchecker/spell.sh events .codecheckignore | |
./tools/test/ci/doxy-spellchecker/spell.sh rtos .codecheckignore | |
./tools/test/ci/doxy-spellchecker/spell.sh connectivity/netsocket .codecheckignore | |
- name: File Naming Checks | |
run: | | |
set -x | |
# Assert that all binary libraries are named correctly | |
# The strange command below asserts that there are exactly 0 libraries | |
# that do not start with lib | |
find "(" -name "*.a" -or -name "*.ar" ")" -and -not -name "lib*" | | |
tee BUILD/badlibs | | |
sed -e "s/^/Bad library name found: /" && [ ! -s BUILD/badlibs ] | |
# Assert that all assembler files are named correctly | |
# The strange command below asserts that there are exactly 0 libraries | |
# that do end with .s | |
find -name "*.s" | tee BUILD/badasm | | |
sed -e "s/^/Bad Assembler file name found: /" && [ ! -s BUILD/badasm ] | |
docs-check: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repo | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
submodules: recursive | |
- name: Create BUILD folder | |
run: | | |
mkdir -p ${{ github.workspace }}/BUILD | |
- name: Doxygen Action | |
uses: mattnotmitt/[email protected] | |
with: | |
doxyfile-path: ./doxyfile_options | |
python-tests: | |
# these tests run in 3.7, hence running in vm not in pre-built docker | |
runs-on: ubuntu-latest | |
steps: | |
- | |
name: Checkout repo | |
uses: actions/checkout@v3 | |
- | |
name: install dependencies | |
run: | | |
sudo apt-get install -y python3-intelhex python3-prettytable python3-future python3-jinja2 python3-click python3-git python3-tqdm python3-tabulate python3-requests python3-psutil python3-pyudev python3-typing-extensions python3-serial python3-dotenv | |
sudo apt-get install -y python3-pytest python3-unittest python3-factory-boy python3-requests-mock python3-mock python3-coverage | |
- | |
name: Python Tests | |
run: | | |
cd tools/python | |
./run_python_tests.sh | |
pin-validation: | |
runs-on: ubuntu-latest | |
container: | |
image: ghcr.io/armmbed/mbed-os-env:master-latest | |
steps: | |
- | |
name: Checkout repo | |
uses: actions/checkout@v3 | |
with: | |
fetch-depth: 0 | |
- | |
name: validate pins | |
run: | | |
set -x | |
git config --global --add safe.directory "$GITHUB_WORKSPACE" | |
git diff --name-only --diff-filter=d origin/${GITHUB_BASE_REF} \ | |
| ( grep '.*[\\|\/]PinNames.h$' || true ) \ | |
| while read file; do python ./hal/tests/pinvalidate/pinvalidate.py -vvvfp "${file}"; done | |
git diff --exit-code --diff-filter=d --color | |
cmake-checks: | |
env: | |
NAME: mbed-test-mode-check | |
ROOT: tools/cmake/tests/mbed_test_mode/ | |
TOOLCHAIN: GCC_ARM | |
TARGET_NAME: K64F | |
PROFILE: develop | |
runs-on: ubuntu-latest | |
container: | |
image: ghcr.io/armmbed/mbed-os-env:master-latest | |
steps: | |
- | |
name: Checkout repo | |
uses: actions/checkout@v3 | |
- | |
name: cmake build | |
run: | | |
set -x | |
cmake -S ${{env.ROOT}} -B ${{ env.ROOT }}/cmake_build/${{env.TARGET_NAME}}/${{ env.PROFILE }}/${{ env.TOOLCHAIN }}/ -GNinja -DCMAKE_BUILD_TYPE=${{ env.PROFILE }} -DMBED_TARGET=${{ env.TARGET_NAME }} | |
cmake --build ${{ env.ROOT }}/cmake_build/${{ env.TARGET_NAME }}/${{ env.PROFILE }}/${{ env.TOOLCHAIN }}/ | |
- | |
name: cmake unittest | |
run: | | |
set -x | |
ctest --build-and-test . build --build-generator Ninja --build-options -DMBED_ENABLE_TESTING=ON -DCMAKE_BUILD_TYPE=Debug -DCOVERAGE=ON --test-command ctest | |
gcovr --gcov-executable gcov -r . ./build -s -e ".*\.h" --exclude-directories=${GITHUB_WORKSPACE}/build/UNITTESTS --exclude-directories=${GITHUB_WORKSPACE}/build/_deps | |
ccache -s |