ci: enable bugprone-* warnings in clang-tidy

[veqcc]

Description

This PR enables bugprone prefix warnings in clang-tidy-ci.

By specifying bugprone-*, first, all the bugprone prefix warnings are enabled.
After that, the warnings which the current Autoware.universe has are disabled by using - prefix.

The enabled checks are the following.
The current Autoware.universe is free of these warnings.

    bugprone-argument-comment
    bugprone-assert-side-effect
    bugprone-bad-signal-to-kill-thread
    bugprone-bool-pointer-implicit-conversion
    bugprone-copy-constructor-init
    bugprone-dangling-handle
    bugprone-dynamic-static-initializers
    bugprone-fold-init-type
    bugprone-forward-declaration-namespace
    bugprone-forwarding-reference-overload
    bugprone-inaccurate-erase
    bugprone-incorrect-roundings
    bugprone-lambda-function-name
    bugprone-macro-repeated-side-effects
    bugprone-misplaced-operator-in-strlen-in-alloc
    bugprone-misplaced-pointer-arithmetic-in-alloc
    bugprone-misplaced-widening-cast
    bugprone-move-forwarding-reference
    bugprone-multiple-statement-macro
    bugprone-no-escape
    bugprone-not-null-terminated-result
    bugprone-posix-return
    bugprone-redundant-branch-condition
    bugprone-signal-handler
    bugprone-sizeof-container
    bugprone-sizeof-expression
    bugprone-spuriously-wake-up-functions
    bugprone-string-constructor
    bugprone-string-integer-assignment
    bugprone-string-literal-with-embedded-nul
    bugprone-stringview-nullptr
    bugprone-suspicious-enum-usage
    bugprone-suspicious-include
    bugprone-suspicious-memory-comparison
    bugprone-suspicious-memset-usage
    bugprone-suspicious-missing-comma
    bugprone-suspicious-semicolon
    bugprone-suspicious-string-compare
    bugprone-swapped-arguments
    bugprone-terminating-continue
    bugprone-throw-keyword-missing
    bugprone-too-small-loop-variable
    bugprone-undefined-memory-manipulation
    bugprone-undelegated-constructor
    bugprone-unhandled-exception-at-new
    bugprone-unhandled-self-assignment
    bugprone-unused-raii
    bugprone-unused-return-value
    bugprone-use-after-move
    bugprone-virtual-near-miss

How was this PR tested?

I locally tested that this configuration works fine and the current Autoware.universe has no errors/warnings with it.

Notes for reviewers

The number of warnings for each check are:

-bugprone-branch-clone, 31
-bugprone-easily-swappable-parameters, too many
-bugprone-exception-escape, 13
-bugprone-implicit-widening-of-multiplication-result, too many
-bugprone-integer-division, 16
-bugprone-macro-parentheses, 1
-bugprone-narrowing-conversions, too many
-bugprone-parent-virtual-call, 1
-bugprone-reserved-identifier, 10
-bugprone-signed-char-misuse" 2

And bugprone-infinite-loop is suppressed because it takes too long time to run checkings.

Effects on system behavior

[github-actions]

Thank you for contributing to the Autoware project!

🚧 If your pull request is in progress, switch it to draft mode.

Please ensure:

• You've checked our contribution guidelines.
• Your PR follows our pull request guidelines.
• All required CI checks pass before marking the PR ready for review.

[xmfcx]

Could you provide the exact steps for me to replicate and test this PR on my local machine?

(you can skip the git checkout parts)

[veqcc]

@xmfcx

Could you provide the exact steps for me to replicate and test this PR on my local machine?

Sure!!
With the following steps, you can check Autoware has no error for the enabled checks.

1. copy .clang-tidy-ci to .clang-tidy

Checks: "
  -*,
  bugprone-*,
  -bugprone-branch-clone,
  -bugprone-easily-swappable-parameters,
  -bugprone-exception-escape,
  -bugprone-implicit-widening-of-multiplication-result,
  -bugprone-integer-division,
  -bugprone-macro-parentheses,
  -bugprone-narrowing-conversions,
  -bugprone-parent-virtual-call,
  -bugprone-reserved-identifier,
  -bugprone-signed-char-misuse"

WarningsAsErrors: "*"

ExtraArgs:
  - -std=c++17
  - -Wno-c11-extensions

2. build autoware with compile_commands.json

$ colcon build --symlink-install --cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -DCMAKE_BUILD_TYPE=Release

3. set environment variable

