graph namespace

.github/workflows/coverage.yml

@@ -3,27 +3,45 @@ name: coverage
 env:
     GXX_VERSION: 12
     TESTS_DIR: out/tests
-    COVERAGE_FILE: coverage.info
+    COBERTURA_REPORT: cobertura.xml
+    COVERALLS_REPORT: coveralls.json
+    HTML_REPORT_DIR: html/
     COVERAGE_ARTIFACT_NAME: coverage-report
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+    - master
+    - development
+    paths-ignore:
+      - 'README.md'
+      - 'docs/'
+  pull_request:
+    branches:
+    - '**'
+    paths-ignore:
+      - 'README.md'
+      - 'docs/'
 
 jobs:
   create-coverage-report:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
-      - name: Install compiler
+      - name: Install prerequisites
         run: |
             sudo apt-get update
+            sudo apt-get install pip -y
+            sudo pip install gcovr
             sudo apt-get install g++-${{ env.GXX_VERSION }} -y
             sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-${{ env.GXX_VERSION }} ${{ env.GXX_VERSION }}00 --slave /usr/bin/gcc gcc /usr/bin/gcc-${{ env.GXX_VERSION }}
             sudo update-alternatives --install /usr/bin/gcov gcov /usr/bin/gcov-${{ env.GXX_VERSION }} ${{ env.GXX_VERSION }}00
 
       - name: Compile tests
         env:
-          CXXFLAGS: "--coverage -fno-inline -fprofile-abs-path"
+          LDFLAGS: "-fprofile-arcs"
+          CXXFLAGS: "-g -O0 --coverage -fno-inline -fprofile-abs-path -fkeep-inline-functions -fkeep-static-functions"
           CC: gcc
           CXX: g++
         run: |
@@ -33,19 +51,34 @@ jobs:
       - name: Run tests
         env:
           CTEST_OUTPUT_ON_FAILURE: 1
-        run: ctest --test-dir ${{ env.TESTS_DIR }} --timeout 30 -C Debug -j4
+        run: ctest --test-dir ${{env.TESTS_DIR}} -C Debug -j4
 
-      - name: Collect data
+      - name: Run gcovr
         run: |
-          sudo apt-get install lcov -y
-          lcov --capture -d ${{env.TESTS_DIR}} -o ${{env.COVERAGE_FILE}} --include "$PWD/include/*"
-          lcov -l ${{env.COVERAGE_FILE}}
+           gcovr --root ${{env.TESTS_DIR}} --filter include/Simple-Utility --keep -j 4 \
+            --exclude-lines-by-pattern "\s*assert\(" \
+            --exclude-unreachable-branches \
+            --exclude-noncode-lines \
+            --exclude-throw-branches \
+            --decisions \
+            --cobertura ${{env.COBERTURA_REPORT}} --cobertura-pretty \
+            --html-nested ${{env.HTML_REPORT_DIR}} --html-title "Simple-Utility Coverage Report" \
+            --coveralls ${{env.COVERALLS_REPORT}} --coveralls-pretty
 
-      - name: Upload artifacts
+      - name: Upload gcov coverage report artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: gcov-files
+          path: "${{env.TESTS_DIR}}/*.gcov"
+
+      - name: Upload generated report artifacts
         uses: actions/upload-artifact@v3
         with:
           name: ${{env.COVERAGE_ARTIFACT_NAME}}
-          path: ${{env.COVERAGE_FILE}}
+          path: |
+              ${{env.COBERTURA_REPORT}}
+              ${{env.COVERALLS_REPORT}}
+              ${{env.HTML_REPORT_DIR}}
 
   codacy-report:
     needs: create-coverage-report
@@ -60,8 +93,8 @@ jobs:
       - name: Upload coverage to Codacy
         uses: codacy/codacy-coverage-reporter-action@v1
         with:
-          project-token: ${{ secrets.CODACY_PROJECT_TOKEN  }}
-          coverage-reports: ${{ env.COVERAGE_FILE }}
+          project-token: ${{secrets.CODACY_PROJECT_TOKEN}}
+          coverage-reports: ${{env.COBERTURA_REPORT}}
 
   codecov-report:
     needs: create-coverage-report
@@ -77,8 +110,8 @@ jobs:
         uses: codecov/codecov-action@v3
         with:
           name: $GITHUB_REPOSITORY
-          token: ${{ secrets.CODECOV_TOKEN }}
-          files: ${{ env.COVERAGE_FILE }}
+          token: ${{secrets.CODECOV_TOKEN}}
+          files: ${{env.COBERTURA_REPORT}}
           fail_ci_if_error: true
           verbose: true
 
@@ -96,6 +129,6 @@ jobs:
         uses: coverallsapp/github-action@v2
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
-          file: ${{env.COVERAGE_FILE}}
-          format: lcov
+          file: ${{env.COVERALLS_REPORT}}
+          format: coveralls
           fail-on-error: true

.github/workflows/run_benchmarks.yml

