Check for possible vulnerabilities in the installed runtime environment packages.

Currently will check only for OpenSSL version and outputs warning message on any discovered vulnerability.

Create Session: create a HTTP session to a server

Arguments

url Base url of the server

alias Robot Framework alias to identify the session

headers Dictionary of default headers

cookies Dictionary of cookies

client_certs ['client certificate', 'client key'] PEM files containing the client key and certificate

timeout Connection timeout

proxies Dictionary mapping protocol or protocol and host to the URL of the proxy

(e.g. {'http': 'foo.bar:3128', 'http://host.name': 'foo.bar:4012'})

verify Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.

Defaults to False.

debug Enable http verbosity option more information

https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel

max_retries Number of maximum retries each connection should attempt.

By default it will retry 3 times in case of connection errors only. A 0 value will disable any kind of retries regardless of other retry settings. In case the number of retries is reached a retry exception is raised.

disable_warnings Disable requests warning useful when you have large number of testcases

backoff_factor Introduces a delay time between retries that is longer after each retry.

eg. if backoff_factor is set to 0.1 the sleep between attemps will be: 0.0, 0.2, 0.4 More info here: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html

retry_method_list List of uppercased HTTP method verbs where retries are allowed.

By default retries are allowed only on HTTP requests methods that are considered to be idempotent (multiple requests with the same parameters end with the same state). eg. set to ['POST', 'GET'] to retry only those kind of requests.

retry_status_list List of integer HTTP status codes that, if returned, a retry is attempted.

eg. set to [502, 503] to retry requests if those status are returned. Note that max_retries must be greater than 0.

Create Session: create a HTTP session to a server

Arguments

url Base url of the server

alias Robot Framework alias to identify the session

headers Dictionary of default headers

cookies Dictionary of cookies

auth A Custom Authentication object to be passed on to the requests library.

http://docs.python-requests.org/en/master/user/advanced/#custom-authentication

timeout Connection timeout

proxies Dictionary mapping protocol or protocol and host to the URL of the proxy

(e.g. {'http': 'foo.bar:3128', 'http://host.name': 'foo.bar:4012'})

verify Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.

Defaults to False.

debug Enable http verbosity option more information

https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel

max_retries Number of maximum retries each connection should attempt.

By default it will retry 3 times in case of connection errors only. A 0 value will disable any kind of retries regardless of other retry settings. In case the number of retries is reached a retry exception is raised.

disable_warnings Disable requests warning useful when you have large number of testcases

backoff_factor Introduces a delay time between retries that is longer after each retry.

eg. if backoff_factor is set to 0.1 the sleep between attemps will be: 0.0, 0.2, 0.4 More info here: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html

retry_method_list List of uppercased HTTP method verbs where retries are allowed.

By default retries are allowed only on HTTP requests methods that are considered to be idempotent (multiple requests with the same parameters end with the same state). eg. set to ['POST', 'GET'] to retry only those kind of requests.

retry_status_list List of integer HTTP status codes that, if returned, a retry is attempted.

eg. set to [502, 503] to retry requests if those status are returned. Note that max_retries must be greater than 0.

Create Session: create a HTTP session to a server

Arguments

url Base url of the server

alias Robot Framework alias to identify the session

headers Dictionary of default headers

cookies Dictionary of cookies

auth ['DOMAIN', 'username', 'password'] for NTLM Authentication

timeout Connection timeout

proxies Dictionary mapping protocol or protocol and host to the URL of the proxy

(e.g. {'http': 'foo.bar:3128', 'http://host.name': 'foo.bar:4012'})

verify Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.

Defaults to False.

debug Enable http verbosity option more information

https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel

max_retries Number of maximum retries each connection should attempt.

By default it will retry 3 times in case of connection errors only. A 0 value will disable any kind of retries regardless of other retry settings. In case the number of retries is reached a retry exception is raised.

disable_warnings Disable requests warning useful when you have large number of testcases

backoff_factor Introduces a delay time between retries that is longer after each retry.

eg. if backoff_factor is set to 0.1 the sleep between attemps will be: 0.0, 0.2, 0.4 More info here: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html

retry_method_list List of uppercased HTTP method verbs where retries are allowed.

By default retries are allowed only on HTTP requests methods that are considered to be idempotent (multiple requests with the same parameters end with the same state). eg. set to ['POST', 'GET'] to retry only those kind of requests.

retry_status_list List of integer HTTP status codes that, if returned, a retry is attempted.

eg. set to [502, 503] to retry requests if those status are returned. Note that max_retries must be greater than 0.

Create Session: create a HTTP session to a server

Arguments

url Base url of the server

alias Robot Framework alias to identify the session

headers Dictionary of default headers

cookies Dictionary of cookies

auth ['DOMAIN', 'username', 'password'] for NTLM Authentication

timeout Connection timeout

proxies Dictionary mapping protocol or protocol and host to the URL of the proxy

(e.g. {'http': 'foo.bar:3128', 'http://host.name': 'foo.bar:4012'})

verify Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.

Defaults to False.

