A minimal smoke testing framework in Bash.
Features:
- Response body checks
- Response code checks
- Response header checks
- GET/POST on endpoints
- CSRF tokens
- Reporting and sane exit codes
Checking if the Google Search home page works and contains the word "search":
#!/bin/bash
. smoke.sh
smoke_url_ok "http://google.com/"
smoke_assert_body "search"
smoke_reportRunning:
$ ./smoke-google
> http://google.com/
[ OK ] 2xx Response code
[ OK ] Body contains "search"
OK (2/2)For a more advanced and complete example, see below.
The recommended setup includes copying the smoke.sh file in the appropriate
place and creating a new file in the same directory that you will write your
tests in.
$ tree -n
.
├── smoke-google
└── smoke.sh
In your file containing the tests, start with sourcing the smoke.sh file and
end with calling smoke_report if you want a final report + appropriate exit
code.
#!/bin/bash
. smoke.sh
# your test assertions go here
smoke_reportThe minimal smoke test will check if a URL returns with a 200 response code:
smoke_url_ok "http://google.com"A more advanced smoke test will POST data to a URL. Such a test can be used to for example check if the login form is functional:
smoke_form_ok "http://example.org/login" path/to/postdataAnd the POST data (path/to/postdata):
username=smoke&password=test
By checking if the response body contains certain strings you can rule out that
your server is serving a 200 OK, which seems fine, while it is actually
serving the apache default page:
smoke_assert_body "Password *"By checking response headers, you can make sure to get the correct content type:
smoke_assert_headers "Content-Type: text/html; charset=utf-8"It is possible to setup a base URL that is prepended for each URL that is requested.
smoke_url_prefix "http://example.org"
smoke_url_ok "/"
smoke_url_ok "/login"If the server requires a certain host header to be set, override the host from the URL with
smoke_host "example.org"
To un-override, set it empty:
smoke_host ""
It's possible to set additional request headers, like X-Forwarded-Proto for local tests.
smoke_header "X-Forwarded-Host: orginal.example.org"
smoke_header "X-Forwarded-Proto: https"
Existing custom headers can be unset with remove_smoke_headers.
Web applications that are protected with CSRF tokens will need to extract a
CSRF token from the responses. The CSRF token will then be used in each POST
request issued by smoke.sh.
Setup an after response callback to extract the token and set it. Example:
#!/bin/bash
. smoke.sh
_extract_csrf() {
CSRF=$(smoke_response_body | grep OUR_CSRF_TOKEN | grep -oE "[a-f0-9]{40}")
if [[ $CSRF != "" ]]; then
smoke_csrf "$CSRF" # set the new CSRF token
fi
}
SMOKE_AFTER_RESPONSE="_extract_csrf"When the CSRF token is set, smoke.sh will replace the string
__SMOKE_CSRF_TOKEN__ in your post data with the given token:
username=smoke&password=test&csrf=__SMOKE_CSRF_TOKEN__
To get data from the last response, three helper functions are available:
smoke_response_code # e.g. 200, 201, 400...
smoke_response_body # raw body (html/json/...)
smoke_response_headers # list of headersMore advanced example showing all features of smoke.sh:
#!/bin/bash
BASE_URL="$1"
if [[ -z "$1" ]]; then
echo "Usage:" $(basename $0) "<base_url>"
exit 1
fi
. smoke.sh
_extract_csrf() {
CSRF=$(smoke_response_body | grep OUR_CSRF_TOKEN | grep -oE "[a-f0-9]{40}")
if [[ $CSRF != "" ]]; then
smoke_csrf "$CSRF" # set the new CSRF token
fi
}
SMOKE_AFTER_RESPONSE="_extract_csrf"
smoke_url_prefix "$BASE_URL"
smoke_host "example.org"
smoke_url_ok "/"
smoke_assert_body "Welcome"
smoke_assert_body "Login"
smoke_assert_body "Password"
smoke_assert_headers "Content-Type: text/html; charset=utf-8"
smoke_form_ok "/login" postdata/login
smoke_assert_body "Hi John Doe"
smoke_assert_headers "Content-Type: text/html; charset=utf-8"
smoke_report| function | description |
|---|---|
smoke_assert_body <string> |
assert that the body contains <string> |
smoke_assert_code <code> |
assert that there was a <code> response code |
smoke_assert_code_ok |
assert that there was a 2xx response code |
smoke_assert_headers <string> |
assert that the headers contain <string> |
smoke_csrf <token> |
set the csrf token to use in POST requests |
smoke_form <url> <datafile> |
POST data on url |
smoke_form_ok <url> <datafile> |
POST data on url and check for a 2xx response code |
smoke_report |
prints the report and exits |
smoke_response_body |
body of the last response |
smoke_response_code |
code of the last response |
smoke_response_headers |
headers of the last response |
smoke_url <url> |
GET a url |
smoke_url_ok <url> |
GET a url and check for a 2xx response code |
smoke_url_prefix <prefix> |
set the prefix to use for every url (e.g. domain) |
smoke_host <host> |
set the host header to use |
smoke_header <header> |
set additional request header |
smoke_tcp_ok <host> <port> |
open a tcp connection and check for a Connected response |
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent