Merge pull request #390 from PaulBrandUWV/new_http_methods

Keywords for TRACE and CONNECT HTTP methods
MarketSquare · May 28, 2024 · 365cbcf · 365cbcf
2 parents a9e8f91 + d93c3a4
commit 365cbcf
Show file tree

Hide file tree

Showing 38 changed files with 1,528 additions and 1,300 deletions.
diff --git a/.gitignore b/.gitignore
@@ -30,3 +30,6 @@ venv/*
 env/*
 
 .vscode/*
+
+# ignore http server log
+atests/http_server/http_server.log
diff --git a/atests/__init__.robot b/atests/__init__.robot
@@ -0,0 +1,5 @@
+*** Settings ***
+Resource            res_setup.robot
+
+Suite Setup         Setup Flask Http Server
+Suite Teardown      Teardown Flask Http Server And Sessions
diff --git a/atests/http_server/core.py b/atests/http_server/core.py
@@ -39,7 +39,7 @@ def view_headers():
     return jsonify(get_dict('headers'))
 
 
-@app.route("/anything", methods=["GET", "POST", "PUT", "DELETE", "PATCH", "TRACE"])
+@app.route("/anything", methods=["GET", "POST", "PUT", "DELETE", "PATCH", "TRACE", "HEAD", "CONNECT"])
 def view_anything(anything=None):
     """Returns anything passed in request data.
     ---
@@ -68,7 +68,7 @@ def view_anything(anything=None):
 
 
 @app.route(
-    "/status/<codes>", methods=["GET", "POST", "PUT", "DELETE", "PATCH", "TRACE"]
+    "/status/<codes>", methods=["GET", "POST", "PUT", "DELETE", "PATCH", "TRACE", "HEAD", "CONNECT"]
 )
 def view_status_code(codes):
     """Return status code or random status code if more than one are given
@@ -118,7 +118,7 @@ def view_status_code(codes):
     return status_code(code)
 
 
-@app.route("/redirect-to", methods=["GET", "POST", "PUT", "DELETE", "PATCH", "TRACE"])
+@app.route("/redirect-to", methods=["GET", "POST", "PUT", "DELETE", "PATCH", "TRACE", "HEAD", "CONNECT", "OPTIONS"])
 def redirect_to():
     """302/3XX Redirects to the given URL.
     ---

diff --git a/atests/issues/17.robot b/atests/issues/17.robot
@@ -1,19 +1,16 @@
 *** Settings ***
-Library  Collections
-Library  String
-Library  RequestsLibrary
-Library  OperatingSystem
-Resource  ../res_setup.robot
+Library     Collections
+Library     String
+Library     RequestsLibrary
+Library     OperatingSystem
 
-Suite Setup     Setup Flask Http Server
-Suite Teardown  Teardown Flask Http Server And Sessions
 
 *** Variables ***
-${JSON_DATA}  '{"file":{"path":"/logo1.png"},"token":"some-valid-oauth-token"}'
+${JSON_DATA}    '{"file":{"path":"/logo1.png"},"token":"some-valid-oauth-token"}'
+
 
 *** Test Cases ***
 Delete Request With Data
-    ${headers}=  Create Dictionary  Content-Type=application/json
-    ${resp}=   DELETE On Session  ${GLOBAL_SESSION}   /anything   data=${JSON_DATA}   headers=${headers}
-    Should Be Equal As Strings    ${resp.json()}[method]  DELETE
-
+    ${headers}=    Create Dictionary    Content-Type=application/json
+    ${resp}=    DELETE On Session    ${GLOBAL_SESSION}    /anything    data=${JSON_DATA}    headers=${headers}
+    Should Be Equal As Strings    ${resp.json()}[method]    DELETE
diff --git a/atests/issues/18.robot b/atests/issues/18.robot
@@ -1,20 +1,20 @@
 *** Settings ***
-Library  Collections
-Library  String
-Library  RequestsLibrary
-Library  OperatingSystem
-Resource  ../res_setup.robot
+Library     Collections
+Library     String
+Library     RequestsLibrary
+Library     OperatingSystem
 
-Suite Setup     Setup Flask Http Server
-Suite Teardown  Teardown Flask Http Server And Sessions
 
 *** Variables ***
-${JSON_DATA}  '{"file":{"path":"/logo1.png"},"token":"some-valid-oauth-token"}'
+${JSON_DATA}    '{"file":{"path":"/logo1.png"},"token":"some-valid-oauth-token"}'
+
 
 *** Test Cases ***
 Encoding Error
-    ${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"}}}
+    ${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 On Session   ${GLOBAL_SESSION}  /anything  data=${data}  headers=${headers}
-    Should Be Equal As Strings  ${resp.status_code}  200
+    ${resp}=    POST On Session    ${GLOBAL_SESSION}    /anything    data=${data}    headers=${headers}
+    Should Be Equal As Strings    ${resp.status_code}    200
diff --git a/atests/issues/259.robot b/atests/issues/259.robot
@@ -1,16 +1,13 @@
 *** Settings ***
-Library   RequestsLibrary
-Resource  ../res_setup.robot
+Library     RequestsLibrary
 
-Suite Setup     Setup Flask Http Server
-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 On Session  ${GLOBAL_SESSION}  /anything  data=${EMPTY}  headers=${content-type}
-    Should Be Empty  ${resp.json()['data']}
+    ${content-type}=    Create Dictionary    content-type    application/json
+    ${resp}=    POST On Session    ${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 On Session  ${GLOBAL_SESSION}  /anything  data=${EMPTY}
-    Should Be Empty  ${resp.json()['data']}
+    ${resp}=    POST On Session    ${GLOBAL_SESSION}    /anything    data=${EMPTY}
+    Should Be Empty    ${resp.json()['data']}
diff --git a/atests/issues/27.robot b/atests/issues/27.robot
@@ -1,24 +1,21 @@
 *** Settings ***
-Library  Collections
-Library  String
-Library  RequestsLibrary
-Library  OperatingSystem
-Resource  ../res_setup.robot
+Library     Collections
+Library     String
+Library     RequestsLibrary
+Library     OperatingSystem
 
-Suite Setup     Setup Flask Http Server
-Suite Teardown  Teardown Flask Http Server And Sessions
 
 *** Test Cases ***
 Post Request With XML File
-    [Tags]  post
-    ${file_data}=  Get File  ${CURDIR}${/}test.xml
-    ${files}=  Create Dictionary  xml=${file_data}
-    ${headers}=  Create Dictionary  Authorization=testing-token
-    Log  ${headers}
-    ${resp}=  POST On Session   ${GLOBAL_SESSION}  /anything  files=${files}  headers=${headers}
+    [Tags]    post
+    ${file_data}=    Get File    ${CURDIR}${/}test.xml
+    ${files}=    Create Dictionary    xml=${file_data}
+    ${headers}=    Create Dictionary    Authorization=testing-token
+    Log    ${headers}
+    ${resp}=    POST On Session    ${GLOBAL_SESSION}    /anything    files=${files}    headers=${headers}
 
-    Log  ${resp.json()}
+    Log    ${resp.json()}
 
-    Set Test Variable  ${req_headers}  ${resp.json()['headers']}
+    Set Test Variable    ${req_headers}    ${resp.json()['headers']}
 
-    Dictionary Should Contain Key  ${req_headers}  Authorization
+    Dictionary Should Contain Key    ${req_headers}    Authorization
diff --git a/atests/issues/305.robot b/atests/issues/305.robot
@@ -1,7 +1,13 @@
 *** Settings ***
-Library   RequestsLibrary
+Library     RequestsLibrary
+
 
 *** Test Cases ***
 Test NTLM Session without installed library
-    ${auth}=    Create List  1  2  3
-    Run Keyword And Expect Error  requests_ntlm module not installed  Create Ntlm Session  ntlm  http://localhost:80  ${auth}
+    ${auth}=    Create List    1    2    3
+    Run Keyword And Expect Error
+    ...    requests_ntlm module not installed
+    ...    Create Ntlm Session
+    ...    ntlm
+    ...    http://localhost:80
+    ...    ${auth}
diff --git a/atests/issues/315.robot b/atests/issues/315.robot
@@ -1,22 +1,16 @@
 *** Settings ***
-Library   RequestsLibrary
-Resource  ../res_setup.robot
+Library     RequestsLibrary
 
-Suite Setup     Setup Flask Http Server
-Suite Teardown  Teardown Flask Http Server And Sessions
 
 *** Test Cases ***
 Test On Session Keyword With Verify As Parameter
-
-    ${resp}=  GET On Session  ${GLOBAL_SESSION}  /  verify=${False}
-    Status Should Be  OK  ${resp}
+    ${resp}=    GET On Session    ${GLOBAL_SESSION}    /    verify=${False}
+    Status Should Be    OK    ${resp}
 
 Test On Session Keyword With None Cookies As Parameter
-
-    ${resp}=  GET On Session  ${GLOBAL_SESSION}  /  cookies=${None}
-    Status Should Be  OK  ${resp}
+    ${resp}=    GET On Session    ${GLOBAL_SESSION}    /    cookies=${None}
+    Status Should Be    OK    ${resp}
 
 Test On Session Keyword With Cookies As Parameter
-
-    ${resp}=  GET On Session  ${GLOBAL_SESSION}  /  cookies=${False}
-    Status Should Be  OK  ${resp}
+    ${resp}=    GET On Session    ${GLOBAL_SESSION}    /    cookies=${False}
+    Status Should Be    OK    ${resp}
diff --git a/atests/issues/320.robot b/atests/issues/320.robot
@@ -1,25 +1,22 @@
 *** Settings ***
-Library   Collections
-Library   RequestsLibrary
-Resource  ../res_setup.robot
+Library     Collections
+Library     RequestsLibrary
 
-Suite Setup     Setup Flask Http Server
-Suite Teardown  Teardown Flask Http Server And Sessions
 
 *** Test Cases ***
 Test GET with list of values as params
-    ${values_list}=     Create List    1    2    3    4    5
-    ${parameters}=      Create Dictionary  key  ${values_list}
-    ${resp}=            GET On Session  ${GLOBAL_SESSION}  url=/anything  params=${parameters}
-    Should Contain      ${resp.json()}[url]  ?key=1&key=2&key=3&key=4&key=5
-    Should Be Equal     ${resp.json()}[args]  ${parameters}
+    ${values_list}=    Create List    1    2    3    4    5
+    ${parameters}=    Create Dictionary    key    ${values_list}
+    ${resp}=    GET On Session    ${GLOBAL_SESSION}    url=/anything    params=${parameters}
+    Should Contain    ${resp.json()}[url]    ?key=1&key=2&key=3&key=4&key=5
+    Should Be Equal    ${resp.json()}[args]    ${parameters}
 
 Test GET with spaces in dictionary as params
-    ${parameters}=      Create Dictionary  key  v a l u e
-    ${resp}=            GET On Session  ${GLOBAL_SESSION}  url=/anything  params=${parameters}
-    Should Be Equal     ${resp.json()}[args]  ${parameters}
+    ${parameters}=    Create Dictionary    key    v a l u e
+    ${resp}=    GET On Session    ${GLOBAL_SESSION}    url=/anything    params=${parameters}
+    Should Be Equal    ${resp.json()}[args]    ${parameters}
 
 Test GET with spaces in string as params
-    ${parameters}=      Create Dictionary
-    ${resp}=            GET On Session  ${GLOBAL_SESSION}  url=/anything  params=key=v a l u e
-    Should Contain      ${resp.json()}[url]  v%20a%20l%20u%20e
+    ${parameters}=    Create Dictionary
+    ${resp}=    GET On Session    ${GLOBAL_SESSION}    url=/anything    params=key=v a l u e
+    Should Contain    ${resp.json()}[url]    v%20a%20l%20u%20e
diff --git a/atests/issues/334.robot b/atests/issues/334.robot
@@ -1,13 +1,9 @@
 *** Settings ***
-Library    RequestsLibrary
-Resource  ../res_setup.robot
+Library     RequestsLibrary
 
-Suite Setup     Setup Flask Http Server
-Suite Teardown  Teardown Flask Http Server And Sessions
 
 *** Test Cases ***
-
 Test evaluated response is always the one passed
-    ${response_error}=  GET On Session  ${GLOBAL_SESSION}  url=/status/404    expected_status=any
-    ${response_ok}=     GET On Session  ${GLOBAL_SESSION}  url=/status/200    expected_status=any
+    ${response_error}=    GET On Session    ${GLOBAL_SESSION}    url=/status/404    expected_status=any
+    ${response_ok}=    GET On Session    ${GLOBAL_SESSION}    url=/status/200    expected_status=any
     Status Should Be    404    ${response_error}
diff --git a/atests/res_setup.robot b/atests/res_setup.robot
@@ -1,6 +1,6 @@
 *** Settings ***
-Library  Process
-Library  RequestsLibrary
+Library     Process
+Library     RequestsLibrary
 
 
 *** Variables ***
@@ -9,28 +9,33 @@ ${HTTP_LOCAL_SERVER}    http://localhost:5010
 
 
 *** Keywords ***
-
 Setup Test Session
-    ${test_session}=  Set Variable  test_session
-    Set Test Variable  ${test_session}
-    Create Session  ${test_session}  ${HTTP_LOCAL_SERVER}
+    ${test_session}=    Set Variable    test_session
+    Set Test Variable    ${test_session}
+    Create Session    ${test_session}    ${HTTP_LOCAL_SERVER}
 
 Teardown Test Session
     Delete All Sessions
+    # Restore global session
+    Create Session    ${GLOBAL_SESSION}    ${HTTP_LOCAL_SERVER}
 
 Setup Flask Http Server
     ${platform}=    Evaluate    sys.platform    sys
-    ${flask_cmd} =  Set Variable If
-    ...  '${platform}'=='win32'  ${CURDIR}/http_server/run.cmd
-    ...  ${CURDIR}/http_server/run.sh
+    ${flask_cmd}=    Set Variable If
+    ...    '${platform}'=='win32'    ${CURDIR}/http_server/run.cmd
+    ...    ${CURDIR}/http_server/run.sh
+
+    Set global variable    ${GLOBAL_SESSION}    ${GLOBAL_SESSION}
+    Set global variable    ${HTTP_LOCAL_SERVER}    ${HTTP_LOCAL_SERVER}
+
     # 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_SESSION}  ${HTTP_LOCAL_SERVER}
+    Start Process    ${flask_cmd}    cwd=${CURDIR}/http_server/    alias=flask    stderr=http_server.log    stdout=http_server.log
+    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 On Session  wait-until-up  /
+    Create Session    wait-until-up    ${HTTP_LOCAL_SERVER}    max_retries=10
+    Get On Session    wait-until-up    /
 
 Teardown Flask Http Server And Sessions
     Delete All Sessions

diff --git a/atests/test_authentication.robot b/atests/test_authentication.robot
@@ -1,35 +1,34 @@
 *** Settings ***
-Library  Collections
-Library  String
-Library  RequestsLibrary
-Library  customAuthenticator.py
-Resource  res_setup.robot
+Library     RequestsLibrary
+Library     customAuthenticator.py
 
-Suite Setup     Setup Flask Http Server
-Suite Teardown  Teardown Flask Http Server And Sessions
 
 *** Test Cases ***
-
 Get With Auth
-    [Tags]  get     get-cert
-    ${auth}=  Create List  user   passwd
-    Create Session    httpbin    https://httpbin.org     auth=${auth}   verify=${CURDIR}${/}cacert.pem
-    ${resp}=  GET On Session  httpbin  /basic-auth/user/passwd
-    Should Be Equal As Strings  ${resp.status_code}  200
-    Should Be Equal As Strings  ${resp.json()['authenticated']}  True
+    [Tags]    get    get-cert
+    ${auth}=    Create List    user    passwd
+    Create Session    httpbin    https://httpbin.org    auth=${auth}    verify=${CURDIR}${/}cacert.pem
+    ${resp}=    GET On Session    httpbin    /basic-auth/user/passwd
+    Should Be Equal As Strings    ${resp.status_code}    200
+    Should Be Equal As Strings    ${resp.json()['authenticated']}    True
 
 Get With Custom Auth
-    [Tags]  get
-    ${auth}=    Get Custom Auth    user   passwd
-    Create Custom Session    httpbin    https://httpbin.org     auth=${auth}   verify=${CURDIR}${/}cacert.pem
-    ${resp}=  GET On Session  httpbin  /basic-auth/user/passwd
-    Should Be Equal As Strings  ${resp.status_code}  200
-    Should Be Equal As Strings  ${resp.json()['authenticated']}  True
+    [Tags]    get
+    ${auth}=    Get Custom Auth    user    passwd
+    Create Custom Session    httpbin    https://httpbin.org    auth=${auth}    verify=${CURDIR}${/}cacert.pem
+    ${resp}=    GET On Session    httpbin    /basic-auth/user/passwd
+    Should Be Equal As Strings    ${resp.status_code}    200
+    Should Be Equal As Strings    ${resp.json()['authenticated']}    True
 
 Get With Digest Auth
-    [Tags]    get   get-cert
+    [Tags]    get    get-cert
     ${auth}=    Create List    user    pass
-    Create Digest Session    httpbin    https://httpbin.org    auth=${auth}    debug=3   verify=${CURDIR}${/}cacert.pem
+    Create Digest Session
+    ...    httpbin
+    ...    https://httpbin.org
+    ...    auth=${auth}
+    ...    debug=3
+    ...    verify=${CURDIR}${/}cacert.pem
     ${resp}=    GET On Session    httpbin    /digest-auth/auth/user/pass
     Should Be Equal As Strings    ${resp.status_code}    200
     Should Be Equal As Strings    ${resp.json()['authenticated']}    True