https://github.com/jesselawson/tasty
A TOML-based API test runner for web services.
https://github.com/jesselawson/tasty
Last synced: 3 months ago
JSON representation
A TOML-based API test runner for web services.
- Host: GitHub
- URL: https://github.com/jesselawson/tasty
- Owner: jesselawson
- License: gpl-3.0
- Created: 2025-02-22T19:11:59.000Z (3 months ago)
- Default Branch: trunk
- Last Pushed: 2025-02-23T06:47:33.000Z (3 months ago)
- Last Synced: 2025-02-23T07:29:31.924Z (3 months ago)
- Language: Rust
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# tasty! 🍰
**Tasty** is a command-line tool that runs API tests defined and grouped in TOML files.
## Status and Roadmap
Tasty is being built as a replacement for my bash scripts that I use for API testing.
As I migrate features into Tasty, I'll release updates to this project. All releases will be backwards-compatible.
The next update will be something from the [Future Improvements](#future-improvements) section below, most likely a way to pass an authentication token between tests (e.g., a text fixtures preamble in the testing files). If you have an idea or request, please don't hesitate to open up an issue and start a conversation.
Right now, Tasty expects that you're working with the `application/json` content type only.
## Installation
### Install with cargo
```bash
cargo install tasty
```
### Build from source
```bash
git clone https://github.com/jesselawson/tasty.git
cd tasty
cargo build --release
```
## Usage
```
$ tasty --help
Tasty, the API server testing tool
Usage: tasty [OPTIONS] [URL] [TESTS]...
Arguments:
[URL] Base URL for the API (defaults to http://127.0.0.1:3030)
[TESTS]... Specific test files to run
Options:
-t, --tests-folder Custom tests folder path
-g, --global-timeout Global timeout in seconds [default: 30]
-j, --json Output results as JSON (Not implemented yet)
-h, --help Print help
-V, --version Print version
```
### Examples
Run all *.toml test files in your current working directory's
`/api_tests` folder against `http://localhost:3030`:
```bash
tasty
```
---
Run all *.toml test files in your current working directory's
`/examples` folder against `http://localhost:3030`:
```bash
tasty -t examples
```
---
Run all *.toml test files in your current working directory's
`/examples` folder against `https://api.example.com`:
```bash
tasty -t examples http://api.example.com
```
---
Run just the `user_auth` test file in your current working
directory's `/api_tests` folder against `https://api.example.com`:
```bash
tasty -t api_tests https://api.example.com user_auth
```
---
Run the `user_signup` and `auth_flow` test files in your current working
directory's `/api_tests` folder against `http://staging-api.example.com`:
```bash
tasty http://staging-api.example.com user_signup auth_flow
```
## Writing Tests
Tests are defined in and grouped by TOML files. If you have a
TOML file named `user_signup.toml`, all the tests in side that file
can be invoked with Tasty by passing it as a command-line argument.
Each test file can contain multiple test cases. Here's an example
of a file with a single test case:
```toml
# user_signup.toml
[accept_valid_signup]
method = "POST"
route = "auth/signup"
payload = { email = "[email protected]", password = "This is a Valid Password!@t%" }
expect_http_status = 200
expect_response_includes = { status = "ok" }
```
### Test File Syntax
Test files have the following properties that MUST be present
in each table:
* `name` _(Optional)_ The table key is the name of the test in the output report,
but you can use this field if you'd like your table keys to be different from
your test names. You might want this if you prefer the table keys in your TOML
files to be organized differently than by the name of each test.
* `method` The HTTP method to be used in the request
* `route` The route to send the request to, not including the base URL
* `payload` A TOML table that includes the request data
* `expect_http_status` The integer HTTP response code that indicates a passing test
* `expect_response_includes` _(Optional)_ One or more properties that MUST be present in the response payload
## Participating & Contributing
Contributions are welcome and encouraged. Please feel free to submit a Pull Request.
For major changes, please open an issue first to discuss what you would like to change.
### Future Improvements
While `tasty` is already useful for my purposes in its current form, I am open to
backwards-compatible enhancements that include (but are not limited to):
- passing response values (like a a JWT) from one test to another
- optional json output of test results
- parallel test execution
- test dependencies and ordering
- response schema validation
- custom test reporters
- environment variable substitution
- request/response logging
## License
This project is licensed under the GNU General Public License version 3. See
the [LICENSE](LICENSE) file for details.
## Lore
The name `tasty!` comes from the English translation of the Japanese word "umai".
As I was building an API server, I found myself digging into a particularly
complex puzzle that involved asynchronous code and mutexes. At one point I was
making changes in one window and running my tests in another window, and as each
test completed I was saying _"delicious!"_. I'm not really sure why, but stay
with me. So in the Japanese manga series _Kimetsu no Yaiba_ ("Demon Slayer"),
there's a character named Rengoku who the protagonists find eating food and saying "umai!"
after each bite. (There's a whole backstory behind why he says this after each bite of
food, which I will not get into here). So I was running these tests and reminding
myself of Rengoku as he was saying "tasty!" after each bite. And thus, _tasty_ was born.
## Changelog
### 0.9.3
* Stops testing if it can't reach the API server on the first test.
### 0.9.2
* Corrected erroneous field name in readme
* Added debug flag (`-d` or `--debug`) for the curious (and/or suspicious).