assert_tools.rest package¶

Submodules¶

assert_tools.rest.response_json module¶

Module contents¶

exception assert_tools.rest.UnsupportedObject[source]¶

Bases: exceptions.Exception

The exception used by :py:method: as_http_response and dict_as_http_response.

exception assert_tools.rest.UnsupportedResponseCode[source]¶

Bases: exceptions.Exception

The exception used by :py:method: assert_response_equal

assert_tools.rest.as_http_response(response, content=None)[source]¶

convert request.Response object to :py:class:httplib2.Response

Parameters:	response – a :py:class:httplib2.Response object or :py:class:request.Response content – content, required for :py:class:httplib2.Response

return: The return value is a tuple of (response, content), the first being and instance of the :py:class:httplib2.Response, the second being a string that contains the response entity body.

assert_tools.rest.assert_delete_request_returns_bad_request_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert delete request returns okay status code

• Perform DELETE request to sever url
• Assert response is DENY
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_delete_request_returns_deny_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert delete request returns okay status code

• Perform DELETE request to sever url
• Assert response is DENY
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_delete_request_returns_forbidden_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert delete request returns okay status code

• Perform DELETE request to sever url
• Assert response is FORBIDDEN
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_delete_request_returns_not_allowed_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert delete request returns okay status code

• Perform GET request to sever url
• Assert response is NOT_ALLOWED
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_delete_request_returns_ok_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert delete request returns okay status code

• Perform DELETE request to sever url
• Assert response is OK
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_delete_request_returns_success_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert delete request returns okay status code

• Perform DELETE request to sever url
• Assert response is SUCCESS
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_get_request_returns_bad_request_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert get request returns okay status code * Perform GET request to sever url * Assert response is DENY * Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_get_request_returns_deny_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert get request returns okay status code

• Perform GET request to sever url
• Assert response is DENY
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_get_request_returns_forbidden_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert get request returns okay status code

• Perform GET request to sever url
• Assert response is FORBIDDEN
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_get_request_returns_not_allowed_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert get request returns okay status code

• Perform GET request to sever url
• Assert response is NOT_ALLOWED
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_get_request_returns_ok_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert get request returns okay status code

• Perform GET request to sever url
• Assert response is OK
• Assert response content is matches the expected content

Parameters:	server_url – expected_content – request_kwargs –

assert_tools.rest.assert_get_request_returns_success_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert get request returns okay status code

• Perform GET request to sever url
• Assert response is SUCCESS
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_head_request_returns_ok_status_code(server_url, expected_content_header_dict=None, request_kwargs=None)[source]¶

Assert options request returns okay status code

• Perform HEAD request to sever url
• Assert response is OK
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content_header_dict – python dict containing expected key value pairing in response returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_options_request_returns_ok_status_code(server_url, expected_content_header_dict=None, expected_content=None, request_kwargs=None)[source]¶

Assert options request returns okay status code

• Perform OPTIONS request to sever url
• Assert response is OK
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request expected_content_header_dict – python dict containing expected key value pairing in response returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_post_request_returns_bad_request_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert get request returns okay status code

• Perform POST request to sever url
• Assert response is DENY
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_post_request_returns_deny_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert post request returns okay status code

• Perform POST request to sever url
• Assert response is DENY
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_post_request_returns_forbidden_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert post request returns okay status code

• Perform POST request to sever url
• Assert response is FORBIDDEN
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_post_request_returns_not_allowed_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert post request returns okay status code

• Perform POST request to sever url
• Assert response is NOT_ALLOWED
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_post_request_returns_ok_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert post request returns okay status code

• Perform POST request to sever url
• Assert response is POST
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_post_request_returns_success_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert post request returns okay status code

• Perform POST request to sever url
• Assert response is SUCCESS
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_put_request_returns_bad_request_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert put request returns okay status code

• Perform PUT request to sever url
• Assert response is DENY
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_put_request_returns_deny_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert put request returns okay status code

• Perform PUT request to sever url
• Assert response is DENY
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_put_request_returns_forbidden_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert put request returns okay status code

• Perform PUT request to sever url
• Assert response is FORBIDDEN
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_put_request_returns_not_allowed_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert put request returns okay status code

• Perform PUT request to sever url
• Assert response is NOT_ALLOWED
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_put_request_returns_ok_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert put request returns okay status code

• Perform PUT request to sever url
• Assert response is OK
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_put_request_returns_success_status_code(server_url, expected_content=None, request_kwargs=None)[source]¶

Assert put request returns okay status code

• Perform PUT request to sever url
• Assert response is SUCCESS
• Assert response content is matches the expected content

Parameters:	server_url – server url expected_content – expected content in content returned :py:class:httplib.HTTP request request_kwargs – keyword arguments for :py:class:httplib.HTTP request

assert_tools.rest.assert_response_bad_request(actual_response)[source]¶

Assert response code is BAD_REQUEST. :param actual_response: actual response

assert_tools.rest.assert_response_content_equal(expected_data, actual_response_content)[source]¶

Assert response content is equal. :param expected_data:expected content :param actual_response_content: actual content

assert_tools.rest.assert_response_deny(actual_response)[source]¶

Assert response code is DENY. :param actual_response: actual response

assert_tools.rest.assert_response_equal(actual_response, expected_response)[source]¶

Assert Response code is equal. :param actual_response: Actual Response :param expected_response: expected Response

assert_tools.rest.assert_response_forbidden(actual_response)[source]¶

Assert response code is FORBIDDEN. :param actual_response: actual response

assert_tools.rest.assert_response_headers_contains(actual_response, expected_content_header_dict)[source]¶

Assert Response header contains a items in expected_header_content. :param actual_response: Actual Response :param expected_content_header_dict: expected content in response header

assert_tools.rest.assert_response_not_allowed(actual_response)[source]¶

Assert response code is NOT_ALLOWED. :param actual_response: actual response

assert_tools.rest.assert_response_ok(actual_response)[source]¶

Assert response code is OK. :param actual_response: actual response

assert_tools.rest.assert_response_success(actual_response)[source]¶

Assert response code is SUCCESS. :param actual_response: actual response

assert_tools.rest.dict_as_http_response(data_dict)[source]¶

convert python dictionary to httplib2 ‘Response’

Parameters:	data_dict – dictionary to convert to httplib2 ‘Response’ object expected_keys: status and body.

return: The return value is a tuple of (response, content), the first being and instance of the httplib2 ‘Response’ class, the second being a string that contains the response entity body.

assert_tools.rest.make_api_call(url, method, kwargs)[source]¶

Perform the call allowed by httplib2 method :param url: Rest API url

Parameters:	method – :py:class:httplib.HTTP request method: GET, POST, PUT, DELETE kwargs – dictionary of supported :py:class:httplib2.Http() request body, headers, redirections, connection_type

return: The return value is a tuple of (response, content), the first

being and instance of the httplib2 ‘Response’ class, the second being a string that contains the response entity body.

usage: extra_args = {

‘body’: {‘abc’: 123}, ‘headers’={}, ‘redirections’:3, ‘connection_type’:’http’} make_api_call(‘some_http_url’, ‘PUT’, extra_args)