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.

Sign up for GitHub

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

Jump to bottom

Document unit test name matching and improve unittest names (Version: [2.0.x]) #4800

Closed
ximinez opened this issue Nov 3, 2023 · 1 comment · Fixed by #4846
Closed

Document unit test name matching and improve unittest names (Version: [2.0.x]) #4800

ximinez opened this issue Nov 3, 2023 · 1 comment · Fixed by #4846
Labels
Feature Request Used to indicate requests to add new features Good First Issue Great issue for a new contributor

Comments

@ximinez
Copy link
Collaborator

ximinez commented Nov 3, 2023

Summary

Follow up to #4634:

  • Document the new unit test name matching behavior in the command line options summary for -u (rippled --help).
    • The provided argument (if any) will be matched against the beginning of the test name.
    • If there is an exact match, no other matching will be done with that name.
  • Where reasonable, rename the split unit test suites from using arbitrary numbers (e.g. Offer0, Offer1, Offer2, etc.) to something more descriptive. (e.g. OfferWFlowCross, OfferWOFlowCross, OfferAllFeatures). All the names must have something after the "base" name to avoid an exact match. (e.g. Don't name any of the examples Offer.)

Motivation

The motivation is to assist developers working on rippled to run unit tests more effectively.

Paths Not Taken

The current naming convention (using numbers) works fine, but isn't as user friendly as it could be.
@ximinez ximinez added Good First Issue Great issue for a new contributor Feature Request Used to indicate requests to add new features labels Nov 3, 2023
@intelliot
Copy link
Collaborator

In addition to --help, it may be helpful to mention the name matching functionality in CONTRIBUTING.md... maybe something along these lines

@ckeshava ckeshava mentioned this issue Dec 6, 2023
Merged
8 tasks
intelliot pushed a commit that referenced this issue Jan 20, 2024
@ckeshava
docs: update help message about unit test-suite pattern matching (#4846)
efe6722 
Update the "rippled --help" message for the "-u" parameter. This
documents the unit test name pattern matching rule implemented by #4634.

Fix #4800
sophiax851 pushed a commit to sophiax851/rippled that referenced this issue Jun 12, 2024
@ckeshava @sophiax851
docs: update help message about unit test-suite pattern matching (XRP…
908c2a0 
…LF#4846)

Update the "rippled --help" message for the "-u" parameter. This
documents the unit test name pattern matching rule implemented by XRPLF#4634.

Fix XRPLF#4800
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Feature Request Used to indicate requests to add new features Good First Issue Great issue for a new contributor
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update help message about unit test-suite pattern matching ckeshava/rippled
2 participants
@intelliot @ximinez