Actions.RestActions package¶

Submodules¶

Actions.RestActions.rest_actions module¶

Copyright 2017, Fujitsu Network Communications, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class Actions.RestActions.rest_actions.RestActions[source]¶

Bases: object

Rest class

perform_http_delete(system_name, variable_config=None, request_id=None, data=None, url=None, expected_response=None, headers=None, user=None, password=None, allow_redirects=None, timeout=None, json=None, cookies=None, files=None, proxies=None, verify=None, stream=None, cert=None, var_sub=None)[source]¶

Perform a http post actions and get the response This keyword uses the warrior recommended Input datafile format for rest

Please refer to perform_http_post keyword documentation to understand all patterns

Arguments:

system_name: Name of the system from the datafile

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Other Restrictions: Should be valid system name from the datafile

eg: http_system_1
request_id: A unique request ID for this request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: 01
url: Represents URL/ip address that is supposed to be tested

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: http://httpbin.org
params: Represents parameters that need to be sent along with the URL

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: postId=1; comments=5
data: Represents data to be posted. HTTP GET does NOT accept this argument.

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Encoding: Unicode

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: userId=1;id=1;title=Changed Post;body=New Comment

u0075u0073u0065u0072u0049u0064u003du0031u003bu0069 u0064u003du0031u003bu0074 path/to/file/containing/data
json: Represents the JSON data that goes into the body of the request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Format: Valid JSON format

eg: {“postId”:”1”, “comments”:”This is a new comment”}
headers: Represents the headers sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: Content-Type=text; Date=04/21/2016; Allow=whatever_you_want_to_allow
cookies: Represents the cookies sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: cookie=cookie_name; details=more_details_abput_the_cookie

path/to/file/containing/cookie/details
files: Lets User accomplish multipart encoding upload

Pattern: string pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”path_to_file1, path_to_file2, path_to_file3”/>

Pattern: dict-tuple pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”file_group_name=path_to_file1,

path_to_file2, path_to_file4, path_to_file5”/>

Pattern: tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”(path_to_file1;content_type),

(path_to_file2;content_type), (path_to_file3;content_type)”/>

Pattern: dict-in-tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values inside the Dictionary Pattern: No Restrictions Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files”

value=”(path_to_file1;content_type;(custom_header_1=value1;

custom_header_2:value2)),

(path_to_file2;content_type;(custom_header_1=value1)), (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3))”/>

eg: <argument name=”files”

value=”(path_to_file1;content_type),

path_to_file2, (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2),

(path_to_file4;content_type), (path_to_file5;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3)),

path_to_file6, path_to_file_7”/>
user: Represents the username that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: Sanika
password: Represents the password that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: password
timeout: Represents the time barrier in which the request should be completed

If 2 values are given, the first value would be treated as a constraint for sending the request, the second would be treated as a constraint for receiving the response. If only one value is given, it would be treated as constraint for sending the request and receiving a response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: Numerical Characters - Int or Float

eg: 0.5, 0.75

0.6
allow_redirects: Allows or disallows redirection

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

eg: yes
proxies: Allows the User to set up proxies for ip addresses

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: http=157.126.12.196:8081; https:157.126.12.144:80
verify: Allows user to enable or disable authentication

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path to a .pem file

eg: path/to/CA_BUNDLE

no
stream: Allows user to enable or disable immediate data downloading

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘no’

eg: yes
cert: Allows user to send his/her own certificate

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: All Characters

Other Restrictions: Both the inputs should be valid file paths. Input 1 should be a file path to the certificate file If the file specified in Input 1 contains the key, Input 2 is not necessary If the key is stored in a different file, Input 2 should contain the path to that file.

eg: path/to/certificate/file, path/to/key/file

path/to/certificate/file/which/contains/the/key
expected_response: User specified expected response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: Numerical Characters - Integers only Default: The entire 200 series of HTTP Responses

eg: 200, 302, 404

200
variable_config: The variable config file that contains variables that need to be substituted into the json that is being passed to this request. This can either be a relative or an absolute path.

Eg: ../Config_files/var_config.xml

/home/user/warrior_main/Warrior/Warriorspace/Config_files/var_config.xml
var_sub: the pattern [var_sub] in the json will get substituted with this value.

Returns:

<system_name>_status(boolean) = status code of the http delete
<system_name>_api_response = the entire response object of the http request

Note: The Request Number is applicable when variable substitution in JSON is being used. As variables get substituted in JSON, multiple JSONs are formed and each JSON is sent as a separate request. These requests are differentiated by adding add “request_number” which is basically the serial number of those requests.

The entire response object of the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_object <system_name>_api_response_object_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_object <system_name>_<request_id>_api_response_object_<request_number>

The response text (in text format) returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_text <system_name>_api_response_text_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_text <system_name>_<request_id>_api_response_text_<request_number>

The status code returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_status <system_name>_api_response_status_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_status <system_name>_<request_id>_api_response_status_<request_number>

The content_type of the response returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_content_type <system_name>_api_response_content_type_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content_type <system_name>_<request_id>_api_response_content_type_<request_number>

