KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

stm32_gtest_c_code

★ 74 Open GitHub ↗

This is a sample project for testing C code for STM32 microcontrollers using the Google Test Framework.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# STM32 C code and Google Test Framework

[![Language](https://img.shields.io/badge/language-C%20%7C%20C++-blue.svg)](https://en.wikipedia.org/wiki/C%2B%2B)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/CharlesDias/stm32_gtest_c_code/main/LICENSE)
[![Test](https://github.com/CharlesDias/stm32_gtest_c_code/actions/workflows/unit-test.yml/badge.svg)](https://github.com/CharlesDias/stm32_gtest_c_code/actions/workflows/unit-test.yml)
[![codecov](https://codecov.io/gh/CharlesDias/stm32_gtest_c_code/branch/main/graph/badge.svg)](https://codecov.io/gh/CharlesDias/stm32_gtest_c_code)
[![Lizard](https://github.com/CharlesDias/stm32_gtest_c_code/actions/workflows/lizard.yml/badge.svg)](https://github.com/CharlesDias/stm32_gtest_c_code/actions/workflows/lizard.yml)
[![Flawfinder](https://github.com/CharlesDias/stm32_gtest_c_code/actions/workflows/flawfinder.yml/badge.svg)](https://github.com/CharlesDias/stm32_gtest_c_code/actions/workflows/flawfinder.yml)

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](https://codecov.io).
* Code quality analysis with Lizard and Flawfinder tools.
* Assert verification and prints the failures via huart3.
* Use of Docker container.

I know! Maybe... you're thinking it's overengineer to blink a LED. However, look on the bright side. The goal is to give an example of how to apply these practices and tools.

## Project structure

``` text
./
├── 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
│   │   │   ├── CMakeLists.txt
│   │   │   ├── Drivers
│   │   │   │   ├── CMakeLists.txt
│   │   │   │   └── Header and source files
│   │   │   └── Middleware
│   │   │       ├── CMakeLists.txt
│   │   │       └── Header and source files
│   │   └── Src
│   │       └── Files generated by STM32CubeIDE
│   │
│   └── stm32-cube-ide
│       ├── BSP
│       │   └── Header and source files
│       ├── 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)
│       │   └── Files generated by STM32CubeIDE
│       └── Project configuration files generated by STM32CubeIDE
│
└── tests
    ├── CMakeLists.txt
    ├── header-overrides
    │   ├── core_cm4_override.h
    │   ├── main_override.h
    │   ├── stm32f446xx_override.h
    │   └── stm32f4xx_hal_gpio_override.h
    ├── integration
    │   └── hello_integration_test.cpp
    ├── mock
    │   ├── assert_mock.c
    │   ├── gpio_mock.cpp
    │   ├── gpio_mock.h
    │   ├── hal_gpio_mock.cpp
    │   └── hal_gpio_mock.h
    └── unit
        ├── drivers
        │   └── gpio_test.cpp
        ├── hello_unit_test.cpp
        └── middleware
            └── led_test.cpp
```

## Building tests project via CMake

Clone this repo for your local machine

```console
git clone https://github.com/CharlesDias/stm32_gtest_c_code.git
```

Access the project folder **stm32_gtest_c_code**

```console
cd stm32_gtest_c_code
```

Pull the latest docker image used to build the project.

```console
docker pull charlesdias/stm32_gtest
```

Run the image docker.

```console
docker run --rm -it -v $(pwd):/home/project -w /home/project charlesdias/stm32_gtest
```

Run the command below inside the Docker container

```console
make clean && make build && make test
```

Access the `build/coverage/index.html` file to see the coverage report.

### Dependency graph

To generate the dependency graph, build the test project as previously described and run the command below:

```console
make dependency
```

Check the file build/graph_image.png.

Dependency graph for test project.

![Dependency graph](https://raw.githubusercontent.com/CharlesDias/stm32_gtest_c_code/main/docs/images/dependency_graph.png "Dependency graph")

The graph_image.png file will be generated inside the build folder.

## Building application project via STM32CubeIDE

Clone this repo for your local machine

```console
git clone https://github.com/CharlesDias/stm32_gtest_c_code.git
```

Open the STM32CubeIDE and import this project.

Build and load the firmware on NUCLEO-F446ZE board. See the expected output.

![STM32 project](https://raw.githubusercontent.com/CharlesDias/stm32_gtest_c_code/main/docs/images/stm32_gtest.gif "STM32 project")

## Improvement suggestions

* 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.

stm32_gtest_c_code

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README