Configure ci clang tidy report by filipe-cuim · Pull Request #338 · eclipse-openbsw/openbsw

filipe-cuim · 2025-12-30T14:46:51Z

Description

The goal of this PR is to configure a .clang-tidy that respects openbsw coding conventions, and a ci job that runs clang-tidy checks on all compilation units that are generated in compile_commands.json.

In this first step we start with fewer clang-tidy checks enabled, because currently with all checks enabled the repository has around 3924 findings (excluding all files in test, 3rdparty and mock) and around 23386 findings (when excluding only 3rdparty folder).

Each clang-tidy CI workflow will print a report of all findings for each checker in stdout. After that it will also upload an artifact with a yaml file generated by clang-tidy, which will contain the location (both file name and file offset) of all findings.

There may also exist some checkers that we do not want to activate, and as such it's better to do small PRs after this one, where only few checkers are considered, in order to limit the amount of changes in the repository.

filipe-cuim · 2026-01-06T11:13:14Z

Hello @rolandreichweinbmw @christian-schilling @hbragge-acn @johannes-esr let's maybe move the discussion here. In this PR I followed the suggestion of doing a full report of clang-tidy findings, instead of just checking a diff.

I tried to fix some of the warnings, but I didn't do it for all of them. There is a commit that addresses only one of the checkers.

I also focused on the posix build, and as such you will find in the s32k1xx build some warnings that supposedly were cleaned up in some of the commits.

There is also some clang-diagnostic-error which I'm not yet sure how to solve. These happen because clang-tidy looks to each compilation unit that is written in the compile_commands.json, and apparently some of these have invalid targets for unit test builds, and because of this CMake ignores those targets, and as such the compile commands becomes incomplete.
Usually these are libraries that depend on something from platforms which is not included in the unit test build, while their unit tests have the correct dependencies (which are different than the dependencies present in the library). An example is the CMake of bspOutputManager which depends on bspIo, while its unit tests depend on utbspIo.
Not sure if I should change the name of the targets to be the same for all (both target and unit test), or if I should change the CMakes somehow so that the compile_commands.json doesn't generate an entry for each library (and instead just for each executable for example).

Let me know what you think. Also, the checkers that I introduced came from a previous project, so I'm not really enforcing them. We may remove the ones you don't want to have.

.github/workflows/clang-tidy.yml

libs/bsp/bspOutputManager/src/outputManager/Output.cpp

libs/bsp/bspInputManager/src/inputManager/DigitalInput.cpp

libs/bsp/bspOutputManager/src/outputManager/Output.cpp

doc/dev/guidelines/practices.rst

.ci/clang-tidy.py

rolandreichweinbmw

Only put a few remarks.

Also: Are the included "Fix" commits directly related to clang-tidy findings? E.g. directly enabling a clean acceptable baseline? Otherwise, "unrelated" changes could be separated out to a cleanup PR.

libs/bsp/bspOutputManager/src/outputManager/Output.cpp

filipe-cuim · 2026-01-20T11:09:12Z

Only put a few remarks.

Also: Are the included "Fix" commits directly related to clang-tidy findings? E.g. directly enabling a clean acceptable baseline? Otherwise, "unrelated" changes could be separated out to a cleanup PR.

Theoretically yes, each commit is respective to one clang-tidy finding. So, in principle, if I remove one commit the PR should remain clean, or at least not needed many rebase changes

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

simon-d-bmw

@filipe-cuim there are still 7 clang-diagnostic-errors remaining.

simon-d-bmw · 2026-01-29T09:28:28Z

doc/dev/guidelines/practices.rst

+
+Additionally, most of these practices are enforced by clang-tidy which is run as part of our CI pipeline.
+The clang-tidy configuration can be found in the file ``.clang-tidy`` in the root directory of openbsw repository.
+The ci script for running clang-tidy is located in ``.ci/clang-tidy.py``, which runs an llvm helper tool called


nit:

Suggested change

The ci script for running clang-tidy is located in ``.ci/clang-tidy.py``, which runs an llvm helper tool called

The CI script for running clang-tidy is located in ``.ci/clang-tidy.py``, which runs an llvm helper tool called

simon-d-bmw · 2026-02-02T21:04:49Z

.ci/clang-tidy.py

+    parser.add_argument(
+        "--build_directory",
+        type=Path,
+        help="Path to the build directory containing compile_commands.json generated by CMake",
+    )


nit:

Suggested change