The extracted response returned from the response object (stored in the format that it is returned in - JSON, XML, Text) is stored as:

If request_id has not been provided:: <system_name>_api_response_content <system_name>_api_response_content_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content <system_name>_<request_id>_api_response_content_<request_number>

perform_http_get(system_name, variable_config=None, request_id=None, url=None, params=None, expected_response=None, headers=None, user=None, password=None, allow_redirects=None, timeout=None, json=None, cookies=None, files=None, proxies=None, verify=None, stream=None, cert=None, var_sub=None)[source]¶

Perform a http post actions and get the response This keyword uses the warrior recommended Input datafile format for rest

Please refer to perform_http_post keyword documentation to understand all patterns

Arguments:

system_name: Name of the system from the datafile

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Other Restrictions: Should be valid system name from the datafile

eg: http_system_1
request_id: A unique request ID for this request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: 01
url: Represents URL/ip address that is supposed to be tested

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: http://httpbin.org
params: Represents parameters that need to be sent along with the URL

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: postId=1; comments=5
json: Represents the JSON data that goes into the body of the request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Format: Valid JSON format

eg: {“postId”:”1”, “comments”:”This is a new comment”}
headers: Represents the headers sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: Content-Type=text; Date=04/21/2016; Allow=whatever_you_want_to_allow
cookies: Represents the cookies sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: cookie=cookie_name; details=more_details_abput_the_cookie

path/to/file/containing/cookie/details
files: Lets User accomplish multipart encoding upload

Pattern: string pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”path_to_file1, path_to_file2, path_to_file3”/>

Pattern: dict-tuple pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”file_group_name=path_to_file1,

path_to_file2, path_to_file4, path_to_file5”/>

Pattern: tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”(path_to_file1;content_type),

(path_to_file2;content_type), (path_to_file3;content_type)”/>

Pattern: dict-in-tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values inside the Dictionary Pattern: No Restrictions Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files”

value=”(path_to_file1;content_type;(custom_header_1=value1;

custom_header_2:value2)),

(path_to_file2;content_type;(custom_header_1=value1)), (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3))”/>

eg: <argument name=”files”

value=”(path_to_file1;content_type),

path_to_file2, (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2),

(path_to_file4;content_type), (path_to_file5;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3)),

path_to_file6, path_to_file_7”/>
user: Represents the username that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: Sanika
password: Represents the password that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: password
timeout: Represents the time barrier in which the request should be completed

If 2 values are given, the first value would be treated as a constraint for sending the request, the second would be treated as a constraint for receiving the response. If only one value is given, it would be treated as constraint for sending the request and receiving a response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: Numerical Characters - Int or Float

eg: 0.5, 0.75

0.6
allow_redirects: Allows or disallows redirection

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

eg: yes
proxies: Allows the User to set up proxies for ip addresses

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: http=157.126.12.196:8081; https:157.126.12.144:80
verify: Allows user to enable or disable authentication

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path to a .pem file

eg: path/to/CA_BUNDLE

no
stream: Allows user to enable or disable immediate data downloading

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘no’

eg: yes
cert: Allows user to send his/her own certificate

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: All Characters

Other Restrictions: Both the inputs should be valid file paths. Input 1 should be a file path to the certificate file If the file specified in Input 1 contains the key, Input 2 is not necessary If the key is stored in a different file, Input 2 should contain the path to that file.

eg: path/to/certificate/file, path/to/key/file

path/to/certificate/file/which/contains/the/key
expected_response: User specified expected response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: Numerical Characters - Integers only Default: The entire 200 series of HTTP Responses

eg: 200, 302, 404

200
variable_config: The variable config file that contains variables that need to be substituted into the json that is being passed to this request. This can either be a relative or an absolute path.

Eg: ../Config_files/var_config.xml

/home/user/warrior_main/Warrior/Warriorspace/Config_files/var_config.xml
var_sub: the pattern [var_sub] in the json will get substituted with this value.

Returns:

<system_name>_status(boolean) = status code of the http get
<system_name>_api_response = the entire response object of the http request

Note: The Request Number is applicable when variable substitution in JSON is being used. As variables get substituted in JSON, multiple JSONs are formed and each JSON is sent as a separate request. These requests are differentiated by adding add “request_number” which is basically the serial number of those requests.

The entire response object of the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_object <system_name>_api_response_object_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_object <system_name>_<request_id>_api_response_object_<request_number>

The response text (in text format) returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_text <system_name>_api_response_text_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_text <system_name>_<request_id>_api_response_text_<request_number>

The status code returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_status <system_name>_api_response_status_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_status <system_name>_<request_id>_api_response_status_<request_number>

The content_type of the response returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_content_type <system_name>_api_response_content_type_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content_type <system_name>_<request_id>_api_response_content_type_<request_number>

The extracted response returned from the response object (stored in the format that it is returned in - JSON, XML, Text) is stored as:

