Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

adding clang-tidy as a linter tool #2269

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
35 changes: 35 additions & 0 deletions ceph-pr-clang-tidy/build/build
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
#!/bin/bash
set -ex

docs_pr_only
if [ "$DOCS_ONLY" = true ]; then
echo "Only the doc/ dir changed. No need to run make check or API tests."
mkdir -p $WORKSPACE/build/out
echo "File created to avoid Jenkins' Artifact Archiving plugin from hanging" > $WORKSPACE/build/out/mgr.foo.log
exit 0
fi

sudo apt-get install -y clang-tidy
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

of course this only works if the build machine is an apt-based system, which it may not be using your current node labels. It might be more appropriate to install the package inside the pbuilder image in that case, too, although it probably doesn't matter too much; there are ways of adding extra packages to the pbuilder image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We still need an answer for this; does clang-tidy exist for RHEL-like systems? or do we want to restrict this job to only apt systems?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is available but for now lets keep the job to apt systems only

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How is this accomplished? won't the command be executed (and fail) on all systems?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The job specifies the labels for the jenkins builder it wants; we'll need to add something like 'jammy' as a label, that should suffice

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where should I add this 'jammy' label?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

job.node is the list of labels the builder must satisfy. You probably want jammy && small

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

job.node is the list of labels the builder must satisfy. You probably want jammy && small

@dmick I have added node: jammy && small


sudo apt-get install -y parallel

build_debs ${VENV} ${vers} ${debian_version}

output_file="clang-tidy-result"
file_list="files_to_check.txt"

# Store the list of files from both rgw and osd directories
find "$WORKSPACE/src/rgw" \( -name '*.cpp' -o -name '*.hpp' -o -name '*.cc' \) > "$file_list"
find "$WORKSPACE/src/osd" \( -name '*.cpp' -o -name '*.hpp' -o -name '*.cc' \) >> "$file_list"

# Run clang-tidy and save output
{
echo "Files being checked:"
cat "$file_list"
echo
parallel -m clang-tidy -checks="-*,bugprone-use-after-move" -p "$WORKSPACE/build" {} < "$file_list"
} | tee "$WORKSPACE/build/$output_file"

sudo chmod +x ../src/script/clang-tidy-to-junit.py

cat "$WORKSPACE/build/$output_file" | ../src/script/clang-tidy-to-junit.py $WORKSPACE/src >"$WORKSPACE/report.xml"
Suyashd999 marked this conversation as resolved.
Show resolved Hide resolved
55 changes: 55 additions & 0 deletions ceph-pr-clang-tidy/config/ceph-pr-clang-tidy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
- job:
name: ceph-pr-clang-tidy
node: small
project-type: freestyle
defaults: global
display-name: 'ceph: Clang-tidy checks'
concurrent: true
quiet-period: 5
block-downstream: false
block-upstream: false
retry-count: 3
properties:
- build-discarder:
days-to-keep: 15
artifact-days-to-keep: 15
- github:
url: https://github.com/ceph/ceph/

scm:
- git:
url: https://github.com/ceph/ceph.git
name: origin
branches:
- origin/pr/${ghprbPullId}/merge
refspec: +refs/pull/${ghprbPullId}/*:refs/remotes/origin/pr/${ghprbPullId}/*
skip-tag: true
shallow-clone: true
honor-refspec: true
timeout: 20

triggers:
- github-pull-request:
allow-whitelist-orgs-as-admins: true
org-list:
- ceph
trigger-phrase: 'jenkins test clang-tidy'
only-trigger-phrase: false
github-hooks: true
permit-all: true
auto-close-on-fail: false
status-context: "Signed-off-by"
started-status: "checking if bugs exist in file"
success-status: "no bugs found"
failure-status: "bugs found"

builders:
- shell:
!include-raw:
- ../../../scripts/build_utils.sh
- ../../build/build

publishers:
- junit:
results: report.xml
allow-empty-results: true