Wallogit.com
2017 © Pedro Peláez
Webunit test client
, (*1)
Webunit is a command line client for automated web application tests., (*2)
``` bash $ composer require michaelhall/webunit, (*3)
## Basic usage The ```webunit``` client requires a file in text format, containing the tests to run. Pass the name of this file as a command line parameter:
$ webunit testfile, (*4)
The tests in the test file consists of one or more test cases. Every test case starts with a command. The most basic test case is just a command, e.g.
get https://example.org/, (*5)
This test will be successful if the Url ```https://example.org/``` is functional and does not return an error or redirect status code. Otherwise, the test will fail. The Url can also be fetched with one of the other supported HTTP methods:
delete https://example.org/ patch https://example.org/ post https://example.org/ put https://example.org/, (*6)
A test case can also contain specific assertions:
get https://example.org/ assert-contains Example, (*7)
Comments and whitespaces can be used to format the test file:
get https://example.org/ assert-contains Example, (*8)
get https://example.org/foobar assert-status-code 404, (*9)
Some assertions can be modified with modifier characters:
get https://example.org/, (*10)
assert-status-code! 404, (*11)
assert-contains^ example, (*12)
assert-contains~ [Ee]xample, (*13)
assert-contains!^ foobar, (*14)
The request can be modified with request modifiers:
put https://example.org/ with-header Content-Type: application/json with-raw-content {"Foo": "Bar"}, (*15)
The test file can set variables to be reused for the tests. Variables are evaluated at parse-time in a manner similar to the preprocessor directives in languages like C and C#.
set Url = https://example.com/, (*16)
get {{ Url }}, (*17)
get {{ Url }}another-page, (*18)
It is also possible to set variables from the command line:
$ webunit --set=Url=https://example.com/ testfile, (*19)
get {{ Url }}, (*20)
A default value can be used to set the variable if not already set. Example 1:
$ webunit testfile, (*21)
set-default Url = https://example.com/, (*22)
get {{ Url }}, (*23)
Example 2:
$ webunit --set=Url=https://example.org/ testfile, (*24)
set-default Url = https://example.com/, (*25)
get {{ Url }}, (*26)
The ```--no-colors``` command line option can be used to disable colors in output.
$ webunit --no-colors testfile, (*27)
The following escape sequences can be used in the test file: | Escape sequence | Character | |-----------------|-----------------| | \\n | Line feed | | \\r | Carriage return | | \\s | Space | | \\t | Horizontal tab | | \\\\ | Backslash |
get https://example.org/ assert-contains \n, (*28)
\n\s
## Commands ### delete _url_ Fetches a Url via a ```DELETE``` request.
delete https://example.org/, (*29)
### get _url_ Fetches a Url via a ```GET``` request.
get https://example.org/, (*30)
### patch _url_ Fetches a Url via a ```PATCH``` request.
patch https://example.org/, (*31)
### post _url_ Fetches a Url via a ```POST``` request.
post https://example.org/, (*32)
### put _url_ Fetches a Url via a ```PUT``` request.
put https://example.org/, (*33)
## Assertions ### assert-contains _content_ Asserts that the content of the result contains the specified content. Allowed modifiers are ```!```, ```^```, ```~```
assert-contains Foo, (*34)
### assert-empty Asserts that the content of the result is empty. Allowed modifier is ```!```
assert-empty, (*35)
### assert-equals _content_ Asserts that the content of the result is the same as the specified content. Allowed modifiers are ```!```, ```^```, ```~```
assert-equals Foo, (*36)
### assert-header _header-name[: header-value]_ Asserts that the result contains a header with the specified name and an optional value. Allowed modifiers are ```!```, ```^```, ```~```
assert-header Location assert-header Location: https://example.com/, (*37)
Note: The header name is always case-insensitive. ### assert-status-code _status-code_ Asserts that the status code of the result is the same as the specified status code. Allowed modifier is ```!``` Note: This assert must be present for a test to pass if the result has a status code other than 200-299.
assert-status-code 301, (*38)
## Request modifiers ### with-header _header-name: header-value_ Sets an HTTP-header with the specified name to the specified value.
with-header Accept-Language: en, (*39)
### with-post-file _parameter-name = file-path_ Sets a POST-parameter with the specified name to a file to be uploaded. The file path can be either absolute or relative to the webunit test script. This request modifier can not be used for GET requests and can not be combined with the _with-raw-content_ request modifier.
with-post-file File = ../../files/foo.txt, (*40)
### with-post-parameter _parameter-name = parameter-value_ Sets a POST-parameter with the specified name to the specified value. This request modifier can not be used for GET requests and can not be combined with the _with-raw-content_ request modifier.
with-post-parameter Text = Foo, (*41)
### with-raw-content _content_ Sets the request body content to the specified content. This request modifier can not be used for GET requests and can not be combined with the _with-post-file_ and _with-post-parameter_ request modifiers.
with-raw-content {"Foo": "Bar"} ```, (*42)
MIT, (*43)
Webunit test client
MIT
web unit
Webunit test client
MIT
web unit