If request_id has not been provided:: <system_name>_api_response_content <system_name>_api_response_content_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content <system_name>_<request_id>_api_response_content_<request_number>

perform_http_head(system_name, variable_config=None, request_id=None, data=None, url=None, expected_response=None, headers=None, user=None, password=None, allow_redirects=None, timeout=None, json=None, cookies=None, files=None, proxies=None, verify=None, stream=None, cert=None, var_sub=None)[source]¶

Perform a http post actions and get the response This keyword uses the warrior recommended Input datafile format for rest

Please refer to perform_http_post keyword documentation to understand all patterns

Arguments:

system_name: Name of the system from the datafile

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Other Restrictions: Should be valid system name from the datafile

eg: http_system_1
request_id: A unique request ID for this request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: 01
url: Represents URL/ip address that is supposed to be tested

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: http://httpbin.org
params: Represents parameters that need to be sent along with the URL

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: postId=1; comments=5
data: Represents data to be posted. HTTP GET does NOT accept this argument.

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Encoding: Unicode

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: userId=1;id=1;title=Changed Post;body=New Comment

u0075u0073u0065u0072u0049u0064u003du0031u003bu0069 u0064u003du0031u003bu0074 path/to/file/containing/data
json: Represents the JSON data that goes into the body of the request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Format: Valid JSON format

eg: {“postId”:”1”, “comments”:”This is a new comment”}
headers: Represents the headers sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: Content-Type=text; Date=04/21/2016; Allow=whatever_you_want_to_allow
cookies: Represents the cookies sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: cookie=cookie_name; details=more_details_abput_the_cookie

path/to/file/containing/cookie/details
files: Lets User accomplish multipart encoding upload

Pattern: string pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”path_to_file1, path_to_file2, path_to_file3”/>

Pattern: dict-tuple pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”file_group_name=path_to_file1,

path_to_file2, path_to_file4, path_to_file5”/>

Pattern: tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”(path_to_file1;content_type),

(path_to_file2;content_type), (path_to_file3;content_type)”/>

Pattern: dict-in-tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values inside the Dictionary Pattern: No Restrictions Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files”

value=”(path_to_file1;content_type;(custom_header_1=value1;

custom_header_2:value2)),

(path_to_file2;content_type;(custom_header_1=value1)), (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3))”/>

eg: <argument name=”files”

value=”(path_to_file1;content_type),

path_to_file2, (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2),

(path_to_file4;content_type), (path_to_file5;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3)),

path_to_file6, path_to_file_7”/>
user: Represents the username that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: Sanika
password: Represents the password that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: password
timeout: Represents the time barrier in which the request should be completed

If 2 values are given, the first value would be treated as a constraint for sending the request, the second would be treated as a constraint for receiving the response. If only one value is given, it would be treated as constraint for sending the request and receiving a response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: Numerical Characters - Int or Float

eg: 0.5, 0.75

0.6
allow_redirects: Allows or disallows redirection

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

eg: yes
proxies: Allows the User to set up proxies for ip addresses

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: http=157.126.12.196:8081; https:157.126.12.144:80
verify: Allows user to enable or disable authentication

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path to a .pem file

eg: path/to/CA_BUNDLE

no
stream: Allows user to enable or disable immediate data downloading

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘no’

eg: yes
cert: Allows user to send his/her own certificate

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: All Characters

Other Restrictions: Both the inputs should be valid file paths. Input 1 should be a file path to the certificate file If the file specified in Input 1 contains the key, Input 2 is not necessary If the key is stored in a different file, Input 2 should contain the path to that file.

eg: path/to/certificate/file, path/to/key/file

path/to/certificate/file/which/contains/the/key
expected_response: User specified expected response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: Numerical Characters - Integers only Default: The entire 200 series of HTTP Responses

eg: 200, 302, 404

200
variable_config: The variable config file that contains variables that need to be substituted into the json that is being passed to this request. This can either be a relative or an absolute path.

Eg: ../Config_files/var_config.xml

/home/user/warrior_main/Warrior/Warriorspace/Config_files/var_config.xml
var_sub: the pattern [var_sub] in the json will get substituted with this value.

Returns:

<system_name>_status(boolean) = status code of the http head
<system_name>_api_response = the entire response object of the http request

Note: The Request Number is applicable when variable substitution in JSON is being used. As variables get substituted in JSON, multiple JSONs are formed and each JSON is sent as a separate request. These requests are differentiated by adding add “request_number” which is basically the serial number of those requests.

The entire response object of the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_object <system_name>_api_response_object_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_object <system_name>_<request_id>_api_response_object_<request_number>

The response text (in text format) returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_text <system_name>_api_response_text_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_text <system_name>_<request_id>_api_response_text_<request_number>

The status code returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_status <system_name>_api_response_status_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_status <system_name>_<request_id>_api_response_status_<request_number>

The content_type of the response returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_content_type <system_name>_api_response_content_type_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content_type <system_name>_<request_id>_api_response_content_type_<request_number>

The extracted response returned from the response object (stored in the format that it is returned in - JSON, XML, Text) is stored as:

