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

Wrap sqlness runner with Clap #2380

Closed
waynexia opened this issue Sep 13, 2023 · 8 comments
Closed

Wrap sqlness runner with Clap #2380

waynexia opened this issue Sep 13, 2023 · 8 comments
Assignees
Labels
C-feature Category Features good first issue Good for newcomers
Milestone

Comments

@waynexia
Copy link
Member

What problem does the new feature solve?

our sqlness runner cargo sqlness only has a very rough cli interface, which is hard to use and understand

What does the feature do?

Wrap a clip parser to the binary. And expose more sqlness configs https://docs.rs/sqlness/latest/sqlness/struct.Config.html#structfield.test_filter

Implementation challenges

No response

@waynexia waynexia added C-feature Category Features good first issue Good for newcomers labels Sep 13, 2023
@WenyXu
Copy link
Member

WenyXu commented Sep 13, 2023

@waynexia
Copy link
Member Author

https://docs.greptime.com/developer-guide/tests/sqlness-test#run-a-specific-test Does this not work?

It works, but we don't provide a help command to tell how to use it. And this is the only sqlness option we supported at present

@Lilit0x
Copy link
Contributor

Lilit0x commented Sep 13, 2023

Hi @waynexia , I'd like to work on this improvement.
Below is a rough outline of what I will do to improve the interface with Clap.

  • First, adding a help message using the description and adding usage examples
  • Some worthy sqlness configurations that I think will be really helpful
    • fail-fast
    • env_config_file : Specifying a custom config file
    • result_extension: Because .res is also a valid result extension

Thanks you.

@waynexia
Copy link
Member Author

Thanks for your enthusiasm!

Some worthy sqlness configurations that I think will be really helpful

👍 For result_extension, it's not likely to change as all the result files are tracked with git and have a fixed extension name.

@Lilit0x
Copy link
Contributor

Lilit0x commented Sep 14, 2023

Hi there, just to confirm again, the binary in the sqlness crate is sqlness-cli, right?
https://github.com/CeresDB/sqlness/tree/main/sqlness-cli

@waynexia
Copy link
Member Author

Nope, sqlness itself is a crate (with its own cli, but we don't use this). We build our runnable on top of the lib sqlness. You can find it in tests/runner/Cargo.toml.

@Lilit0x
Copy link
Contributor

Lilit0x commented Sep 14, 2023

Ohh, okay.
Found it. Thanks

@evenyag
Copy link
Contributor

evenyag commented Sep 17, 2023

Closed by #2400

@evenyag evenyag closed this as completed Sep 17, 2023
@killme2008 killme2008 added this to the v0.4 milestone Sep 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-feature Category Features good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

5 participants