debug Enable http verbosity option more information

https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel

max_retries Number of maximum retries each connection should attempt.

By default it will retry 3 times in case of connection errors only. A 0 value will disable any kind of retries regardless of other retry settings. In case the number of retries is reached a retry exception is raised.

disable_warnings Disable requests warning useful when you have large number of testcases

backoff_factor Introduces a delay time between retries that is longer after each retry.

eg. if backoff_factor is set to 0.1 the sleep between attemps will be: 0.0, 0.2, 0.4 More info here: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html

retry_method_list List of uppercased HTTP method verbs where retries are allowed.

By default retries are allowed only on HTTP requests methods that are considered to be idempotent (multiple requests with the same parameters end with the same state). eg. set to ['POST', 'GET'] to retry only those kind of requests.

retry_status_list List of integer HTTP status codes that, if returned, a retry is attempted.

eg. set to [502, 503] to retry requests if those status are returned. Note that max_retries must be greater than 0.

Create Session: create a HTTP session to a server

Arguments

alias Robot Framework alias to identify the session

url Base url of the server

headers Dictionary of default headers

cookies Dictionary of cookies

auth List of username & password for HTTP Basic Auth

timeout Connection timeout

proxies Dictionary mapping protocol or protocol and host to the URL of the proxy

(e.g. {'http': 'foo.bar:3128', 'http://host.name': 'foo.bar:4012'})

verify Whether the SSL cert will be verified. A CA_BUNDLE path can also be provided.

debug Enable http verbosity option more information

https://docs.python.org/2/library/httplib.html#httplib.HTTPConnection.set_debuglevel

max_retries Number of maximum retries each connection should attempt.

By default it will retry 3 times in case of connection errors only. A 0 value will disable any kind of retries regardless of other retry settings. In case the number of retries is reached a retry exception is raised.

disable_warnings Disable requests warning useful when you have large number of testcases

backoff_factor Introduces a delay time between retries that is longer after each retry.

eg. if backoff_factor is set to 0.1 the sleep between attemps will be: 0.0, 0.2, 0.4 More info here: https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html

retry_method_list List of uppercased HTTP method verbs where retries are allowed.

By default retries are allowed only on HTTP requests methods that are considered to be idempotent (multiple requests with the same parameters end with the same state). eg. set to ['POST', 'GET'] to retry only those kind of requests.

retry_status_list List of integer HTTP status codes that, if returned, a retry is attempted.

eg. set to [502, 503] to retry requests if those status are returned. Note that max_retries must be greater than 0.

Sends a DELETE request.

Arguments

The endpoint used to send the request is the url parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Removes all the session objects

Sends a DELETE request on a previously created HTTP Session.

Arguments

Session will be identified using the alias name. The endpoint used to send the request is the url parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

DEPRECATED Please use DELETE On Session instead.

Arguments

Send a DELETE request on the session object found using the given alias

alias that will be used to identify the Session object in the cache

uri to send the DELETE request to

json a value that will be json encoded

and sent as request data if data is not specified

headers a dictionary of headers to use with the request

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

timeout connection timeout

An alias for the HTTP Get keyword.

Arguments

The difference in use is that the URL is always downloaded based on the URL path (even without target_file). If there is a filename in the path, then that is used as target_file to save to. By default, the filename will be "downloaded.html".

Sends a GET request.

Arguments

The endpoint used to retrieve the resource is the url, while query string parameters can be passed as string, dictionary (or list of tuples or bytes) through the params.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs here is a list:

For more updated and complete information verify the official Requests api documentation: https://requests.readthedocs.io/en/latest/api/

Get request session alias that was used with the HTTP Get keyword.

Opens and returns a file descriptor of a specified file to be passed as data parameter to other requests keywords.

Arguments

This allows streaming upload of large files without reading them into memory.

File descriptor is binary mode and read only. Requests keywords will automatically close the file, if used outside this library it's up to the caller to close it.

Sends a GET request on a previously created HTTP Session.

Arguments

Session will be identified using the alias name. The endpoint used to retrieve the resource is the url, while query string parameters can be passed as string, dictionary (or list of tuples or bytes) through the params.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

DEPRECATED Please use GET On Session instead.

Arguments

Send a GET request on the session object found using the given alias

alias that will be used to identify the Session object in the cache

uri to send the GET request to

params url parameters to append to the uri

headers a dictionary of headers to use with the request

data a dictionary of key-value pairs that will be urlencoded

and sent as GET data or binary data that is sent as the raw body content

json a value that will be json encoded

and sent as GET data if data is not specified

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

timeout connection timeout

Sends a HEAD request.

Arguments

The endpoint used to retrieve the HTTP headers is the url.

allow_redirects parameter is not provided, it will be set to False (as opposed to the default behavior).

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Sends a HEAD request on a previously created HTTP Session.

Arguments

Session will be identified using the alias name. The endpoint used to retrieve the HTTP headers is the url.

allow_redirects parameter is not provided, it will be set to False (as opposed to the default behavior).

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

