def test_extend_with_wrong_number_of_args_is_typeerror(
self, d: HTTPHeaderDict, args: Tuple[int, ...]
) -> None:
with pytest.raises(
TypeError, match=r"extend\(\) takes at most 1 positional arguments"
):
d.extend(*args) # type: ignore[arg-type]
class TestHTTPHeaderDict(unittest.TestCase):
def setUp(self):
self.d = HTTPHeaderDict(Cookie='foo')
self.d.add('cookie', 'bar')
def test_create_from_kwargs(self):
h = HTTPHeaderDict(ab=1, cd=2, ef=3, gh=4)
self.assertEqual(len(h), 4)
self.assertTrue('ab' in h)
def test_create_from_dict(self):
h = HTTPHeaderDict(dict(ab=1, cd=2, ef=3, gh=4))
self.assertEqual(len(h), 4)
self.assertTrue('ab' in h)
def test_create_from_iterator(self):
teststr = 'urllib3ontherocks'
h = HTTPHeaderDict((c, c*5) for c in teststr)
self.assertEqual(len(h), len(set(teststr)))
def test_create_from_list(self):
h = HTTPHeaderDict([('ab', 'A'), ('cd', 'B'), ('cookie', 'C'), ('cookie', 'D'), ('cookie', 'E')])
self.assertEqual(len(h), 3)
self.assertTrue('ab' in h)
clist = h.getlist('cookie')
self.assertEqual(len(clist), 3)
self.assertEqual(clist[0], 'C')
self.assertEqual(clist[-1], 'E')
def test_create_from_headerdict(self):
org = HTTPHeaderDict([('ab', 'A'), ('cd', 'B'), ('cookie', 'C'), ('cookie', 'D'), ('cookie', 'E')])
h = HTTPHeaderDict(org)
self.assertEqual(len(h), 3)
self.assertTrue('ab' in h)
clist = h.getlist('cookie')
self.assertEqual(len(clist), 3)
self.assertEqual(clist[0], 'C')
self.assertEqual(clist[-1], 'E')
self.assertFalse(h is org)
self.assertEqual(h, org)
def test_setitem(self):
self.d['Cookie'] = 'foo'
self.assertEqual(self.d['cookie'], 'foo')
self.d['cookie'] = 'with, comma'
self.assertEqual(self.d.getlist('cookie'), ['with, comma'])
def test_update(self):
self.d.update(dict(Cookie='foo'))
self.assertEqual(self.d['cookie'], 'foo')
self.d.update(dict(cookie='with, comma'))
self.assertEqual(self.d.getlist('cookie'), ['with, comma'])
def test_delitem(self):
del self.d['cookie']
self.assertFalse('cookie' in self.d)
self.assertFalse('COOKIE' in self.d)
def test_add_well_known_multiheader(self):
self.d.add('COOKIE', 'asdf')
self.assertEqual(self.d.getlist('cookie'), ['foo', 'bar', 'asdf'])
self.assertEqual(self.d['cookie'], 'foo, bar, asdf')
def test_add_comma_separated_multiheader(self):
self.d.add('bar', 'foo')
self.d.add('BAR', 'bar')
self.d.add('Bar', 'asdf')
self.assertEqual(self.d.getlist('bar'), ['foo', 'bar', 'asdf'])
self.assertEqual(self.d['bar'], 'foo, bar, asdf')
def test_extend_from_list(self):
self.d.extend([('set-cookie', '100'), ('set-cookie', '200'), ('set-cookie', '300')])
self.assertEqual(self.d['set-cookie'], '100, 200, 300')
def test_extend_from_dict(self):
self.d.extend(dict(cookie='asdf'), b='100')
self.assertEqual(self.d['cookie'], 'foo, bar, asdf')
self.assertEqual(self.d['b'], '100')
self.d.add('cookie', 'with, comma')
self.assertEqual(self.d.getlist('cookie'), ['foo', 'bar', 'asdf', 'with, comma'])
def test_extend_from_container(self):
h = NonMappingHeaderContainer(Cookie='foo', e='foofoo')
self.d.extend(h)
self.assertEqual(self.d['cookie'], 'foo, bar, foo')
self.assertEqual(self.d['e'], 'foofoo')
self.assertEqual(len(self.d), 2)
def test_extend_from_headerdict(self):
h = HTTPHeaderDict(Cookie='foo', e='foofoo')
self.d.extend(h)
self.assertEqual(self.d['cookie'], 'foo, bar, foo')
self.assertEqual(self.d['e'], 'foofoo')
self.assertEqual(len(self.d), 2)
def test_copy(self):
h = self.d.copy()
self.assertTrue(self.d is not h)
self.assertEqual(self.d, h)
def test_getlist(self):
self.assertEqual(self.d.getlist('cookie'), ['foo', 'bar'])
self.assertEqual(self.d.getlist('Cookie'), ['foo', 'bar'])
self.assertEqual(self.d.getlist('b'), [])
self.d.add('b', 'asdf')
self.assertEqual(self.d.getlist('b'), ['asdf'])
def test_getlist_after_copy(self):
self.assertEqual(self.d.getlist('cookie'), HTTPHeaderDict(self.d).getlist('cookie'))
def test_equal(self):
b = HTTPHeaderDict(cookie='foo, bar')
c = NonMappingHeaderContainer(cookie='foo, bar')
self.assertEqual(self.d, b)
self.assertEqual(self.d, c)
self.assertNotEqual(self.d, 2)
def test_not_equal(self):
b = HTTPHeaderDict(cookie='foo, bar')
c = NonMappingHeaderContainer(cookie='foo, bar')
self.assertFalse(self.d != b)
self.assertFalse(self.d != c)
self.assertNotEqual(self.d, 2)
def test_pop(self):
key = 'Cookie'
a = self.d[key]
b = self.d.pop(key)
self.assertEqual(a, b)
self.assertFalse(key in self.d)
self.assertRaises(KeyError, self.d.pop, key)
dummy = object()
self.assertTrue(dummy is self.d.pop(key, dummy))
def test_discard(self):
self.d.discard('cookie')
self.assertFalse('cookie' in self.d)
self.d.discard('cookie')
def test_len(self):
self.assertEqual(len(self.d), 1)
self.d.add('cookie', 'bla')
self.d.add('asdf', 'foo')
# len determined by unique fieldnames
self.assertEqual(len(self.d), 2)
def test_repr(self):
rep = "HTTPHeaderDict({'Cookie': 'foo, bar'})"
self.assertEqual(repr(self.d), rep)
def test_items(self):
items = self.d.items()
self.assertEqual(len(items), 2)
self.assertEqual(items[0][0], 'Cookie')
self.assertEqual(items[0][1], 'foo')
self.assertEqual(items[1][0], 'Cookie')
self.assertEqual(items[1][1], 'bar')
def test_dict_conversion(self):
# Also tested in connectionpool, needs to preserve case
hdict = {'Content-Length': '0', 'Content-type': 'text/plain', 'Server': 'TornadoServer/1.2.3'}
h = dict(HTTPHeaderDict(hdict).items())
self.assertEqual(hdict, h)
self.assertEqual(hdict, dict(HTTPHeaderDict(hdict)))
def test_string_enforcement(self):
# This currently throws AttributeError on key.lower(), should probably be something nicer
self.assertRaises(Exception, self.d.__setitem__, 3, 5)
self.assertRaises(Exception, self.d.add, 3, 4)
self.assertRaises(Exception, self.d.__delitem__, 3)
self.assertRaises(Exception, HTTPHeaderDict, {3: 3})
def test_from_httplib_py2(self):
if six.PY3:
raise SkipTest("python3 has a different internal header implementation")
msg = """
Server: nginx
Content-Type: text/html; charset=windows-1251
Connection: keep-alive
X-Some-Multiline: asdf
asdf
asdf
Set-Cookie: bb_lastvisit=1348253375; expires=Sat, 21-Sep-2013 18:49:35 GMT; path=/
Set-Cookie: bb_lastactivity=0; expires=Sat, 21-Sep-2013 18:49:35 GMT; path=/
www-authenticate: asdf
www-authenticate: bla
"""
buffer = six.moves.StringIO(msg.lstrip().replace('\n', '\r\n'))
msg = six.moves.http_client.HTTPMessage(buffer)
d = HTTPHeaderDict.from_httplib(msg)
self.assertEqual(d['server'], 'nginx')
cookies = d.getlist('set-cookie')
self.assertEqual(len(cookies), 2)
self.assertTrue(cookies[0].startswith("bb_lastvisit"))
self.assertTrue(cookies[1].startswith("bb_lastactivity"))
self.assertEqual(d['x-some-multiline'].split(), ['asdf', 'asdf', 'asdf'])
self.assertEqual(d['www-authenticate'], 'asdf, bla')
self.assertEqual(d.getlist('www-authenticate'), ['asdf', 'bla'])
def post_view_config(
self: api_client.Api,
body: typing.Union[SchemaForRequestBodyApplicationJson],
header_params: RequestHeaderParams = frozendict(),
path_params: RequestPathParams = frozendict(),
content_type: str = 'application/json',
accept_content_types: typing.Tuple[str] = _all_accept_content_types,
stream: bool = False,
timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
skip_deserialization: bool = False,
) -> typing.Union[ApiResponseFor200,
api_client.ApiResponseWithoutDeserialization]:
"""
:param skip_deserialization: If true then api_response.response will be set but
api_response.body and api_response.headers will not be deserialized into schema
class instances
"""
self._verify_typed_dict_inputs(RequestHeaderParams, header_params)
self._verify_typed_dict_inputs(RequestPathParams, path_params)
_path_params = {}
for parameter in (request_path_name, ):
parameter_data = path_params.get(parameter.name, unset)
if parameter_data is unset:
continue
serialized_data = parameter.serialize(parameter_data)
_path_params.update(serialized_data)
_headers = HTTPHeaderDict()
for parameter in (request_header_jenkins_crumb, ):
parameter_data = header_params.get(parameter.name, unset)
if parameter_data is unset:
continue
serialized_data = parameter.serialize(parameter_data)
_headers.extend(serialized_data)
# TODO add cookie handling
if accept_content_types:
for accept_content_type in accept_content_types:
_headers.add('Accept', accept_content_type)
if body is unset:
raise exceptions.ApiValueError(
'The required body parameter has an invalid value of: unset. Set a valid value instead'
)
_fields = None
_body = None
serialized_data = request_body_body.serialize(body, content_type)
_headers.add('Content-Type', content_type)
if 'fields' in serialized_data:
_fields = serialized_data['fields']
elif 'body' in serialized_data:
_body = serialized_data['body']
response = self.api_client.call_api(
resource_path=_path,
method=_method,
path_params=_path_params,
headers=_headers,
fields=_fields,
body=_body,
auth_settings=_auth,
stream=stream,
timeout=timeout,
)
if skip_deserialization:
api_response = api_client.ApiResponseWithoutDeserialization(
response=response)
else:
response_for_status = _status_code_to_response.get(
str(response.status))
if response_for_status:
api_response = response_for_status.deserialize(
response, self.api_client.configuration)
else:
api_response = api_client.ApiResponseWithoutDeserialization(
response=response)
if not 200 <= response.status <= 299:
raise exceptions.ApiException(api_response=api_response)
return api_response
def parameter_collisions(
self: api_client.Api,
body: typing.Union[SchemaForRequestBodyApplicationJson, Unset] = unset,
query_params: RequestQueryParams = frozendict(),
header_params: RequestHeaderParams = frozendict(),
path_params: RequestPathParams = frozendict(),
cookie_params: RequestCookieParams = frozendict(),
content_type: str = 'application/json',
accept_content_types: typing.Tuple[str] = _all_accept_content_types,
stream: bool = False,
timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
skip_deserialization: bool = False,
) -> typing.Union[ApiResponseFor200,
api_client.ApiResponseWithoutDeserialization]:
"""
parameter collision case
:param skip_deserialization: If true then api_response.response will be set but
api_response.body and api_response.headers will not be deserialized into schema
class instances
"""
self._verify_typed_dict_inputs(RequestQueryParams, query_params)
self._verify_typed_dict_inputs(RequestHeaderParams, header_params)
self._verify_typed_dict_inputs(RequestPathParams, path_params)
self._verify_typed_dict_inputs(RequestCookieParams, cookie_params)
_path_params = {}
for parameter in (
request_path__3,
request_path_a_b5,
request_path_ab2,
request_path__self3,
request_path_a_b6,
):
parameter_data = path_params.get(parameter.name, unset)
if parameter_data is unset:
continue
serialized_data = parameter.serialize(parameter_data)
_path_params.update(serialized_data)
_query_params = []
for parameter in (
request_query__1,
request_query_a_b,
request_query_ab,
request_query__self,
request_query_a_b2,
):
parameter_data = query_params.get(parameter.name, unset)
if parameter_data is unset:
continue
serialized_data = parameter.serialize(parameter_data)
_query_params.extend(serialized_data)
_headers = HTTPHeaderDict()
for parameter in (
request_header__2,
request_header_a_b3,
request_header__self2,
request_header_a_b4,
):
parameter_data = header_params.get(parameter.name, unset)
if parameter_data is unset:
continue
serialized_data = parameter.serialize(parameter_data)
_headers.extend(serialized_data)
# TODO add cookie handling
if accept_content_types:
for accept_content_type in accept_content_types:
_headers.add('Accept', accept_content_type)
_fields = None
_body = None
if body is not unset:
serialized_data = request_body_body.serialize(body, content_type)
_headers.add('Content-Type', content_type)
if 'fields' in serialized_data:
_fields = serialized_data['fields']
elif 'body' in serialized_data:
_body = serialized_data['body']
response = self.api_client.call_api(
resource_path=_path,
method=_method,
path_params=_path_params,
query_params=tuple(_query_params),
headers=_headers,
fields=_fields,
body=_body,
stream=stream,
timeout=timeout,
)
if skip_deserialization:
api_response = api_client.ApiResponseWithoutDeserialization(
response=response)
else:
response_for_status = _status_code_to_response.get(
str(response.status))
if response_for_status:
api_response = response_for_status.deserialize(
response, self.api_client.configuration)
else:
api_response = api_client.ApiResponseWithoutDeserialization(
response=response)
if not 200 <= response.status <= 299:
raise exceptions.ApiException(api_response=api_response)
return api_response
def group_parameters(
self: api_client.Api,
query_params: RequestQueryParams = frozendict(),
header_params: RequestHeaderParams = frozendict(),
stream: bool = False,
timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
skip_deserialization: bool = False,
) -> typing.Union[api_client.ApiResponseWithoutDeserialization]:
"""
Fake endpoint to test group parameters (optional)
:param skip_deserialization: If true then api_response.response will be set but
api_response.body and api_response.headers will not be deserialized into schema
class instances
"""
self._verify_typed_dict_inputs(RequestQueryParams, query_params)
self._verify_typed_dict_inputs(RequestHeaderParams, header_params)
_query_params = []
for parameter in (
request_query_required_string_group,
request_query_required_int64_group,
request_query_string_group,
request_query_int64_group,
):
parameter_data = query_params.get(parameter.name, unset)
if parameter_data is unset:
continue
serialized_data = parameter.serialize(parameter_data)
_query_params.extend(serialized_data)
_headers = HTTPHeaderDict()
for parameter in (
request_header_required_boolean_group,
request_header_boolean_group,
):
parameter_data = header_params.get(parameter.name, unset)
if parameter_data is unset:
continue
serialized_data = parameter.serialize(parameter_data)
_headers.extend(serialized_data)
# TODO add cookie handling
response = self.api_client.call_api(
resource_path=_path,
method=_method,
query_params=tuple(_query_params),
headers=_headers,
auth_settings=_auth,
stream=stream,
timeout=timeout,
)
if skip_deserialization:
api_response = api_client.ApiResponseWithoutDeserialization(
response=response)
else:
response_for_status = _status_code_to_response.get(
str(response.status))
if response_for_status:
api_response = response_for_status.deserialize(
response, self.api_client.configuration)
else:
api_response = api_client.ApiResponseWithoutDeserialization(
response=response)
if not 200 <= response.status <= 299:
raise exceptions.ApiException(api_response=api_response)
return api_response
def enum_parameters(
self: api_client.Api,
body: typing.Union[SchemaForRequestBodyApplicationXWwwFormUrlencoded,
Unset] = unset,
query_params: RequestQueryParams = frozendict(),
header_params: RequestHeaderParams = frozendict(),
content_type: str = 'application/x-www-form-urlencoded',
stream: bool = False,
timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
skip_deserialization: bool = False,
) -> typing.Union[api_client.ApiResponseWithoutDeserialization]:
"""
To test enum parameters
:param skip_deserialization: If true then api_response.response will be set but
api_response.body and api_response.headers will not be deserialized into schema
class instances
"""
self._verify_typed_dict_inputs(RequestQueryParams, query_params)
self._verify_typed_dict_inputs(RequestHeaderParams, header_params)
_query_params = []
for parameter in (
request_query_enum_query_string_array,
request_query_enum_query_string,
request_query_enum_query_integer,
request_query_enum_query_double,
):
parameter_data = query_params.get(parameter.name, unset)
if parameter_data is unset:
continue
serialized_data = parameter.serialize(parameter_data)
_query_params.extend(serialized_data)
_headers = HTTPHeaderDict()
for parameter in (
request_header_enum_header_string_array,
request_header_enum_header_string,
):
parameter_data = header_params.get(parameter.name, unset)
if parameter_data is unset:
continue
serialized_data = parameter.serialize(parameter_data)
_headers.extend(serialized_data)
# TODO add cookie handling
_fields = None
_body = None
if body is not unset:
serialized_data = request_body_body.serialize(body, content_type)
_headers.add('Content-Type', content_type)
if 'fields' in serialized_data:
_fields = serialized_data['fields']
elif 'body' in serialized_data:
_body = serialized_data['body']
response = self.api_client.call_api(
resource_path=_path,
method=_method,
query_params=tuple(_query_params),
headers=_headers,
fields=_fields,
body=_body,
stream=stream,
timeout=timeout,
)
if skip_deserialization:
api_response = api_client.ApiResponseWithoutDeserialization(
response=response)
else:
response_for_status = _status_code_to_response.get(
str(response.status))
if response_for_status:
api_response = response_for_status.deserialize(
response, self.api_client.configuration)
else:
api_response = api_client.ApiResponseWithoutDeserialization(
response=response)
if not 200 <= response.status <= 299:
raise exceptions.ApiException(api_response=api_response)
return api_response
class TestHTTPHeaderDict(unittest.TestCase):
def setUp(self):
self.d = HTTPHeaderDict(Cookie='foo')
self.d.add('cookie', 'bar')
def test_create_from_kwargs(self):
h = HTTPHeaderDict(ab=1, cd=2, ef=3, gh=4)
self.assertEqual(len(h), 4)
self.assertTrue('ab' in h)
def test_create_from_dict(self):
h = HTTPHeaderDict(dict(ab=1, cd=2, ef=3, gh=4))
self.assertEqual(len(h), 4)
self.assertTrue('ab' in h)
def test_create_from_iterator(self):
teststr = 'urllib3ontherocks'
h = HTTPHeaderDict((c, c * 5) for c in teststr)
self.assertEqual(len(h), len(set(teststr)))
def test_create_from_list(self):
h = HTTPHeaderDict([('ab', 'A'), ('cd', 'B'), ('cookie', 'C'),
('cookie', 'D'), ('cookie', 'E')])
self.assertEqual(len(h), 3)
self.assertTrue('ab' in h)
clist = h.getlist('cookie')
self.assertEqual(len(clist), 3)
self.assertEqual(clist[0], 'C')
self.assertEqual(clist[-1], 'E')
def test_create_from_headerdict(self):
org = HTTPHeaderDict([('ab', 'A'), ('cd', 'B'), ('cookie', 'C'),
('cookie', 'D'), ('cookie', 'E')])
h = HTTPHeaderDict(org)
self.assertEqual(len(h), 3)
self.assertTrue('ab' in h)
clist = h.getlist('cookie')
self.assertEqual(len(clist), 3)
self.assertEqual(clist[0], 'C')
self.assertEqual(clist[-1], 'E')
self.assertFalse(h is org)
self.assertEqual(h, org)
def test_setitem(self):
self.d['Cookie'] = 'foo'
self.assertEqual(self.d['cookie'], 'foo')
self.d['cookie'] = 'with, comma'
self.assertEqual(self.d.getlist('cookie'), ['with, comma'])
def test_update(self):
self.d.update(dict(Cookie='foo'))
self.assertEqual(self.d['cookie'], 'foo')
self.d.update(dict(cookie='with, comma'))
self.assertEqual(self.d.getlist('cookie'), ['with, comma'])
def test_delitem(self):
del self.d['cookie']
self.assertFalse('cookie' in self.d)
self.assertFalse('COOKIE' in self.d)
def test_add_well_known_multiheader(self):
self.d.add('COOKIE', 'asdf')
self.assertEqual(self.d.getlist('cookie'), ['foo', 'bar', 'asdf'])
self.assertEqual(self.d['cookie'], 'foo, bar, asdf')
def test_add_comma_separated_multiheader(self):
self.d.add('bar', 'foo')
self.d.add('BAR', 'bar')
self.d.add('Bar', 'asdf')
self.assertEqual(self.d.getlist('bar'), ['foo', 'bar', 'asdf'])
self.assertEqual(self.d['bar'], 'foo, bar, asdf')
def test_extend_from_list(self):
self.d.extend([('set-cookie', '100'), ('set-cookie', '200'),
('set-cookie', '300')])
self.assertEqual(self.d['set-cookie'], '100, 200, 300')
def test_extend_from_dict(self):
self.d.extend(dict(cookie='asdf'), b='100')
self.assertEqual(self.d['cookie'], 'foo, bar, asdf')
self.assertEqual(self.d['b'], '100')
self.d.add('cookie', 'with, comma')
self.assertEqual(self.d.getlist('cookie'),
['foo', 'bar', 'asdf', 'with, comma'])
def test_extend_from_container(self):
h = NonMappingHeaderContainer(Cookie='foo', e='foofoo')
self.d.extend(h)
self.assertEqual(self.d['cookie'], 'foo, bar, foo')
self.assertEqual(self.d['e'], 'foofoo')
self.assertEqual(len(self.d), 2)
def test_extend_from_headerdict(self):
h = HTTPHeaderDict(Cookie='foo', e='foofoo')
self.d.extend(h)
self.assertEqual(self.d['cookie'], 'foo, bar, foo')
self.assertEqual(self.d['e'], 'foofoo')
self.assertEqual(len(self.d), 2)
def test_copy(self):
h = self.d.copy()
self.assertTrue(self.d is not h)
self.assertEqual(self.d, h)
def test_getlist(self):
self.assertEqual(self.d.getlist('cookie'), ['foo', 'bar'])
self.assertEqual(self.d.getlist('Cookie'), ['foo', 'bar'])
self.assertEqual(self.d.getlist('b'), [])
self.d.add('b', 'asdf')
self.assertEqual(self.d.getlist('b'), ['asdf'])
def test_getlist_after_copy(self):
self.assertEqual(self.d.getlist('cookie'),
HTTPHeaderDict(self.d).getlist('cookie'))
def test_equal(self):
b = HTTPHeaderDict(cookie='foo, bar')
c = NonMappingHeaderContainer(cookie='foo, bar')
self.assertEqual(self.d, b)
self.assertEqual(self.d, c)
self.assertNotEqual(self.d, 2)
def test_not_equal(self):
b = HTTPHeaderDict(cookie='foo, bar')
c = NonMappingHeaderContainer(cookie='foo, bar')
self.assertFalse(self.d != b)
self.assertFalse(self.d != c)
self.assertNotEqual(self.d, 2)
def test_pop(self):
key = 'Cookie'
a = self.d[key]
b = self.d.pop(key)
self.assertEqual(a, b)
self.assertFalse(key in self.d)
self.assertRaises(KeyError, self.d.pop, key)
dummy = object()
self.assertTrue(dummy is self.d.pop(key, dummy))
def test_discard(self):
self.d.discard('cookie')
self.assertFalse('cookie' in self.d)
self.d.discard('cookie')
def test_len(self):
self.assertEqual(len(self.d), 1)
self.d.add('cookie', 'bla')
self.d.add('asdf', 'foo')
# len determined by unique fieldnames
self.assertEqual(len(self.d), 2)
def test_repr(self):
rep = "HTTPHeaderDict({'Cookie': 'foo, bar'})"
self.assertEqual(repr(self.d), rep)
def test_items(self):
items = self.d.items()
self.assertEqual(len(items), 2)
self.assertEqual(items[0][0], 'Cookie')
self.assertEqual(items[0][1], 'foo')
self.assertEqual(items[1][0], 'Cookie')
self.assertEqual(items[1][1], 'bar')
def test_dict_conversion(self):
# Also tested in connectionpool, needs to preserve case
hdict = {
'Content-Length': '0',
'Content-type': 'text/plain',
'Server': 'TornadoServer/1.2.3'
}
h = dict(HTTPHeaderDict(hdict).items())
self.assertEqual(hdict, h)
self.assertEqual(hdict, dict(HTTPHeaderDict(hdict)))
def test_string_enforcement(self):
# This currently throws AttributeError on key.lower(), should probably be something nicer
self.assertRaises(Exception, self.d.__setitem__, 3, 5)
self.assertRaises(Exception, self.d.add, 3, 4)
self.assertRaises(Exception, self.d.__delitem__, 3)
self.assertRaises(Exception, HTTPHeaderDict, {3: 3})
def test_from_httplib_py2(self):
if six.PY3:
raise SkipTest(
"python3 has a different internal header implementation")
msg = """
Server: nginx
Content-Type: text/html; charset=windows-1251
Connection: keep-alive
X-Some-Multiline: asdf
asdf
asdf
Set-Cookie: bb_lastvisit=1348253375; expires=Sat, 21-Sep-2013 18:49:35 GMT; path=/
Set-Cookie: bb_lastactivity=0; expires=Sat, 21-Sep-2013 18:49:35 GMT; path=/
www-authenticate: asdf
www-authenticate: bla
"""
buffer = six.moves.StringIO(msg.lstrip().replace('\n', '\r\n'))
msg = six.moves.http_client.HTTPMessage(buffer)
d = HTTPHeaderDict.from_httplib(msg)
self.assertEqual(d['server'], 'nginx')
cookies = d.getlist('set-cookie')
self.assertEqual(len(cookies), 2)
self.assertTrue(cookies[0].startswith("bb_lastvisit"))
self.assertTrue(cookies[1].startswith("bb_lastactivity"))
self.assertEqual(d['x-some-multiline'].split(),
['asdf', 'asdf', 'asdf'])
self.assertEqual(d['www-authenticate'], 'asdf, bla')
self.assertEqual(d.getlist('www-authenticate'), ['asdf', 'bla'])
class TestHTTPHeaderDict(unittest.TestCase):
def setUp(self):
self.d = HTTPHeaderDict(Cookie='foo')
self.d.add('cookie', 'bar')
def test_overwriting_with_setitem_replaces(self):
d = HTTPHeaderDict()
d['Cookie'] = 'foo'
self.assertEqual(d['cookie'], 'foo')
d['cookie'] = 'bar'
self.assertEqual(d['Cookie'], 'bar')
def test_copy(self):
h = self.d.copy()
self.assertTrue(self.d is not h)
self.assertEqual(self.d, h)
def test_add_multiple_allowed(self):
d = HTTPHeaderDict()
d['Cookie'] = 'foo'
d.add('cookie', 'bar')
self.assertEqual(d['cookie'], 'foo, bar')
self.assertEqual(d['Cookie'], 'foo, bar')
d.add('cookie', 'asdf')
self.assertEqual(d['cookie'], 'foo, bar, asdf')
def test_add_multiple_not_allowed(self):
self.d.add('notmulti', 'should be overwritten on next add call')
self.d.add('notmulti', 'new val')
self.assertEqual(self.d['notmulti'], 'new val')
def test_extend(self):
self.d.extend([('set-cookie', '100'), ('set-cookie', '200'),
('set-cookie', '300')])
self.assertEqual(self.d['set-cookie'], '100, 200, 300')
self.d.extend(dict(cookie='asdf'), b='100')
self.assertEqual(self.d['cookie'], 'foo, bar, asdf')
self.assertEqual(self.d['b'], '100')
self.d.add('cookie', 'with, comma')
self.assertEqual(self.d.getlist('cookie'),
['foo', 'bar', 'asdf', 'with, comma'])
header_object = NonMappingHeaderContainer(e='foofoo')
self.d.extend(header_object)
self.assertEqual(self.d['e'], 'foofoo')
def test_getlist(self):
self.assertEqual(self.d.getlist('cookie'), ['foo', 'bar'])
self.assertEqual(self.d.getlist('Cookie'), ['foo', 'bar'])
self.assertEqual(self.d.getlist('b'), [])
self.d.add('b', 'asdf')
self.assertEqual(self.d.getlist('b'), ['asdf'])
def test_update(self):
self.d.update(dict(cookie='with, comma'))
self.assertEqual(self.d.getlist('cookie'), ['with, comma'])
def test_delitem(self):
del self.d['cookie']
self.assertFalse('cookie' in self.d)
self.assertFalse('COOKIE' in self.d)
def test_equal(self):
b = HTTPHeaderDict(cookie='foo, bar')
c = NonMappingHeaderContainer(cookie='foo, bar')
self.assertEqual(self.d, b)
self.assertEqual(self.d, c)
self.assertNotEqual(self.d, 2)
def test_not_equal(self):
b = HTTPHeaderDict(cookie='foo, bar')
c = NonMappingHeaderContainer(cookie='foo, bar')
self.assertFalse(self.d != b)
self.assertFalse(self.d != c)
self.assertNotEqual(self.d, 2)
def test_pop(self):
key = 'Cookie'
a = self.d[key]
b = self.d.pop(key)
self.assertEqual(a, b)
self.assertFalse(key in self.d)
self.assertRaises(KeyError, self.d.pop, key)
dummy = object()
self.assertTrue(dummy is self.d.pop(key, dummy))
def test_discard(self):
self.d.discard('cookie')
self.assertFalse('cookie' in self.d)
self.d.discard('cookie')
def test_len(self):
self.assertEqual(len(self.d), 1)
def test_repr(self):
rep = "HTTPHeaderDict({'Cookie': 'foo, bar'})"
self.assertEqual(repr(self.d), rep)
def test_items(self):
items = self.d.items()
self.assertEqual(len(items), 2)
self.assertEqual(items[0][0], 'Cookie')
self.assertEqual(items[0][1], 'foo')
self.assertEqual(items[1][0], 'Cookie')
self.assertEqual(items[1][1], 'bar')
def test_items_preserving_case(self):
# Should not be tested only in connectionpool
HEADERS = {
'Content-Length': '0',
'Content-type': 'text/plain',
'Server': 'TornadoServer/1.2.3'
}
h = dict(HTTPHeaderDict(HEADERS).items())
self.assertEqual(HEADERS, h) # to preserve case sensitivity
def test_from_httplib(self):
if six.PY3:
raise SkipTest()
from httplib import HTTPMessage
from StringIO import StringIO
msg = """
Server: nginx
Content-Type: text/html; charset=windows-1251
Connection: keep-alive
Set-Cookie: bb_lastvisit=1348253375; expires=Sat, 21-Sep-2013 18:49:35 GMT; path=/
Set-Cookie: bb_lastactivity=0; expires=Sat, 21-Sep-2013 18:49:35 GMT; path=/
"""
msg = HTTPMessage(StringIO(msg.lstrip().replace('\n', '\r\n')))
d = HTTPHeaderDict.from_httplib(msg)
self.assertEqual(d['server'], 'nginx')
cookies = d.getlist('set-cookie')
self.assertEqual(len(cookies), 2)
self.assertTrue(cookies[0].startswith("bb_lastvisit"))
self.assertTrue(cookies[1].startswith("bb_lastactivity"))
class TestHTTPHeaderDict(unittest.TestCase):
def setUp(self):
self.d = HTTPHeaderDict(Cookie="foo")
self.d.add("cookie", "bar")
def test_create_from_kwargs(self):
h = HTTPHeaderDict(ab=1, cd=2, ef=3, gh=4)
self.assertEqual(len(h), 4)
self.assertTrue("ab" in h)
def test_create_from_dict(self):
h = HTTPHeaderDict(dict(ab=1, cd=2, ef=3, gh=4))
self.assertEqual(len(h), 4)
self.assertTrue("ab" in h)
def test_create_from_iterator(self):
teststr = "urllib3ontherocks"
h = HTTPHeaderDict((c, c * 5) for c in teststr)
self.assertEqual(len(h), len(set(teststr)))
def test_create_from_list(self):
h = HTTPHeaderDict([("ab", "A"), ("cd", "B"), ("cookie", "C"), ("cookie", "D"), ("cookie", "E")])
self.assertEqual(len(h), 3)
self.assertTrue("ab" in h)
clist = h.getlist("cookie")
self.assertEqual(len(clist), 3)
self.assertEqual(clist[0], "C")
self.assertEqual(clist[-1], "E")
def test_create_from_headerdict(self):
org = HTTPHeaderDict([("ab", "A"), ("cd", "B"), ("cookie", "C"), ("cookie", "D"), ("cookie", "E")])
h = HTTPHeaderDict(org)
self.assertEqual(len(h), 3)
self.assertTrue("ab" in h)
clist = h.getlist("cookie")
self.assertEqual(len(clist), 3)
self.assertEqual(clist[0], "C")
self.assertEqual(clist[-1], "E")
self.assertFalse(h is org)
self.assertEqual(h, org)
def test_setitem(self):
self.d["Cookie"] = "foo"
self.assertEqual(self.d["cookie"], "foo")
self.d["cookie"] = "with, comma"
self.assertEqual(self.d.getlist("cookie"), ["with, comma"])
def test_update(self):
self.d.update(dict(Cookie="foo"))
self.assertEqual(self.d["cookie"], "foo")
self.d.update(dict(cookie="with, comma"))
self.assertEqual(self.d.getlist("cookie"), ["with, comma"])
def test_delitem(self):
del self.d["cookie"]
self.assertFalse("cookie" in self.d)
self.assertFalse("COOKIE" in self.d)
def test_add_well_known_multiheader(self):
self.d.add("COOKIE", "asdf")
self.assertEqual(self.d.getlist("cookie"), ["foo", "bar", "asdf"])
self.assertEqual(self.d["cookie"], "foo, bar, asdf")
def test_add_comma_separated_multiheader(self):
self.d.add("bar", "foo")
self.d.add("BAR", "bar")
self.d.add("Bar", "asdf")
self.assertEqual(self.d.getlist("bar"), ["foo", "bar", "asdf"])
self.assertEqual(self.d["bar"], "foo, bar, asdf")
def test_extend_from_list(self):
self.d.extend([("set-cookie", "100"), ("set-cookie", "200"), ("set-cookie", "300")])
self.assertEqual(self.d["set-cookie"], "100, 200, 300")
def test_extend_from_dict(self):
self.d.extend(dict(cookie="asdf"), b="100")
self.assertEqual(self.d["cookie"], "foo, bar, asdf")
self.assertEqual(self.d["b"], "100")
self.d.add("cookie", "with, comma")
self.assertEqual(self.d.getlist("cookie"), ["foo", "bar", "asdf", "with, comma"])
def test_extend_from_container(self):
h = NonMappingHeaderContainer(Cookie="foo", e="foofoo")
self.d.extend(h)
self.assertEqual(self.d["cookie"], "foo, bar, foo")
self.assertEqual(self.d["e"], "foofoo")
self.assertEqual(len(self.d), 2)
def test_extend_from_headerdict(self):
h = HTTPHeaderDict(Cookie="foo", e="foofoo")
self.d.extend(h)
self.assertEqual(self.d["cookie"], "foo, bar, foo")
self.assertEqual(self.d["e"], "foofoo")
self.assertEqual(len(self.d), 2)
def test_copy(self):
h = self.d.copy()
self.assertTrue(self.d is not h)
self.assertEqual(self.d, h)
def test_getlist(self):
self.assertEqual(self.d.getlist("cookie"), ["foo", "bar"])
self.assertEqual(self.d.getlist("Cookie"), ["foo", "bar"])
self.assertEqual(self.d.getlist("b"), [])
self.d.add("b", "asdf")
self.assertEqual(self.d.getlist("b"), ["asdf"])
def test_getlist_after_copy(self):
self.assertEqual(self.d.getlist("cookie"), HTTPHeaderDict(self.d).getlist("cookie"))
def test_equal(self):
b = HTTPHeaderDict(cookie="foo, bar")
c = NonMappingHeaderContainer(cookie="foo, bar")
self.assertEqual(self.d, b)
self.assertEqual(self.d, c)
self.assertNotEqual(self.d, 2)
def test_not_equal(self):
b = HTTPHeaderDict(cookie="foo, bar")
c = NonMappingHeaderContainer(cookie="foo, bar")
self.assertFalse(self.d != b)
self.assertFalse(self.d != c)
self.assertNotEqual(self.d, 2)
def test_pop(self):
key = "Cookie"
a = self.d[key]
b = self.d.pop(key)
self.assertEqual(a, b)
self.assertFalse(key in self.d)
self.assertRaises(KeyError, self.d.pop, key)
dummy = object()
self.assertTrue(dummy is self.d.pop(key, dummy))
def test_discard(self):
self.d.discard("cookie")
self.assertFalse("cookie" in self.d)
self.d.discard("cookie")
def test_len(self):
self.assertEqual(len(self.d), 1)
self.d.add("cookie", "bla")
self.d.add("asdf", "foo")
# len determined by unique fieldnames
self.assertEqual(len(self.d), 2)
def test_repr(self):
rep = "HTTPHeaderDict({'Cookie': 'foo, bar'})"
self.assertEqual(repr(self.d), rep)
def test_items(self):
items = self.d.items()
self.assertEqual(len(items), 2)
self.assertEqual(items[0][0], "Cookie")
self.assertEqual(items[0][1], "foo")
self.assertEqual(items[1][0], "Cookie")
self.assertEqual(items[1][1], "bar")
def test_dict_conversion(self):
# Also tested in connectionpool, needs to preserve case
hdict = {"Content-Length": "0", "Content-type": "text/plain", "Server": "TornadoServer/1.2.3"}
h = dict(HTTPHeaderDict(hdict).items())
self.assertEqual(hdict, h)
def test_string_enforcement(self):
# This currently throws AttributeError on key.lower(), should probably be something nicer
self.assertRaises(Exception, self.d.__setitem__, 3, 5)
self.assertRaises(Exception, self.d.add, 3, 4)
self.assertRaises(Exception, self.d.__delitem__, 3)
self.assertRaises(Exception, HTTPHeaderDict, {3: 3})
def test_from_httplib_py2(self):
if six.PY3:
raise SkipTest("python3 has a different internal header implementation")
msg = """
Server: nginx
Content-Type: text/html; charset=windows-1251
Connection: keep-alive
X-Some-Multiline: asdf
asdf
asdf
Set-Cookie: bb_lastvisit=1348253375; expires=Sat, 21-Sep-2013 18:49:35 GMT; path=/
Set-Cookie: bb_lastactivity=0; expires=Sat, 21-Sep-2013 18:49:35 GMT; path=/
www-authenticate: asdf
www-authenticate: bla
"""
buffer = six.moves.StringIO(msg.lstrip().replace("\n", "\r\n"))
msg = six.moves.http_client.HTTPMessage(buffer)
d = HTTPHeaderDict.from_httplib(msg)
self.assertEqual(d["server"], "nginx")
cookies = d.getlist("set-cookie")
self.assertEqual(len(cookies), 2)
self.assertTrue(cookies[0].startswith("bb_lastvisit"))
self.assertTrue(cookies[1].startswith("bb_lastactivity"))
self.assertEqual(d["x-some-multiline"].split(), ["asdf", "asdf", "asdf"])
self.assertEqual(d["www-authenticate"], "asdf, bla")
self.assertEqual(d.getlist("www-authenticate"), ["asdf", "bla"])
class TestHTTPHeaderDict(unittest.TestCase):
def setUp(self):
self.d = HTTPHeaderDict(Cookie='foo')
self.d.add('cookie', 'bar')
def test_overwriting_with_setitem_replaces(self):
d = HTTPHeaderDict()
d['Cookie'] = 'foo'
self.assertEqual(d['cookie'], 'foo')
d['cookie'] = 'bar'
self.assertEqual(d['Cookie'], 'bar')
def test_copy(self):
h = self.d.copy()
self.assertTrue(self.d is not h)
self.assertEqual(self.d, h)
def test_add_multiple_allowed(self):
d = HTTPHeaderDict()
d['Cookie'] = 'foo'
d.add('cookie', 'bar')
self.assertEqual(d['cookie'], 'foo, bar')
self.assertEqual(d['Cookie'], 'foo, bar')
d.add('cookie', 'asdf')
self.assertEqual(d['cookie'], 'foo, bar, asdf')
def test_add_multiple_not_allowed(self):
self.d.add('notmulti', 'should be overwritten on next add call')
self.d.add('notmulti', 'new val')
self.assertEqual(self.d['notmulti'], 'new val')
def test_extend(self):
self.d.extend([('set-cookie', '100'), ('set-cookie', '200'), ('set-cookie', '300')])
self.assertEqual(self.d['set-cookie'], '100, 200, 300')
self.d.extend(dict(cookie='asdf'), b='100')
self.assertEqual(self.d['cookie'], 'foo, bar, asdf')
self.assertEqual(self.d['b'], '100')
self.d.add('cookie', 'with, comma')
self.assertEqual(self.d.getlist('cookie'), ['foo', 'bar', 'asdf', 'with, comma'])
header_object = NonMappingHeaderContainer(e='foofoo')
self.d.extend(header_object)
self.assertEqual(self.d['e'], 'foofoo')
def test_getlist(self):
self.assertEqual(self.d.getlist('cookie'), ['foo', 'bar'])
self.assertEqual(self.d.getlist('Cookie'), ['foo', 'bar'])
self.assertEqual(self.d.getlist('b'), [])
self.d.add('b', 'asdf')
self.assertEqual(self.d.getlist('b'), ['asdf'])
def test_update(self):
self.d.update(dict(cookie='with, comma'))
self.assertEqual(self.d.getlist('cookie'), ['with, comma'])
def test_delitem(self):
del self.d['cookie']
self.assertFalse('cookie' in self.d)
self.assertFalse('COOKIE' in self.d)
def test_equal(self):
b = HTTPHeaderDict(cookie='foo, bar')
c = NonMappingHeaderContainer(cookie='foo, bar')
self.assertEqual(self.d, b)
self.assertEqual(self.d, c)
self.assertNotEqual(self.d, 2)
def test_not_equal(self):
b = HTTPHeaderDict(cookie='foo, bar')
c = NonMappingHeaderContainer(cookie='foo, bar')
self.assertFalse(self.d != b)
self.assertFalse(self.d != c)
self.assertNotEqual(self.d, 2)
def test_pop(self):
key = 'Cookie'
a = self.d[key]
b = self.d.pop(key)
self.assertEqual(a, b)
self.assertFalse(key in self.d)
self.assertRaises(KeyError, self.d.pop, key)
dummy = object()
self.assertTrue(dummy is self.d.pop(key, dummy))
def test_discard(self):
self.d.discard('cookie')
self.assertFalse('cookie' in self.d)
self.d.discard('cookie')
def test_len(self):
self.assertEqual(len(self.d), 1)
def test_repr(self):
rep = "HTTPHeaderDict({'Cookie': 'foo, bar'})"
self.assertEqual(repr(self.d), rep)
def test_items(self):
items = self.d.items()
self.assertEqual(len(items), 2)
self.assertEqual(items[0][0], 'Cookie')
self.assertEqual(items[0][1], 'foo')
self.assertEqual(items[1][0], 'Cookie')
self.assertEqual(items[1][1], 'bar')
def test_items_preserving_case(self):
# Should not be tested only in connectionpool
HEADERS = {'Content-Length': '0', 'Content-type': 'text/plain',
'Server': 'TornadoServer/1.2.3'}
h = dict(HTTPHeaderDict(HEADERS).items())
self.assertEqual(HEADERS, h) # to preserve case sensitivity
def test_from_httplib(self):
if six.PY3:
raise SkipTest()
from httplib import HTTPMessage
from StringIO import StringIO
msg = """
Server: nginx
Content-Type: text/html; charset=windows-1251
Connection: keep-alive
Set-Cookie: bb_lastvisit=1348253375; expires=Sat, 21-Sep-2013 18:49:35 GMT; path=/
Set-Cookie: bb_lastactivity=0; expires=Sat, 21-Sep-2013 18:49:35 GMT; path=/
"""
msg = HTTPMessage(StringIO(msg.lstrip().replace('\n', '\r\n')))
d = HTTPHeaderDict.from_httplib(msg)
self.assertEqual(d['server'], 'nginx')
cookies = d.getlist('set-cookie')
self.assertEqual(len(cookies), 2)
self.assertTrue(cookies[0].startswith("bb_lastvisit"))
self.assertTrue(cookies[1].startswith("bb_lastactivity"))
def post_job_disable(
self: api_client.Api,
header_params: RequestHeaderParams = frozendict(),
path_params: RequestPathParams = frozendict(),
stream: bool = False,
timeout: typing.Optional[typing.Union[int, typing.Tuple]] = None,
skip_deserialization: bool = False,
) -> typing.Union[ApiResponseFor200,
api_client.ApiResponseWithoutDeserialization]:
"""
:param skip_deserialization: If true then api_response.response will be set but
api_response.body and api_response.headers will not be deserialized into schema
class instances
"""
self._verify_typed_dict_inputs(RequestHeaderParams, header_params)
self._verify_typed_dict_inputs(RequestPathParams, path_params)
_path_params = {}
for parameter in (request_path_name, ):
parameter_data = path_params.get(parameter.name, unset)
if parameter_data is unset:
continue
serialized_data = parameter.serialize(parameter_data)
_path_params.update(serialized_data)
_headers = HTTPHeaderDict()
for parameter in (request_header_jenkins_crumb, ):
parameter_data = header_params.get(parameter.name, unset)
if parameter_data is unset:
continue
serialized_data = parameter.serialize(parameter_data)
_headers.extend(serialized_data)
# TODO add cookie handling
response = self.api_client.call_api(
resource_path=_path,
method=_method,
path_params=_path_params,
headers=_headers,
auth_settings=_auth,
stream=stream,
timeout=timeout,
)
if skip_deserialization:
api_response = api_client.ApiResponseWithoutDeserialization(
response=response)
else:
response_for_status = _status_code_to_response.get(
str(response.status))
if response_for_status:
api_response = response_for_status.deserialize(
response, self.api_client.configuration)
else:
api_response = api_client.ApiResponseWithoutDeserialization(
response=response)
if not 200 <= response.status <= 299:
raise exceptions.ApiException(api_response=api_response)
return api_response
def test_extend_from_headerdict(self, d: HTTPHeaderDict) -> None:
h = HTTPHeaderDict(Cookie="foo", e="foofoo")
d.extend(h)
assert d["cookie"] == "foo, bar, foo"
assert d["e"] == "foofoo"
assert len(d) == 2
def test_extend_from_container(self, d: HTTPHeaderDict) -> None:
h = NonMappingHeaderContainer(Cookie="foo", e="foofoo")
d.extend(h)
assert d["cookie"] == "foo, bar, foo"
assert d["e"] == "foofoo"
assert len(d) == 2
def test_extend_from_dict(self, d: HTTPHeaderDict) -> None:
d.extend(dict(cookie="asdf"), b="100")
assert d["cookie"] == "foo, bar, asdf"
assert d["b"] == "100"
d.add("cookie", "with, comma")
assert d.getlist("cookie") == ["foo", "bar", "asdf", "with, comma"]
def test_extend_from_list(self, d: HTTPHeaderDict) -> None:
d.extend([("set-cookie", "100"), ("set-cookie", "200"), ("set-cookie", "300")])
assert d["set-cookie"] == "100, 200, 300"
