Update sonar.yaml #44
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Licensed to the Apache Software Foundation (ASF) under one | |
| # or more contributor license agreements. See the NOTICE file | |
| # distributed with this work for additional information | |
| # regarding copyright ownership. The ASF licenses this file | |
| # to you under the Apache License, Version 2.0 (the | |
| # "License"); you may not use this file except in compliance | |
| # with the License. You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, | |
| # software distributed under the License is distributed on an | |
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | |
| # KIND, either express or implied. See the License for the | |
| # specific language governing permissions and limitations | |
| # under the License. | |
| name: CI | |
| on: [push, pull_request] | |
| # Concurrency strategy: | |
| # github.workflow: distinguish this workflow from others | |
| # github.event_name: distinguish `push` event from `pull_request` event | |
| # github.event.number: set to the number of the pull request if `pull_request` event | |
| # github.run_id: otherwise, it's a `push` event, only cancel if we rerun the workflow | |
| # | |
| # Reference: | |
| # https://docs.github.com/en/actions/using-jobs/using-concurrency | |
| # https://docs.github.com/en/actions/learn-github-actions/contexts#github-context | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.number || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| precondition: | |
| name: Precondition | |
| runs-on: ubuntu-22.04 | |
| outputs: | |
| docs_only: ${{ steps.result.outputs.docs_only }} | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: dorny/paths-filter@v2 | |
| id: changes | |
| with: | |
| filters: .github/config/changes.yml | |
| list-files: csv | |
| - name: Calculate changes | |
| id: result | |
| run: | | |
| echo "docs_only=${{ fromJSON(steps.changes.outputs.all_count) == fromJSON(steps.changes.outputs.docs_count) && fromJSON(steps.changes.outputs.docs_count) > 0 }}" >> $GITHUB_OUTPUT | |
| check-typos: | |
| name: Check typos | |
| runs-on: ubuntu-22.04 | |
| env: | |
| FORCE_COLOR: 1 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Install typos | |
| run: curl -LsSf https://github.com/crate-ci/typos/releases/download/v1.16.3/typos-v1.16.3-x86_64-unknown-linux-musl.tar.gz | tar zxf - -C ${CARGO_HOME:-~/.cargo}/bin | |
| - name: Run typos check | |
| run: typos --config .github/config/typos.toml | |
| check-and-lint: | |
| name: Lint and check code | |
| needs: [precondition] | |
| if: ${{ needs.precondition.outputs.docs_only != 'true' }} | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-go@v3 | |
| with: | |
| go-version-file: 'tests/gocase/go.mod' | |
| - name: Prepare Dependencies | |
| run: | | |
| sudo apt update | |
| sudo apt install -y clang-format-14 clang-tidy-14 | |
| - uses: apache/skywalking-eyes/header@v0.4.0 | |
| with: | |
| config: .github/config/licenserc.yml | |
| - name: Check with clang-format | |
| id: check-format | |
| run: ./x.py check format --clang-format-path clang-format-14 | |
| - name: Check with clang-tidy | |
| run: | | |
| ./x.py build --skip-build | |
| ./x.py check tidy -j $(nproc) --clang-tidy-path clang-tidy-14 --run-clang-tidy-path run-clang-tidy-14 | |
| - name: Lint with golangci-lint | |
| run: ./x.py check golangci-lint | |
| - name: Prepare format patch | |
| if: always() && steps.check-format.outcome != 'success' | |
| run: | | |
| ./x.py format --clang-format-path clang-format-14 | |
| git diff -p > clang-format.patch | |
| cat clang-format.patch | |
| - name: Upload format patch | |
| uses: actions/upload-artifact@v3 | |
| if: always() && steps.check-format.outcome != 'success' | |
| with: | |
| path: clang-format.patch | |
| build-and-test: | |
| name: Build and test | |
| needs: [precondition, check-and-lint, check-typos] | |
| if: ${{ needs.precondition.outputs.docs_only != 'true' }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| include: | |
| - name: SonarCloud with Coverage | |
| os: ubuntu-22.04 | |
| compiler: gcc | |
| sonarcloud: -DCMAKE_CXX_FLAGS=--coverage | |
| runs-on: ${{ matrix.os }} | |
| env: | |
| SONARCLOUD_OUTPUT_DIR: sonarcloud-data | |
| steps: | |
| - name: Setup macOS | |
| if: ${{ startsWith(matrix.os, 'macos') }} | |
| run: | | |
| brew install cmake gcc autoconf automake libtool openssl | |
| echo "NPROC=$(sysctl -n hw.ncpu)" >> $GITHUB_ENV | |
| echo "CMAKE_EXTRA_DEFS=-DOPENSSL_ROOT_DIR=/usr/local/opt/openssl" >> $GITHUB_ENV | |
| - name: Setup Linux | |
| if: ${{ startsWith(matrix.os, 'ubuntu') }} | |
| run: | | |
| sudo apt update | |
| sudo apt install -y ninja-build | |
| echo "NPROC=$(nproc)" >> $GITHUB_ENV | |
| - name: Cache redis | |
| id: cache-redis | |
| uses: actions/cache@v3 | |
| with: | |
| path: | | |
| ~/local/bin/redis-cli | |
| key: ${{ runner.os }}-redis-cli | |
| - name: Install redis | |
| if: steps.cache-redis.outputs.cache-hit != 'true' | |
| run: | | |
| curl -O https://download.redis.io/releases/redis-6.2.7.tar.gz | |
| tar -xzvf redis-6.2.7.tar.gz | |
| mkdir -p $HOME/local/bin | |
| pushd redis-6.2.7 && BUILD_TLS=yes make -j$NPROC redis-cli && mv src/redis-cli $HOME/local/bin/ && popd | |
| - uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.x | |
| - uses: actions/setup-go@v3 | |
| with: | |
| go-version-file: 'tests/gocase/go.mod' | |
| - name: Install gcovr 5.0 | |
| run: pip install gcovr==5.0 # 5.1 is not supported | |
| if: ${{ matrix.sonarcloud }} | |
| - name: Install sonar-scanner and build-wrapper | |
| uses: SonarSource/sonarcloud-github-c-cpp@v2 | |
| if: ${{ matrix.sonarcloud }} | |
| - name: Build Kvrocks | |
| if: ${{ !matrix.sonarcloud }} | |
| run: | | |
| ./x.py build -j$NPROC --unittest --compiler ${{ matrix.compiler }} ${{ matrix.without_jemalloc }} \ | |
| ${{ matrix.without_luajit }} ${{ matrix.with_ninja }} ${{ matrix.with_sanitizer }} ${{ matrix.with_openssl }} \ | |
| ${{ matrix.new_encoding }} ${{ matrix.with_speedb }} ${{ env.CMAKE_EXTRA_DEFS }} | |
| - name: Build Kvrocks (SonarCloud) | |
| if: ${{ matrix.sonarcloud }} | |
| run: | | |
| build-wrapper-linux-x86-64 --out-dir ${{ env.SONARCLOUD_OUTPUT_DIR }} ./x.py build -j$NPROC --unittest --compiler ${{ matrix.compiler }} ${{ matrix.sonarcloud }} | |
| - name: Setup Coredump | |
| if: ${{ startsWith(matrix.os, 'ubuntu') }} | |
| run: | | |
| echo "$(pwd)/coredumps/corefile-%e-%p-%t" | sudo tee /proc/sys/kernel/core_pattern | |
| mkdir coredumps | |
| - name: Run Unit Test | |
| run: | | |
| ulimit -c unlimited | |
| export LSAN_OPTIONS="suppressions=$(realpath ./tests/lsan-suppressions)" | |
| export TSAN_OPTIONS="suppressions=$(realpath ./tests/tsan-suppressions)" | |
| ./x.py test cpp | |
| - name: Run Go Integration Cases | |
| run: | | |
| ulimit -c unlimited | |
| export LSAN_OPTIONS="suppressions=$(realpath ./tests/lsan-suppressions)" | |
| export TSAN_OPTIONS="suppressions=$(realpath ./tests/tsan-suppressions)" | |
| export PATH=$PATH:$HOME/local/bin/ | |
| GOCASE_RUN_ARGS="" | |
| if [[ -n "${{ matrix.with_openssl }}" ]] && [[ "${{ matrix.os }}" == ubuntu* ]]; then | |
| git clone https://github.com/jsha/minica | |
| cd minica && go build && cd .. | |
| ./minica/minica --domains localhost | |
| cp localhost/cert.pem tests/gocase/tls/cert/server.crt | |
| cp localhost/key.pem tests/gocase/tls/cert/server.key | |
| cp minica.pem tests/gocase/tls/cert/ca.crt | |
| GOCASE_RUN_ARGS="-tlsEnable" | |
| fi | |
| ./x.py test go build $GOCASE_RUN_ARGS ${{ matrix.ignore_when_tsan}} | |
| - name: Find reports and crashes | |
| if: always() | |
| run: | | |
| SANITIZER_OUTPUT=$(grep "Sanitizer:" tests/gocase/workspace -r || true) | |
| if [[ $SANITIZER_OUTPUT ]]; then | |
| echo "found sanitizer reports:" | |
| echo "$SANITIZER_OUTPUT" | |
| echo "detail log:" | |
| cat $(echo "$SANITIZER_OUTPUT" | awk -F ':' '{print $1}') | |
| exit 1 | |
| fi | |
| CRASHES=$(grep "Ooops!" tests/gocase/workspace -r || true) | |
| if [[ $CRASHES ]]; then | |
| echo "found crashes:" | |
| echo "$CRASHES" | |
| echo "detail log:" | |
| cat $(echo "$CRASHES" | awk -F ':' '{print $1}') | |
| exit 1 | |
| fi | |
| - uses: actions/upload-artifact@v3 | |
| if: ${{ failure() && startsWith(matrix.os, 'ubuntu') }} | |
| with: | |
| name: kvrocks-coredumps-${{ matrix.name }} | |
| path: | | |
| ./build/kvrocks | |
| ./coredumps/* | |
| - name: Collect coverage into one XML report | |
| if: ${{ matrix.sonarcloud }} | |
| run: | | |
| gcovr --sonarqube > ${{ env.SONARCLOUD_OUTPUT_DIR }}/coverage.xml | |
| - name: Add event information | |
| if: ${{ matrix.sonarcloud }} | |
| env: | |
| GITHUB_EVENT_JSON: ${{ toJson(github.event) }} | |
| run: | | |
| echo "$GITHUB_EVENT_JSON" | tee ${{ env.SONARCLOUD_OUTPUT_DIR }}/github-event.json | |
| - name: Upload SonarCloud data | |
| if: ${{ matrix.sonarcloud }} | |
| uses: actions/upload-artifact@v3 | |
| with: | |
| name: sonarcloud-data | |
| path: ${{ env.SONARCLOUD_OUTPUT_DIR }} |