@@ -0,0 +1,161 @@
+name: run benchmarks
+
+env:
+  BUILD_DIR: out    # root build directory
+  BENCHMARK_DIR: benchmarks   # relative directory below BUILD_DIR
+  ARTIFACTS_DIR: artifacts # relative directory below BENCHMARK_DIR
+
+on:
+  push:
+    branches:
+    - master
+    - development
+    paths-ignore:
+      - 'README.md'
+      - 'docs/'
+  pull_request:
+    branches:
+    - '**'
+    paths-ignore:
+      - 'README.md'
+      - 'docs/'
+
+jobs:
+  ubuntu-22_04:
+    runs-on: ubuntu-22.04
+
+    strategy:
+      fail-fast: false
+      matrix:
+        build_mode: [Release]
+        compiler:
+          - pkg: g++-12
+            exe: g++-12
+          - pkg: g++-11
+            exe: g++-11
+          - pkg: g++-10
+            exe: g++-10
+          - pkg: clang-14
+            exe: clang++-14
+          - pkg: clang-13
+            exe: clang++-13
+          - pkg: clang-12
+            exe: clang++-12
+          - pkg: clang-11
+            exe: clang++-11
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install compiler
+      run: |
+        sudo apt-get update
+        sudo apt-get install ${{ matrix.compiler.pkg }} -y
+    - name: Compile
+      env:
+        CXX: ${{ matrix.compiler.exe }}
+      run: |
+        cmake -DCMAKE_BUILD_TYPE=${{ matrix.build_mode }} -DSIMPLE_UTILITY_BUILD_BENCHMARKS=Yes -B ${{ env.BUILD_DIR }} -S .
+        cmake --build ${{ env.BUILD_DIR }} -j4
+    - name: Run benchmarks
+      run: "${{env.BUILD_DIR}}/${{env.BENCHMARK_DIR}}/Simple-Utility-Benchmarks"
+    - name: Upload generated report artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        path: "${{env.ARTIFACTS_DIR}}"
+
+
+  ubuntu-20_04:
+    runs-on: ubuntu-20.04
+
+    strategy:
+      fail-fast: false
+      matrix:
+        build_mode: [Release]
+        compiler:
+          - pkg: g++-11
+            exe: g++-11
+          - pkg: g++-10
+            exe: g++-10
+          - pkg: clang-12
+            exe: clang++-12
+          - pkg: clang-11
+            exe: clang++-11
+          - pkg: clang-10
+            exe: clang++-10
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install compiler
+      run: |
+        sudo apt-get update
+        sudo apt-get install ${{ matrix.compiler.pkg }} -y
+    - name: Compile
+      env:
+        CXX: ${{ matrix.compiler.exe }}
+      run: |
+        cmake -DCMAKE_BUILD_TYPE=${{ matrix.build_mode }} -DSIMPLE_UTILITY_BUILD_BENCHMARKS=Yes -B ${{ env.BUILD_DIR }} -S .
+        cmake --build ${{ env.BUILD_DIR }} -j4
+    - name: Run benchmarks
+      run: "${{env.BUILD_DIR}}/${{env.BENCHMARK_DIR}}/Simple-Utility-Benchmarks"
+    - name: Upload generated report artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        path: "${{env.ARTIFACTS_DIR}}"
+
+
+  windows_2022:
+    runs-on: windows-2022
+
+    strategy:
+      fail-fast: false
+      matrix:
+        build_mode: [Release]
+        toolset: [v142, v143, ClangCl]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Compile
+      run: |
+        cmake -G"Visual Studio 17 2022" `
+              -T${{matrix.toolset}} `
+              -DCMAKE_BUILD_TYPE=${{matrix.build_mode}} `
+              -DSIMPLE_UTILITY_BUILD_BENCHMARKS=Yes `
+              -B${{env.BUILD_DIR}} `
+              -Ax64 `
+              -S .
+        cmake --build ${{ env.BUILD_DIR }} --config ${{ matrix.build_mode }} -j4
+    - name: Run benchmarks
+      run: ".\\${{env.BUILD_DIR}}\\${{env.BENCHMARK_DIR}}\\${{matrix.build_mode}}\\Simple-Utility-Benchmarks.exe"
+    - name: Upload generated report artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        path: "${{env.ARTIFACTS_DIR}}"
+
+
+  windows_2019:
+    runs-on: windows-2019
+
+    strategy:
+      fail-fast: false
+      matrix:
+        build_mode: [Release]
+        toolset: [v142, ClangCl]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Compile
+      run: |
+        cmake -G"Visual Studio 16 2019" `
+              -T${{matrix.toolset}} `
+              -DCMAKE_BUILD_TYPE=${{matrix.build_mode}} `
+              -DSIMPLE_UTILITY_BUILD_BENCHMARKS=Yes `
+              -B${{env.BUILD_DIR}} `
+              -Ax64 `
+              -S .
+        cmake --build ${{env.BUILD_DIR}} --config ${{matrix.build_mode}} -j4
+    - name: Run benchmarks
+      run: ".\\${{env.BUILD_DIR}}\\${{env.BENCHMARK_DIR}}\\${{matrix.build_mode}}\\Simple-Utility-Benchmarks.exe"
+    - name: Upload generated report artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        path: "${{env.ARTIFACTS_DIR}}"

.github/workflows/run_tests.yml

@@ -6,9 +6,18 @@ env:
 
 on:
   push:
-    branches: [master, development]
+    branches:
+    - master
+    - development
+    paths-ignore:
+      - 'README.md'
+      - 'docs/'
   pull_request:
-    branches: [master, development]
+    branches:
+    - '**'
+    paths-ignore:
+      - 'README.md'
+      - 'docs/'
 
 jobs:
   ubuntu-22_04:

CMakeLists.txt

@@ -32,6 +32,12 @@ if (SIMPLE_UTILITY_BUILD_TESTS OR CMAKE_SOURCE_DIR STREQUAL Simple-Utility_SOURC
 	add_subdirectory("tests")
 endif()
 
+OPTION(SIMPLE_UTILITY_BUILD_BENCHMARKS "Determines whether benchmarks will be built." OFF)
+if (SIMPLE_UTILITY_BUILD_BENCHMARKS)
+	include(CTest)
+	add_subdirectory("benchmarks")
+endif()
+
 option(SIMPLE_UTILITY_GEN_DOCS_ENABLED "Enables the GenerateDocs target." OFF)
 if (SIMPLE_UTILITY_GEN_DOCS_ENABLED)
 	add_subdirectory("docs")