[build] added conan

.github/workflows/ci.yml

@@ -1,73 +1,226 @@
-name: CI
+name: Continuous Integration
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+    - master
+
+  pull_request:
+    branches:
+    - master
 
 jobs:
-  test:
+  lint:
     runs-on: ubuntu-22.04
 
     steps:
-      - name: Checkout source
-        uses: actions/checkout@v4
-
-      - name: Install dependencies
-        run: |
-          sudo apt-get update -q
-          sudo apt-get install clang-tidy-14 cppcheck doxygen -y -q
-          sudo update-alternatives --install /usr/bin/clang-tidy clang-tidy /usr/bin/clang-tidy-14 140
-
-      - name: Download utest.h
-        run: |
-          mkdir -p test/source
-          curl -o test/source/utest.h https://raw.githubusercontent.com/sheredom/utest.h/master/utest.h
-
-      - name: Build and Install Headers
-        run: |
-          mkdir -p build
-          cd build
-          cmake ..
-          cmake --build . --config Release
-          sudo cmake --install . --prefix /usr/local
-          cd ..
-
-      - name: Build tests
-        run: |
-          cd test
-          mkdir -p build
-          cd build/
-          cmake ..
-          cd ..
-          cmake --build build --config Release
-
-      - name: Run Tests
-        run: |
-          cd test/build/
-          ctest --output-on-failure -j 2
-          
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v5
+      with: { python-version: "3.12" }
+
+    - name: Install codespell
+      run: pip3 install codespell
+
+    - name: Lint
+      run: cmake -D FORMAT_COMMAND=clang-format-14 -P cmake/lint.cmake
+
+    - name: Spell check
+      if: always()
+      run: cmake -P cmake/spell.cmake
+
+  coverage:
+    needs: [lint]
+
+    runs-on: ubuntu-22.04
+
+    # To enable coverage, delete the last line from the conditional below and
+    # edit the "<name>" placeholder to your GitHub name.
+    # If you do not wish to use codecov, then simply delete this job from the
+    # workflow.
+    if: github.repository_owner == '<name>'
+      && false
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install LCov
+      run: sudo apt-get update -q
+        && sudo apt-get install lcov -q -y
+
+    - name: Install Python
+      uses: actions/setup-python@v5
+      with: { python-version: "3.12" }
+
+    - name: Conan cache
+      uses: actions/cache@v4
+      with:
+        path: conan_cache_save.tgz
+        key: conan-coverage-${{ hashFiles('conan*.[pl][yo]*') }}
+
+    - name: Install dependencies
+      run: bash < .github/scripts/conan-ci-setup.sh
+
+    - name: Configure
+      run: cmake --preset=ci-coverage
+
+    - name: Build
+      run: cmake --build build/coverage -j 2
+
+    - name: Test
+      working-directory: build/coverage
+      run: ctest --output-on-failure --no-tests=error -j 2
+
+    - name: Process coverage info
+      run: cmake --build build/coverage -t coverage
+
+    - name: Submit to codecov.io
+      uses: codecov/codecov-action@v4
+      with:
+        file: build/coverage/coverage.info
+        token: ${{ secrets.CODECOV_TOKEN }}
+
+  sanitize:
+    needs: [lint]
+
+    runs-on: ubuntu-22.04
+
+    env: { CC: clang-14, CXX: clang++-14 }
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install Python
+      uses: actions/setup-python@v5
+      with: { python-version: "3.12" }
+
+    - name: Conan cache
+      uses: actions/cache@v4
+      with:
+        path: conan_cache_save.tgz
+        key: conan-sanitize-${{ hashFiles('conan*.[pl][yo]*') }}
+
+    - name: Install dependencies
+      run: bash < .github/scripts/conan-ci-setup.sh
+
+    - name: Configure
+      run: cmake --preset=ci-sanitize
+
+    - name: Build
+      run: cmake --build build/sanitize -j 2
+
+    - name: Test
+      working-directory: build/sanitize
+      env:
+        ASAN_OPTIONS: "strict_string_checks=1:\
+          detect_stack_use_after_return=1:\
+          check_initialization_order=1:\
+          strict_init_order=1:\
+          detect_leaks=1:\
+          halt_on_error=1"
+        UBSAN_OPTIONS: "print_stacktrace=1:\
+          halt_on_error=1"
+      run: ctest --output-on-failure --no-tests=error -j 2
+
+  test:
+    needs: [lint]
+
+    strategy:
+      matrix:
+        os: [macos-14, ubuntu-22.04, windows-2022]
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install static analyzers
+      if: matrix.os == 'ubuntu-22.04'
+      run: >-
+        sudo apt-get install clang-tidy-14 cppcheck -y -q
+
+        sudo update-alternatives --install
+        /usr/bin/clang-tidy clang-tidy
+        /usr/bin/clang-tidy-14 140
+
+    - name: Install Python
+      uses: actions/setup-python@v5
+      with: { python-version: "3.12" }
+
+    - name: Conan cache
+      uses: actions/cache@v4
+      with:
+        path: conan_cache_save.tgz
+        key: conan-${{ matrix.os }}-${{ hashFiles('conan*.[pl][yo]*') }}
+
+    - name: Install dependencies
+      shell: bash
+      run: bash < .github/scripts/conan-ci-setup.sh
+
+    - name: Setup MultiToolTask
+      if: matrix.os == 'windows-2022'
+      run: |
+        Add-Content "$env:GITHUB_ENV" 'UseMultiToolTask=true'
+        Add-Content "$env:GITHUB_ENV" 'EnforceProcessCountAcrossBuilds=true'
+
+    - name: Configure
+      shell: pwsh
+      run: cmake "--preset=ci-$("${{ matrix.os }}".split("-")[0])"
+
+    - name: Build
+      run: cmake --build build --config Release -j 2
+
+    - name: Install
+      run: cmake --install build --config Release --prefix prefix
+
+    - name: Test
+      working-directory: build
+      run: ctest --output-on-failure --no-tests=error -C Release -j 2
 
   docs:
