tempest/tests/test_glance_http.py

# Copyright 2014 IBM Corp.
# All Rights Reserved.
#
#    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.

import socket

import mock
from oslotest import mockpatch
import six
from six.moves import http_client as httplib

from tempest.common import glance_http
from tempest import exceptions
from tempest.tests import base
from tempest.tests import fake_auth_provider
from tempest.tests.lib import fake_http


class TestGlanceHTTPClient(base.TestCase):

    def setUp(self):
        super(TestGlanceHTTPClient, self).setUp()
        self.endpoint = 'http://fake_url.com'
        self.fake_auth = fake_auth_provider.FakeAuthProvider()

        self.fake_auth.base_url = mock.MagicMock(return_value=self.endpoint)

        self.useFixture(mockpatch.PatchObject(
            httplib.HTTPConnection,
            'request',
            side_effect=b'fake_body'))
        self.client = glance_http.HTTPClient(self.fake_auth, {})

    def _set_response_fixture(self, header, status, resp_body):
        resp = fake_http.fake_http_response(header, status=status,
                                            body=six.StringIO(resp_body))
        self.useFixture(mockpatch.PatchObject(httplib.HTTPConnection,
                        'getresponse', return_value=resp))
        return resp

    def test_raw_request(self):
        self._set_response_fixture({}, 200, 'fake_response_body')
        resp, body = self.client.raw_request('GET', '/images')
        self.assertEqual(200, resp.status)
        self.assertEqual('fake_response_body', body.read())

    def test_raw_request_with_response_chunked(self):
        self._set_response_fixture({}, 200, 'fake_response_body')
        self.useFixture(mockpatch.PatchObject(glance_http,
                                              'CHUNKSIZE', 1))
        resp, body = self.client.raw_request('GET', '/images')
        self.assertEqual(200, resp.status)
        self.assertEqual('fake_response_body', body.read())

    def test_raw_request_chunked(self):
        self.useFixture(mockpatch.PatchObject(glance_http,
                                              'CHUNKSIZE', 1))
        self.useFixture(mockpatch.PatchObject(httplib.HTTPConnection,
                        'endheaders'))
        self.useFixture(mockpatch.PatchObject(httplib.HTTPConnection,
                        'send'))

        self._set_response_fixture({}, 200, 'fake_response_body')
        req_body = six.StringIO('fake_request_body')
        resp, body = self.client.raw_request('PUT', '/images', body=req_body)
        self.assertEqual(200, resp.status)
        self.assertEqual('fake_response_body', body.read())
        call_count = httplib.HTTPConnection.send.call_count
        self.assertEqual(call_count - 1, req_body.tell())

    def test_get_connection_class_for_https(self):
        conn_class = self.client._get_connection_class('https')
        self.assertEqual(glance_http.VerifiedHTTPSConnection, conn_class)

    def test_get_connection_class_for_http(self):
        conn_class = (self.client._get_connection_class('http'))
        self.assertEqual(httplib.HTTPConnection, conn_class)

    def test_get_connection_http(self):
        self.assertIsInstance(self.client._get_connection(),
                              httplib.HTTPConnection)

    def test_get_connection_https(self):
        endpoint = 'https://fake_url.com'
        self.fake_auth.base_url = mock.MagicMock(return_value=endpoint)
        self.client = glance_http.HTTPClient(self.fake_auth, {})
        self.assertIsInstance(self.client._get_connection(),
                              glance_http.VerifiedHTTPSConnection)

    def test_get_connection_ipv4_https(self):
        endpoint = 'https://127.0.0.1'
        self.fake_auth.base_url = mock.MagicMock(return_value=endpoint)
        self.client = glance_http.HTTPClient(self.fake_auth, {})
        self.assertIsInstance(self.client._get_connection(),
                              glance_http.VerifiedHTTPSConnection)

    def test_get_connection_ipv6_https(self):
        endpoint = 'https://[::1]'
        self.fake_auth.base_url = mock.MagicMock(return_value=endpoint)
        self.client = glance_http.HTTPClient(self.fake_auth, {})
        self.assertIsInstance(self.client._get_connection(),
                              glance_http.VerifiedHTTPSConnection)

    def test_get_connection_url_not_fount(self):
        self.useFixture(mockpatch.PatchObject(self.client, 'connection_class',
                                              side_effect=httplib.InvalidURL()
                                              ))
        self.assertRaises(exceptions.EndpointNotFound,
                          self.client._get_connection)

    def test_get_connection_kwargs_default_for_http(self):
        kwargs = self.client._get_connection_kwargs('http')
        self.assertEqual(600, kwargs['timeout'])
        self.assertEqual(1, len(kwargs.keys()))

    def test_get_connection_kwargs_set_timeout_for_http(self):
        kwargs = self.client._get_connection_kwargs('http', timeout=10,
                                                    ca_certs='foo')
        self.assertEqual(10, kwargs['timeout'])
        # nothing more than timeout is evaluated for http connections
        self.assertEqual(1, len(kwargs.keys()))

    def test_get_connection_kwargs_default_for_https(self):
        kwargs = self.client._get_connection_kwargs('https')
        self.assertEqual(600, kwargs['timeout'])
        self.assertIsNone(kwargs['ca_certs'])
        self.assertIsNone(kwargs['cert_file'])
        self.assertIsNone(kwargs['key_file'])
        self.assertEqual(False, kwargs['insecure'])
        self.assertEqual(True, kwargs['ssl_compression'])
        self.assertEqual(6, len(kwargs.keys()))

    def test_get_connection_kwargs_set_params_for_https(self):
        kwargs = self.client._get_connection_kwargs('https', timeout=10,
                                                    ca_certs='foo',
                                                    cert_file='/foo/bar.cert',
                                                    key_file='/foo/key.pem',
                                                    insecure=True,
                                                    ssl_compression=False)
        self.assertEqual(10, kwargs['timeout'])
        self.assertEqual('foo', kwargs['ca_certs'])
        self.assertEqual('/foo/bar.cert', kwargs['cert_file'])
        self.assertEqual('/foo/key.pem', kwargs['key_file'])
        self.assertEqual(True, kwargs['insecure'])
        self.assertEqual(False, kwargs['ssl_compression'])
        self.assertEqual(6, len(kwargs.keys()))


