Skip to content

Conversation

@LHT129
Copy link
Collaborator

@LHT129 LHT129 commented Nov 26, 2025

Summary by Sourcery

Add CI jobs to run ASan-instrumented example binaries on both x86 and AArch64 builds.

CI:

  • Add ASan-based example test job for x86 artifacts in the asan_build_and_test workflow.
  • Add ASan-based example test job for AArch64 artifacts in the asan_build_and_test workflow.

@LHT129 LHT129 requested a review from inabao November 26, 2025 08:34
@LHT129 LHT129 self-assigned this Nov 26, 2025
@LHT129 LHT129 added the kind/improvement Code improvements (variable/function renaming, refactoring, etc. ) label Nov 26, 2025
@LHT129 LHT129 requested a review from wxyucs as a code owner November 26, 2025 08:34
@gemini-code-assist
Copy link

Note

Gemini is unable to generate a summary for this pull request due to the file types involved not being currently supported.

@sourcery-ai
Copy link

sourcery-ai bot commented Nov 26, 2025

Reviewer's Guide

Adds two new CI jobs to run ASan-instrumented example binaries for x86 and AArch64 artifacts in the GitHub Actions workflow.

File-Level Changes

Change Details Files
Add ASan example test job for x86 artifacts in CI.
  • Define new job that depends on the existing x86 ASan build job
  • Run on ubuntu-22.04 runner and free disk space before execution
  • Check out repository and clean any existing build directory
  • Download x86 ASan test artifact into ./build using the GitHub run ID
  • Iterate over all files in ./build/examples/cpp, make them executable, and run each binary
.github/workflows/asan_build_and_test.yml
Add ASan example test job for AArch64 artifacts in CI.
  • Define new job that depends on the existing AArch64 ASan build job
  • Run on ubuntu-22.04-arm runner and free disk space before execution
  • Check out repository and clean any existing build directory
  • Download AArch64 ASan test artifact into ./build using the GitHub run ID
  • Iterate over all files in ./build/examples/cpp, make them executable, and run each binary
.github/workflows/asan_build_and_test.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • The for example in ./*; do loop will iterate over directories and non-binaries as well; consider restricting to regular files (e.g. via find . -maxdepth 1 -type f -executable) and quoting $example to avoid issues with spaces or non-executable entries.
  • The test_example_x86 and test_example_aarch64 jobs are nearly identical; consider factoring the common steps into a matrix job or a reusable workflow to reduce duplication and keep the two architectures in sync more easily.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The `for example in ./*; do` loop will iterate over directories and non-binaries as well; consider restricting to regular files (e.g. via `find . -maxdepth 1 -type f -executable`) and quoting `$example` to avoid issues with spaces or non-executable entries.
- The `test_example_x86` and `test_example_aarch64` jobs are nearly identical; consider factoring the common steps into a matrix job or a reusable workflow to reduce duplication and keep the two architectures in sync more easily.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Nov 26, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@            Coverage Diff             @@
##             main    #1381      +/-   ##
==========================================
- Coverage   91.66%   91.66%   -0.01%     
==========================================
  Files         325      325              
  Lines       18630    18569      -61     
==========================================
- Hits        17077    17021      -56     
+ Misses       1553     1548       -5     
Flag Coverage Δ
cpp 91.66% <ø> (-0.01%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
common 85.70% <ø> (+0.18%) ⬆️
datacell 93.51% <ø> (+0.19%) ⬆️
index 90.90% <ø> (-0.03%) ⬇️
simd 100.00% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4b45778...9121ff6. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@LHT129 LHT129 force-pushed the example_ci branch 3 times, most recently from 2b39345 to 982bf3d Compare November 28, 2025 07:28
@LHT129 LHT129 requested a review from jiaweizone as a code owner November 28, 2025 07:28
Copy link
Collaborator

@wxyucs wxyucs left a comment

Choose a reason for hiding this comment

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

lgtm

@pull-request-size pull-request-size bot added size/L and removed size/M labels Dec 1, 2025
@LHT129 LHT129 force-pushed the example_ci branch 2 times, most recently from 4bb9e53 to 9cd23b0 Compare December 2, 2025 06:20
@LHT129 LHT129 force-pushed the example_ci branch 3 times, most recently from cf4521c to 223e070 Compare December 15, 2025 06:17
@LHT129 LHT129 force-pushed the example_ci branch 2 times, most recently from b2dfd30 to 607c521 Compare December 24, 2025 04:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/improvement Code improvements (variable/function renaming, refactoring, etc. ) module/example size/L version/0.18

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants