Skip to content

Add tests for serial and static backend#3004

Draft
vchuravy wants to merge 3 commits into
mainfrom
vc/test_for_backends
Draft

Add tests for serial and static backend#3004
vchuravy wants to merge 3 commits into
mainfrom
vc/test_for_backends

Conversation

@vchuravy
Copy link
Copy Markdown
Member

@vchuravy vchuravy commented May 7, 2026

Given that we are adding some more backend specific behavior (as an example #3003),
we should have some smoke tests for the different backends

  • Add serial and Threads.@threads backend tests
  • Add serial and threads CI jobs
  • Fix test_serial and test_threads: mkpath outdir, higher alloc limits for static

vchuravy and others added 3 commits May 7, 2026 22:33
Follows the same pattern as test_kernelabstractions.jl: sets the backend preference,
relaunches Julia so the @static dispatch in @threaded compiles with the new backend,
runs a basic advection and Euler test to confirm correctness, then restores the original backend.

The serial test uses exact reference values; the static (Threads.@threads) test uses rtol=0.001
to allow for non-deterministic floating-point ordering across threads.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…for static

The euler example needs the out/ directory to exist before saving restart files.
Threads.@threads :static allocates ~20-32KB per rhs! call (vs ~0 for Polyester @Batch),
so use per-backend allocation thresholds rather than the Polyester-tuned 5000 limit.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 7, 2026

Review checklist

This checklist is meant to assist creators of PRs (to let them know what reviewers will typically look for) and reviewers (to guide them in a structured review process). Items do not need to be checked explicitly for a PR to be eligible for merging.

Purpose and scope

  • The PR has a single goal that is clear from the PR title and/or description.
  • All code changes represent a single set of modifications that logically belong together.
  • No more than 500 lines of code are changed or there is no obvious way to split the PR into multiple PRs.

Code quality

  • The code can be understood easily.
  • Newly introduced names for variables etc. are self-descriptive and consistent with existing naming conventions.
  • There are no redundancies that can be removed by simple modularization/refactoring.
  • There are no leftover debug statements or commented code sections.
  • The code adheres to our conventions and style guide, and to the Julia guidelines.

Documentation

  • New functions and types are documented with a docstring or top-level comment.
  • Relevant publications are referenced in docstrings (see example for formatting).
  • Inline comments are used to document longer or unusual code sections.
  • Comments describe intent ("why?") and not just functionality ("what?").
  • If the PR introduces a significant change or new feature, it is documented in NEWS.md with its PR number.

Testing

  • The PR passes all tests.
  • New or modified lines of code are covered by tests.
  • New or modified tests run in less then 10 seconds.

Performance

  • There are no type instabilities or memory allocations in performance-critical parts.
  • If the PR intent is to improve performance, before/after time measurements are posted in the PR.

Verification

  • The correctness of the code was verified using appropriate tests.
  • If new equations/methods are added, a convergence test has been run and the results
    are posted in the PR.

Created with ❤️ by the Trixi.jl community.

Comment thread test/test_serial.jl
# (e.g., from type instabilities)
@test_allocations(Trixi.rhs!, semi, sol, 5000)
end

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[JuliaFormatter] reported by reviewdog 🐶

Suggested change

Comment thread test/test_threads.jl
# Threads.@threads :static has more overhead than Polyester's @batch
@test_allocations(Trixi.rhs!, semi, sol, 50_000)
end

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

[JuliaFormatter] reported by reviewdog 🐶

Suggested change

@codecov
Copy link
Copy Markdown

codecov Bot commented May 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.13%. Comparing base (bb36217) to head (9cb0c24).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3004   +/-   ##
=======================================
  Coverage   97.13%   97.13%           
=======================================
  Files         625      625           
  Lines       48514    48516    +2     
=======================================
+ Hits        47122    47124    +2     
  Misses       1392     1392           
Flag Coverage Δ
unittests 97.13% <ø> (+<0.01%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

Comment thread .github/workflows/ci.yml
Comment on lines +89 to +90
- serial
- threads
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Can we find a bit more descriptive name for it, e.g., base_threads or so?

Copy link
Copy Markdown
Member

@ranocha ranocha left a comment

Choose a reason for hiding this comment

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

Thanks, that's a good idea. Since we will likely not need many tests in here, could it be an option to use a single additional CI job for both cases to reduce overhead from installing Trixi.jl etc.?
Did you make sure to include at least

  • one elixir without manual threading for the ODE solver,
  • one elixir with manual threading for the ODE solver,
  • and one elixir with a Trixi.jl-internal time integrator?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants