Merge pull request #309 from MarketSquare/0.8

"Lock down" 0.8 release on the go... smile

Author: lucagiove

.github/workflows/pythonapp.yml

@@ -46,24 +46,25 @@ jobs:
         coverage report
         coverage xml
     - name: Update codecov for unit tests
-      uses: codecov/codecov-action@v1.0.6
+      uses: codecov/codecov-action@v1
       with:
         flags: unit
         file: coverage.xml
     - name: Test with Robot Framework and coverage
       run: |
         coverage erase
-        coverage run --branch --source src/ -m robot --exclude skip --pythonpath src --outputdir ./tests-report --consolecolors ansi atests
+        coverage run --branch --source src/ -m robot --loglevel trace:info --exclude skip --pythonpath src --outputdir ./tests-report --consolecolors ansi atests
     - name: Acceptance tests coverage
       run: |
         coverage report
         coverage xml
     - name: Update codecov for acceptance tests
-      uses: codecov/codecov-action@v1.0.6
+      uses: codecov/codecov-action@v1
       with:
         flags: acceptance
         file: coverage.xml
     - name: Archive Robot Framework Tests Report
+      if: ${{ always() }}
       uses: actions/upload-artifact@v1
       with:
         name: rf-tests-report-${{ matrix.os }}-${{ matrix.python-version }}

CONTRIBUTING.md

@@ -46,9 +46,9 @@ Test coverage is evaluated for unit and acceptance tests, after test execution
 
 #### Documentation
 
-Keywords documentation can be updated running the following command:
+Keywords documentation (on Linux) can be updated running the following script:
 
-`python -m robot.libdoc src/RequestsLibrary doc/RequestsLibrary.html`
+`doc/generate_doc.sh`
 
 # What can I do?
 

README.md

