CI-CD Updates (#260)

* Use new version of CI-CD Actions,  checkout@v3 instead of checkout@v2 on all jobs
* Use cSpell spell check, and use ubuntu-20.04 for formatting check
* Add in bot formatting action

.github/.cSpellWords.txt

@@ -0,0 +1,34 @@
+CBMC
+CBOR
+CMOCK
+CMock
+CSDK
+Cmock
+Coverity
+DCMOCK
+DNDEBUG
+DUNITY
+MISRA
+MQTT
+Misra
+UNACKED
+UNSUB
+UNSUBACK
+Wunused
+cbmc
+cbor
+cmock
+coremqtt
+coverity
+ctest
+getpacketid
+isystem
+lcov
+misra
+mypy
+pylint
+pytest
+pyyaml
+sinclude
+unsubscriptions
+utest

.github/workflows/ci.yml

@@ -1,4 +1,10 @@
-name: CI Checks
+name: "CI Checks"
+
+env:
+ bashPass: \033[32;1mPASSED -
+ bashInfo: \033[33;1mINFO -
+ bashFail: \033[31;1mFAILED -
+ bashEnd: \033[0m
 
 on:
  push:
@@ -12,71 +18,93 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - name: Clone This Repo
- uses: actions/checkout@v2
- - name: Build
+ uses: actions/checkout@v3
+
+ - env:
+ stepName: Build CoreMQTT
  run: |
+ # ${{ env.stepName }}
+ echo -e "::group::${{ env.bashInfo }} ${{ env.stepName }} ${{ env.bashEnd }}"
+
  sudo apt-get install -y lcov
  cmake -S test -B build/ \
  -G "Unix Makefiles" \
  -DCMAKE_BUILD_TYPE=Debug \
  -DBUILD_CLONE_SUBMODULES=ON \
  -DCMAKE_C_FLAGS='--coverage -Wall -Wextra -Werror -DNDEBUG -DLIBRARY_LOG_LEVEL=LOG_DEBUG'
  make -C build/ all
- - name: Test
- run: |
- cd build/
- ctest -E system --output-on-failure
- cd ..
- - name: Run Coverage
+ echo "::endgroup::"
+
+ echo -e "${{ env.bashPass }} ${{env.stepName}} ${{ env.bashEnd }}"
+
+ - name: Run System Tests
+ run: ctest --test-dir build -E system --output-on-failure
+
+ - env:
+ stepName: Line and Branch Coverage Build
  run: |
+ # ${{ env.stepName }}
+ echo -e "::group::${{ env.bashInfo }} Build Coverage Target ${{ env.bashEnd }}"
+ # Build the coverage target
  make -C build/ coverage
- declare -a EXCLUDE=("\*test\*" "\*CMakeCCompilerId\*" "\*mocks\*")
- echo ${EXCLUDE[@]} | xargs lcov --rc lcov_branch_coverage=1 -r build/coverage.info -o build/coverage.info
+
+ echo -e "::group::${{ env.bashInfo }} Generate Coverage Report ${{ env.bashEnd }}"
+ # Generate coverage report, excluding extra directories
+ lcov --rc lcov_branch_coverage=1 -r build/coverage.info -o build/coverage.info '*test*' '*CMakeCCompilerId*' '*mocks*'
+
+ echo "::endgroup::"
  lcov --rc lcov_branch_coverage=1 --list build/coverage.info
+ echo -e "${{ env.bashPass }} ${{env.stepName}} ${{ env.bashEnd }}"
+
  - name: Check Coverage
  uses: FreeRTOS/CI-CD-Github-Actions/coverage-cop@main
  with:
- path: ./build/coverage.info
+ coverage-file: ./build/coverage.info
+
  complexity:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
  - name: Check complexity
  uses: FreeRTOS/CI-CD-Github-Actions/complexity@main
  with:
  path: ./
- horrid_threshold: 10
+ horrid_threshold: 12
+
  doxygen:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
  - name: Run doxygen build
  uses: FreeRTOS/CI-CD-Github-Actions/doxygen@main
  with:
  path: ./
+
  spell-check:
  runs-on: ubuntu-latest
  steps:
  - name: Clone This Repo
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
  - name: Run spellings check
  uses: FreeRTOS/CI-CD-Github-Actions/spellings@main
  with:
  path: ./
+
  formatting:
  runs-on: ubuntu-20.04
  steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
  - name: Check formatting
  uses: FreeRTOS/CI-CD-Github-Actions/formatting@main
  with:
  path: ./
+
  git-secrets:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
  - name: Checkout awslabs/git-secrets
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
  with:
  repository: awslabs/git-secrets
  ref: master
@@ -87,37 +115,76 @@ jobs:
  run: |
  git-secrets --register-aws
  git-secrets --scan
+
  custom-standard-c-headers:
  runs-on: ubuntu-latest
  steps:
  - name: Clone This Repo
- uses: actions/checkout@v2
- - name: Build
+ uses: actions/checkout@v3
+ - env:
+ stepName: Build With Custom Headers
  run: |
+ # ${{ env.stepName }}
+ echo -e "::group::${{ env.bashInfo }} ${{ env.stepName }} ${{ env.bashEnd }}"
+
+ # Copy the custom headers into the build directory
  mkdir -p override-include
  cp source/include/stdbool.readme override-include/stdbool.h
  cp source/include/stdint.readme override-include/stdint.h
+
+ # Build using the custom headers
  cmake -S test -B build/ \
  -G "Unix Makefiles" \
  -DBUILD_CLONE_SUBMODULES=ON \
  -DCMAKE_C_FLAGS='-Wall -Wextra -I../override-include'
  make -C build/ coverity_analysis
+ echo "::endgroup::"
+
+ echo -e "${{ env.bashPass }} ${{ env.stepName }} ${{ env.bashEnd }}"
+
  memory_statistics:
  runs-on: ubuntu-latest
  steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
  with:
  submodules: 'recursive'
  - name: Install Python3
- uses: actions/setup-python@v2
+ uses: actions/setup-python@v3
  with:
  python-version: '3.11.0'
  - name: Measure sizes
  uses: FreeRTOS/CI-CD-Github-Actions/memory_statistics@main
  with:
  config: .github/memory_statistics_config.json
  check_against: docs/doxygen/include/size_table.md
+
+ link-verifier:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - name: Check Links
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ uses: FreeRTOS/CI-CD-Github-Actions/link-verifier@main
+ with:
+ path: ./
+
+ verify-manifest:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ with:
+ submodules: true
+ fetch-depth: 0
+
+ - name: Run manifest verifier
+ uses: FreeRTOS/CI-CD-GitHub-Actions/manifest-verifier@main
+ with:
+ path: ./
+ fail-on-incorrect-version: true
+
  proof_ci:
+ if: ${{ github.event.pull_request }}
  runs-on: cbmc_ubuntu-latest_64-core
  steps:
  - name: Set up CBMC runner

.github/workflows/formatting.yml

@@ -0,0 +1,23 @@
+name: Format Pull Request Files
+
+on:
+ issue_comment:
+ types: [created]
+
+env:
+ bashPass: \033[32;1mPASSED -
+ bashInfo: \033[33;1mINFO -
+ bashFail: \033[31;1mFAILED -
+ bashEnd: \033[0m
+
+jobs:
+ Formatting:
+ name: Run Formatting Check
+ if: ${{ github.event.issue.pull_request }} &&
+ ( ( github.event.comment.body == '/bot run uncrustify' ) ||
+ ( github.event.comment.body == '/bot run formatting' ) )
+ runs-on: ubuntu-20.04
+ steps:
+ - name: Apply Formatting Fix
+ uses: FreeRTOS/CI-CD-Github-Actions/formatting-bot@main
+ id: check-formatting

.github/workflows/release.yml

@@ -22,7 +22,7 @@ jobs:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  steps:
  - name: Checkout code
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
  - name: Check if tag exists
  run: |
  git fetch origin
@@ -49,7 +49,7 @@ jobs:
  runs-on: ubuntu-latest
  steps:
  - name: Checkout code
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
  with:
  ref: ${{ github.event.inputs.commit_id }}
  - name: Configure git identity
@@ -87,7 +87,7 @@ jobs:
  - name: Install ZIP tools
  run: sudo apt-get install zip unzip
  - name: Checkout code
- uses: actions/checkout@v2
+ uses: actions/checkout@v3
  with:
  ref: ${{ github.event.inputs.commit_id }}
  path: coreMQTT