Strest
⚡️ CI-ready tests for REST APIs configured in YAML
Install / Use
/learn @eykrehbein/StrestREADME
:link: Connect multiple requests: Example Embed an authorization token you got as a response from a login request in your following requests automatically
:memo: YAML Syntax: Write all of your tests in YAML files
:tada: Easy to understand: You'll understand the concept in seconds and be able to start instantly (seriously!)
Try it with Gitpod
Run some Tests
npm i -g @strest/cli
strest tests/success/postman.strest.yml
Getting Started in your own environment
# Via Yarn
yarn global add @strest/cli
# Via npm
npm i -g @strest/cli
# Via Docker
# The image contains everything in the tests directory
docker run -it eykrehbein/strest:latest strest tests/success/chaining/
# Bring your own test and environment
docker run -it --env STREST_URL=https://jsonplaceholder.typicode.com -v ${PWD}:/app/data eykrehbein/strest:latest strest /data/tests/success/Env/
We'll be using the postman-echo test API in this tutorial.
To get started, we're using this file (The extension needs to be .strest.yml or .strest.yaml)
version: 2 # only version at the moment
requests: # all test requests will be listed here
testRequest: # name the request however you want
request:
url: https://postman-echo.com/get # required
method: GET # required
queryString:
- name: foo1
value: bar1
- name: foo2
value: bar2
# log: true # uncomment this to log the response
To run the test, open your terminal and type
strest tests/success/postman.strest.yml
You may also run multiple test files at the same time by pointing to the directory, where the files are stored
strest tests/success/chaining
# or
strest # this will recursively search for all .strest.yml files in the cwd and it's subdirectories
Success! If you've done everything correctly, you'll get a response like this
[ Strest ] Found 4 test file(s)
[ Strest ] Schema validation: 4 of 4 file(s) passed
Executing tests in ./
✔ Testing login succeeded (0.463s)
✔ Testing verify_login succeeded (0.32s)
✔ Testing verify_login_chained succeeded (0.233s)
Executing tests in: ./var/
✔ Testing chaining_var1 succeeded (0.128s)
✔ Testing chaining_var2 succeeded (0.131s)
[ Strest ] ✨ Done in 1.337s
Writing .strest.yml test files
The examples in tests/success are used for testing this library. Read through the examples to see what is possible.
VS Code extension
Send requests directly from the yml file.
Documentation
Using & Connecting multiple requests
With traditional tools like Postman or Insomnia it's common to perform only a single request at a time. Moreover, you have to trigger each request on your own with a click on a button.
With Strest you're able to predefine a very well structured test file once, and every time you make any changes to your API you can test it with just one command in your terminal. Additionally, you can add hundreds or thousands of requests and endpoints which will run synchronously one after the other.
To create multiple requests, simply add multiple entries into the requests yaml object.
version: 2
requests:
requestOne:
...
requestTwo:
...
requestThree:
...
Running this will result in something like
[ Strest ] Found 1 test file(s)
[ Strest ] Schema validation: 1 of 1 file(s) passed
✔ Testing requestOne succeeded (0.1s)
✔ Testing requestTwo succeeded (0.32s)
✔ Testing requestThree succeeded (0.11s)
[ Strest ] ✨ Done in 0.62s
Chaining multiple requests
What is meant by chaining multiple requests?
Chaining multiple requests means that you write a request and in each of the following requests you are able to use and insert any of the data that was responded by this request.
Each reponse is stored as a dictionary for future requests to use. The format is HAR. This format is used by browsers to store request and response history.
{
"login": {
"status": 200,
"statusText": "OK",
"headers": {
"content-type": "application/json; charset=utf-8",
"date": "Mon, 12 Nov 2018 19:04:52 GMT",
"vary": "Accept-Encoding",
"content-length": "22",
"connection": "Close"
},
"content": {
"authenticated": true
}
}
}
Chaining Example
requests:
login: # will return { authenticated: true }
...
authNeeded:
request:
...
headers:
- name: Authorization
value: Bearer <$ login.content.authenticated $> # It's possible to use the status code, headers, and status text from previous calls.
As you could see, the usage is very simple. Just use <$ requestName.content.jsonKey $> to use any of the JSON data that was retrieved from a previous request. If you want to use raw data, just use <$ requestName.content $> without any keys.
You can use this syntax anywhere regardless of whether it is inside of some string like https://localhost/posts/<$ postKey.content.key $>/... or as a standalone term like Authorization: <$ login.content.token $>
This can also be used across files as demonstrated here
JsonPath
Use JsonPath to extract specific data from previous. This library is used.
version: 2
requests:
set_JsonPath:
request:
url: https://jsonplaceholder.typicode.com/posts
method: POST
postData:
mimeType: application/json
text:
firstName: John
lastName: doe
age: 26
address:
streetAddress: 'naist street'
city: Nara
postalCode: 630-0192
phoneNumbers:
- {type: iPhone, number: 0123-4567-8888}
- {type: home, number: 0123-4567-8910}
JsonPath:
request:
url: https://postman-echo.com/get
method: GET
queryString:
- name: foo
value: <$ JsonPath("set_JsonPath.content.phoneNumbers[?(@.type == \"home\")].number") $>
validate:
- jsonpath: content.args.foo
expect: 0123-4567-8910
Practice here
Using random values with Faker
If you need to generate some random values, you are able to do so by using Faker API templates.
Example - Faker
version: 2
requests:
fake:
request:
url: https://postman-echo.com/get
method: GET
queryString:
- name: first
value: <$ Faker("name.firstName") $>
- name: first_last
value: <$ Faker("name.firstName") $> <$ Faker("name.lastName") $>
log: true
Visit Faker.js Documentation for more methods
Replacing values with predefined environment variables
Example - Environment Variables
export STREST_URL=https://jsonplaceholder.typicode.com
strest tests/success/Env/environ.strest.yml
version: 2
# ensure the ENV var is set: `export STREST_URL=https://jsonplaceholder.typicode.com`
requests:
environment:
request:
url: <$ Env("STREST_URL") $>/todos/1
method: GET
Replacing values with predefined custom variables
Example - User Defined Variables
version: 2
variables: # Define variables here
testUrl: https://jsonplaceholder.typicode.com/todos/1
to_log: true
requests:
my_variable_request:
request:
url: <$ testUrl $>
method: GET
log: <$ to_log $>
Only Execute If
With Strest you can skip a response by setting a match criteria
version: 2
requests:
if_Set:
request:
url: https://jsonplaceholder.typicode.com/posts
method: POST
postData:
mimeType: application/json
text:
foo: 1
skipped:
if:
operand: <$ if_Set.content.foo $>
equals: 2
request:
url: https://jsonplaceholder.typicode.com/todos/2
method: GET
executed:
if:
operand: <$ if_Set.content.foo $>
equals: 1
request:
url: https://jsonplaceholder.typicode.com/todos/2
method: GET
Use strest file name as parameter in the tests
You can use the strest file name as a parameter in the tests .
note that the strest suffix is removed
Usage The file name for this example is postman-echo.strest.yml
version: 2
requests:
test-file-name:
request:
url: https://<$ Filename() $>.com/get
method: GET
validate:
- jsonpath: status
expect: 200
Using dates and dates format
You can insert dates times plus format them using the custom [nunjucks date filt