$ export FILES=($(find src/universe/autoware.universe/ -name '*.cpp' -not -path '*/test/*' -not -path '*/examples/*'))

4. run clang-tidy ( .clang-tidy will automatically loaded )

$ run-clang-tidy -j $(nproc) -p build/ "${FILES[@]}"

As I have written in Notes, this command takes much long time (some hours in my env)...

[xmfcx]

@veqcc -san I will test this today, sorry for being late.

[xmfcx]

Hello @veqcc -san, thank you for providing the steps.

Only difference is I build with colcon build --symlink-install --event-handlers=console_cohesion+ --cmake-args -DCMAKE_BUILD_TYPE=RelWithDebInfo -DCMAKE_EXPORT_COMPILE_COMMANDS=1

I followed them but got all these errors: https://gist.github.com/xmfcx/9c51facc1147f0ea9734bd1b91a02db2

Am I missing something?

I've also checked https://github.com/autowarefoundation/autoware-github-actions/blob/main/clang-tidy/action.yaml and couldn't figure out what might me missing.

I am on Ubuntu 22.04 and installed sudo apt install clang-tidy libomp-dev.

My .bashrc has:

# Ccache
export CC="/usr/lib/ccache/gcc"
export CXX="/usr/lib/ccache/g++"
export CCACHE_DIR="$HOME/.cache/ccache/"

I wonder if this might have caused it 🤔

[veqcc]

@xmfcx

Somehow, clang-tidy seems not recognizing C++ headers 🥹
Could you try adding extra args?

  - -I/usr/include/c++/11
  - -I/usr/include/x86_64-linux-gnu/c++/11

So the .clang-tidy file looks like

Checks: "
  -*,
  bugprone-*,
  -bugprone-branch-clone,
  -bugprone-easily-swappable-parameters,
  -bugprone-exception-escape,
  -bugprone-implicit-widening-of-multiplication-result,
  -bugprone-integer-division,
  -bugprone-macro-parentheses,
  -bugprone-narrowing-conversions,
  -bugprone-parent-virtual-call,
  -bugprone-reserved-identifier,
  -bugprone-signed-char-misuse"

WarningsAsErrors: "*"

ExtraArgs:
  - -std=c++17
  - -Wno-c11-extensions
  - -I/usr/include/c++/11
  - -I/usr/include/x86_64-linux-gnu/c++/11

[veqcc]

@xmfcx
I additionally suppressed bugprone-infinite-loop check, because I found it takes so much time to run.
Without it, run-clang-tidy for all packages in Autoware.universe completes within 30 minutes in my local env.

[xmfcx]

In the latest main of current time, this has passed with the following mods:

My .clang-tidy file:

Checks: "
  -*,
  bugprone-*,
  -bugprone-branch-clone,
  -bugprone-easily-swappable-parameters,
  -bugprone-exception-escape,
  -bugprone-implicit-widening-of-multiplication-result,
  -bugprone-infinite-loop,
  -bugprone-integer-division,
  -bugprone-macro-parentheses,
  -bugprone-narrowing-conversions,
  -bugprone-parent-virtual-call,
  -bugprone-reserved-identifier,
  -bugprone-signed-char-misuse"

WarningsAsErrors: "*"

ExtraArgs:
  - -std=c++17
  - -Wno-c11-extensions
  - -I/usr/include/c++/11
  - -I/usr/include/x86_64-linux-gnu/c++/11

 # I have these in my .bashrc
export CC="/usr/lib/ccache/gcc"
export CXX="/usr/lib/ccache/g++"
export CCACHE_DIR="$HOME/.cache/ccache/"
export CMAKE_EXPORT_COMPILE_COMMANDS=1

# Install stuff
sudo apt update
sudo apt install clang-tidy libomp-dev

# Commands
colcon build --symlink-install --event-handlers=console_cohesion+ --cmake-args -DCMAKE_BUILD_TYPE=RelWithDebInfo

export FILES=($(find src/universe/autoware.universe/ -name '*.cpp' -not -path '*/test/*' -not -path '*/examples/*'))

run-clang-tidy -j $(nproc) -p build/ "${FILES[@]}"

To measure the time it took, I ran it with:

time run-clang-tidy -j $(nproc) -p build/ "${FILES[@]}"

And it took about 11mins. (I was using a 5900x 12c24t cpu)

real	10m53,005s
user	238m6,803s
sys  	10m53,759s

Results(no errors): https://gist.github.com/xmfcx/0733a689acdf7cfb4479a4e118b5bfdd 🎊