schmokin

A wrapper for curl providing chainable assertions to create simple but powerful smoke tests all written in bash

install . . .

curl -Ls https://github.com/reaandrew/schmokin/releases/latest/download/schmokin_install | bash

use . . .

schmokin <url> [schmokin-args] -- [curl-args]

Simple set of assertions

flag	description
--eq	equals
--gt	greater than
--ge	greater than or equals
--lt	less than
--le	less than or equals
--co	contains

Simple set of extractors

flag	description
--jq	JQ expression
--req-header	HTTP Request Header
--res-header	HTTP Response Header
--res-body	HTTP Response Body
--status	HTTP Status

Utilities

flag	description
--export	Export extracted variable
--debug	Show verbose curl output

Simple set of metrics

All the metrics which curl offers with the -w argument are available

--content_type

--filename_effective

--ftp_entry_path

--http_code

--http_connect

--local_ip

--local_port

--num_connects

--num_redirects

--redirect_url

--remote_ip

--remote_port

--size_download

--size_header

--size_request

--size_upload

--speed_download

--speed_upload

--ssl_verify_result

--time_appconnect

--time_connect

--time_namelookup

--time_pretransfer

--time_redirect

--time_starttransfer

--time_total

--url_effective

Uses JQ under the hood for JSON extraction

./schmokin $URL --jq '.status' --eq "UP"

Shiny output

Adds to existing curl capabilities

Any extra curl arguments can be placed after the -- separator.

./schmokin $URL --req-header "X-FU" --eq 'BAR' -- -H "X-FU: BAR"

Examples

Assert on HTTP status

schmokin $URL --status -eq 200

Equals Assertion

schmokin $URL --jq '.status' --eq "UP"

Greater Than Assertion

schmokin $URL --jq '. | length' --gt 4

Greater Than or Equals Assertion

schmokin $URL --jq '. | length' --ge 6

Less Than Assertion

schmokin $URL --jq '. | length' --lt 4

Less Than or Equals Assertion

schmokin $URL --jq '. | length' --le 6

Range Assertions

schmokin $ENDPOINT/created --status --gt 200 --lt 202

Request Header Extractor

schmokin $URL --req-header "X-FU" --eq 'BAR' -- -H "X-FU: BAR"

Response Header Extractor

schmokin $URL --res-header "Content-Type" --eq 'application/json'

Response Body Extractor

schmokin $URL --res-body --eq 'UP' -- -X POST -d 'UP'

JQ Extractor

schmokin $URL --jq '.status' --eq "UP"

Export Utility

# Store the status message of the application in a variable named appStatus
schmokin $ENDPOINT/simple --jq '.status' --export appStatus 

# Post the appStatus value and assert on the value
schmokin $ENDPOINT/echo --jq '.message' --eq 'UP' -- -X POST -d '{\"message\":\"$appStatus\"}'