DEPRECATED Please use HEAD On Session instead.

Arguments

Send a HEAD request on the session object found using the given alias

alias that will be used to identify the Session object in the cache

uri to send the HEAD request to

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

headers a dictionary of headers to use with the request

timeout connection timeout

A helper method for Get Request that will create a session, perform GET request, and store the target file, if set by the target_file parameter.

Arguments

The old session will be used if the URL scheme and the host are the same as previously, e.g., 'https://www.google.fi' part of the URL.

Sends a OPTIONS request.

Arguments

The endpoint used to retrieve the resource is the url.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Sends a OPTIONS request on a previously created HTTP Session.

Arguments

Session will be identified using the alias name. The endpoint used to retrieve the resource is the url.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

DEPRECATED Please use OPTIONS On Session instead.

Arguments

Send an OPTIONS request on the session object found using the given alias

alias that will be used to identify the Session object in the cache

uri to send the OPTIONS request to

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

headers a dictionary of headers to use with the request

timeout connection timeout

Sends a PUT request.

Arguments

The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Sends a PATCH request on a previously created HTTP Session.

Arguments

Session will be identified using the alias name. The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

DEPRECATED Please use PATCH On Session instead.

Arguments

Send a PATCH request on the session object found using the given alias

alias that will be used to identify the Session object in the cache

uri to send the PATCH request to

data a dictionary of key-value pairs that will be urlencoded

and sent as PATCH data or binary data that is sent as the raw body content or file descriptor retrieved by Get File For Streaming Upload

json a value that will be json encoded

and sent as PATCH data if data is not specified

headers a dictionary of headers to use with the request

files a dictionary of file names containing file data to PATCH to the server

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

params url parameters to append to the uri

timeout connection timeout

Sends a POST request.

Arguments

The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Sends a POST request on a previously created HTTP Session.

Arguments

Session will be identified using the alias name. The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

DEPRECATED Please use POST On Session instead.

Arguments

Send a POST request on the session object found using the given alias

alias that will be used to identify the Session object in the cache

uri to send the POST request to

data a dictionary of key-value pairs that will be urlencoded

and sent as POST data or binary data that is sent as the raw body content or passed as such for multipart form data if files is also defined or file descriptor retrieved by Get File For Streaming Upload

json a value that will be json encoded

and sent as POST data if files or data is not specified

params url parameters to append to the uri

headers a dictionary of headers to use with the request

files a dictionary of file names containing file data to POST to the server

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

timeout connection timeout

Sends a PUT request.

Arguments

The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

Sends a PUT request on a previously created HTTP Session.

Arguments

Session will be identified using the alias name. The endpoint used to send the request is the url parameter, while its body can be passed using data or json parameters.

data can be a dictionary, list of tuples, bytes, or file-like object. If you want to pass a json body pass a dictionary as json parameter.

By default this keyword fails if a status code with error values is returned in the response, this behavior can be modified using the expected_status and msg parameters, read more about it in Status Should Be keyword documentation. In order to disable this implicit assert mechanism you can pass as expected_status the values any or anything.

Other optional requests arguments can be passed using **kwargs see the GET keyword for the complete list.

DEPRECATED Please use PUT On Session instead.

Arguments

Send a PUT request on the session object found using the given alias

alias that will be used to identify the Session object in the cache

uri to send the PUT request to

data a dictionary of key-value pairs that will be urlencoded

and sent as PUT data or binary data that is sent as the raw body content or file descriptor retrieved by Get File For Streaming Upload

json a value that will be json encoded

and sent as PUT data if data is not specified

headers a dictionary of headers to use with the request

allow_redirects Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.

params url parameters to append to the uri

timeout connection timeout

Fails if response status code is a client or server error (4xx, 5xx).

Arguments

response is the output of other requests keywords like GET On Session. If omitted the last response will be used.

In case of failure an HTTPError will be automatically raised.

For a more versatile assert keyword see Status Should Be.

Return True if the session has been already created

Arguments

alias that has been used to identify the Session object in the cache

Fails if response status code is different than the expected.

Arguments

expected_status could be the code number as an integer or as string. But it could also be a named status code like 'ok', 'created', 'accepted' or 'bad request', 'not found' etc.

response is the output of other requests keywords like GET or GET On Session. If omitted the last response will be used.

In case of failure an HTTPError will be automatically raised. A custom failure message msg can be added like in built-in keywords.

New requests keywords like GET or GET On Session (starting from 0.8 version) already have an implicit assert mechanism that, by default, verifies the response status code. Status Should Be keyword can be useful when you disable implicit assert using expected_status=anything.

For example when you have a nested keyword that is used for both OK and ERROR responses:

DEPRECATED Please use ${resp.json()} instead. Have a look at the improved HTML output as pretty printing replacement.

Arguments

Convert a string to a JSON object

content String content to convert into JSON

pretty_print If defined, will output JSON is pretty print format

Updates HTTP Session Headers and Cookies.

Arguments

Session will be identified using the alias name. Dictionary of headers and cookies to be updated and merged into session data.