Upload clang-tidy report only if findings are found

Create an id for the clang-tidy step and use its outcome to decide if uploading the clang-tidy report is necessary.
Added some options of the clang-tidy script as required.
Changed a name of a method used in the unit tests of uds.
Fixed typo on practices.rst

Author: filipe-cuim

.ci/clang-tidy.py

@@ -41,12 +41,14 @@ def parse_arguments():
         "--build_directory",
         type=Path,
         help="Path to the build directory containing compile_commands.json generated by CMake",
+        required=True,
     )
 
     parser.add_argument(
         "--output_file",
         type=str,
         help="Path to the output YAML file where clang-tidy findings will be stored",
+        required=True,
     )
 
     parser.add_argument(

.github/workflows/clang-tidy.yml

@@ -40,13 +40,15 @@ jobs:
         run: >-
           DOCKER_UID=$(id -u) DOCKER_GID=$(id -g) DOCKER_HISTORY=/dev/null docker compose run --rm development
           python3 .ci/build.py --preset ${{ matrix.preset }} --platform "linux" --cxxid "clang" --cxxstd "14" --config "${{ matrix.config }}"
+
       - name: Run the clang-tidy.py inside the docker container
+        id: clang-tidy
         run: >-
           DOCKER_UID=$(id -u) DOCKER_GID=$(id -g) DOCKER_HISTORY=/dev/null docker compose run --rm development
           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()
+        if: ${{ steps.clang_tidy.outcome == 'failure' }}
         uses: actions/upload-artifact@v4
         with:
           name: ct-findings-${{ matrix.platform }}-${{ matrix.config }}

doc/dev/guidelines/practices.rst

@@ -12,7 +12,7 @@ Clang-tidy
 
 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
+The CI script for running clang-tidy is located in ``.ci/clang-tidy.py``, which runs an llvm helper tool called
 ``run-clang-tidy`` which checks all compilation units specified in a compile_commands.json file, which is generated by
 current CMake configurations.
 In case you want to run the llvm helper tool ``run-clang-tidy`` locally, you can use the dev container in the root

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

@@ -159,7 +159,7 @@ class AbstractDiagJob : public ::etl::uncopyable
     }
 
 #ifdef UNIT_TEST
-    static void unsetDiagSession() { sfpSessionManager = nullptr; }
+    static void unsetDiagSessionManager() { sfpSessionManager = nullptr; }
 
     virtual ~AbstractDiagJob() {}
 #endif

libs/bsw/uds/test/src/uds/base/AbstractDiagJobTest.cpp

@@ -287,15 +287,15 @@ TEST_F(
     AbstractDiagJobTest,
     getDiagSessionManager_calls_an_exception_if_a_sessionManager_does_not_exist)
 {
-    AbstractDiagJob::unsetDiagSession();
+    AbstractDiagJob::unsetDiagSessionManager();
     ASSERT_THROW(fTestableDiagJob.getDiagSessionManager(), ::etl::exception);
 }
 
 TEST_F(
     AbstractDiagJobTest,
     const_getDiagSessionManager_calls_an_exception_if_a_sessionManager_does_not_exist)
 {
-    AbstractDiagJob::unsetDiagSession();
+    AbstractDiagJob::unsetDiagSessionManager();
     TestableDiagJob const diagJob(IMPLEMENTED_REQUEST, sizeof(IMPLEMENTED_REQUEST), 0U, 0U, 1U);
 
     ASSERT_THROW(diagJob.getDiagSessionManager(), ::etl::exception);