Skip to content

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

Merged
vkarak merged 2 commits into
reframe-hpc:developfrom
vkarak:feat/descr-by-docstring
Nov 4, 2026
Merged

vkarak merged 2 commits 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 91.92%. Comparing base (2355c3d) to head (57595b1).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #3746      +/-   ##
===========================================
+ Coverage    91.90%   91.92%   +0.01%     
===========================================
  Files           63       63              
  Lines        13943    13950       +7     
===========================================
+ Hits         12815    12823       +8     
+ Misses        1128     1127       -1     

☔ 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.

@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
vkarak and others added 2 commits November 3, 2026 23:39
Signed-off-by: Vasileios Karakasis <vkarakasis@nvidia.com>
Signed-off-by: Vasileios Karakasis <vkarak@gmail.com>
@vkarak
vkarak force-pushed the feat/descr-by-docstring branch from 19e59a9 to 57595b1 Compare November 3, 2026 22:39

@victorusu victorusu left a comment

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.

lgtm

@github-project-automation github-project-automation Bot moved this from Todo to In Progress in ReFrame Backlog Nov 4, 2026
@vkarak
vkarak merged commit aefaf91 into reframe-hpc:develop Nov 4, 2026
33 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in ReFrame Backlog Nov 4, 2026
@vkarak
vkarak deleted the feat/descr-by-docstring branch November 4, 2026 18:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

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

2 participants