This is a sample project for testing C code for STM32 microcontrollers using the Google Test Framework. Some topics covered:
- Sample project using the NUCLEO-F446ZE board.
- Embedded system without RTOS (bare metal).
- Distinct folders for library, executable, and test code.
- Use of STM32CubeIDE for building and compiling the application project.
- Use of CMake for building the test code.
- Testing C code via Google Test Framework.
- Use GMock for mocking the STM32 HAL functions.
- Code coverage with Github Actions and Codecov.
- Code quality analysis with Lizard and Flawfinder tools.
- Assert verification and prints the failures via huart3.
- Use of Docker container.
./
├── CMakeLists.txt
│
├── cmake
│ └── cmake modules
│
├── docker
│ └── Dockerfile
│
├── docs
│ └── Documentation files
│
├── .github
│ └── workflows
│ └── GitHub workflows
│
├── source
│ ├── CMakeLists.txt
│ │
│ ├── nucleo-f446ze-library
│ │ ├── CMakeLists.txt
│ │ ├── BuildArtifacts
│ │ │ └── Library artifacts
│ │ ├── Drivers
│ │ │ └── Files generated by STM32CubeIDE
│ │ ├── Inc
│ │ │ └── Files generated by STM32CubeIDE
│ │ ├── Libraries
│ │ │ └── Header and source files
│ │ └── Src
│ │ └── Files generated by STM32CubeIDE
│ │
│ └── stm32-cube-ide
│ ├── Core (Files generated by STM32CubeIDE)
│ │ ├── Inc
│ │ │ └── Files generated by STM32CubeIDE
│ │ ├── Src
│ │ │ ├── main.c (Sample code)
│ │ │ └── ...
│ │ └── Startup
│ │ └── Files generated by STM32CubeIDE
│ └── Drivers
│ └── Files generated by STM32CubeIDE
│
└── tests
├── CMakeLists.txt
├── header-overrides
│ └── Overrides some header files copied from the STM32CubeIDE project that are needed by the mock
├── integration
│ └── integration_hello_test.cpp
├── mock
│ ├── fixture.h
│ └── hal_gpio_mock.cpp
└── unit
├── gpio_test.cpp
└── unit_hello_test.cpp
Clone this repo for your local machine
git clone https://github.com/CharlesDias/stm32_gtest_c_code.gitAccess the project folder stm32_gtest_c_code
cd stm32_gtest_c_codePull the latest docker image used to build the project.
docker pull charlesdias/stm32_gtestRun the image docker.
docker run --rm -it -v $(pwd):/home/project -w /home/project charlesdias/stm32_gtestRun the command below inside the Docker container
make clean && make build && make testAccess the build/coverage/index.html file to see the coverage report.
Dependency graph for test project.
Clone this repo for your local machine
git clone https://github.com/CharlesDias/stm32_gtest_c_code.gitOpen the STM32CubeIDE and import this project.
Build and load the firmware on NUCLEO-F446ZE board. See the expected output.
- Add some function example to increase the CCN (cyclomatic complexity number).
- Add some function example with security weaknesses to test the Flawfinder.
- Build the application project via CMake.
- Add Doxygen configuration.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent