RequestsLibrary is a Robot Framework test library that uses the Requests HTTP client.
Install robotframework-requests and it's dependencies via pip
pip install robotframework-requestsHere is a sample test case:
*** Settings ***
Library Collections
Library RequestsLibrary
*** Test Cases ***
Get Requests
Create Session github http://api.github.com
Create Session google http://www.google.com
${resp}= Get Request google /
Status Should Be 200 ${resp}
${resp}= Get Request github /users/bulkan
Request Should Be Successful ${resp}
Dictionary Should Contain Value ${resp.json()} Bulkan EvcimenRequestsLibrary tries to follow the same API as requests. In the above example, we load in the RequestsLibrary using the Library keyword. To be able to distinguish HTTP requests to different hosts and for ease of creation of test cases, you need to create a Session. Internally this will create a request.Session object. The Create Session keyword accepts two arguments:
- alias to identify the session later
- root url to the server
HTTP verbs are mapped keywords which accept two arguments:
- alias identifying the Session we created earlier.
- URI to send the request to.
Above we create two Sessions - one to the github api, and the other to google. Creating sessions doesn't send any requests.
After we create a Session we can send any of the following Get, Post, Put, Patch, Options, Delete, and Head requests. In the above example we send a GET request to the session with the alias google and check the HTTP response code. Then send a another GET request but this time to the session with the alias github and pass in a uri. In this case it is /users/bulkan which will return a JSON string. RequestsLibrary returned object provides a method to get the content as a JSON object format called json().
Here is another test case where an outbound http proxy is used.
*** Settings ***
Library RequestsLibrary
*** Test Cases ***
Proxy Requests
${proxies}= Create Dictionary http=http://acme.com:912 https=http://acme.com:913
Create Session github http://api.github.com proxies=${proxies}
${resp}= Get Request github /
Status Should Be OK ${resp}Another test case where cookies are sent in the request headers:
*** Settings ***
Library RequestsLibrary
*** Test Cases ***
Cookies in request
${cookies}= Create Dictionary userid=1234567 last_visit=2017-12-22
Create Session github http://api.github.com cookies=${cookies}
${resp}= Get Request github /
Should Be Equal As Strings ${resp.status_code} 200For more examples see the tests folder which contains testcase files that is used to test the keywords in this library against httpbin.org.
For individual keyword documentation see the following:
Send your questions to the
See the How To Contribute to the project page.
Please install it:
pip install robotframework-requests --preand give us feedback!