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

Documentation and critical functional issues #806

Open
alekdavis opened this issue Oct 9, 2024 · 1 comment
Open

Documentation and critical functional issues #806

alekdavis opened this issue Oct 9, 2024 · 1 comment

Comments

@alekdavis
Copy link

alekdavis commented Oct 9, 2024

Just started looking at the CLI usage and want to report a couple of issues (mostly about the documentation page but also about functionality):

  • There are no examples of the CLI usage. The Example section, shows the test/request example, but it does not have any examples of the actual CLI usage (the examples and guide links in this section also do not point to any CLI examples, although if you scroll down the guide post, which is titled Overview and click the CLI link at the bottom of the post, then you can find a some basic examples). It would be nice to have more and easier to find examples of the CLI usage.
  • What does the --quiet flag mean? (Shouldn't there be a -q shortcut?)
  • How do you pass multiple values to a command-line switch? I think you just need to separate them by spaces, but it's not covered and I did not find any examples. It would be nice to have it cleared.
  • It looks like when you do not pass any parameter to the -o or --output-failed switches it will output everything, but it would be nice if this were documented (I had to try it to make sure).
  • It would be nice to have the counters of skipped (and maybe disabled, but disabled are not important) tests in the summary.
  • Counters in the JUNIT output do not make much sense (or maybe I'm not reading them correctly).

THIS ONE IS CRITICAL:

  • The conditional cancelation logic does not work. If I run tests in a file with the -a switch (meaning to run all tests, except explicitly disabled via @disabled), then if any test is cancelled (via $cancel), then it will not execute any other tests after the first encountered cancellation condition, not even the tests with no dependencies).

Overall, the CLI looks pretty good.

@alekdavis alekdavis changed the title Documentation issues Documentation and critical functional issues Oct 9, 2024
@alekdavis
Copy link
Author

I created a separate issue to track the $cancel CLI logic bug here *since it is a critical bug, unlike docs): #808

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

No branches or pull requests

1 participant