import sys import re import ssl from mock import Mock, patch import urllib3 import warnings from requests.auth import AuthBase from elasticsearch.exceptions import TransportError, ConflictError, RequestError, NotFoundError from elasticsearch.connection import RequestsHttpConnection, \ Urllib3HttpConnection from elasticsearch.exceptions import ImproperlyConfigured from .test_cases import TestCase, SkipTest class TestUrllib3Connection(TestCase): def test_ssl_context(self): try: context = ssl.create_default_context() except AttributeError: # if create_default_context raises an AttributeError Exception # it means SSLContext is not available for that version of python # and we should skip this test. raise SkipTest( "Test test_ssl_context is skipped cause SSLContext is not available for this version of ptyhon") con = Urllib3HttpConnection(use_ssl=True, ssl_context=context) self.assertEqual(len(con.pool.conn_kw.keys()), 1) self.assertIsInstance( con.pool.conn_kw['ssl_context'], ssl.SSLContext ) self.assertTrue(con.use_ssl) def test_http_compression(self): con = Urllib3HttpConnection(http_compress=True) self.assertTrue(con.http_compress) self.assertEquals(con.headers['content-encoding'], 'gzip') def test_timeout_set(self): con = Urllib3HttpConnection(timeout=42) self.assertEquals(42, con.timeout) def test_keep_alive_is_on_by_default(self): con = Urllib3HttpConnection() self.assertEquals({'connection': 'keep-alive', 'content-type': 'application/json'}, con.headers) def test_http_auth(self): con = Urllib3HttpConnection(http_auth='username:secret') self.assertEquals({ 'authorization': 'Basic dXNlcm5hbWU6c2VjcmV0', 'connection': 'keep-alive', 'content-type': 'application/json' }, con.headers) def test_http_auth_tuple(self): con = Urllib3HttpConnection(http_auth=('username', 'secret')) self.assertEquals({'authorization': 'Basic dXNlcm5hbWU6c2VjcmV0', 'content-type': 'application/json', 'connection': 'keep-alive'}, con.headers) def test_http_auth_list(self): con = Urllib3HttpConnection(http_auth=['username', 'secret']) self.assertEquals({'authorization': 'Basic dXNlcm5hbWU6c2VjcmV0', 'content-type': 'application/json', 'connection': 'keep-alive'}, con.headers) def test_uses_https_if_verify_certs_is_off(self): with warnings.catch_warnings(record=True) as w: con = Urllib3HttpConnection(use_ssl=True, verify_certs=False) self.assertEquals(1, len(w)) self.assertEquals('Connecting to localhost using SSL with verify_certs=False is insecure.', str(w[0].message)) self.assertIsInstance(con.pool, urllib3.HTTPSConnectionPool) def test_doesnt_use_https_if_not_specified(self): con = Urllib3HttpConnection() self.assertIsInstance(con.pool, urllib3.HTTPConnectionPool) class TestRequestsConnection(TestCase): def _get_mock_connection(self, connection_params={}, status_code=200, response_body='{}'): con = RequestsHttpConnection(**connection_params) def _dummy_send(*args, **kwargs): dummy_response = Mock() dummy_response.headers = {} dummy_response.status_code = status_code dummy_response.text = response_body dummy_response.request = args[0] dummy_response.cookies = {} _dummy_send.call_args = (args, kwargs) return dummy_response con.session.send = _dummy_send return con def _get_request(self, connection, *args, **kwargs): if 'body' in kwargs: kwargs['body'] = kwargs['body'].encode('utf-8') status, headers, data = connection.perform_request(*args, **kwargs) self.assertEquals(200, status) self.assertEquals('{}', data) timeout = kwargs.pop('timeout', connection.timeout) args, kwargs = connection.session.send.call_args self.assertEquals(timeout, kwargs['timeout']) self.assertEquals(1, len(args)) return args[0] def test_custom_http_auth_is_allowed(self): auth = AuthBase() c = RequestsHttpConnection(http_auth=auth) self.assertEquals(auth, c.session.auth) def test_timeout_set(self): con = RequestsHttpConnection(timeout=42) self.assertEquals(42, con.timeout) def test_uses_https_if_verify_certs_is_off(self): with warnings.catch_warnings(record=True) as w: con = self._get_mock_connection({'use_ssl': True, 'url_prefix': 'url', 'verify_certs': False}) self.assertEquals(1, len(w)) self.assertEquals('Connecting to https://localhost:9200/url using SSL with verify_certs=False is insecure.', str(w[0].message)) request = self._get_request(con, 'GET', '/') self.assertEquals('https://localhost:9200/url/', request.url) self.assertEquals('GET', request.method) self.assertEquals(None, request.body) def test_merge_headers(self): con = self._get_mock_connection(connection_params={'headers': {'h1': 'v1', 'h2': 'v2'}}) req = self._get_request(con, 'GET', '/', headers={'h2': 'v2p', 'h3': 'v3'}) self.assertEquals(req.headers['h1'], 'v1') self.assertEquals(req.headers['h2'], 'v2p') self.assertEquals(req.headers['h3'], 'v3') def test_http_auth(self): con = RequestsHttpConnection(http_auth='username:secret') self.assertEquals(('username', 'secret'), con.session.auth) def test_http_auth_tuple(self): con = RequestsHttpConnection(http_auth=('username', 'secret')) self.assertEquals(('username', 'secret'), con.session.auth) def test_http_auth_list(self): con = RequestsHttpConnection(http_auth=['username', 'secret']) self.assertEquals(('username', 'secret'), con.session.auth) def test_repr(self): con = self._get_mock_connection({"host": "elasticsearch.com", "port": 443}) self.assertEquals('', repr(con)) def test_conflict_error_is_returned_on_409(self): con = self._get_mock_connection(status_code=409) self.assertRaises(ConflictError, con.perform_request, 'GET', '/', {}, '') def test_not_found_error_is_returned_on_404(self): con = self._get_mock_connection(status_code=404) self.assertRaises(NotFoundError, con.perform_request, 'GET', '/', {}, '') def test_request_error_is_returned_on_400(self): con = self._get_mock_connection(status_code=400) self.assertRaises(RequestError, con.perform_request, 'GET', '/', {}, '') @patch('elasticsearch.connection.base.logger') def test_head_with_404_doesnt_get_logged(self, logger): con = self._get_mock_connection(status_code=404) self.assertRaises(NotFoundError, con.perform_request, 'HEAD', '/', {}, '') self.assertEquals(0, logger.warning.call_count) @patch('elasticsearch.connection.base.tracer') @patch('elasticsearch.connection.base.logger') def test_failed_request_logs_and_traces(self, logger, tracer): con = self._get_mock_connection(response_body='{"answer": 42}', status_code=500) self.assertRaises(TransportError, con.perform_request, 'GET', '/', {'param': 42}, '{}'.encode('utf-8')) # trace request self.assertEquals(1, tracer.info.call_count) # trace response self.assertEquals(1, tracer.debug.call_count) # log url and duration self.assertEquals(1, logger.warning.call_count) self.assertTrue(re.match( '^GET http://localhost:9200/\?param=42 \[status:500 request:0.[0-9]{3}s\]', logger.warning.call_args[0][0] % logger.warning.call_args[0][1:] )) @patch('elasticsearch.connection.base.tracer') @patch('elasticsearch.connection.base.logger') def test_success_logs_and_traces(self, logger, tracer): con = self._get_mock_connection(response_body='''{"answer": "that's it!"}''') status, headers, data = con.perform_request('GET', '/', {'param': 42}, '''{"question": "what's that?"}'''.encode('utf-8')) # trace request self.assertEquals(1, tracer.info.call_count) self.assertEquals( """curl -H 'Content-Type: application/json' -XGET 'http://localhost:9200/?pretty¶m=42' -d '{\n "question": "what\\u0027s that?"\n}'""", tracer.info.call_args[0][0] % tracer.info.call_args[0][1:] ) # trace response self.assertEquals(1, tracer.debug.call_count) self.assertTrue(re.match( '#\[200\] \(0.[0-9]{3}s\)\n#\{\n# "answer": "that\\\\u0027s it!"\n#\}', tracer.debug.call_args[0][0] % tracer.debug.call_args[0][1:] )) # log url and duration self.assertEquals(1, logger.info.call_count) self.assertTrue(re.match( 'GET http://localhost:9200/\?param=42 \[status:200 request:0.[0-9]{3}s\]', logger.info.call_args[0][0] % logger.info.call_args[0][1:] )) # log request body and response self.assertEquals(2, logger.debug.call_count) req, resp = logger.debug.call_args_list self.assertEquals( '> {"question": "what\'s that?"}', req[0][0] % req[0][1:] ) self.assertEquals( '< {"answer": "that\'s it!"}', resp[0][0] % resp[0][1:] ) def test_defaults(self): con = self._get_mock_connection() request = self._get_request(con, 'GET', '/') self.assertEquals('http://localhost:9200/', request.url) self.assertEquals('GET', request.method) self.assertEquals(None, request.body) def test_params_properly_encoded(self): con = self._get_mock_connection() request = self._get_request(con, 'GET', '/', params={'param': 'value with spaces'}) self.assertEquals('http://localhost:9200/?param=value+with+spaces', request.url) self.assertEquals('GET', request.method) self.assertEquals(None, request.body) def test_body_attached(self): con = self._get_mock_connection() request = self._get_request(con, 'GET', '/', body='{"answer": 42}') self.assertEquals('http://localhost:9200/', request.url) self.assertEquals('GET', request.method) self.assertEquals('{"answer": 42}'.encode('utf-8'), request.body) def test_http_auth_attached(self): con = self._get_mock_connection({'http_auth': 'username:secret'}) request = self._get_request(con, 'GET', '/') self.assertEquals(request.headers['authorization'], 'Basic dXNlcm5hbWU6c2VjcmV0') @patch('elasticsearch.connection.base.tracer') def test_url_prefix(self, tracer): con = self._get_mock_connection({"url_prefix": "/some-prefix/"}) request = self._get_request(con, 'GET', '/_search', body='{"answer": 42}', timeout=0.1) self.assertEquals('http://localhost:9200/some-prefix/_search', request.url) self.assertEquals('GET', request.method) self.assertEquals('{"answer": 42}'.encode('utf-8'), request.body) # trace request self.assertEquals(1, tracer.info.call_count) self.assertEquals( "curl -H 'Content-Type: application/json' -XGET 'http://localhost:9200/_search?pretty' -d '{\n \"answer\": 42\n}'", tracer.info.call_args[0][0] % tracer.info.call_args[0][1:] )