If request_id has not been provided:: <system_name>_api_response_content <system_name>_api_response_content_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content <system_name>_<request_id>_api_response_content_<request_number>

perform_http_options(system_name, variable_config=None, request_id=None, data=None, url=None, expected_response=None, headers=None, user=None, password=None, allow_redirects=None, timeout=None, json=None, cookies=None, files=None, proxies=None, verify=None, stream=None, cert=None, var_sub=None)[source]¶

Perform a http post actions and get the response This keyword uses the warrior recommended Input datafile format for rest

Please refer to perform_http_post keyword documentation to understand all patterns

Arguments:

system_name: Name of the system from the datafile

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Other Restrictions: Should be valid system name from the datafile

eg: http_system_1
request_id: A unique request ID for this request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: 01
url: Represents URL/ip address that is supposed to be tested

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: http://httpbin.org
params: Represents parameters that need to be sent along with the URL

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: postId=1; comments=5
data: Represents data to be posted. HTTP GET does NOT accept this argument.

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Encoding: Unicode

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: userId=1;id=1;title=Changed Post;body=New Comment

u0075u0073u0065u0072u0049u0064u003du0031u003bu0069 u0064u003du0031u003bu0074 path/to/file/containing/data
json: Represents the JSON data that goes into the body of the request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Format: Valid JSON format

eg: {“postId”:”1”, “comments”:”This is a new comment”}
headers: Represents the headers sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: Content-Type=text; Date=04/21/2016; Allow=whatever_you_want_to_allow
cookies: Represents the cookies sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: cookie=cookie_name; details=more_details_abput_the_cookie

path/to/file/containing/cookie/details
files: Lets User accomplish multipart encoding upload

Pattern: string pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”path_to_file1, path_to_file2, path_to_file3”/>

Pattern: dict-tuple pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”file_group_name=path_to_file1,

path_to_file2, path_to_file4, path_to_file5”/>

Pattern: tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”(path_to_file1;content_type),

(path_to_file2;content_type), (path_to_file3;content_type)”/>

Pattern: dict-in-tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values inside the Dictionary Pattern: No Restrictions Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files”

value=”(path_to_file1;content_type;(custom_header_1=value1;

custom_header_2:value2)),

(path_to_file2;content_type;(custom_header_1=value1)), (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3))”/>

eg: <argument name=”files”

value=”(path_to_file1;content_type),

path_to_file2, (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2),

(path_to_file4;content_type), (path_to_file5;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3)),

path_to_file6, path_to_file_7”/>
user: Represents the username that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: Sanika
password: Represents the password that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: password
timeout: Represents the time barrier in which the request should be completed

If 2 values are given, the first value would be treated as a constraint for sending the request, the second would be treated as a constraint for receiving the response. If only one value is given, it would be treated as constraint for sending the request and receiving a response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: Numerical Characters - Int or Float

eg: 0.5, 0.75

0.6
allow_redirects: Allows or disallows redirection

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

eg: yes
proxies: Allows the User to set up proxies for ip addresses

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: http=157.126.12.196:8081; https:157.126.12.144:80
verify: Allows user to enable or disable authentication

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path to a .pem file

eg: path/to/CA_BUNDLE

no
stream: Allows user to enable or disable immediate data downloading

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘no’

eg: yes
cert: Allows user to send his/her own certificate

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: All Characters

Other Restrictions: Both the inputs should be valid file paths. Input 1 should be a file path to the certificate file If the file specified in Input 1 contains the key, Input 2 is not necessary If the key is stored in a different file, Input 2 should contain the path to that file.

eg: path/to/certificate/file, path/to/key/file

path/to/certificate/file/which/contains/the/key
expected_response: User specified expected response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: Numerical Characters - Integers only Default: The entire 200 series of HTTP Responses

eg: 200, 302, 404

200
variable_config: The variable config file that contains variables that need to be substituted into the json that is being passed to this request. This can either be a relative or an absolute path.

Eg: ../Config_files/var_config.xml

/home/user/warrior_main/Warrior/Warriorspace/Config_files/var_config.xml
var_sub: the pattern [var_sub] in the json will get substituted with this value.

Returns:

<system_name>_status(boolean) = status code of the http options
<system_name>_api_response = the entire response object of the http request

Note: The Request Number is applicable when variable substitution in JSON is being used. As variables get substituted in JSON, multiple JSONs are formed and each JSON is sent as a separate request. These requests are differentiated by adding add “request_number” which is basically the serial number of those requests.

The entire response object of the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_object <system_name>_api_response_object_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_object <system_name>_<request_id>_api_response_object_<request_number>

The response text (in text format) returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_text <system_name>_api_response_text_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_text <system_name>_<request_id>_api_response_text_<request_number>

The status code returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_status <system_name>_api_response_status_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_status <system_name>_<request_id>_api_response_status_<request_number>

The content_type of the response returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_content_type <system_name>_api_response_content_type_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content_type <system_name>_<request_id>_api_response_content_type_<request_number>

