forked from percona/percona-server
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PS-9040 Integrate clang-tidy checks for Percona server
https://perconadev.atlassian.net/browse/PS-9040 Creates a workflow to be triggered on a pull request to perform clang-tidy checks on the changed code and post the violations as comments on the pull request to be addressed. The workflow triggers a run of generating comiplation commands and uses the same to perform a clang-tidy check on the modified files and generates a report of the warnings in the changed code through a github action bot in the form of review comments on the pull request.
- Loading branch information
1 parent
78a93d5
commit 7d4d1e2
Showing
2 changed files
with
171 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
# Workflow with limited permissions that performs the checks and provides analysis results through an artifact | ||
name: Static_analysis | ||
run-name: GitHub actions for clang-tidy checks | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- 8.0 | ||
- trunk | ||
- release-* | ||
|
||
env: | ||
UBUNTU_CODE_NAME: "jammy" | ||
COMPILER_VERSION: "17" | ||
BOOST_VERSION: "1_77_0" | ||
BOOST_DIR: "/home/runner/my_boost" | ||
|
||
jobs: | ||
clang-tidy: | ||
runs-on: ubuntu-22.04 | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
ref: ${{ github.event.pull_request.head.sha }} | ||
fetch-depth: 0 | ||
submodules: 'recursive' | ||
|
||
- name: Fetch base branch | ||
run: | | ||
git remote add target "https://github.com/${{ github.event.pull_request.base.repo.full_name }}" | ||
git fetch --no-tags --no-recurse-submodules target "${{ github.event.pull_request.base.ref }}" | ||
- name: Install dependencies and clang-tidy | ||
run: | | ||
curl -sSL "http://apt.llvm.org/llvm-snapshot.gpg.key" | sudo -E apt-key add - | ||
echo "deb http://apt.llvm.org/${UBUNTU_CODE_NAME}/ llvm-toolchain-${UBUNTU_CODE_NAME}-${COMPILER_VERSION} main" | sudo tee -a /etc/apt/sources.list > /dev/null | ||
sudo apt-get update | ||
sudo apt-get install -y --allow-unauthenticated --no-install-recommends --no-install-recommends clang-${COMPILER_VERSION} clang-tidy-${COMPILER_VERSION} libldap2-dev curl libcurl4-openssl-dev bison libudev-dev libkrb5-dev libreadline-dev zlib1g-dev liblz4-dev \ | ||
libedit-dev libevent-dev protobuf-compiler libprotobuf-dev libprotoc-dev libfido2-dev libldap2-dev libsasl2-dev libsasl2-modules | ||
- name: Cache boost | ||
id: cache-boost | ||
uses: actions/cache@v3 | ||
with: | ||
path: ${{ env.BOOST_DIR }} | ||
key: ${{ runner.os }}-boost-${{ env.BOOST_VERSION }} | ||
|
||
- name: Download boost | ||
if: steps.cache-boost.outputs.cache-hit != 'true' | ||
run: | | ||
wget --progress=dot:giga -P ${BOOST_DIR} "http://downloads.sourceforge.net/boost/boost/${BOOST_VERSION//_/.}/boost_${BOOST_VERSION}.tar.gz" | ||
tar -xzf "${BOOST_DIR}/boost_${BOOST_VERSION}.tar.gz" -C "${BOOST_DIR}" | ||
- name: Prepare compile_commands.json | ||
run: | | ||
cmake -B ../debug-build -DCMAKE_INSTALL_PREFIX=../install -DCMAKE_BUILD_TYPE=Debug -DWITH_BOOST=${BOOST_DIR} -DWITH_SSL=system \ | ||
-DWITH_AUTHENTICATION_LDAP=ON -DWITH_KEYRING_VAULT=ON -DWITH_ROCKSDB=ON -DCMAKE_C_COMPILER=clang-${COMPILER_VERSION} -DCMAKE_CXX_COMPILER=clang++-${COMPILER_VERSION} \ | ||
-DCMAKE_EXPORT_COMPILE_COMMANDS=ON -DWITH_SYSTEM_LIBS=ON ${{ github.workspace }} | ||
- name: Create results directory | ||
run: | | ||
mkdir clang-tidy-result | ||
- name: Analyze | ||
# Don't disable push/merge option in the PR even if there are unfixed warnings. | ||
continue-on-error: true | ||
run: | | ||
git diff -U0 "$(git merge-base HEAD "target/${{ github.event.pull_request.base.ref }}")" | clang-tidy-diff-${COMPILER_VERSION}.py -p1 -path ../debug-build -export-fixes clang-tidy-result/fixes.yml | ||
- name: Save PR metadata | ||
run: | | ||
echo "${{ github.event.number }}" > clang-tidy-result/pr-id.txt | ||
echo "${{ github.event.pull_request.head.repo.full_name }}" > clang-tidy-result/pr-head-repo.txt | ||
echo "${{ github.event.pull_request.head.sha }}" > clang-tidy-result/pr-head-sha.txt | ||
- uses: actions/upload-artifact@v4 | ||
with: | ||
name: clang-tidy-result | ||
path: clang-tidy-result/ |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
# Secure workflow with access to repository secrets and GitHub token for posting analysis results | ||
name: Post the static analysis results | ||
|
||
on: | ||
workflow_run: | ||
workflows: [ Static_analysis ] | ||
types: | ||
- completed | ||
|
||
jobs: | ||
clang-tidy-results: | ||
# Trigger the job only if the Static_analysis workflow completed successfully | ||
if: ${{ github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion == 'success' }} | ||
runs-on: ubuntu-22.04 | ||
permissions: | ||
pull-requests: write | ||
steps: | ||
- name: Download analysis results | ||
uses: actions/github-script@v7 | ||
with: | ||
script: | | ||
const artifacts = await github.rest.actions.listWorkflowRunArtifacts({ | ||
owner: context.repo.owner, | ||
repo: context.repo.repo, | ||
run_id: ${{ github.event.workflow_run.id }}, | ||
}); | ||
const matchArtifact = artifacts.data.artifacts.filter((artifact) => { | ||
return artifact.name == "clang-tidy-result" | ||
})[0]; | ||
const download = await github.rest.actions.downloadArtifact({ | ||
owner: context.repo.owner, | ||
repo: context.repo.repo, | ||
artifact_id: matchArtifact.id, | ||
archive_format: "zip", | ||
}); | ||
const fs = require("fs"); | ||
fs.writeFileSync("${{ github.workspace }}/clang-tidy-result.zip", Buffer.from(download.data)); | ||
- name: Extract analysis results | ||
run: | | ||
mkdir clang-tidy-result | ||
unzip -j clang-tidy-result.zip -d clang-tidy-result | ||
- name: Set environment variables | ||
uses: actions/github-script@v7 | ||
with: | ||
script: | | ||
const assert = require("node:assert").strict; | ||
const fs = require("fs"); | ||
function exportVar(varName, fileName, regEx) { | ||
const val = fs.readFileSync("${{ github.workspace }}/clang-tidy-result/" + fileName, { | ||
encoding: "ascii" | ||
}).trimEnd(); | ||
assert.ok(regEx.test(val), "Invalid value format for " + varName); | ||
core.exportVariable(varName, val); | ||
} | ||
exportVar("PR_ID", "pr-id.txt", /^[0-9]+$/); | ||
exportVar("PR_HEAD_REPO", "pr-head-repo.txt", /^[-./0-9A-Z_a-z]+$/); | ||
exportVar("PR_HEAD_SHA", "pr-head-sha.txt", /^[0-9A-Fa-f]+$/); | ||
- uses: actions/checkout@v4 | ||
with: | ||
repository: ${{ env.PR_HEAD_REPO }} | ||
ref: ${{ env.PR_HEAD_SHA }} | ||
persist-credentials: false | ||
- name: Redownload analysis results | ||
uses: actions/github-script@v7 | ||
with: | ||
script: | | ||
const artifacts = await github.rest.actions.listWorkflowRunArtifacts({ | ||
owner: context.repo.owner, | ||
repo: context.repo.repo, | ||
run_id: ${{ github.event.workflow_run.id }}, | ||
}); | ||
const matchArtifact = artifacts.data.artifacts.filter((artifact) => { | ||
return artifact.name == "clang-tidy-result" | ||
})[0]; | ||
const download = await github.rest.actions.downloadArtifact({ | ||
owner: context.repo.owner, | ||
repo: context.repo.repo, | ||
artifact_id: matchArtifact.id, | ||
archive_format: "zip", | ||
}); | ||
const fs = require("fs"); | ||
fs.writeFileSync("${{ github.workspace }}/clang-tidy-result.zip", Buffer.from(download.data)); | ||
- name: Extract analysis results | ||
run: | | ||
mkdir clang-tidy-result | ||
unzip -j clang-tidy-result.zip -d clang-tidy-result | ||
- name: Run clang-tidy-pr-comments action | ||
uses: platisd/clang-tidy-pr-comments@v1 | ||
with: | ||
github_token: ${{ secrets.GITHUB_TOKEN }} | ||
clang_tidy_fixes: clang-tidy-result/fixes.yml | ||
pull_request_id: ${{ env.PR_ID }} |