Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add TipsPlugin to provide helpful tips #105

Merged
merged 4 commits into from
Jan 16, 2025
Merged

Add TipsPlugin to provide helpful tips #105

merged 4 commits into from
Jan 16, 2025

Conversation

tsv1
Copy link
Member

@tsv1 tsv1 commented Oct 7, 2024

This PR introduces the TipAdviserPlugin, which enhances the user experience by analyzing command-line arguments to provide actionable tips for optimizing test execution.

Key Features:

  • The plugin generates helpful tips based on command-line arguments like --repeats, --fail-fast, and --fixed-seed.
  • Tips are displayed in the summary report after test execution, offering guidance on improving testing practices.
  • The plugin behavior is controlled through the TipAdviser configuration class, with an option to enable or disable tips (show_tips).

Plugin Highlights:

  • Encourages best practices, such as using --fixed-seed for consistent results in repeated test runs or enabling --fail-fast-on-repeat for faster feedback in failing scenarios.
  • Easily disabled via the vedro plugin disable vedro.plugins.tip_adviser command.

Copy link

codecov bot commented Oct 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.90%. Comparing base (8a0479e) to head (ebfe080).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #105      +/-   ##
==========================================
+ Coverage   90.82%   90.90%   +0.07%     
==========================================
  Files         168      170       +2     
  Lines        4874     4914      +40     
  Branches      701      706       +5     
==========================================
+ Hits         4427     4467      +40     
  Misses        387      387              
  Partials       60       60              

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

@tsv1 tsv1 changed the base branch from master to main January 3, 2025 19:01
@tsv1 tsv1 changed the title add TipsPlugin to provide helpful tips Add TipsPlugin to provide helpful tips Jan 7, 2025
@tsv1 tsv1 marked this pull request as ready for review January 16, 2025 18:48
@tsv1 tsv1 merged commit 72c70a1 into main Jan 16, 2025
6 checks passed
@tsv1 tsv1 deleted the tips-plugin branch January 16, 2025 18:48
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.

1 participant