The extracted response returned from the response object (stored in the format that it is returned in - JSON, XML, Text) is stored as:

If request_id has not been provided:: <system_name>_api_response_content <system_name>_api_response_content_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content <system_name>_<request_id>_api_response_content_<request_number>

perform_http_patch(system_name, variable_config=None, request_id=None, data=None, url=None, expected_response=None, headers=None, user=None, password=None, allow_redirects=None, timeout=None, json=None, cookies=None, files=None, proxies=None, verify=None, stream=None, cert=None, var_sub=None)[source]¶

Perform a http post actions and get the response This keyword uses the warrior recommended Input datafile format for rest

Please refer to perform_http_post keyword documentation to understand all patterns

Arguments:

system_name: Name of the system from the datafile

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Other Restrictions: Should be valid system name from the datafile

eg: http_system_1
request_id: A unique request ID for this request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: 01
url: Represents URL/ip address that is supposed to be tested

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: http://httpbin.org
params: Represents parameters that need to be sent along with the URL

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: postId=1; comments=5
data: Represents data to be posted. HTTP GET does NOT accept this argument.

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Encoding: Unicode

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: userId=1;id=1;title=Changed Post;body=New Comment

u0075u0073u0065u0072u0049u0064u003du0031u003bu0069 u0064u003du0031u003bu0074 path/to/file/containing/data
json: Represents the JSON data that goes into the body of the request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Format: Valid JSON format

eg: {“postId”:”1”, “comments”:”This is a new comment”}
headers: Represents the headers sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: Content-Type=text; Date=04/21/2016; Allow=whatever_you_want_to_allow
cookies: Represents the cookies sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: cookie=cookie_name; details=more_details_abput_the_cookie

path/to/file/containing/cookie/details
files: Lets User accomplish multipart encoding upload

Pattern: string pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”path_to_file1, path_to_file2, path_to_file3”/>

Pattern: dict-tuple pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”file_group_name=path_to_file1,

path_to_file2, path_to_file4, path_to_file5”/>

Pattern: tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”(path_to_file1;content_type),

(path_to_file2;content_type), (path_to_file3;content_type)”/>

Pattern: dict-in-tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values inside the Dictionary Pattern: No Restrictions Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files”

value=”(path_to_file1;content_type;(custom_header_1=value1;

custom_header_2:value2)),

(path_to_file2;content_type;(custom_header_1=value1)), (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3))”/>

eg: <argument name=”files”

value=”(path_to_file1;content_type),

path_to_file2, (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2),

(path_to_file4;content_type), (path_to_file5;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3)),

path_to_file6, path_to_file_7”/>
user: Represents the username that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: Sanika
password: Represents the password that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: password
timeout: Represents the time barrier in which the request should be completed

If 2 values are given, the first value would be treated as a constraint for sending the request, the second would be treated as a constraint for receiving the response. If only one value is given, it would be treated as constraint for sending the request and receiving a response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: Numerical Characters - Int or Float

eg: 0.5, 0.75

0.6
allow_redirects: Allows or disallows redirection

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

eg: yes
proxies: Allows the User to set up proxies for ip addresses

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: http=157.126.12.196:8081; https:157.126.12.144:80
verify: Allows user to enable or disable authentication

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path to a .pem file

eg: path/to/CA_BUNDLE

no
stream: Allows user to enable or disable immediate data downloading

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘no’

eg: yes
cert: Allows user to send his/her own certificate

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: All Characters

Other Restrictions: Both the inputs should be valid file paths. Input 1 should be a file path to the certificate file If the file specified in Input 1 contains the key, Input 2 is not necessary If the key is stored in a different file, Input 2 should contain the path to that file.

eg: path/to/certificate/file, path/to/key/file

path/to/certificate/file/which/contains/the/key
expected_response: User specified expected response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: Numerical Characters - Integers only Default: The entire 200 series of HTTP Responses

eg: 200, 302, 404

200
variable_config: The variable config file that contains variables that need to be substituted into the json that is being passed to this request. This can either be a relative or an absolute path.

Eg: ../Config_files/var_config.xml

/home/user/warrior_main/Warrior/Warriorspace/Config_files/var_config.xml
var_sub: the pattern [var_sub] in the json will get substituted with this value.

Returns:

<system_name>_status(boolean) = status code of the http patch
<system_name>_api_response = the entire response object of the http request

Note: The Request Number is applicable when variable substitution in JSON is being used. As variables get substituted in JSON, multiple JSONs are formed and each JSON is sent as a separate request. These requests are differentiated by adding add “request_number” which is basically the serial number of those requests.

The entire response object of the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_object <system_name>_api_response_object_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_object <system_name>_<request_id>_api_response_object_<request_number>

The response text (in text format) returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_text <system_name>_api_response_text_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_text <system_name>_<request_id>_api_response_text_<request_number>

The status code returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_status <system_name>_api_response_status_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_status <system_name>_<request_id>_api_response_status_<request_number>

The content_type of the response returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_content_type <system_name>_api_response_content_type_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content_type <system_name>_<request_id>_api_response_content_type_<request_number>

