# Copyright 2012 New Dream Network, LLC (DreamHost) # # 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. # # @author: Mark McClain, DreamHost import contextlib import socket import mock import testtools import webob from neutron.agent.metadata import agent from neutron.common import constants from neutron.common import utils from neutron.tests import base EXPECTED_OWNER_ROUTERS = [ constants.DEVICE_OWNER_ROUTER_INTF, constants.DEVICE_OWNER_DVR_INTERFACE ] class FakeConf(object): admin_user = 'neutron' admin_password = 'password' admin_tenant_name = 'tenant' auth_url = 'http://127.0.0.1' auth_strategy = 'keystone' auth_region = 'region' auth_insecure = False auth_ca_cert = None endpoint_type = 'adminURL' nova_metadata_ip = '9.9.9.9' nova_metadata_port = 8775 metadata_proxy_shared_secret = 'secret' nova_metadata_protocol = 'http' nova_metadata_insecure = True nova_client_cert = 'nova_cert' nova_client_priv_key = 'nova_priv_key' cache_url = '' class FakeConfCache(FakeConf): cache_url = 'memory://?default_ttl=5' class TestMetadataProxyHandlerCache(base.BaseTestCase): fake_conf = FakeConfCache def setUp(self): super(TestMetadataProxyHandlerCache, self).setUp() self.qclient_p = mock.patch('neutronclient.v2_0.client.Client') self.qclient = self.qclient_p.start() self.log_p = mock.patch.object(agent, 'LOG') self.log = self.log_p.start() self.handler = agent.MetadataProxyHandler(self.fake_conf) def test_call(self): req = mock.Mock() with mock.patch.object(self.handler, '_get_instance_and_tenant_id') as get_ids: get_ids.return_value = ('instance_id', 'tenant_id') with mock.patch.object(self.handler, '_proxy_request') as proxy: proxy.return_value = 'value' retval = self.handler(req) self.assertEqual(retval, 'value') def test_call_no_instance_match(self): req = mock.Mock() with mock.patch.object(self.handler, '_get_instance_and_tenant_id') as get_ids: get_ids.return_value = None, None retval = self.handler(req) self.assertIsInstance(retval, webob.exc.HTTPNotFound) def test_call_internal_server_error(self): req = mock.Mock() with mock.patch.object(self.handler, '_get_instance_and_tenant_id') as get_ids: get_ids.side_effect = Exception retval = self.handler(req) self.assertIsInstance(retval, webob.exc.HTTPInternalServerError) self.assertEqual(len(self.log.mock_calls), 2) def test_get_router_networks(self): router_id = 'router-id' expected = ('network_id1', 'network_id2') ports = {'ports': [{'network_id': 'network_id1', 'something': 42}, {'network_id': 'network_id2', 'something_else': 32}], 'not_used': [1, 2, 3]} mock_list_ports = self.qclient.return_value.list_ports mock_list_ports.return_value = ports networks = self.handler._get_router_networks(router_id) mock_list_ports.assert_called_once_with( device_id=router_id, device_owner=EXPECTED_OWNER_ROUTERS) self.assertEqual(expected, networks) def _test_get_router_networks_twice_helper(self): router_id = 'router-id' ports = {'ports': [{'network_id': 'network_id1', 'something': 42}], 'not_used': [1, 2, 3]} expected_networks = ('network_id1',) with mock.patch( 'neutron.openstack.common.timeutils.utcnow_ts', return_value=0): mock_list_ports = self.qclient.return_value.list_ports mock_list_ports.return_value = ports networks = self.handler._get_router_networks(router_id) mock_list_ports.assert_called_once_with( device_id=router_id, device_owner=EXPECTED_OWNER_ROUTERS) self.assertEqual(expected_networks, networks) networks = self.handler._get_router_networks(router_id) def test_get_router_networks_twice(self): self._test_get_router_networks_twice_helper() self.assertEqual( 1, self.qclient.return_value.list_ports.call_count) def test_get_ports_for_remote_address(self): remote_address = 'remote_address' networks = ('network_id1', 'network_id3') fixed_ips = ["ip_address=%s" % remote_address] expected_ports = [{'network_id': 'network_id1', 'something': 42}] mock_list_ports = self.qclient.return_value.list_ports mock_list_ports.return_value = {'ports': [{'network_id': 'network_id1', 'something': 42}, {'network_id': 'network_id2', 'something_else': 64}]} ports = self.handler._get_ports_for_remote_address(remote_address, networks) mock_list_ports.assert_called_once_with(fixed_ips=fixed_ips) self.assertEqual(expected_ports, ports) def _get_ports_for_remote_address_cache_hit_helper(self): remote_address = 'remote_address' networks = ('net1', 'net2') fixed_ips = ["ip_address=%s" % remote_address] mock_list_ports = self.qclient.return_value.list_ports mock_list_ports.return_value = {'ports': [{'network_id': 'net1', 'something': 42}]} self.handler._get_ports_for_remote_address(remote_address, networks) mock_list_ports.assert_called_once_with( fixed_ips=fixed_ips) self.assertEqual(1, mock_list_ports.call_count) self.handler._get_ports_for_remote_address(remote_address, networks) def test_get_ports_for_remote_address_cache_hit(self): self._get_ports_for_remote_address_cache_hit_helper() self.assertEqual( 1, self.qclient.return_value.list_ports.call_count) def test_get_ports_network_id(self): network_id = 'network-id' router_id = 'router-id' remote_address = 'remote-address' expected = ['port1'] networks = (network_id,) with contextlib.nested( mock.patch.object(self.handler, '_get_ports_for_remote_address'), mock.patch.object(self.handler, '_get_router_networks') ) as (mock_get_ip_addr, mock_get_router_networks): mock_get_ip_addr.return_value = expected ports = self.handler._get_ports(remote_address, network_id, router_id) mock_get_ip_addr.assert_called_once_with(remote_address, networks) self.assertFalse(mock_get_router_networks.called) self.assertEqual(expected, ports) def test_get_ports_router_id(self): router_id = 'router-id' remote_address = 'remote-address' expected = ['port1'] networks = ('network1', 'network2') with contextlib.nested( mock.patch.object(self.handler, '_get_ports_for_remote_address', return_value=expected), mock.patch.object(self.handler, '_get_router_networks', return_value=networks) ) as (mock_get_ip_addr, mock_get_router_networks): ports = self.handler._get_ports(remote_address, router_id=router_id) mock_get_router_networks.called_once_with(router_id) mock_get_ip_addr.assert_called_once_with(remote_address, networks) self.assertEqual(expected, ports) def test_get_ports_no_id(self): self.assertRaises(TypeError, self.handler._get_ports, 'remote_address') def _get_instance_and_tenant_id_helper(self, headers, list_ports_retval, networks=None, router_id=None): remote_address = '192.168.1.1' headers['X-Forwarded-For'] = remote_address req = mock.Mock(headers=headers) def mock_list_ports(*args, **kwargs): return {'ports': list_ports_retval.pop(0)} self.qclient.return_value.list_ports.side_effect = mock_list_ports instance_id, tenant_id = self.handler._get_instance_and_tenant_id(req) new_qclient_call = mock.call( username=FakeConf.admin_user, tenant_name=FakeConf.admin_tenant_name, region_name=FakeConf.auth_region, auth_url=FakeConf.auth_url, password=FakeConf.admin_password, auth_strategy=FakeConf.auth_strategy, token=None, insecure=FakeConf.auth_insecure, ca_cert=FakeConf.auth_ca_cert, endpoint_url=None, endpoint_type=FakeConf.endpoint_type) expected = [new_qclient_call] if router_id: expected.extend([ new_qclient_call, mock.call().list_ports( device_id=router_id, device_owner=EXPECTED_OWNER_ROUTERS ) ]) expected.extend([ new_qclient_call, mock.call().list_ports( fixed_ips=['ip_address=192.168.1.1']) ]) self.qclient.assert_has_calls(expected) return (instance_id, tenant_id) def test_get_instance_id_router_id(self): router_id = 'the_id' headers = { 'X-Neutron-Router-ID': router_id } networks = ('net1', 'net2') ports = [ [{'network_id': 'net1'}, {'network_id': 'net2'}], [{'device_id': 'device_id', 'tenant_id': 'tenant_id', 'network_id': 'net1'}] ] self.assertEqual( self._get_instance_and_tenant_id_helper(headers, ports, networks=networks, router_id=router_id), ('device_id', 'tenant_id') ) def test_get_instance_id_router_id_no_match(self): router_id = 'the_id' headers = { 'X-Neutron-Router-ID': router_id } networks = ('net1', 'net2') ports = [ [{'network_id': 'net1'}, {'network_id': 'net2'}], [] ] self.assertEqual( self._get_instance_and_tenant_id_helper(headers, ports, networks=networks, router_id=router_id), (None, None) ) def test_get_instance_id_network_id(self): network_id = 'the_id' headers = { 'X-Neutron-Network-ID': network_id } ports = [ [{'device_id': 'device_id', 'tenant_id': 'tenant_id', 'network_id': 'the_id'}] ] self.assertEqual( self._get_instance_and_tenant_id_helper(headers, ports, networks=('the_id',)), ('device_id', 'tenant_id') ) def test_get_instance_id_network_id_no_match(self): network_id = 'the_id' headers = { 'X-Neutron-Network-ID': network_id } ports = [[]] self.assertEqual( self._get_instance_and_tenant_id_helper(headers, ports, networks=('the_id',)), (None, None) ) def _proxy_request_test_helper(self, response_code=200, method='GET'): hdrs = {'X-Forwarded-For': '8.8.8.8'} body = 'body' req = mock.Mock(path_info='/the_path', query_string='', headers=hdrs, method=method, body=body) resp = mock.MagicMock(status=response_code) req.response = resp with mock.patch.object(self.handler, '_sign_instance_id') as sign: sign.return_value = 'signed' with mock.patch('httplib2.Http') as mock_http: resp.__getitem__.return_value = "text/plain" mock_http.return_value.request.return_value = (resp, 'content') retval = self.handler._proxy_request('the_id', 'tenant_id', req) mock_http.assert_called_once_with( ca_certs=None, disable_ssl_certificate_validation=True) mock_http.assert_has_calls([ mock.call().add_certificate( FakeConf.nova_client_priv_key, FakeConf.nova_client_cert, "%s:%s" % (FakeConf.nova_metadata_ip, FakeConf.nova_metadata_port) ), mock.call().request( 'http://9.9.9.9:8775/the_path', method=method, headers={ 'X-Forwarded-For': '8.8.8.8', 'X-Instance-ID-Signature': 'signed', 'X-Instance-ID': 'the_id', 'X-Tenant-ID': 'tenant_id' }, body=body )] ) return retval def test_proxy_request_post(self): response = self._proxy_request_test_helper(method='POST') self.assertEqual(response.content_type, "text/plain") self.assertEqual(response.body, 'content') def test_proxy_request_200(self): response = self._proxy_request_test_helper(200) self.assertEqual(response.content_type, "text/plain") self.assertEqual(response.body, 'content') def test_proxy_request_403(self): self.assertIsInstance(self._proxy_request_test_helper(403), webob.exc.HTTPForbidden) def test_proxy_request_404(self): self.assertIsInstance(self._proxy_request_test_helper(404), webob.exc.HTTPNotFound) def test_proxy_request_409(self): self.assertIsInstance(self._proxy_request_test_helper(409), webob.exc.HTTPConflict) def test_proxy_request_500(self): self.assertIsInstance(self._proxy_request_test_helper(500), webob.exc.HTTPInternalServerError) def test_proxy_request_other_code(self): with testtools.ExpectedException(Exception): self._proxy_request_test_helper(302) def test_sign_instance_id(self): self.assertEqual( self.handler._sign_instance_id('foo'), '773ba44693c7553d6ee20f61ea5d2757a9a4f4a44d2841ae4e95b52e4cd62db4' ) class TestMetadataProxyHandlerNoCache(TestMetadataProxyHandlerCache): fake_conf = FakeConf def test_get_router_networks_twice(self): self._test_get_router_networks_twice_helper() self.assertEqual( 2, self.qclient.return_value.list_ports.call_count) def test_get_ports_for_remote_address_cache_hit(self): self._get_ports_for_remote_address_cache_hit_helper() self.assertEqual( 2, self.qclient.return_value.list_ports.call_count) class TestUnixDomainHttpProtocol(base.BaseTestCase): def test_init_empty_client(self): u = agent.UnixDomainHttpProtocol(mock.Mock(), '', mock.Mock()) self.assertEqual(u.client_address, ('', 0)) def test_init_with_client(self): u = agent.UnixDomainHttpProtocol(mock.Mock(), 'foo', mock.Mock()) self.assertEqual(u.client_address, 'foo') class TestUnixDomainWSGIServer(base.BaseTestCase): def setUp(self): super(TestUnixDomainWSGIServer, self).setUp() self.eventlet_p = mock.patch.object(agent, 'eventlet') self.eventlet = self.eventlet_p.start() self.server = agent.UnixDomainWSGIServer('test') def test_start(self): mock_app = mock.Mock() with mock.patch.object(self.server, 'pool') as pool: self.server.start(mock_app, '/the/path', workers=0, backlog=128) self.eventlet.assert_has_calls([ mock.call.listen( '/the/path', family=socket.AF_UNIX, backlog=128 )] ) pool.spawn_n.assert_called_once_with( self.server._run, mock_app, self.eventlet.listen.return_value ) @mock.patch('neutron.openstack.common.service.ProcessLauncher') def test_start_multiple_workers(self, process_launcher): launcher = process_launcher.return_value mock_app = mock.Mock() self.server.start(mock_app, '/the/path', workers=2, backlog=128) launcher.running = True launcher.launch_service.assert_called_once_with(self.server._server, workers=2) self.server.stop() self.assertFalse(launcher.running) self.server.wait() launcher.wait.assert_called_once_with() def test_run(self): with mock.patch.object(agent, 'logging') as logging: self.server._run('app', 'sock') self.eventlet.wsgi.server.assert_called_once_with( 'sock', 'app', protocol=agent.UnixDomainHttpProtocol, log=mock.ANY, custom_pool=self.server.pool ) self.assertTrue(len(logging.mock_calls)) class TestUnixDomainMetadataProxy(base.BaseTestCase): def setUp(self): super(TestUnixDomainMetadataProxy, self).setUp() self.cfg_p = mock.patch.object(agent, 'cfg') self.cfg = self.cfg_p.start() looping_call_p = mock.patch( 'neutron.openstack.common.loopingcall.FixedIntervalLoopingCall') self.looping_mock = looping_call_p.start() self.cfg.CONF.metadata_proxy_socket = '/the/path' self.cfg.CONF.metadata_workers = 0 self.cfg.CONF.metadata_backlog = 128 def test_init_doesnot_exists(self): with mock.patch('os.path.isdir') as isdir: with mock.patch('os.makedirs') as makedirs: isdir.return_value = False agent.UnixDomainMetadataProxy(mock.Mock()) isdir.assert_called_once_with('/the') makedirs.assert_called_once_with('/the', 0o755) def test_init_exists(self): with mock.patch('os.path.isdir') as isdir: with mock.patch('os.unlink') as unlink: isdir.return_value = True agent.UnixDomainMetadataProxy(mock.Mock()) isdir.assert_called_once_with('/the') unlink.assert_called_once_with('/the/path') def test_init_exists_unlink_no_file(self): with mock.patch('os.path.isdir') as isdir: with mock.patch('os.unlink') as unlink: with mock.patch('os.path.exists') as exists: isdir.return_value = True exists.return_value = False unlink.side_effect = OSError agent.UnixDomainMetadataProxy(mock.Mock()) isdir.assert_called_once_with('/the') unlink.assert_called_once_with('/the/path') exists.assert_called_once_with('/the/path') def test_init_exists_unlink_fails_file_still_exists(self): with mock.patch('os.path.isdir') as isdir: with mock.patch('os.unlink') as unlink: with mock.patch('os.path.exists') as exists: isdir.return_value = True exists.return_value = True unlink.side_effect = OSError with testtools.ExpectedException(OSError): agent.UnixDomainMetadataProxy(mock.Mock()) isdir.assert_called_once_with('/the') unlink.assert_called_once_with('/the/path') exists.assert_called_once_with('/the/path') def test_run(self): with mock.patch.object(agent, 'MetadataProxyHandler') as handler: with mock.patch.object(agent, 'UnixDomainWSGIServer') as server: with mock.patch('os.path.isdir') as isdir: with mock.patch('os.makedirs') as makedirs: isdir.return_value = False p = agent.UnixDomainMetadataProxy(self.cfg.CONF) p.run() isdir.assert_called_once_with('/the') makedirs.assert_called_once_with('/the', 0o755) server.assert_has_calls([ mock.call('neutron-metadata-agent'), mock.call().start(handler.return_value, '/the/path', workers=0, backlog=128), mock.call().wait()] ) def test_main(self): with mock.patch.object(agent, 'UnixDomainMetadataProxy') as proxy: with mock.patch.object(agent, 'config') as config: with mock.patch.object(agent, 'cfg') as cfg: with mock.patch.object(utils, 'cfg'): agent.main() self.assertTrue(config.setup_logging.called) proxy.assert_has_calls([ mock.call(cfg.CONF), mock.call().run()] ) def test_init_state_reporting(self): with mock.patch('os.makedirs'): proxy = agent.UnixDomainMetadataProxy(mock.Mock()) self.looping_mock.assert_called_once_with(proxy._report_state) self.looping_mock.return_value.start.assert_called_once_with( interval=mock.ANY) def test_report_state(self): with mock.patch('neutron.agent.rpc.PluginReportStateAPI') as state_api: with mock.patch('os.makedirs'): proxy = agent.UnixDomainMetadataProxy(mock.Mock()) self.assertTrue(proxy.agent_state['start_flag']) proxy._report_state() self.assertNotIn('start_flag', proxy.agent_state) state_api_inst = state_api.return_value state_api_inst.report_state.assert_called_once_with( proxy.context, proxy.agent_state, use_call=True)