Merge pull request Zuehlke#19 from StephanKa/feature/add-example-for-static-analysis

Added example for static analysis

Author: StephanKa

.github/workflows/build_cmake.yml

@@ -81,3 +81,60 @@ jobs:
     - name: Test
       shell: bash
       run: ctest --preset test-unixlike-${{ matrix.compiler.preset }}-${{ matrix.buildtype }}
+
+  linux-static_analysis:
+    name: Static Analysis, ${{ matrix.os }}, ${{ matrix.compiler.name }}, ${{ matrix.buildtype }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false  # 'false' means Don't stop matrix workflows even if some matrix entry fails.
+      matrix:
+        os: [ubuntu-22.04]
+        buildtype: [debug]
+        compiler: [{name: 'Clang 15', preset: clang-15, pkgs: 'clang-15 llvm-15 llvm-15-dev libclang-15-dev', iwyu_branch: 'clang_15', path_prefix: "/usr/lib/llvm-15"}]
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Cache
+      uses: actions/cache@v3
+      env:
+        cache-name: cache-conan-modules
+      with:
+        path: |
+          ${{ env.CONAN_USER_HOME }}
+          ~/.cache/pip
+        key: ${{ runner.os }}-${{ env.BUILD_TYPE }}-${{ hashFiles('CMakeLists.txt') }}-${{ hashFiles('cmake/Conan.cmake') }}
+
+    - name: Install conan
+      shell: bash
+      run: |
+        python3 -m pip install --upgrade pip setuptools conan==1.59
+        source ~/.profile
+
+    - name: Install dependencies
+      run:   |
+             sudo bash -c "$(wget -O - https://apt.llvm.org/llvm.sh)"
+             sudo apt update
+             sudo apt install ninja-build ${{ matrix.compiler.pkgs }} cppcheck
+      shell: bash
+
+    - name: Compile and install IWYU
+      run:   |
+             mkdir iwyu && cd iwyu
+             git clone https://github.com/include-what-you-use/include-what-you-use.git
+             cd include-what-you-use
+             git checkout ${{ matrix.compiler.iwyu_branch }}
+             cd ..
+             mkdir build && cd build
+             cmake -G "Ninja" -DCMAKE_PREFIX_PATH=${{ matrix.compiler.path_prefix }} ../include-what-you-use
+             ninja
+             sudo ninja install
+      shell: bash
+
+    - name: Configure via CMake
+      shell: bash
+      run: cmake --preset unixlike-${{ matrix.compiler.preset }}-${{ matrix.buildtype }}-static-analysis
+
+    - name: Build
+      shell: bash
+      run:  cmake --build --preset build-unixlike-${{ matrix.compiler.preset }}-${{ matrix.buildtype }}-static-analysis

CMakePresets.json

@@ -304,6 +304,20 @@
         "CMAKE_CXX_COMPILER": "g++.exe",
         "CMAKE_BUILD_TYPE": "Release"
       }
+    },
+    {
+      "name": "unixlike-clang-15-debug-static-analysis",
+      "displayName": "Clang 15 Debug - Static Analysis",
+      "description": "Target Unix-like OS with the Clang 15 compiler, debug build type",
+      "inherits": "unixlike-clang-15-debug",
+      "cacheVariables": {
+        "CMAKE_C_COMPILER": "clang-15",
+        "CMAKE_CXX_COMPILER": "clang++-15",
+        "CMAKE_BUILD_TYPE": "Debug",
+        "ENABLE_CPPCHECK": "ON",
+        "ENABLE_CLANG_TIDY": "ON",
+        "ENABLE_INCLUDE_WHAT_YOU_USE": "ON"
+      }
     }
   ],
   "buildPresets": [
@@ -386,6 +400,10 @@
     {
       "name": "build-win32-gcc-x64-mingw-release",
       "configurePreset": "win32-gcc-x64-mingw-release"
+    },
+    {
+      "name": "build-unixlike-clang-15-debug-static-analysis",
+      "configurePreset": "unixlike-clang-15-debug-static-analysis"
     }
   ],
   "testPresets": [

azure.yml

@@ -5,17 +5,19 @@
 FROM ubuntu:22.10 as cpp-docker-common
 
 ARG DEBIAN_FRONTEND=noninteractive
+ARG CLANG_COMPILER_VERSION=15
+ARG CMAKE_VERSION=3.26.3
 ENV PATH="${PATH}:/cmake-3.26.3-linux-x86_64/bin/:"
 
 RUN apt-get update && apt-get -y dist-upgrade && apt-get -y install --fix-missing \
-  apturl \
   binutils \
   build-essential \
   bzip2 \
   cppcheck \
   ccache \
   doxygen \
   graphviz \
+  git \
   lsb-release \
   ninja-build \
   python3 \
@@ -27,13 +29,23 @@ RUN apt-get update && apt-get -y dist-upgrade && apt-get -y install --fix-missin
   tar \
   valgrind \
   wget
-RUN wget https://github.com/Kitware/CMake/releases/download/v3.26.3/cmake-3.26.3-linux-x86_64.sh  \
-    && chmod +x cmake-3.26.3-linux-x86_64.sh  \
-    && ./cmake-3.26.3-linux-x86_64.sh --include-subdir --skip-license \
-    && rm cmake-3.26.3-linux-x86_64.sh
+
+RUN wget https://github.com/Kitware/CMake/releases/download/v${CMAKE_VERSION}/cmake-${CMAKE_VERSION}-linux-x86_64.sh  \
+    && chmod +x cmake-${CMAKE_VERSION}-linux-x86_64.sh  \
+    && ./cmake-${CMAKE_VERSION}-linux-x86_64.sh --include-subdir --skip-license \
+    && rm cmake-${CMAKE_VERSION}-linux-x86_64.sh
 RUN bash -c "$(wget -O - https://apt.llvm.org/llvm.sh)"
-RUN apt-get -y install clang-format clang-tidy clang-15
-RUN apt-get autoremove -y && apt-get clean
+
+RUN apt-get -y install --fix-missing clang-format clang-tidy clang-${CLANG_COMPILER_VERSION} llvm-${CLANG_COMPILER_VERSION} llvm-${CLANG_COMPILER_VERSION}-dev libclang-${CLANG_COMPILER_VERSION}-dev \
+    && apt-get autoremove -y && apt-get clean
+
+RUN mkdir iwyu && cd iwyu \
+    && git clone --branch clang_${CLANG_COMPILER_VERSION} https://github.com/include-what-you-use/include-what-you-use.git \
+    && mkdir build && cd build \
+    && cmake -G "Ninja" -DCMAKE_PREFIX_PATH=/usr/lib/llvm-${CLANG_COMPILER_VERSION} ../include-what-you-use \
+    && sudo ninja install \
+    && cd ../.. \
+    && rm -rf iwyu
 
 
 # =================================

docker/Dockerfile

@@ -2,4 +2,5 @@
 
 DOCKER_BUILDKIT=1 docker -l debug build \
     --target cpp-docker-ci \
+    --build-arg CI_USER=ci \
     -t cpp_ci_env:latest .