parser.add_argument(

"--build_directory",

type=Path,

help="Path to the build directory containing compile_commands.json generated by CMake",

)

parser.add_argument(

"--build_directory",

type=Path,

help="Path to the build directory containing compile_commands.json generated by CMake",

required=True

)

simon-d-bmw · 2026-02-02T21:09:34Z

.ci/clang-tidy.py

+    parser.add_argument(
+        "--output_file",
+        type=str,
+        help="Path to the output YAML file where clang-tidy findings will be stored",


nit:

Suggested change

help="Path to the output YAML file where clang-tidy findings will be stored",

help="Path to the output YAML file where clang-tidy findings will be stored",

required=True

simon-d-bmw · 2026-02-02T21:20:18Z

.github/workflows/clang-tidy.yml

+          python3 .ci/clang-tidy.py --build_directory=build/tests/${{ matrix.platform }}/${{ matrix.config }} --output_file=ct-findings.yaml --exclude="3rdparty" --ignore-checks="clang-diagnostic-error"
+
+      - name: Upload clang-tidy findings
+        if: always()


nit: can't we skip this upload if the output file doesn't exist?

matthiaskessler · 2026-02-10T14:35:38Z

platforms/s32k1xx/bsp/canflex2Transceiver/src/can/transceiver/canflex2/CanFlex2Transceiver.cpp

 {
    // 64 = 8 byte payload
    // 53 = CAN overhead
+    // NOLINTNEXTLINE(clang-analyzer-core.DivideZero): CAN Baudrate can never be zero here.


@filipe-cuim , just a quick question: Have you ever experimented with __builtin_assume()? I know this might introduce portability issues, but I was generally curious if the could work in such cases.

matthiaskessler · 2026-02-10T14:37:25Z

Interesting...I was actually trying to review and approve commit by commit but that doesn't seem to work...

matthiaskessler · 2026-02-10T14:42:59Z

libs/bsw/runtime/test/src/StatisticsContainerTest.cpp

 using namespace ::runtime;
 using namespace ::estd::test;

+// NOLINTBEGIN(cert-oop54-cpp): This is intentional for testing purposes.


Same here, if it's an alias, we should only check for one rule.

matthiaskessler · 2026-02-10T14:43:23Z

libs/bsw/runtime/test/src/SharedStatisticsContainerTest.cpp

 using namespace ::runtime;
 using namespace ::estd::test;

+// NOLINTBEGIN(cert-oop54-cpp): This is intentional for testing purposes.


According to here the two rules are aliased. If that's the case, we should only have suppressions for one.

matthiaskessler · 2026-02-10T14:46:12Z

libs/bsp/bspCharInputOutput/src/charInputOutput/bspIo.cpp

 // NOLINTBEGIN(bugprone-reserved-identifier): Explanation for this suppression is below
 /**
 * \par Linking this module
 * The diab compiler is providing these methods for char in-/output. They will


I think, we need to review this since we are using gcc and clang.

matthiaskessler · 2026-02-10T14:58:45Z

libs/bsp/bspCharInputOutput/src/charInputOutput/bspIo.cpp

 {
 #endif

+// NOLINTBEGIN(cert-dcl51-cpp): Explanation for this suppression is below


According to here
these rules are aliases. I don't think we should suppress each of them but decide to use only one rule.

matthiaskessler · 2026-02-10T16:22:31Z

libs/bsw/uds/include/uds/base/AbstractDiagJob.h

    }

 #ifdef UNIT_TEST
+    static void unsetDiagSession() { sfpSessionManager = nullptr; }


nit: I'd call it unsetDiagSessionManager() to have a clear distiction between session manager and the actual session.

filipe-cuim marked this pull request as draft December 30, 2025 14:51

filipe-cuim force-pushed the ConfigureCIClangTidyReport branch 5 times, most recently from d256dec to 18cf424 Compare January 5, 2026 11:18

simon-d-bmw reviewed Jan 7, 2026

View reviewed changes

.ci/clang-tidy.py Outdated Show resolved Hide resolved

.ci/clang-tidy.py Outdated Show resolved Hide resolved

.ci/clang-tidy.py Outdated Show resolved Hide resolved

rolandreichweinbmw reviewed Jan 19, 2026

View reviewed changes

libs/bsp/bspOutputManager/src/outputManager/Output.cpp Outdated Show resolved Hide resolved

libs/bsp/bspOutputManager/src/outputManager/Output.cpp Outdated Show resolved Hide resolved

filipe-cuim force-pushed the ConfigureCIClangTidyReport branch 2 times, most recently from d829127 to 7d9d4f7 Compare January 20, 2026 11:10

filipe-cuim marked this pull request as ready for review January 20, 2026 11:10

filipe-cuim force-pushed the ConfigureCIClangTidyReport branch 4 times, most recently from b816b37 to 385b457 Compare January 26, 2026 17:02

filipe-cuim force-pushed the ConfigureCIClangTidyReport branch 4 times, most recently from 27cb498 to 3d404e2 Compare January 27, 2026 19:49

filipe-cuim added 8 commits January 28, 2026 17:38

Create clang-tidy report in CI

2646e4b

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix llvm-namespace-comment

6d28326

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix bugprone-too-small-loop-variable

244baea

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix clang-analyzer-deadcode.DeadStores

88abe96

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix clang-analyzer-core.NonNullParamChecker

ec30f62

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix bugprone-implicit-widening-of-multiplication-result

1488f1d

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix bugprone-reserved-identifier

902f706

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix bugprone-branch-clone

67238c5

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

filipe-cuim and others added 19 commits January 28, 2026 17:38

Update requirements.txt

904ba21

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Address comments

80f463e

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix clang-analyzer-core.NullDereference

0d0171f

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix clang-analyzer-security.insecureAPI.strcpy

d436606

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix clang-analyzer-core.CallAndMessage

c993114

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix clang-diagnostic-error related to bspIo

eb5f9d0

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Suppress bugprone-unhandled-self-assignment

5098ac8

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Suppress bugprone-exception-escape

7bd88c2

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Suppress bugprone-unhandled-self-assignment

561923b

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix cert-err58-cpp

58a2ae3

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Suppress cert-dcl50-cpp

425bb38

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Suppress cert-dcl37-c

43f5f1a

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Suppress cert-dcl51-cpp

05b7394

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix cert-err33-c

d43d313

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix cert-dcl51-cpp

ce1bb67

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Suppress cert-msc30-c and others related

e0f4a00

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Fix .clang-tidy config error

5ed683f

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Suppress clang-analyzer-core.DivideZero

b52ac0d

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

Ignore clang-diagnostic-error for now at script level

19193f1

Signed-off-by: Filipe Cuim <filipe.cuim@ctw.bmwgroup.com>

filipe-cuim force-pushed the ConfigureCIClangTidyReport branch from 3d404e2 to 19193f1 Compare January 28, 2026 17:42

rolandreichweinbmw requested review from aschaal and christian-schilling January 29, 2026 09:38

rolandreichweinbmw approved these changes Jan 29, 2026

View reviewed changes

simon-d-bmw reviewed Feb 2, 2026

View reviewed changes

simon-d-bmw approved these changes Feb 10, 2026

View reviewed changes

matthiaskessler reviewed Feb 10, 2026

View reviewed changes

matthiaskessler approved these changes Feb 10, 2026

View reviewed changes

matthiaskessler reviewed Feb 10, 2026

View reviewed changes

	The ci script for running clang-tidy is located in ``.ci/clang-tidy.py``, which runs an llvm helper tool called
	The CI script for running clang-tidy is located in ``.ci/clang-tidy.py``, which runs an llvm helper tool called

	help="Path to the output YAML file where clang-tidy findings will be stored",
	help="Path to the output YAML file where clang-tidy findings will be stored",
	required=True

Conversation

filipe-cuim commented Dec 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Uh oh!

filipe-cuim commented Jan 6, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rolandreichweinbmw left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

filipe-cuim commented Jan 20, 2026

Uh oh!

simon-d-bmw left a comment

Choose a reason for hiding this comment

Uh oh!

simon-d-bmw Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

simon-d-bmw Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

simon-d-bmw Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

simon-d-bmw Feb 2, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matthiaskessler Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

matthiaskessler commented Feb 10, 2026

Uh oh!

matthiaskessler Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

matthiaskessler Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

matthiaskessler Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

matthiaskessler Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

matthiaskessler Feb 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

filipe-cuim commented Dec 30, 2025 •

edited

Loading

simon-d-bmw Jan 29, 2026 •

edited

Loading

simon-d-bmw Feb 2, 2026 •

edited

Loading

simon-d-bmw Feb 2, 2026 •

edited

Loading

simon-d-bmw Feb 2, 2026 •

edited

Loading