+    # Deploy docs only when builds succeed
+    needs: [sanitize, test]
+
     runs-on: ubuntu-22.04
-    needs: test
+
+    # To enable, first you have to create an orphaned gh-pages branch:
+    #
+    #    git switch --orphan gh-pages
+    #    git commit --allow-empty -m "Initial commit"
+    #    git push -u origin gh-pages
+    #
+    # Edit the <name> placeholder below to your GitHub name, so this action
+    # runs only in your repository and no one else's fork. After these, delete
+    # this comment and the last line in the conditional below.
+    # If you do not wish to use GitHub Pages for deploying documentation, then
+    # simply delete this job similarly to the coverage one.
+    if: github.ref == 'refs/heads/master'
+      && github.event_name == 'push'
+      && github.repository_owner == '<name>'
+      && false
+
+    permissions:
+      contents: write
 
     steps:
-      - name: Checkout source
-        uses: actions/checkout@v4
-
-      - name: Install Doxygen
-        run: sudo apt-get install doxygen -y -q
-
-      - name: Build documentation
-        run: |
-          cmake --preset=ci-linux
-          cmake --build build --target docs
-
-      - name: Deploy documentation to branch
-        run: |
-          git config --global user.name 'github-actions'
-          git config --global user.email 'github-actions@github.com'
-          git checkout --orphan gh-pages
-          git rm -rf .
-          cp -r build/docs/html/* .
-          git add .
-          git commit -m "Deploy docs"
-          git push --force origin gh-pages
+    - uses: actions/checkout@v4
+
+    - uses: actions/setup-python@v5
+      with: { python-version: "3.12" }
+
+    - name: Install m.css dependencies
+      run: pip3 install jinja2 Pygments
+
+    - name: Install Doxygen
+      run: sudo apt-get update -q
+        && sudo apt-get install doxygen -q -y
+
+    - name: Build docs
+      run: cmake "-DPROJECT_SOURCE_DIR=$PWD" "-DPROJECT_BINARY_DIR=$PWD/build"
+        -P cmake/docs-ci.cmake
+
+    - name: Deploy docs
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: build/docs/html

CMakeLists.txt

@@ -10,7 +10,6 @@ project(
     LANGUAGES NONE
 )
 
-
 include(cmake/variables.cmake)
 
 # ---- Declare library ----
@@ -31,6 +30,9 @@ target_include_directories(
 
 target_compile_features(ccontainer_ccontainer INTERFACE c_std_99)
 
+find_package(unity REQUIRED)
+target_link_libraries(ccontainer_ccontainer INTERFACE json-c::json-c)
+
 # ---- Install rules ----
 
 if(NOT CMAKE_SKIP_INSTALL_RULES)