The extracted response returned from the response object (stored in the format that it is returned in - JSON, XML, Text) is stored as:

If request_id has not been provided:: <system_name>_api_response_content <system_name>_api_response_content_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content <system_name>_<request_id>_api_response_content_<request_number>

perform_http_post(system_name, variable_config=None, request_id=None, url=None, data=None, expected_response=None, headers=None, user=None, password=None, allow_redirects=None, timeout=None, json=None, cookies=None, files=None, proxies=None, verify=None, stream=None, cert=None, var_sub=None)[source]¶

Perform a http post actions and get the response This keyword uses the warrior recommended Input datafile format for rest

GLOSSARY

** string pattern ** This pattern basically accepts every alphabet, number, and special character. Multiple values are accepted only where specified. Separator would be specified if multiple values are accepted. Other restrictions would be specified wherever needed

** dictionary pattern **

This pattern does not accept multiple values for a single key. Key-Value pairs are separated by ; Key and the corresponding value is separated by =

Eg. key1=value1; key2=value2; key3=value3

** dict-tuple pattern **

This pattern accepts multiple values for every key. Key-Value pairs are separated by , Key and the corresponding value/s is/are separated by = Values are separated by ;

Eg. key1=value1;value2;value3, key2=value4;value5;value6, key3=value6;value7

** tuple pattern **

This pattern accepts groups of elements. Groups are separated by commas Elements inside the group are separated by ; Groups are enclosed inside parenthesis Maximum number of elements inside a group: 2

(element_11; element_12),(element_21; element_22),(element_31; element_32)

** dict-in-tuple pattern ** This pattern accepts groups of elements. Only in the 3rd position, a dictionary patten is accepted. Maximum number of elements inside a group: 3 Maximum number of elements inside the dictionary patten: No restrictions The first two place do not accept dictionary pattern. Groups are separated by , Groups are enclosed inside parenthesis The dictionary patten inside the group is also enclosed in a parenthesis Elements inside a group are separated by ; Dictionary pattern accepted in the third position follows the specified dictionary pattern

(element_11;element_12;(key_11=value_11; key_12:value_12)), (element_21;element_22;(key_21=value_21)), (element_31;element_32;(key_31=value_31; key_32:value_32; key_33=value_33; key_34:value_34))

Arguments:

system_name: Name of the system from the datafile

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Other Restrictions: Should be valid system name from the datafile

eg: http_system_1
url: Represents URL/ip address that is supposed to be tested

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: http://httpbin.org
params: Represents parameters that need to be sent along with the URL

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: postId=1; comments=5
data: Represents data to be posted. HTTP GET does NOT accept this argument.

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Encoding: Unicode

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: userId=1;id=1;title=Changed Post;body=New Comment

u0075u0073u0065u0072u0049u0064u003du0031u003bu0069 u0064u003du0031u003bu0074 path/to/file/containing/data
json: Represents the JSON data that goes into the body of the request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Format: Valid JSON format

eg: {“postId”:”1”, “comments”:”This is a new comment”}
headers: Represents the headers sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: Content-Type=text; Date=04/21/2016; Allow=whatever_you_want_to_allow
cookies: Represents the cookies sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: cookie=cookie_name; details=more_details_abput_the_cookie

path/to/file/containing/cookie/details
files: Lets User accomplish multipart encoding upload

Pattern: string pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”path_to_file1, path_to_file2, path_to_file3”/>

Pattern: dict-tuple pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”file_group_name=path_to_file1, path_to_file2,

path_to_file4, path_to_file5”/>

Pattern: tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”(path_to_file1;content_type),

(path_to_file2;content_type), (path_to_file3;content_type)”/>

Pattern: dict-in-tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values inside the Dictionary Pattern: No Restrictions Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files”

value=”(path_to_file1;content_type;(custom_header_1=value1;

custom_header_2:value2)),

(path_to_file2;content_type;(custom_header_1=value1)), (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3))”/>

eg: <argument name=”files”

value=”(path_to_file1;content_type),

path_to_file2, (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2),

(path_to_file4;content_type), (path_to_file5;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3)),

path_to_file6, path_to_file_7”/>
user: Represents the username that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: Sanika
password: Represents the password that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: password
timeout: Represents the time barrier in which the request should be completed

If 2 values are given, the first value would be treated as a constraint for sending the request, the second would be treated as a constraint for receiving the response. If only one value is given, it would be treated as constraint for sending the request and receiving a response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: Numerical Characters - Int or Float

eg: 0.5, 0.75

0.6
allow_redirects: Allows or disallows redirection

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

eg: yes
proxies: Allows the User to set up proxies for ip addresses

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: http=157.126.12.196:8081; https:157.126.12.144:80
verify: Allows user to enable or disable authentication

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path to a .pem file

eg: path/to/CA_BUNDLE

no
stream: Allows user to enable or disable immediate data downloading

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘no’

eg: yes
cert: Allows user to send his/her own certificate

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: All Characters