class TestVerifiedHTTPSConnection(base.TestCase):

    @mock.patch('socket.socket')
    @mock.patch('tempest.common.glance_http.OpenSSLConnectionDelegator')
    def test_connect_ipv4(self, mock_delegator, mock_socket):
        connection = glance_http.VerifiedHTTPSConnection('127.0.0.1')
        connection.connect()

        mock_socket.assert_called_once_with(socket.AF_INET, socket.SOCK_STREAM)
        mock_delegator.assert_called_once_with(connection.context,
                                               mock_socket.return_value)
        mock_delegator.return_value.connect.assert_called_once_with(
            (connection.host, 443))

    @mock.patch('socket.socket')
    @mock.patch('tempest.common.glance_http.OpenSSLConnectionDelegator')
    def test_connect_ipv6(self, mock_delegator, mock_socket):
        connection = glance_http.VerifiedHTTPSConnection('[::1]')
        connection.connect()

        mock_socket.assert_called_once_with(socket.AF_INET6,
                                            socket.SOCK_STREAM)
        mock_delegator.assert_called_once_with(connection.context,
                                               mock_socket.return_value)
        mock_delegator.return_value.connect.assert_called_once_with(
            (connection.host, 443, 0, 0))

    @mock.patch('tempest.common.glance_http.OpenSSLConnectionDelegator')
    @mock.patch('socket.getaddrinfo',
                side_effect=OSError('Gettaddrinfo failed'))
    def test_connect_with_address_lookup_failure(self, mock_getaddrinfo,
                                                 mock_delegator):
        connection = glance_http.VerifiedHTTPSConnection('127.0.0.1')
        self.assertRaises(exceptions.RestClientException, connection.connect)

        mock_getaddrinfo.assert_called_once_with(
            connection.host, connection.port, 0, socket.SOCK_STREAM)

    @mock.patch('socket.socket')
    @mock.patch('socket.getaddrinfo',
                return_value=[(2, 1, 6, '', ('127.0.0.1', 443))])
    @mock.patch('tempest.common.glance_http.OpenSSLConnectionDelegator')
    def test_connect_with_socket_failure(self, mock_delegator,
                                         mock_getaddrinfo,
                                         mock_socket):
        mock_delegator.return_value.connect.side_effect = \
            OSError('Connect failed')

        connection = glance_http.VerifiedHTTPSConnection('127.0.0.1')
        self.assertRaises(exceptions.RestClientException, connection.connect)

        mock_getaddrinfo.assert_called_once_with(
            connection.host, connection.port, 0, socket.SOCK_STREAM)
        mock_socket.assert_called_once_with(socket.AF_INET, socket.SOCK_STREAM)
        mock_delegator.return_value.connect.\
            assert_called_once_with((connection.host, 443))


class TestResponseBodyIterator(base.TestCase):

    def test_iter_default_chunk_size_64k(self):
        resp = fake_http.fake_http_response({}, six.StringIO(
            'X' * (glance_http.CHUNKSIZE + 1)))
        iterator = glance_http.ResponseBodyIterator(resp)
        chunks = list(iterator)
        self.assertEqual(chunks, ['X' * glance_http.CHUNKSIZE, 'X'])