-
Notifications
You must be signed in to change notification settings - Fork 174
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(ci): split perf CI from ci.yml and add a create-comment on top …
…of it. Signed-off-by: Federico Di Pierro <[email protected]>
- Loading branch information
Showing
3 changed files
with
163 additions
and
72 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
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,54 @@ | ||
# NOTE: This has read-write repo token and access to secrets, so this must | ||
# not run any untrusted code. | ||
# see: https://securitylab.github.com/research/github-actions-preventing-pwn-requests/ | ||
name: Comment on the pull request | ||
|
||
on: | ||
workflow_run: | ||
workflows: ["Perf CI"] | ||
types: | ||
- completed | ||
|
||
jobs: | ||
upload: | ||
runs-on: ubuntu-latest | ||
if: github.event.workflow_run.event == 'pull_request' | ||
steps: | ||
- name: 'Download artifact' | ||
uses: actions/[email protected] | ||
with: | ||
script: | | ||
var artifacts = await github.rest.actions.listWorkflowRunArtifacts({ | ||
owner: context.repo.owner, | ||
repo: context.repo.repo, | ||
run_id: ${{github.event.workflow_run.id }}, | ||
}); | ||
var matchArtifact = artifacts.data.artifacts.filter((artifact) => { | ||
return artifact.name == "pr" | ||
})[0]; | ||
var download = await github.rest.actions.downloadArtifact({ | ||
owner: context.repo.owner, | ||
repo: context.repo.repo, | ||
artifact_id: matchArtifact.id, | ||
archive_format: 'zip', | ||
}); | ||
var fs = require('fs'); | ||
fs.writeFileSync('${{github.workspace}}/pr.zip', Buffer.from(download.data)); | ||
- name: 'Unpack artifact' | ||
run: unzip pr.zip | ||
|
||
- name: 'Comment on PR' | ||
uses: actions/[email protected] | ||
with: | ||
github-token: ${{ secrets.GITHUB_TOKEN }} | ||
script: | | ||
var fs = require('fs'); | ||
var issue_number = Number(fs.readFileSync('./NR')); | ||
var comment_body = fs.readFileSync('./COMMENT'); | ||
await github.rest.issues.createComment({ | ||
owner: context.repo.owner, | ||
repo: context.repo.repo, | ||
issue_number: issue_number, | ||
body: comment_body.toString('utf8') | ||
}); |
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,109 @@ | ||
name: Perf CI | ||
on: | ||
pull_request: | ||
push: | ||
branches: | ||
- master | ||
workflow_dispatch: | ||
|
||
# Checks if any concurrent jobs under the same pull request or branch are being executed | ||
concurrency: | ||
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}-perf | ||
cancel-in-progress: true | ||
|
||
jobs: | ||
perf-libs-linux-amd64: | ||
runs-on: 'ubuntu-22.04' | ||
steps: | ||
- name: Checkout Libs ⤵️ | ||
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1 | ||
with: | ||
fetch-depth: 0 | ||
|
||
- name: Install deps ⛓️ | ||
run: | | ||
sudo apt update && sudo apt install -y --no-install-recommends ca-certificates cmake build-essential git clang llvm pkg-config autoconf automake libtool libelf-dev wget libc-ares-dev libcurl4-openssl-dev libssl-dev libtbb-dev libjq-dev libjsoncpp-dev libgrpc++-dev protobuf-compiler-grpc libgtest-dev libprotobuf-dev | ||
sudo .github/install-deps.sh | ||
- name: Build | ||
run: | | ||
mkdir -p build | ||
cd build && cmake -DUSE_BUNDLED_DEPS=False ../ | ||
make unit-test-libsinsp -j4 | ||
- name: Run Perf | ||
run: | | ||
cd build | ||
sudo perf record --call-graph dwarf ./libsinsp/test/unit-test-libsinsp | ||
- name: Archive perf report (PR) | ||
if: github.event_name == 'pull_request' | ||
uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3 | ||
with: | ||
name: perf_report | ||
retention-days: 1 # just 1 day because they are big and there can be multiple ones (ie: on each push to the PR) | ||
path: build/perf.data | ||
if-no-files-found: error | ||
|
||
- name: Archive perf report (master) | ||
if: github.event_name == 'push' | ||
uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3 | ||
with: | ||
name: perf_report | ||
retention-days: 14 # 14 days because this is the artifact on master; we need to retain it to be able to properly diff it | ||
path: build/perf.data | ||
if-no-files-found: error | ||
|
||
- name: Download latest master report | ||
if: github.event_name == 'pull_request' | ||
uses: dawidd6/action-download-artifact@v6 | ||
with: | ||
workflow: ci.yml | ||
branch: master | ||
event: push | ||
name: perf_report | ||
|
||
- name: Diff from master | ||
if: github.event_name == 'pull_request' | ||
run: | | ||
sudo perf diff perf.data build/perf.data -d unit-test-libsinsp -b -o 0 --percentage relative -q &> perf_diff.txt | ||
- name: Archive perf diff | ||
if: github.event_name == 'pull_request' | ||
uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 # v3.1.3 | ||
with: | ||
name: perf_diff | ||
path: perf_diff.txt | ||
if-no-files-found: error | ||
|
||
- name: Check > 2% threshold | ||
if: github.event_name == 'pull_request' | ||
id: compare | ||
run: | | ||
awk '{if (substr($2,RSTART+RLENGTH)+0 > 2) print }' perf_diff.txt &> perf_diff_above_thresh.txt | ||
if [ -s perf_diff_above_thresh.txt ]; then | ||
echo "comment_file=perf_diff_above_thresh.txt" >> $GITHUB_OUTPUT | ||
fi | ||
- name: Save PR info | ||
if: steps.compare.outputs.comment_file != '' | ||
run: | | ||
mkdir -p ./pr | ||
echo ${{ github.event.number }} > ./pr/NR | ||
touch ./pr/COMMENT | ||
echo "# Perf diff from master above 2% slowdown threshold" >> ./pr/COMMENT | ||
echo "\`\`\`" >> ./pr/COMMENT | ||
cat "${{ steps.compare.outputs.comment_file }}" >> ./pr/COMMENT | ||
echo "\`\`\`" >> ./pr/COMMENT | ||
echo Uploading PR info... | ||
cat ./pr/COMMENT | ||
echo "" | ||
- name: Upload PR info as artifact | ||
if: steps.compare.outputs.comment_file != '' | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: pr | ||
path: pr/ | ||
retention-days: 1 | ||
if-no-files-found: warn |