-
-
Notifications
You must be signed in to change notification settings - Fork 197
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: adding a testing infos file to guide everyone through tests
- Loading branch information
1 parent
ef3c90d
commit fbcace1
Showing
2 changed files
with
34 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Testing eza | ||
|
||
## Running tests | ||
|
||
In order to run the tests in eza you need: | ||
- [just](https://github.com/casey/just) | ||
- [nix](https://nixos.org) | ||
|
||
then either run: | ||
- `just itest` | ||
- `nix build -L trycmd-local` | ||
|
||
## Modifying tests | ||
|
||
In order to test your changes on eza, you will need to do one or multiple things in different cases. | ||
You will need the additional tool | ||
- [powertest](https://github.com/eza-community/powertest) | ||
|
||
You will also need to modify the `devtools/dir-generator.sh` file if you want to add some test cases | ||
|
||
### You added/modified an option | ||
|
||
Please run `just regen` to regenerate powertesting. Then look into `tests/gen` or `tests/cmd` for any tests not passing | ||
|
||
### You changed the output of eza | ||
|
||
Please run `nix build -L trydump` or `just idump` | ||
And lookout for any test no longer passing |