Skip to content

[feat] Set test description from test class' docstring - #3746

Open
vkarak wants to merge 1 commit into
reframe-hpc:developfrom
vkarak:feat/descr-by-docstring
Open

vkarak wants to merge 1 commit into
reframe-hpc:developfrom
vkarak:feat/descr-by-docstring

Conversation

@vkarak

@vkarak vkarak commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

The test's description is now set automatically to the test class' docstring upon registration with the @simple_test decorator. The docstrings of user-defined RegressionTest-based classes are inherited, but never the docstring of these builtins. Also, a docstring will never default to that of an inherited plugin.

Closes #3686.

Todos

  • Update the docs
  • Extend unit tests to cover the case where descr is set by a test

@vkarak vkarak added this to the ReFrame 4.11 milestone Oct 24, 2026
@vkarak
vkarak requested review from ekouts and victorusu October 24, 2026 15:47
@vkarak vkarak self-assigned this Oct 24, 2026
@vkarak
vkarak marked this pull request as draft October 24, 2026 15:47
@codecov

codecov Bot commented Oct 24, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 32.27%. Comparing base (fa567a8) to head (3c63e10).

❗ There is a different number of reports uploaded between BASE (fa567a8) and HEAD (3c63e10). Click for more details.

HEAD has 14 uploads less than BASE
Flag BASE (fa567a8) HEAD (3c63e10)
18 4
Additional details and impacted files
@@             Coverage Diff              @@
##           develop    #3746       +/-   ##
============================================
- Coverage    91.90%   32.27%   -59.63%     
============================================
  Files           62       62               
  Lines        13927    13934        +7     
============================================
- Hits         12799     4497     -8302     
- Misses        1128     9437     +8309     

☔ View full report in Codecov by Harness.
📢 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.

Signed-off-by: Vasileios Karakasis <vkarakasis@nvidia.com>
@vkarak
vkarak force-pushed the feat/descr-by-docstring branch from 9c24d7e to 3c63e10 Compare October 24, 2026 16:08
@vkarak
vkarak marked this pull request as ready for review October 24, 2026 16:09

This branch has not been deployed

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

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

Automatically set the test's description by test's docstring

1 participant