From d93e03c5139a87d1ab792943034a606f1620837f Mon Sep 17 00:00:00 2001 From: Peter Gubka Date: Tue, 9 May 2017 17:48:38 +0200 Subject: [PATCH] Add http_timeout to TempletedRequests library Change-Id: I86e87694fb6ad83a2f26585e1d73065cb9ca6def Signed-off-by: Peter Gubka --- csit/libraries/TemplatedRequests.robot | 84 ++++++++++++++++---------- 1 file changed, 52 insertions(+), 32 deletions(-) diff --git a/csit/libraries/TemplatedRequests.robot b/csit/libraries/TemplatedRequests.robot index e6fe496fbc..928a84f137 100644 --- a/csit/libraries/TemplatedRequests.robot +++ b/csit/libraries/TemplatedRequests.robot @@ -66,7 +66,10 @@ Documentation Resource for supporting http Requests based on data stored in ... which includes auth, host, port and (lack of) base URI. ... It is recommended to have everything past port (for example /restconf) be defined ... not in the session, but in URI data of individual templates. -... Headers are set in Keywords appropriately. +... Headers are set in Keywords appropriately. Http session's timout is configurable +... both on session level (where it becomes a default value for requests) and on request +... level (when present, it overrides the session value). To override the default +... value keywords' http_timeout parameter may be used. ... ... These Keywords contain frequent BuiltIn.Log invocations, ... so they are not suited for scale or performance suites. @@ -131,48 +134,56 @@ Create_Default_Session Get_As_Json_Templated [Arguments] ${folder} ${mapping}={} ${session}=default ${verify}=False ${iterations}=${EMPTY} ${iter_start}=1 + ... ${http_timeout}=${EMPTY} [Documentation] Add arguments sensible for JSON data, return Get_Templated response text. ... Optionally, verification against JSON data (may be iterated) is called. ... Only subset of JSON data is verified and returned if JMES path is specified in ... file ${folder}${/}jmespath.expr. ${response_text} = Get_Templated folder=${folder} mapping=${mapping} accept=${ACCEPT_EMPTY} session=${session} normalize_json=True + ... http_timeout=${http_timeout} BuiltIn.Run_Keyword_If ${verify} Verify_Response_As_Json_Templated response=${response_text} folder=${folder} base_name=data mapping=${mapping} ... iterations=${iterations} iter_start=${iter_start} [Return] ${response_text} Get_As_Xml_Templated [Arguments] ${folder} ${mapping}={} ${session}=default ${verify}=False ${iterations}=${EMPTY} ${iter_start}=1 + ... ${http_timeout}=${EMPTY} [Documentation] Add arguments sensible for XML data, return Get_Templated response text. ... Optionally, verification against XML data (may be iterated) is called. ${response_text} = Get_Templated folder=${folder} mapping=${mapping} accept=${ACCEPT_XML} session=${session} normalize_json=False + ... http_timeout=${http_timeout} BuiltIn.Run_Keyword_If ${verify} Verify_Response_As_Xml_Templated response=${response_text} folder=${folder} base_name=data mapping=${mapping} ... iterations=${iterations} iter_start=${iter_start} [Return] ${response_text} Put_As_Json_Templated [Arguments] ${folder} ${mapping}={} ${session}=default ${verify}=False ${iterations}=${EMPTY} ${iter_start}=1 + ... ${http_timeout}=${EMPTY} [Documentation] Add arguments sensible for JSON data, return Put_Templated response text. ... Optionally, verification against response.json (no iteration) is called. ... Only subset of JSON data is verified and returned if JMES path is specified in ... file ${folder}${/}jmespath.expr. ${response_text} = Put_Templated folder=${folder} base_name=data extension=json accept=${ACCEPT_EMPTY} content_type=${HEADERS_YANG_JSON} ... mapping=${mapping} session=${session} normalize_json=True endline=${\n} iterations=${iterations} iter_start=${iter_start} + ... http_timeout=${http_timeout} BuiltIn.Run_Keyword_If ${verify} Verify_Response_As_Json_Templated response=${response_text} folder=${folder} base_name=response mapping=${mapping} [Return] ${response_text} Put_As_Xml_Templated [Arguments] ${folder} ${mapping}={} ${session}=default ${verify}=False ${iterations}=${EMPTY} ${iter_start}=1 + ... ${http_timeout}=${EMPTY} [Documentation] Add arguments sensible for XML data, return Put_Templated response text. ... Optionally, verification against response.xml (no iteration) is called. # In case of iterations, we use endlines in data to send, as it should not matter and it is more readable. ${response_text} = Put_Templated folder=${folder} base_name=data extension=xml accept=${ACCEPT_XML} content_type=${HEADERS_XML} ... mapping=${mapping} session=${session} normalize_json=False endline=${\n} iterations=${iterations} iter_start=${iter_start} + ... http_timeout=${http_timeout} BuiltIn.Run_Keyword_If ${verify} Verify_Response_As_Xml_Templated response=${response_text} folder=${folder} base_name=response mapping=${mapping} [Return] ${response_text} Post_As_Json_Templated [Arguments] ${folder} ${mapping}={} ${session}=default ${verify}=False ${iterations}=${EMPTY} ${iter_start}=1 - ... ${additional_allowed_status_codes}=${NO_STATUS_CODES} ${explicit_status_codes}=${NO_STATUS_CODES} + ... ${additional_allowed_status_codes}=${NO_STATUS_CODES} ${explicit_status_codes}=${NO_STATUS_CODES} ${http_timeout}=${EMPTY} [Documentation] Add arguments sensible for JSON data, return Post_Templated response text. ... Optionally, verification against response.json (no iteration) is called. ... Only subset of JSON data is verified and returned if JMES path is specified in @@ -181,27 +192,27 @@ Post_As_Json_Templated ... created from all positive HTTP status codes together with ${additional_allowed_status_codes}. ${response_text} = Post_Templated folder=${folder} base_name=data extension=json accept=${ACCEPT_EMPTY} content_type=${HEADERS_YANG_JSON} ... mapping=${mapping} session=${session} normalize_json=True endline=${\n} iterations=${iterations} iter_start=${iter_start} - ... additional_allowed_status_codes=${additional_allowed_status_codes} explicit_status_codes=${explicit_status_codes} + ... additional_allowed_status_codes=${additional_allowed_status_codes} explicit_status_codes=${explicit_status_codes} http_timeout=${http_timeout} BuiltIn.Run_Keyword_If ${verify} Verify_Response_As_Json_Templated response=${response_text} folder=${folder} base_name=response mapping=${mapping} [Return] ${response_text} Post_As_Xml_Templated [Arguments] ${folder} ${mapping}={} ${session}=default ${verify}=False ${iterations}=${EMPTY} ${iter_start}=1 - ... ${additional_allowed_status_codes}=${NO_STATUS_CODES} ${explicit_status_codes}=${NO_STATUS_CODES} + ... ${additional_allowed_status_codes}=${NO_STATUS_CODES} ${explicit_status_codes}=${NO_STATUS_CODES} ${http_timeout}=${EMPTY} [Documentation] Add arguments sensible for XML data, return Post_Templated response text. ... Optionally, verification against response.xml (no iteration) is called. # In case of iterations, we use endlines in data to send, as it should not matter and it is more readable. ${response_text} = Post_Templated folder=${folder} base_name=data extension=xml accept=${ACCEPT_XML} content_type=${HEADERS_XML} ... mapping=${mapping} session=${session} normalize_json=False endline=${\n} iterations=${iterations} iter_start=${iter_start} - ... additional_allowed_status_codes=${additional_allowed_status_codes} explicit_status_codes=${explicit_status_codes} + ... additional_allowed_status_codes=${additional_allowed_status_codes} explicit_status_codes=${explicit_status_codes} http_timeout=${http_timeout} BuiltIn.Run_Keyword_If ${verify} Verify_Response_As_Xml_Templated response=${response_text} folder=${folder} base_name=response mapping=${mapping} [Return] ${response_text} Delete_Templated - [Arguments] ${folder} ${mapping}={} ${session}=default ${additional_allowed_status_codes}=${NO_STATUS_CODES} + [Arguments] ${folder} ${mapping}={} ${session}=default ${additional_allowed_status_codes}=${NO_STATUS_CODES} ${http_timeout}=${EMPTY} [Documentation] Resolve URI from folder, issue DELETE request. ${uri} = Resolve_Text_From_Template_Folder folder=${folder} base_name=location extension=uri mapping=${mapping} - ${response_text} = Delete_From_Uri uri=${uri} session=${session} additional_allowed_status_codes=${additional_allowed_status_codes} + ${response_text} = Delete_From_Uri uri=${uri} session=${session} additional_allowed_status_codes=${additional_allowed_status_codes} http_timeout=${http_timeout} [Return] ${response_text} Verify_Response_As_Json_Templated @@ -219,54 +230,55 @@ Verify_Response_As_Xml_Templated ... endline=${EMPTY} iterations=${iterations} iter_start=${iter_start} Get_As_Json_From_Uri - [Arguments] ${uri} ${session}=default + [Arguments] ${uri} ${session}=default ${http_timeout}=${EMPTY} [Documentation] Specify JSON headers and return Get_From_Uri normalized response text. - ${response_text} = Get_From_Uri uri=${uri} accept=${ACCEPT_EMPTY} session=${session} normalize_json=True + ${response_text} = Get_From_Uri uri=${uri} accept=${ACCEPT_EMPTY} session=${session} normalize_json=True http_timeout=${http_timeout} [Return] ${response_text} Get_As_Xml_From_Uri - [Arguments] ${uri} ${session}=default + [Arguments] ${uri} ${session}=default ${http_timeout}=${EMPTY} [Documentation] Specify XML headers and return Get_From_Uri response text. - ${response_text} = Get_From_Uri uri=${uri} accept=${ACCEPT_XML} session=${session} normalize_json=False + ${response_text} = Get_From_Uri uri=${uri} accept=${ACCEPT_XML} session=${session} normalize_json=False http_timeout=${http_timeout} [Return] ${response_text} Put_As_Json_To_Uri - [Arguments] ${uri} ${data} ${session}=default + [Arguments] ${uri} ${data} ${session}=default ${http_timeout}=${EMPTY} [Documentation] Specify JSON headers and return Put_To_Uri normalized response text. ... Yang json content type is used as a workaround to RequestsLibrary json conversion eagerness. ${response_text} = Put_To_Uri uri=${uri} data=${data} accept=${ACCEPT_EMPTY} content_type=${HEADERS_YANG_JSON} session=${session} - ... normalize_json=True + ... normalize_json=True http_timeout=${http_timeout} [Return] ${response_text} Put_As_Xml_To_Uri - [Arguments] ${uri} ${data} ${session}=default + [Arguments] ${uri} ${data} ${session}=default ${http_timeout}=${EMPTY} [Documentation] Specify XML headers and return Put_To_Uri response text. ${response_text} = Put_To_Uri uri=${uri} data=${data} accept=${ACCEPT_XML} content_type=${HEADERS_XML} session=${session} - ... normalize_json=False + ... normalize_json=False http_timeout=${http_timeout} [Return] ${response_text} Post_As_Json_To_Uri - [Arguments] ${uri} ${data} ${session}=default ${additional_allowed_status_codes}=${NO_STATUS_CODES} ${explicit_status_codes}=${NO_STATUS_CODES} + [Arguments] ${uri} ${data} ${session}=default ${additional_allowed_status_codes}=${NO_STATUS_CODES} ${explicit_status_codes}=${NO_STATUS_CODES} ${http_timeout}=${EMPTY} [Documentation] Specify JSON headers and return Post_To_Uri normalized response text. ... Yang json content type is used as a workaround to RequestsLibrary json conversion eagerness. ... Response status code must be one of values from ${explicit_status_codes} if specified or one of set ... created from all positive HTTP status codes together with ${additional_allowed_status_codes}. ${response_text} = Post_To_Uri uri=${uri} data=${data} accept=${ACCEPT_EMPTY} content_type=${HEADERS_YANG_JSON} session=${session} - ... normalize_json=True additional_allowed_status_codes=${additional_allowed_status_codes} explicit_status_codes=${explicit_status_codes} + ... normalize_json=True additional_allowed_status_codes=${additional_allowed_status_codes} explicit_status_codes=${explicit_status_codes} http_timeout=${http_timeout} [Return] ${response_text} Post_As_Xml_To_Uri - [Arguments] ${uri} ${data} ${session}=default + [Arguments] ${uri} ${data} ${session}=default ${http_timeout}=${EMPTY} [Documentation] Specify XML headers and return Post_To_Uri response text. ${response_text} = Post_To_Uri uri=${uri} data=${data} accept=${ACCEPT_XML} content_type=${HEADERS_XML} session=${session} - ... normalize_json=False + ... normalize_json=False http_timeout=${http_timeout} [Return] ${response_text} Delete_From_Uri - [Arguments] ${uri} ${session}=default ${additional_allowed_status_codes}=${NO_STATUS_CODES} + [Arguments] ${uri} ${session}=default ${additional_allowed_status_codes}=${NO_STATUS_CODES} ${http_timeout}=${EMPTY} [Documentation] DELETE resource at URI, check status_code and return response text.. BuiltIn.Log ${uri} - ${response} = RequestsLibrary.Delete_Request alias=${session} uri=${uri} + ${response} = BuiltIn.Run_Keyword_If """${http_timeout}""" == """${EMPTY}""" RequestsLibrary.Delete_Request alias=${session} uri=${uri} + ... ELSE RequestsLibrary.Delete_Request alias=${session} uri=${uri} timeout=${http_timeout} Check_Status_Code ${response} additional_allowed_status_codes=${additional_allowed_status_codes} [Return] ${response.text} @@ -280,36 +292,37 @@ Resolve_Jmes_Path [Return] ${expression} Get_Templated - [Arguments] ${folder} ${accept} ${mapping}={} ${session}=default ${normalize_json}=False + [Arguments] ${folder} ${accept} ${mapping}={} ${session}=default ${normalize_json}=False ${http_timeout}=${EMPTY} [Documentation] Resolve URI from folder, call Get_From_Uri, return response text. ${uri} = Resolve_Text_From_Template_Folder folder=${folder} base_name=location extension=uri mapping=${mapping} ${jmes_expression} = Resolve_Jmes_Path ${folder} ${response_text} = Get_From_Uri uri=${uri} accept=${accept} session=${session} normalize_json=${normalize_json} jmes_path=${jmes_expression} + ... http_timeout=${http_timeout} [Return] ${response_text} Put_Templated [Arguments] ${folder} ${base_name} ${extension} ${content_type} ${accept} ${mapping}={} - ... ${session}=default ${normalize_json}=False ${endline}=${\n} ${iterations}=${EMPTY} ${iter_start}=1 + ... ${session}=default ${normalize_json}=False ${endline}=${\n} ${iterations}=${EMPTY} ${iter_start}=1 ${http_timeout}=${EMPTY} [Documentation] Resolve URI and data from folder, call Put_To_Uri, return response text. ${uri} = Resolve_Text_From_Template_Folder folder=${folder} base_name=location extension=uri mapping=${mapping} ${data} = Resolve_Text_From_Template_Folder folder=${folder} base_name=${base_name} extension=${extension} mapping=${mapping} endline=${endline} ... iterations=${iterations} iter_start=${iter_start} ${jmes_expression} = Resolve_Jmes_Path ${folder} ${response_text} = Put_To_Uri uri=${uri} data=${data} content_type=${content_type} accept=${accept} session=${session} - ... normalize_json=${normalize_json} jmes_path=${jmes_expression} + ... http_timeout=${http_timeout} normalize_json=${normalize_json} jmes_path=${jmes_expression} [Return] ${response_text} Post_Templated [Arguments] ${folder} ${base_name} ${extension} ${content_type} ${accept} ${mapping}={} ... ${session}=default ${normalize_json}=False ${endline}=${\n} ${iterations}=${EMPTY} ${iter_start}=1 ${additional_allowed_status_codes}=${NO_STATUS_CODES} - ... ${explicit_status_codes}=${NO_STATUS_CODES} + ... ${explicit_status_codes}=${NO_STATUS_CODES} ${http_timeout}=${EMPTY} [Documentation] Resolve URI and data from folder, call Post_To_Uri, return response text. ${uri} = Resolve_Text_From_Template_Folder folder=${folder} base_name=location extension=uri mapping=${mapping} ${data} = Resolve_Text_From_Template_Folder folder=${folder} name_prefix=post_ base_name=${base_name} extension=${extension} mapping=${mapping} ... endline=${endline} iterations=${iterations} iter_start=${iter_start} ${jmes_expression} = Resolve_Jmes_Path ${folder} ${response_text} = Post_To_Uri uri=${uri} data=${data} content_type=${content_type} accept=${accept} session=${session} - ... jmes_path=${jmes_expression} normalize_json=${normalize_json} additional_allowed_status_codes=${additional_allowed_status_codes} explicit_status_codes=${explicit_status_codes} + ... jmes_path=${jmes_expression} normalize_json=${normalize_json} additional_allowed_status_codes=${additional_allowed_status_codes} explicit_status_codes=${explicit_status_codes} http_timeout=${http_timeout} [Return] ${response_text} Verify_Response_Templated @@ -325,13 +338,14 @@ Verify_Response_Templated ... ELSE BuiltIn.Should_Be_Equal ${expected_text} ${response} Get_From_Uri - [Arguments] ${uri} ${accept}=${ACCEPT_EMPTY} ${session}=default ${normalize_json}=False ${jmes_path}=${EMPTY} + [Arguments] ${uri} ${accept}=${ACCEPT_EMPTY} ${session}=default ${normalize_json}=False ${jmes_path}=${EMPTY} ${http_timeout}=${EMPTY} [Documentation] GET data from given URI, check status code and return response text. ... \${accept} is a Python object with headers to use. ... If \${normalize_json}, normalize as JSON text before returning. BuiltIn.Log ${uri} BuiltIn.Log ${accept} - ${response} = RequestsLibrary.Get_Request alias=${session} uri=${uri} headers=${accept} + ${response} = BuiltIn.Run_Keyword_If """${http_timeout}""" == """${EMPTY}""" RequestsLibrary.Get_Request alias=${session} uri=${uri} headers=${accept} + ... ELSE RequestsLibrary.Get_Request alias=${session} uri=${uri} headers=${accept} timeout=${http_timeout} Check_Status_Code ${response} BuiltIn.Run_Keyword_Unless ${normalize_json} BuiltIn.Return_From_Keyword ${response.text} ${text_normalized} = norm_json.normalize_json_text ${response.text} jmes_path=${jmes_path} @@ -339,7 +353,7 @@ Get_From_Uri Put_To_Uri [Arguments] ${uri} ${data} ${content_type} ${accept} ${session}=default ${normalize_json}=False - ... ${jmes_path}=${EMPTY} + ... ${jmes_path}=${EMPTY} ${http_timeout}=${EMPTY} [Documentation] PUT data to given URI, check status code and return response text. ... \${content_type} and \${accept} are mandatory Python objects with headers to use. ... If \${normalize_json}, normalize text before returning. @@ -348,7 +362,10 @@ Put_To_Uri BuiltIn.Log ${content_type} BuiltIn.Log ${accept} ${headers} = Join_Two_Headers first=${content_type} second=${accept} - ${response} = RequestsLibrary.Put_Request alias=${session} uri=${uri} data=${data} headers=${headers} + ${response} = BuiltIn.Run_Keyword_If """${http_timeout}""" == """${EMPTY}""" RequestsLibrary.Put_Request alias=${session} uri=${uri} data=${data} + ... headers=${headers} + ... ELSE RequestsLibrary.Put_Request alias=${session} uri=${uri} data=${data} headers=${headers} + ... timeout=${http_timeout} Check_Status_Code ${response} BuiltIn.Run_Keyword_Unless ${normalize_json} BuiltIn.Return_From_Keyword ${response.text} ${text_normalized} = norm_json.normalize_json_text ${response.text} jmes_path=${jmes_path} @@ -356,7 +373,7 @@ Put_To_Uri Post_To_Uri [Arguments] ${uri} ${data} ${content_type} ${accept} ${session}=default ${normalize_json}=False - ... ${jmes_path}=${EMPTY} ${additional_allowed_status_codes}=${NO_STATUS_CODES} ${explicit_status_codes}=${NO_STATUS_CODES} + ... ${jmes_path}=${EMPTY} ${additional_allowed_status_codes}=${NO_STATUS_CODES} ${explicit_status_codes}=${NO_STATUS_CODES} ${http_timeout}=${EMPTY} [Documentation] POST data to given URI, check status code and return response text. ... \${content_type} and \${accept} are mandatory Python objects with headers to use. ... If \${normalize_json}, normalize text before returning. @@ -365,7 +382,10 @@ Post_To_Uri BuiltIn.Log ${content_type} BuiltIn.Log ${accept} ${headers} = Join_Two_Headers first=${content_type} second=${accept} - ${response} = RequestsLibrary.Post_Request alias=${session} uri=${uri} data=${data} headers=${headers} + ${response} = BuiltIn.Run_Keyword_If """${http_timeout}""" == """${EMPTY}""" RequestsLibrary.Post_Request alias=${session} uri=${uri} data=${data} + ... headers=${headers} + ... ELSE RequestsLibrary.Post_Request alias=${session} uri=${uri} data=${data} headers=${headers} + ... timeout=${http_timeout} Check_Status_Code ${response} additional_allowed_status_codes=${additional_allowed_status_codes} explicit_status_codes=${explicit_status_codes} BuiltIn.Run_Keyword_Unless ${normalize_json} BuiltIn.Return_From_Keyword ${response.text} ${text_normalized} = norm_json.normalize_json_text ${response.text} jmes_path=${jmes_path} -- 2.36.6