Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alepez/provola
A tool for quick development/test cycle in any language
https://github.com/alepez/provola
rust tdd test-automation testing-tools
Last synced: 29 days ago
JSON representation
A tool for quick development/test cycle in any language
- Host: GitHub
- URL: https://github.com/alepez/provola
- Owner: alepez
- License: apache-2.0
- Created: 2021-11-26T18:03:26.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-21T23:01:40.000Z (about 2 years ago)
- Last Synced: 2024-05-30T01:21:21.071Z (7 months ago)
- Topics: rust, tdd, test-automation, testing-tools
- Language: Rust
- Homepage:
- Size: 752 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Provola
> ~~Test it!~~ → ~~Provalo!~~ → Provola!
`provola` is your best ~~cheese~~ friend when you need to test code quickly.
## Input/Output test
Just create an *input* file, an *expected output* file and a program to digest
the input and `provola` will test your program automatically whenever you change
the code.
```shell
# Create a simple haskell program
echo 'main = interact reverse' > reverse.hs
# An input for your nice program
echo -n abcd > in.txt
# The expected output
echo -n dcba > out.txt
# Run provola!
provola -i in.txt -o out.txt -s reverse.hs -w .
```
Where:
- `-i` is the input file
- `-o` is the expected output file
- `-s` is the source code
- `-w` is the file or directory to watch for changes
### Supported languages
| Language | Build | Run |
|------------|-------------|----------|
| Bash | / | ✓ |
| C++ | `gcc` | ✓ |
| C | `gcc` | ✓ |
| Haskell | `stack ghc` | ✓ |
| JavaScript | | ✓ `node` |
| PHP | | ✓ |
| Python | | ✓ |
| Rust | `rustc` | ✓ |
## Test frameworks
`provola` is able to use test runners generated by popular test frameworks.
Example:
```shell
provola -T GoogleTest -t path/to/gtest/executable
```
Where:
- `-T` is the test runner type (e.g.: GoogleTest, Catch2, ...)
- `-t` is the executable to run
You don't need to specify what files to watch, because in this case `provola` is
automatically watching changes in the test runner (not the sources!).
You can also find an example of GoogleTest runner inside
`provola-googletest/examples/data/`
This is a (work in progress) list of supported frameworks:
| Framework | Language |
|-------------|----------|
| Google Test | C++ |
| Catch2 | C++ |
## Install
If you have a rust toolchain, just clone this project and from the root
directory:
```shell
cargo install --path .
```
`egui` feature, which provides a GUI, is enabled by default. You can disable it:
```shell
cargo install --no-default-features --path .
```
### Arch Linux
You can install [the `provola` package](https://aur.archlinux.org/packages/provola/) from aur:
```shell
yay -S provola
```
## Shell auto completion
`provola` provides shell autocompletion for even faster usage.
You can install autocompletion for yout favourite shell:
```shell
provola --shell-compl zsh > ~/.zfunc/_provola
```