Analysis workflow (#783)

.github/workflows/analysis_workflow.yml

@@ -0,0 +1,195 @@
+name: Build with analysis tools
+on:
+  workflow_dispatch:
+    inputs:
+      run:
+        type: boolean
+
+  schedule: # Schdeule the job to run at 12 a.m. daily
+    - cron: '0 0 * * *'
+jobs:
+  cibw_docker_image:
+    uses: ./.github/workflows/cibw_docker_image.yml
+    permissions: {packages: write}
+    with:
+        cibuildwheel_ver: "2.12.1"
+        force_update: false
+
+  code_coverage:
+    needs: [cibw_docker_image]  
+    runs-on: "ubuntu-latest"
+    container:
+        image: ${{needs.cibw_docker_image.outputs.tag}}
+    services:
+      mongodb:
+        image: mongo:4.4
+        ports:
+          - 27017:27017
+    env:
+      SCCACHE_GHA_VERSION: ${{vars.SCCACHE_GHA_VERSION || 1}} # Setting this env var enables the caching
+      VCPKG_NUGET_USER: ${{secrets.VCPKG_NUGET_USER || github.repository_owner}}
+      VCPKG_NUGET_TOKEN: ${{secrets.VCPKG_NUGET_TOKEN || secrets.GITHUB_TOKEN}}
+      VCPKG_MAN_NUGET_USER: ${{secrets.VCPKG_MAN_NUGET_USER}} # For forks to download pre-compiled dependencies from the Man repo
+      VCPKG_MAN_NUGET_TOKEN: ${{secrets.VCPKG_MAN_NUGET_TOKEN}}
+      CMAKE_C_COMPILER_LAUNCHER: sccache
+      CMAKE_CXX_COMPILER_LAUNCHER: sccache
+      ARCTIC_CMAKE_PRESET: linux-debug
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Get number of CPU cores
+        uses: SimenB/github-actions-cpu-cores@v1
+        id: cpu-cores
+
+      - name: Extra envs
+        run: |
+          . build_tooling/vcpkg_caching.sh # Linux follower needs another call in CIBW
+          echo -e "VCPKG_BINARY_SOURCES=$VCPKG_BINARY_SOURCES
+          VCPKG_ROOT=$PLATFORM_VCPKG_ROOT" | tee -a $GITHUB_ENV
+          cmake -P cpp/CMake/CpuCount.cmake | sed 's/^-- //' | tee -a $GITHUB_ENV
+        env:
+          CMAKE_BUILD_PARALLEL_LEVEL: ${{vars.CMAKE_BUILD_PARALLEL_LEVEL}}
+
+      - name: Prepare C++ compilation env
+        run: . build_tooling/prep_cpp_build.sh 
+
+      - name: CMake compile
+        uses: lukka/run-cmake@v10
+        with:
+          cmakeListsTxtPath: ${{github.workspace}}/cpp/CMakeLists.txt
+          configurePreset: ${{env.ARCTIC_CMAKE_PRESET}}
+          buildPreset: ${{env.ARCTIC_CMAKE_PRESET}}
+        env:
+          ARCTICDB_CODE_COVERAGE_BUILD: 1
+          ARCTICDB_DEBUG_FIND_PYTHON: ${{vars.ARCTICDB_DEBUG_FIND_PYTHON}}
+          python_impl_name: 'cp311'
+
+      - name: Run C++ Tests
+        shell: bash -l {0}
+        run: |
+          cd cpp/out/linux-debug-build/
+          ls arcticdb
+          make -j ${{ steps.cpu-cores.outputs.count }} arcticdb_rapidcheck_tests
+          make -j ${{ steps.cpu-cores.outputs.count }} test_unit_arcticdb
+          ctest
+
+      # We are chainging the python here because we want to use the default python to build (it is devel version)
+      # and this python for the rest of the testing
+      - name: Select Python (Linux)
+        run: echo /opt/python/cp36-cp36m/bin >> $GITHUB_PATH
+
+      - name: Test with pytest
+        shell: bash -l {0}
+        run: |
+          yum install nodejs npm -y
+          npm config set strict-ssl false
+          npm install -g azurite
+          python -m pip install --upgrade pip
+
+          python >build_tooling/requirements-analysis-workflow.txt <<END
+          from configparser import ConfigParser
+          cf = ConfigParser()
+          cf.read("setup.cfg");
+
+          # setup_requires is not needed
+          print(cf['options']['setup_requires'])
+          print(cf['options']['install_requires'])
+          print(cf['options.extras_require']['Testing'])
+          END
+
+          python -m pip install -r build_tooling/requirements-analysis-workflow.txt
+          python -m grpc_tools.protoc -Icpp/proto --python_out=./python cpp/proto/arcticc/pb2/*.proto
+          cd python
+          ln -s ../cpp/out/linux-debug-build/arcticdb/arcticdb_ext.cpython-36m-x86_64-linux-gnu.so
+          python -m coverage run -m pytest tests
+        env:
+          TEST_OUTPUT_DIR: ${{runner.temp}}
+          # Use the Mongo created in the service container above to test against
+          CI_MONGO_HOST: mongodb
+          ARCTICDB_PERSISTENT_STORAGE_LIB_NAME: 'test_${{ github.run_id }}_${{matrix.os}}_${{env.python_impl_name}}${{matrix.python_deps_id}}'
+
+      - name: Get python Coverage report
+        shell: bash -l {0}
+        run: |
+          cd python
+          python -m coverage report -m | tee output.txt
+          python -m coverage html
+          zip -r python_cov.zip htmlcov/
+
+          echo "PYTHON_COV_PERCENT=$(cat output.txt | grep 'TOTAL' | awk '{print $NF}' | tr -d '%')" >> $GITHUB_ENV
+
+      - name: Run Gcovr manually post-pytest
+        shell: bash -l {0}
+        run: |
+          cd cpp/out/linux-debug-build/
+          python -m pip install gcovr
+          mkdir coverage
+          python -m gcovr --txt --html-details coverage/index.html -e vcpkg_installed/ -e proto/ -e ../../third_party -e ../../arcticdb/util/test/ -r ../.. --exclude-throw-branches --exclude-unreachable-branches -u --exclude-function-lines | tee output.txt
+          zip -r coverage.zip coverage/
+
+          echo "CPP_COV_PERCENT=$(cat output.txt | grep 'TOTAL' | awk '{print $NF}' | tr -d '%')" >> $GITHUB_ENV
+
+      - name: Upload Coverage
+        uses: actions/upload-artifact@v3
+        with:
+          name: cpp-coverage-artifact
+          path: cpp/out/linux-debug-build/coverage.zip
+
+      - name: Upload Python Coverage
+        uses: actions/upload-artifact@v3
+        with:
+          name: python-coverage-artifact
+          path: python/python_cov.zip
+
+      - name: Restore cpp cache
+        id: cache
+        uses: actions/cache@v2
+        with:
+          path: coverage.txt
+          key: coverage
+
+      - name: Get and compare coverage if cache was restored
+        run: |
+          # if cache was restored, compare coverage
+          if [ -f coverage.txt ]; then
+            PREV_COVERAGE=$(cat coverage.txt | cut -d' ' -f2)
+            echo "Previous coverage: $PREV_COVERAGE"
+            CURR_COVERAGE=${{env.CPP_COV_PERCENT}}
+            echo "CPP_COV_PREV_PERCENT=$PREV_COVERAGE" >> $GITHUB_ENV
+            echo "Current coverage: $CURR_COVERAGE"
+            if [ $CURR_COVERAGE -gt $PREV_COVERAGE ]; then
+              echo "Coverage increased"
+            elif [ $CURR_COVERAGE -lt $PREV_COVERAGE ]; then
+              echo "Coverage decreased"
+            else
+              echo "Coverage unchanged"
+            fi
+          fi
+
+      - name: Save coverage percentage to file
+        run: |
+          echo "Coverage: ${{ env.CPP_COV_PERCENT }}" > coverage.txt
+
+      - name: Check percentage and send Slack notification
+        if: ${{ env.CPP_COV_PREV_PERCENT && env.CPP_COV_PERCENT && env.CPP_COV_PERCENT < env.CPP_COV_PREV_PERCENT }}
+        uses: slackapi/[email protected]
+        with:
+          # For posting a rich message using Block Kit
+          payload: |
+            {
+              "text": "The CPP Code Coverage has been reduced",
+              "blocks": [
+                {
+                  "type": "section",
+                  "text": {
+                    "type": "mrkdwn",
+                    "text": "The CPP Code Coverage from the current run(${{ env.CPP_COV_PERCENT }}%) is lower the previous one(${{ env.CPP_COV_PREV_PERCENT }}%)."
+                  }
+                }
+              ]
+            }
+        env:
+          SLACK_WEBHOOK_URL: ${{ secrets.ARCTICDB_DEV_WEBHOOK_URL }}
+          SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK

cpp/CMakeLists.txt

@@ -35,6 +35,9 @@ else()
         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Wextra")
     endif()
     set(CMAKE_CXX_FLAGS_DEBUG "-ggdb")
+    if(DEFINED ENV{ARCTICDB_CODE_COVERAGE_BUILD})
+        set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} --coverage -g -O0")
+    endif()
     set(CMAKE_CXX_FLAGS_RELEASE "-O3 -DNDEBUG")
     set(CMAKE_CXX_FLAGS_RELWITHDEBINFO "-O3 -ggdb")
 endif()

setup.cfg

@@ -128,6 +128,7 @@ Testing =
     pymongo
     azure-storage-blob
     azure-identity
+    coverage
 
 [options.entry_points]
 console_scripts =