Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abhimanyu003/probe
Simplified Integration Testing Using YAML and JQ
https://github.com/abhimanyu003/probe
api-testing assertions cli contract-testing developer-tools devutils e2e-testing end-to-end-testing go golang http integration-testing rest-api-test test-automation test-framework testing testing-tools
Last synced: 3 months ago
JSON representation
Simplified Integration Testing Using YAML and JQ
- Host: GitHub
- URL: https://github.com/abhimanyu003/probe
- Owner: abhimanyu003
- License: mit
- Created: 2023-02-17T15:08:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-17T07:39:51.000Z (almost 2 years ago)
- Last Synced: 2024-06-19T23:14:25.146Z (8 months ago)
- Topics: api-testing, assertions, cli, contract-testing, developer-tools, devutils, e2e-testing, end-to-end-testing, go, golang, http, integration-testing, rest-api-test, test-automation, test-framework, testing, testing-tools
- Language: Go
- Homepage: https://abhimanyu003.github.io/probe/
- Size: 4.95 MB
- Stars: 29
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Probe
Simplified End-to-End Testing Using YAML and JQ.
**Full documentation is available on the official website: https://abhimanyu003.github.io/probe/**
## All Features
* **Cross-platform:** Runs on windows, mac and linux.
* **JQ:** Full in-built [JQ](https://stedolan.github.io/jq/) support ( no need to install JQ ).
* **Parallel:** Fast parallel testing for multiple tests
* **Multi-Stages:** Call multiple systems and services in single test.
* **Variables:** Supports env and user defined variables.
* **Setup and Teardown:** Run things beforeEach, afterEach, beforeAll, afterAll, stages.
* **Logs:** powerful logs that, dump the complete request and response content.
* **Request Builder:** Easy request builder that allows you to set:
* Allow Insecure
* Basic Auth
* Bearer Auth Token
* Body
* Form Data
* Headers
* Json
* Query Param
* Sleep
* Timeout
* User-Agent
* Upload
## Documentation
Documentation is available at [https://abhimanyu003.github.io/probe/](https://abhimanyu003.github.io/probe/)
* [Getting Started](https://abhimanyu003.github.io/probe/docs/writing-tests/overview/)
* [Asserts](https://abhimanyu003.github.io/probe/docs/writing-tests/assertions/)
* [Install](https://abhimanyu003.github.io/probe/docs/prologue/install/)
#### Tutorials and examples
* [How to Auth and Get User](https://abhimanyu003.github.io/probe/docs/examples/auth-and-get-user/)
* [How to set Form Data](https://abhimanyu003.github.io/probe/docs/examples/form-data/)
* [How to use JQ functions](https://abhimanyu003.github.io/probe/docs/examples/jq-example/)
* [How to get JSON keys using JQ](https://abhimanyu003.github.io/probe/docs/examples/json-keys/)
## :battery: Install Probe
Probe support wide variety of OS
* linux, darwin, windows
* 386, amd64, arm64
#### Auto Install
```
curl -L https://raw.githubusercontent.com/abhimanyu003/probe/main/install.sh | bash
```
*This script installs the latest release by default.*
#### Brew
```
brew install abhimanyu003/tap/probe
```
#### Scoop
```
scoop bucket add probe https://github.com/abhimanyu003/scoop-bucket.git
scoop install probe
```
#### Arch Linux
```
yay -S probe-bin
```
#### Snap
> At this point we have to alias while using snap
```
sudo snap install go-probe
sudo snap alias go-probe.probe probe
```
#### Go Install
```
go install github.com/abhimanyu003/probe@latest
```
#### Wget
Use wget to download, gzipped pre-compiled binaries.
For instance, `VERSION=v0.0.1` and `BINARY=probe_0.0.1_linux_amd64`
```
wget https://github.com/abhimanyu003/probe/releases/download/${VERSION}/${BINARY}.tar.gz -O - |\
tar xz && mv probe /usr/bin/probe
```
You can find list of binary and release over [Release Page!](https://github.com/abhimanyu003/probe/releases)
#### Manually
Download the pre-compiled binaries from the [Release!](https://github.com/abhimanyu003/probe/releases) page and copy them
to the desired location.
You can download
* DEB
* RPM
* Pre-compiled binary
Visit [Release!](https://github.com/abhimanyu003/probe/releases)
## :boom: Usages
**Full documentation is available on the official website: https://abhimanyu003.github.io/probe/**
**Quick Example**
* Create `main.yaml` file
```yaml
name: Writing Test
stages:
- name: first stage
request:
url: "https://httpbin.org/get"
method: GET
assert:
status: 200
```
* Run
```
probe run main.yaml
```
## Examples
Here are some quick example that shows how you can use probe with YAML + JQ.
This will help you get some quick idea on how you can write your API tests
#### JQ Example
```yaml
name: JQ Example
stages:
- name: get products request
request:
url: "https://dummyjson.com/products"
method: GET
assert:
status: 200
body:
- select: .products | length
want: 50
- select: .products[0].id | isnormal
want: true
- select: .products[0].images | length
want: 5
- select: .products[] | select(.title == "iPhone 9") | .id
want: 1
```
#### Form Data
```yaml
name: Form Data
stages:
- name: add product
request:
url: "https://dummyjson.com/products/add"
method: POST
headers:
Content-Type: 'application/json'
formData:
title: 'BMW Pencil'
assert:
status: 200
body:
- select: .id
want: 101
```
## Contribution
This project welcomes your PR and issues. For example, refactoring, adding features, correcting English, etc.
A quick development guide can be found on. [Developer-Guides](https://github.com/abhimanyu003/probe/wiki/Developer-Guides) wiki page.
If you need any help, you can contact me on [Twitter](https://twitter.com/abhimanyu003).
Thanks to all the people who already contributed and libraries imported in [go.mod](./go.mod)
## License
[MIT](./LICENSE)