@@ -3,21 +3,15 @@
 [![PyPi downloads](https://img.shields.io/pypi/dm/robotframework-requests.svg)](https://pypi.python.org/pypi/robotframework-requests)
 [![Latest Version](https://img.shields.io/pypi/v/robotframework-requests.svg)](https://pypi.python.org/pypi/robotframework-requests)
 
-🏠 ``RequestsLibrary`` is a [Robot Framework](https://robotframework.org/) test library that uses the [Requests](https://github.com/kennethreitz/requests) HTTP client.
+🏠 ``RequestsLibrary`` is a [Robot Framework](https://robotframework.org/) library
+aimed to provide HTTP api testing functionalities by wrapping the well known [Python Requests Library](https://github.com/kennethreitz/requests).
 
 
 ## Install stable version
 ```sh
 pip install robotframework-requests
 ```
 
-## ✨ Install latest 0.8 pre-release version (recommended) ✨
-```sh
-pip install robotframework-requests --pre
-```
-- [0.8 README](https://github.com/MarketSquare/robotframework-requests/blob/0.8/README.md)
-- [0.8 Keywords documentation](https://robotframework-requests.netlify.app/doc/requestslibrary)
-
 ### What's new in 0.8
 
 **New keywords structure:**
@@ -28,7 +22,8 @@ when a session is not needed.
 
 **Implicit assert on status code:**
 `* On Session` keywords automatically fail if an error status code is returned.
-`expect_status=` could be used to specify a status code (`201`, `OK`, `Bad request`) or `any` if you want to evaluate the response in any case. 
+`expect_status=` could be used to specify a status code (`201`, `OK`, `Bad request`) 
+or `any` if you want to evaluate the response in any case. 
 
 **Closer to the original Requests library:**
 New keywords have the same parameter orders and structure as the original.
@@ -43,18 +38,27 @@ Main keywords file has been split with a more logic division to allow better and
 Library               Collections
 Library               RequestsLibrary
 
+Suite Setup           Create Session    jsonplaceholder    https://jsonplaceholder.typicode.com
+
 *** Test Cases ***
-Get Request
-    Create Session    jsonplaceholder         https://jsonplaceholder.typicode.com
-    ${resp}=          Get request    jsonplaceholder     /posts/1
-    Dictionary Should Contain Value   ${resp.json()}     sunt aut facere repellat provident occaecati excepturi
-
-Post Request
-    Create Session    jsonplaceholder         https://jsonplaceholder.typicode.com
-    &{data}=          Create dictionary       title=Robotframework requests  body=This is a test!  userId=1
-    ${resp}=          Post request    jsonplaceholder     /posts    json=${data}
-    Dictionary Should Contain Key   ${resp.json()}     id
+
+Get Request Test
+    Create Session    google             http://www.google.com
+
+    ${resp_google}=   GET On Session     google             /           expected_status=200
+    ${resp_json}=     GET On Session     jsonplaceholder    /posts/1
+
+    Should Be Equal As Strings           ${resp_google.reason}    OK
+    Dictionary Should Contain Value      ${resp_json.json()}    sunt aut facere repellat provident occaecati excepturi optio reprehenderit
+
+Post Request Test
+    &{data}=          Create dictionary  title=Robotframework requests  body=This is a test!  userId=1
+    ${resp}=          POST On Session    jsonplaceholder     /posts    json=${data}
+    
+    Status Should Be                     201    ${resp}
+    Dictionary Should Contain Key        ${resp.json()}     id
 ```
+
 ### 📖 Keywords documentation
 Robotframework-requests offers a wide set of keywords which can be found in the [Keywords documentation](http://marketsquare.github.io/robotframework-requests/doc/RequestsLibrary.html)
 

atests/deprecated_test_to_json.robot

@@ -0,0 +1,42 @@
+*** Settings ***
+Library  Collections
+Library  RequestsLibrary
+Resource  res_setup.robot
+
+Suite Setup     Run Keywords  Setup Flask Http Server
+...             Setup Response For Json Tests
+Suite Teardown  Teardown Flask Http Server And Sessions
+
+*** Variables ***
+${resp}         created in the setup
+&{dict_params}  key_one=true    key_two=this is a test string
+
+*** Test Cases ***
+
+Do Not Pretty Print a JSON object
+    [Tags]    json
+    ${jsondata}=    To Json    ${resp.content}
+    Dictionaries Should Be Equal   ${jsondata['args']}    ${dict_params}
+
+Pretty Print a JSON object
+    [Tags]    json
+    Comment    Define json variable.
+    ${output}=    To Json    ${resp.content}    pretty_print=True
+    Should Contain    ${output}    "key_one": "true"
+    Should Contain    ${output}    "key_two": "this is a test string"
+    Should Not Contain    ${output}    {u'key_two': u'this is a test string', u'key_one': u'true'}
+
+Set Pretty Print to non-Boolean value
+    [Tags]    json
+    Comment    Define json variable.
+    ${output}=    To Json    ${resp.content}    pretty_print="Hello"
+    Log    ${output}
+    Should Contain    ${output}    "key_one": "true"
+    Should Contain    ${output}    "key_two": "this is a test string"
+    Should Not Contain    ${output}    {u'key_two': u'this is a test string', u'key_one': u'true'}
+
+*** Keywords ***
+
+Setup Response For Json Tests
+    ${resp}=   GET On Session    ${GLOBAL_SESSION}    /anything    params=${dict_params}
+    Set Suite Variable  ${resp}

atests/issues/17.robot

@@ -1,7 +1,7 @@
 *** Settings ***
 Library  Collections
 Library  String
-Library  ../../src/RequestsLibrary/RequestsKeywords.py
+Library  RequestsLibrary
 Library  OperatingSystem
 Suite Teardown  Delete All Sessions
 
@@ -11,6 +11,6 @@ ${JSON_DATA}  '{"file":{"path":"/logo1.png"},"token":"some-valid-oauth-token"}'
 *** Test Cases ***
 Delete Request With Data
     Create Session   httpbin   http://httpbin.org
-    &{headers}=  Create Dictionary  Content-Type=application/json
+    ${headers}=  Create Dictionary  Content-Type=application/json
     ${resp}=   Delete Request   httpbin   /delete   data=${JSON_DATA}   headers=${headers}
     ${jsondata}=   To Json   ${resp.content}

atests/issues/18.robot

@@ -1,7 +1,7 @@
 *** Settings ***
 Library  Collections
 Library  String
-Library  ../../src/RequestsLibrary/RequestsKeywords.py
+Library  RequestsLibrary
 Library  OperatingSystem
 Suite Teardown  Delete All Sessions
 
@@ -11,8 +11,8 @@ ${JSON_DATA}  '{"file":{"path":"/logo1.png"},"token":"some-valid-oauth-token"}'
 *** Test Cases ***
 Encoding Error
     Create Session   httpbin   http://httpbin.org
-    &{headers}=  Create Dictionary  Content-Type=application/json
+    ${headers}=  Create Dictionary  Content-Type=application/json
     Set Suite Variable  ${data}   { "elementToken":"token", "matchCriteria":[{"field":"name","dataType":"string","useOr":"false","fieldValue":"Operation check 07", "closeParen": "false", "openParen": "false", "operator": "equalTo"}], "account": { "annualRevenue": "456666", "name": "Account", "numberOfEmployees": "integer", "billingAddress": { "city": "Miami", "country": "US", "countyOrDistrict": "us or fl", "postalCode": "33131", "stateOrProvince": "florida", "street1": "Trade Center", "street2": "North Main rd" }, "number": "432", "industry": "Bank", "type": "string", "shippingAddress": { "city": "denver", "country": "us", "countyOrDistrict": "us or co", "postalCode": "80202", "stateOrProvince": "colorado", "street1": "Main street", "street2": "101 Avenu"}}}
 
     ${resp}=  Post Request  httpbin  /post  data=${data}  headers=${headers}
-    Should Be Equal As Strings  ${resp.status_code}  200 
+    Should Be Equal As Strings  ${resp.status_code}  200

atests/issues/259.robot

@@ -1,5 +1,5 @@
 *** Settings ***
-Library  ../../src/RequestsLibrary/RequestsKeywords.py
+Library   RequestsLibrary
 Resource  ../res_setup.robot
 
 Suite Setup     Setup Flask Http Server
@@ -9,9 +9,9 @@ Suite Teardown  Teardown Flask Http Server And Sessions
 *** Test Cases ***
 Post Content application/json With Empty Data Should Have No Body
     ${content-type}=  Create Dictionary  content-type  application/json
-    ${resp}=  Post Request  ${GLOBAL_LOCAL_SESSION}  /anything  data=${EMPTY}  headers=${content-type}
+    ${resp}=  Post Request  ${GLOBAL_SESSION}  /anything  data=${EMPTY}  headers=${content-type}
     Should Be Empty  ${resp.json()['data']}
 
 Post Content With Empty Data Should Have No Body
-    ${resp}=  Post Request  ${GLOBAL_LOCAL_SESSION}  /anything  data=${EMPTY}
+    ${resp}=  Post Request  ${GLOBAL_SESSION}  /anything  data=${EMPTY}
     Should Be Empty  ${resp.json()['data']}

atests/issues/27.robot

@@ -1,7 +1,7 @@
 *** Settings ***
 Library  Collections
 Library  String
-Library  ../../src/RequestsLibrary/RequestsKeywords.py
+Library  RequestsLibrary
 Library  OperatingSystem
 Suite Teardown  Delete All Sessions
 
@@ -11,8 +11,8 @@ Post Request With XML File
     Create Session  httpbin  http://httpbin.org
 
     ${file_data}=  Get File  ${CURDIR}${/}test.xml
-    &{files}=  Create Dictionary  xml=${file_data}
-    &{headers}=  Create Dictionary  Authorization=testing-token
+    ${files}=  Create Dictionary  xml=${file_data}
+    ${headers}=  Create Dictionary  Authorization=testing-token
     Log  ${headers}
     ${resp}=  Post Request  httpbin  /post  files=${files}  headers=${headers}
 

atests/issues/305.robot

@@ -1,6 +1,5 @@
 *** Settings ***
-Library  ../../src/RequestsLibrary/RequestsKeywords.py
-
+Library   RequestsLibrary
 
 *** Test Cases ***
 Test NTLM Session without installed library

atests/res_setup.robot

@@ -1,11 +1,11 @@
 *** Settings ***
 Library  Process
-Library  ../src/RequestsLibrary/RequestsKeywords.py
+Library  RequestsLibrary
 
 
 *** Variables ***
-${GLOBAL_LOCAL_SESSION}     global_local_session
-${HTTP_LOCAL_SERVER}        http://localhost:5000
+${GLOBAL_SESSION}       global_session
+${HTTP_LOCAL_SERVER}    http://localhost:5000
 
 
 *** Keywords ***
@@ -23,13 +23,14 @@ Setup Flask Http Server
     ${flask_cmd} =  Set Variable If
     ...  '${platform}'=='win32'  ${CURDIR}/http_server/run.cmd
     ...  ${CURDIR}/http_server/run.sh
+    # No way to have the return code or other data on the process since it's in background
     Start Process  ${flask_cmd}  cwd=${CURDIR}/http_server/  alias=flask
-    Create Session  ${GLOBAL_LOCAL_SESSION}  ${HTTP_LOCAL_SERVER}
+    Create Session  ${GLOBAL_SESSION}  ${HTTP_LOCAL_SERVER}
     Wait Until Http Server Is Up And Running
 
 Wait Until Http Server Is Up And Running
     Create Session  wait-until-up  ${HTTP_LOCAL_SERVER}  max_retries=10
-    Get Request  wait-until-up  /
+    Get On Session  wait-until-up  /
 
 Teardown Flask Http Server And Sessions
     Delete All Sessions