Other Restrictions: Both the inputs should be valid file paths. Input 1 should be a file path to the certificate file If the file specified in Input 1 contains the key, Input 2 is not necessary If the key is stored in a different file, Input 2 should contain the path to that file.

eg: path/to/certificate/file, path/to/key/file

path/to/certificate/file/which/contains/the/key
expected_response: User specified expected response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: Numerical Characters - Integers only Default: The entire 200 series of HTTP Responses

eg: 200, 302, 404

200
request_id: A unique request ID for this request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: 01
variable_config: The variable config file that contains variables that need to be substituted into the json that is being passed to this request. This can either be a relative or an absolute path.

Eg: ../Config_files/var_config.xml

/home/user/warrior_main/Warrior/Warriorspace/Config_files/var_config.xml
var_sub: the pattern [var_sub] in the json will get substituted with this value.

Returns:

<system_name>_status(boolean) = status code of the http post
<system_name>_api_response = the entire response object of the http request

Note: The Request Number is applicable when variable substitution in JSON is being used. As variables get substituted in JSON, multiple JSONs are formed and each JSON is sent as a separate request. These requests are differentiated by adding add “request_number” which is basically the serial number of those requests.

The entire response object of the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_object <system_name>_api_response_object_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_object <system_name>_<request_id>_api_response_object_<request_number>

The response text (in text format) returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_text <system_name>_api_response_text_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_text <system_name>_<request_id>_api_response_text_<request_number>

The status code returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_status <system_name>_api_response_status_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_status <system_name>_<request_id>_api_response_status_<request_number>

The content_type of the response returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_content_type <system_name>_api_response_content_type_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content_type <system_name>_<request_id>_api_response_content_type_<request_number>

The extracted response returned from the response object (stored in the format that it is returned in - JSON, XML, Text) is stored as:

If request_id has not been provided:: <system_name>_api_response_content <system_name>_api_response_content_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content <system_name>_<request_id>_api_response_content_<request_number>

perform_http_put(system_name, variable_config=None, request_id=None, data=None, url=None, expected_response=None, headers=None, user=None, password=None, allow_redirects=None, timeout=None, json=None, cookies=None, files=None, proxies=None, verify=None, stream=None, cert=None, var_sub=None)[source]¶

Perform a http post actions and get the response This keyword uses the warrior recommended Input datafile format for rest

Please refer to perform_http_post keyword documentation to understand all patterns

Arguments:

system_name: Name of the system from the datafile

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Other Restrictions: Should be valid system name from the datafile

eg: http_system_1
request_id: A unique request ID for this request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: 01
url: Represents URL/ip address that is supposed to be tested

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: http://httpbin.org
params: Represents parameters that need to be sent along with the URL

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: postId=1; comments=5
data: Represents data to be posted. HTTP GET does NOT accept this argument.

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Encoding: Unicode

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: userId=1;id=1;title=Changed Post;body=New Comment

u0075u0073u0065u0072u0049u0064u003du0031u003bu0069 u0064u003du0031u003bu0074 path/to/file/containing/data
json: Represents the JSON data that goes into the body of the request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Format: Valid JSON format

eg: {“postId”:”1”, “comments”:”This is a new comment”}
headers: Represents the headers sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: Content-Type=text; Date=04/21/2016; Allow=whatever_you_want_to_allow
cookies: Represents the cookies sent along with the request

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path

eg: cookie=cookie_name; details=more_details_abput_the_cookie

path/to/file/containing/cookie/details
files: Lets User accomplish multipart encoding upload

Pattern: string pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”path_to_file1, path_to_file2, path_to_file3”/>

Pattern: dict-tuple pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”file_group_name=path_to_file1,

path_to_file2, path_to_file4, path_to_file5”/>

Pattern: tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files” value=”(path_to_file1;content_type),

(path_to_file2;content_type), (path_to_file3;content_type)”/>

Pattern: dict-in-tuple pattern Multiple Values: As specified in Glossary Separators: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Max Numbers of Values inside a Group: As specified in Glossary Max Numbers of Values inside the Dictionary Pattern: No Restrictions Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: <argument name=”files”

value=”(path_to_file1;content_type;(custom_header_1=value1;

custom_header_2:value2)),

(path_to_file2;content_type;(custom_header_1=value1)), (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3))”/>

eg: <argument name=”files”

value=”(path_to_file1;content_type),

