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

CLI --seed without value and files argument is counterintuitive #1691

Closed
Krinkle opened this issue May 1, 2022 · 1 comment · Fixed by #1800
Closed

CLI --seed without value and files argument is counterintuitive #1691

Krinkle opened this issue May 1, 2022 · 1 comment · Fixed by #1800
Assignees
@Krinkle
Labels
Component: CLI Type: Enhancement New idea or feature request.
Milestone
3.0 release

Comments

@Krinkle
Copy link
Member

Krinkle commented May 1, 2022 

Usage: qunit [options] [files]

[…]

Options:
  --seed [value]         specify a seed to re-order your tests;
                         if specified without a value, a seed will be generated
  […]

When using qunit --seed it will default to running test/**.js and will print the randomly selected seed for future re-use. This works as expected:

$ qunit --seed
Running tests with seed: 3vjdr2nhlga
TAP version 13
ok 1 Single > has a test
1..1
# pass 1
# skip 0
# todo 0
# fail 0

The problem is, when using a files argument, the command becomes ambiguous and it naturally becomes the value for the seed instead:

$ qunit --seed test/single.js
Running tests with seed: test/single.js
[…]

This can be worked around currently by using -- to mark the end of the options and the start of the arguments:

$ qunit --seed -- test/single.js 
Running tests with seed: 3vjdr2nhlga
TAP version 13
ok 1 Single > has a test
1..1
# pass 1
# skip 0
# todo 0
# fail 0
@Krinkle Krinkle added Type: Enhancement New idea or feature request. Component: CLI labels May 1, 2022
@Krinkle
Copy link
Member Author

Krinkle commented Sep 8, 2024 •
edited
Loading

Strawman proposal:

  • In QUnit 3.0, reserve "new" and "true" as special seed values that result in a new random seed being used each time. This means --seed=new and --seed=true will no longer be treated as actual seeds but instead as instruction to generate a new seed. I think this will be more intuitive than introducing a separate option like --newseed, and keeps the diferent interfaces (preconfig, config, URL param, CLI option) more in line with each other.
  • In the HTML Reporter and TAP Reporter, present these to users to help reproduce a specific failure.

Alternatives I considered:

  • Introduce --newseed CLI option (along with ?newseed parameter, and QUnit.config.newseed = true). This will instruct QUnit to generate a new seed, and assign it to QUnit.config.seed. This can be backported to QUnit 2.x to ease the transition and allow for forward-compatible adoption.
  • In QUnit 3.0, change --seed CLI option to require a value, thus qunit --seed and qunit --seed -- test/ would fail due to a missing option value.

@Krinkle Krinkle added this to the 3.0 release milestone Sep 8, 2024
Krinkle added a commit to Krinkle/qunit that referenced this issue Sep 16, 2024
@Krinkle
CLI: Add --seed=true to generate a new seed
1345241 
Fixes qunitjs#1691.
@Krinkle Krinkle self-assigned this Sep 16, 2024
@Krinkle Krinkle mentioned this issue Sep 16, 2024
Merged
Krinkle added a commit to Krinkle/qunit that referenced this issue Sep 16, 2024
@Krinkle
CLI: Add --seed=true to generate a new seed
97614bb 
Fixes qunitjs#1691.
Krinkle added a commit to Krinkle/qunit that referenced this issue Sep 16, 2024
@Krinkle
CLI: Add --seed=true to generate a new seed
390a5b7 
Fixes qunitjs#1691.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Krinkle Krinkle

Labels
Component: CLI Type: Enhancement New idea or feature request.
Milestone
3.0 release
Development

Successfully merging a pull request may close this issue.

CLI: Add --seed=true to generate a new seed Krinkle/qunit
1 participant
@Krinkle