path_to_file2, (path_to_file3;content_type;(custom_header_1=value1;

custom_header_2=value2),

(path_to_file4;content_type), (path_to_file5;content_type;(custom_header_1=value1;

custom_header_2=value2; custom_header_3=value3)),

path_to_file6, path_to_file_7”/>
user: Represents the username that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: Sanika
password: Represents the password that would be required for authentication.

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: password
timeout: Represents the time barrier in which the request should be completed

If 2 values are given, the first value would be treated as a constraint for sending the request, the second would be treated as a constraint for receiving the response. If only one value is given, it would be treated as constraint for sending the request and receiving a response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: Numerical Characters - Int or Float

eg: 0.5, 0.75

0.6
allow_redirects: Allows or disallows redirection

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

eg: yes
proxies: Allows the User to set up proxies for ip addresses

Pattern: Dictionary Pattern Multiple Values: As specified in Glossary Separator: As specified in Glossary Max Numbers of Values Accepted: No Restrictions Characters Accepted: All Characters

eg: http=157.126.12.196:8081; https:157.126.12.144:80
verify: Allows user to enable or disable authentication

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘yes’

OR

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Other Restrictions: Should be a valid file path to a .pem file

eg: path/to/CA_BUNDLE

no
stream: Allows user to enable or disable immediate data downloading

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: ‘yes’ and ‘no’ Default: ‘no’

eg: yes
cert: Allows user to send his/her own certificate

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: 2 Characters Accepted: All Characters

Other Restrictions: Both the inputs should be valid file paths. Input 1 should be a file path to the certificate file If the file specified in Input 1 contains the key, Input 2 is not necessary If the key is stored in a different file, Input 2 should contain the path to that file.

eg: path/to/certificate/file, path/to/key/file

path/to/certificate/file/which/contains/the/key
expected_response: User specified expected response.

Pattern: String Pattern Multiple Values: Yes Separator: , Max Numbers of Values Accepted: No Restrictions Characters Accepted: Numerical Characters - Integers only Default: The entire 200 series of HTTP Responses

eg: 200, 302, 404

200
variable_config: The variable config file that contains variables that need to be substituted into the json that is being passed to this request. This can either be a relative or an absolute path.

Eg: ../Config_files/var_config.xml

/home/user/warrior_main/Warrior/Warriorspace/Config_files/var_config.xml
var_sub: the pattern [var_sub] in the json will get substituted with this value.

Returns:

<system_name>_status(boolean) = status code of the http put
<system_name>_api_response = the entire response object of the http request

Note: The Request Number is applicable when variable substitution in JSON is being used. As variables get substituted in JSON, multiple JSONs are formed and each JSON is sent as a separate request. These requests are differentiated by adding add “request_number” which is basically the serial number of those requests.

The entire response object of the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_object <system_name>_api_response_object_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_object <system_name>_<request_id>_api_response_object_<request_number>

The response text (in text format) returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_text <system_name>_api_response_text_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_text <system_name>_<request_id>_api_response_text_<request_number>

The status code returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_status <system_name>_api_response_status_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_status <system_name>_<request_id>_api_response_status_<request_number>

The content_type of the response returned by the http request is stored as:

If request_id has not been provided:: <system_name>_api_response_content_type <system_name>_api_response_content_type_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content_type <system_name>_<request_id>_api_response_content_type_<request_number>

The extracted response returned from the response object (stored in the format that it is returned in - JSON, XML, Text) is stored as:

If request_id has not been provided:: <system_name>_api_response_content <system_name>_api_response_content_<request_number>
If request_id has been provided:: <system_name>_<request_id>_api_response_content <system_name>_<request_id>_api_response_content_<request_number>

verify_response(system_name, expected_api_response, expected_response_type, comparison_mode, request_id=None, generate_output_diff_file='Yes')[source]¶

Verifies the api response with the expected response and returns True or False

Arguments:

system_name: Name of the system from the datafile

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters Other Restrictions: Should be valid system name from the datafile

eg: http_system_1

request_id: A unique request ID for this request

Pattern: String Pattern Multiple Values: No Max Numbers of Values Accepted: 1 Characters Accepted: All Characters

eg: 01

expected_api_response: expected api response given by the user.

pattern: can be string or file name and response can be simple text or xml or json Multiple Values: No Max Number of values accepted: 1

expected_response_type: The type of expected response

Can be xml or json or text For jsonpath & xpath comparison_modes, verify status will be marked as pass if anyone the below operations is successful:

1. Equality match: Check if the expected response is equal to API response 2. Regex search: Check if the expected response(pattern) is in API response

Use ‘regex=expression’ as comparison_mode to support python regular expression for text response.

comparison_mode: This is the mode in which you wish to compare The supported comparison modes are file, string, regex=expression, jsonpath=path, xpath=path If you have given comparison_mode as file or string then whole comparison will take place If you wish to check content of expected response and if it is only one value_check pass it in either data file or test case file If it is more than one value_check then pass it in data file in comparison_mode and expected_api_response tags under system If it is xml response then you need to give xpath=path to it If it is string response then you can pass regex=expressions and you can leave expected_api_response empty Ex for passing values in data file if it is json response <comparison_mode>

<response_path>jsonpath=1.2.3</response_path> <response_path>jsonpath=1.2</response_path>

</comparison_mode> <expected_api_response>

<response_value>4</response_value> <response_value>5</response_value>

</expected_api_response>

generate_output_diff_file: If the responses doesn’t match,

then saves the difference between the responses in a file by default and if this sets to ‘no’, doesn’t save any difference.

returns:: If api response matches with expected_api_response then returns True else False.

Module contents¶

Copyright 2017, Fujitsu Network Communications, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.