openstack/python-swiftclient
Code Issues Proposed changes

Use mock patch to handle get_auth_keystone

Browse Source 
Setting c.get_auth_keystone = fake_get_auth_keystone is setting a new
method on the module. This information is not reset between test runs
and therefore has the potential to corrupt other tests.

Use mock patch so that the mock is reset after the test is complete.

Change-Id: Ifb9ba72634cf477c72dda080b5aed8f8e3a7ac89
This commit is contained in:
Jamie Lennox 2016-08-24 23:10:59 +10:00
parent 5acefd27e4
commit fd675b2c5a
1 changed files with 138 additions and 127 deletions

265
tests/unit/test_swiftclient.py

@ -335,79 +335,84 @@ class TestGetAuth(MockHttpTest):
def test_auth_v2_with_tenant_name(self): def test_auth_v2_with_tenant_name(self):
os_options = {'tenant_name': 'asdf'} os_options = {'tenant_name': 'asdf'}
req_args = {'auth_version': '2.0'} req_args = {'auth_version': '2.0'}
c.get_auth_keystone = fake_get_auth_keystone(os_options, ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
required_kwargs=req_args) with mock.patch('swiftclient.client.get_auth_keystone', ks):
url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf', url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
os_options=os_options, os_options=os_options,
auth_version="2.0") auth_version="2.0")
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
def test_auth_v2_with_tenant_id(self): def test_auth_v2_with_tenant_id(self):
os_options = {'tenant_id': 'asdf'} os_options = {'tenant_id': 'asdf'}
req_args = {'auth_version': '2.0'} req_args = {'auth_version': '2.0'}
c.get_auth_keystone = fake_get_auth_keystone(os_options, ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
required_kwargs=req_args) with mock.patch('swiftclient.client.get_auth_keystone', ks):
url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf', url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
os_options=os_options, os_options=os_options,
auth_version="2.0") auth_version="2.0")
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
def test_auth_v2_with_project_name(self): def test_auth_v2_with_project_name(self):
os_options = {'project_name': 'asdf'} os_options = {'project_name': 'asdf'}
req_args = {'auth_version': '2.0'} req_args = {'auth_version': '2.0'}
c.get_auth_keystone = fake_get_auth_keystone(os_options, ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
required_kwargs=req_args) with mock.patch('swiftclient.client.get_auth_keystone', ks):
url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf', url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
os_options=os_options, os_options=os_options,
auth_version="2.0") auth_version="2.0")
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
def test_auth_v2_with_project_id(self): def test_auth_v2_with_project_id(self):
os_options = {'project_id': 'asdf'} os_options = {'project_id': 'asdf'}
req_args = {'auth_version': '2.0'} req_args = {'auth_version': '2.0'}
c.get_auth_keystone = fake_get_auth_keystone(os_options,
required_kwargs=req_args) ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf', with mock.patch('swiftclient.client.get_auth_keystone', ks):
os_options=os_options, url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
auth_version="2.0") os_options=os_options,
auth_version="2.0")
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
def test_auth_v2_no_tenant_name_or_tenant_id(self): def test_auth_v2_no_tenant_name_or_tenant_id(self):
c.get_auth_keystone = fake_get_auth_keystone({}) with mock.patch('swiftclient.client.get_auth_keystone',
self.assertRaises(c.ClientException, c.get_auth, fake_get_auth_keystone({})):
'http://www.tests.com', 'asdf', 'asdf', self.assertRaises(c.ClientException, c.get_auth,
os_options={}, 'http://www.tests.com', 'asdf', 'asdf',
auth_version='2.0') os_options={},
auth_version='2.0')
def test_auth_v2_with_tenant_name_none_and_tenant_id_none(self): def test_auth_v2_with_tenant_name_none_and_tenant_id_none(self):
os_options = {'tenant_name': None, os_options = {'tenant_name': None,
'tenant_id': None} 'tenant_id': None}
c.get_auth_keystone = fake_get_auth_keystone(os_options) with mock.patch('swiftclient.client.get_auth_keystone',
self.assertRaises(c.ClientException, c.get_auth, fake_get_auth_keystone(os_options)):
'http://www.tests.com', 'asdf', 'asdf', self.assertRaises(c.ClientException, c.get_auth,
os_options=os_options, 'http://www.tests.com', 'asdf', 'asdf',
auth_version='2.0') os_options=os_options,
auth_version='2.0')
def test_auth_v2_with_tenant_user_in_user(self): def test_auth_v2_with_tenant_user_in_user(self):
tenant_option = {'tenant_name': 'foo'} tenant_option = {'tenant_name': 'foo'}
c.get_auth_keystone = fake_get_auth_keystone(tenant_option) with mock.patch('swiftclient.client.get_auth_keystone',
url, token = c.get_auth('http://www.test.com', 'foo:bar', 'asdf', fake_get_auth_keystone(tenant_option)):
os_options={}, url, token = c.get_auth('http://www.test.com', 'foo:bar', 'asdf',
auth_version="2.0") os_options={},
auth_version="2.0")
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
def test_auth_v2_tenant_name_no_os_options(self): def test_auth_v2_tenant_name_no_os_options(self):
tenant_option = {'tenant_name': 'asdf'} tenant_option = {'tenant_name': 'asdf'}
c.get_auth_keystone = fake_get_auth_keystone(tenant_option) with mock.patch('swiftclient.client.get_auth_keystone',
url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf', fake_get_auth_keystone(tenant_option)):
tenant_name='asdf', url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
os_options={}, tenant_name='asdf',
auth_version="2.0") os_options={},
auth_version="2.0")
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
@ -415,138 +420,141 @@ class TestGetAuth(MockHttpTest):
os_options = {'service_type': 'object-store', os_options = {'service_type': 'object-store',
'endpoint_type': 'internalURL', 'endpoint_type': 'internalURL',
'tenant_name': 'asdf'} 'tenant_name': 'asdf'}
c.get_auth_keystone = fake_get_auth_keystone(os_options) with mock.patch('swiftclient.client.get_auth_keystone',
url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf', fake_get_auth_keystone(os_options)):
os_options=os_options, url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
auth_version="2.0") os_options=os_options,
auth_version="2.0")
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
def test_auth_v2_with_tenant_user_in_user_no_os_options(self): def test_auth_v2_with_tenant_user_in_user_no_os_options(self):
tenant_option = {'tenant_name': 'foo'} tenant_option = {'tenant_name': 'foo'}
c.get_auth_keystone = fake_get_auth_keystone(tenant_option) with mock.patch('swiftclient.client.get_auth_keystone',
url, token = c.get_auth('http://www.test.com', 'foo:bar', 'asdf', fake_get_auth_keystone(tenant_option)):
auth_version="2.0") url, token = c.get_auth('http://www.test.com', 'foo:bar', 'asdf',
auth_version="2.0")
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
def test_auth_v2_with_os_region_name(self): def test_auth_v2_with_os_region_name(self):
os_options = {'region_name': 'good-region', os_options = {'region_name': 'good-region',
'tenant_name': 'asdf'} 'tenant_name': 'asdf'}
c.get_auth_keystone = fake_get_auth_keystone(os_options) with mock.patch('swiftclient.client.get_auth_keystone',
url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf', fake_get_auth_keystone(os_options)):
os_options=os_options, url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
auth_version="2.0") os_options=os_options,
auth_version="2.0")
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
def test_auth_v2_no_endpoint(self): def test_auth_v2_no_endpoint(self):
os_options = {'region_name': 'unknown_region', os_options = {'region_name': 'unknown_region',
'tenant_name': 'asdf'} 'tenant_name': 'asdf'}
c.get_auth_keystone = fake_get_auth_keystone( with mock.patch('swiftclient.client.get_auth_keystone',
os_options, c.ClientException) fake_get_auth_keystone(os_options, c.ClientException)):
self.assertRaises(c.ClientException, c.get_auth, self.assertRaises(c.ClientException, c.get_auth,
'http://www.tests.com', 'asdf', 'asdf', 'http://www.tests.com', 'asdf', 'asdf',
os_options=os_options, auth_version='2.0') os_options=os_options, auth_version='2.0')
def test_auth_v2_ks_exception(self): def test_auth_v2_ks_exception(self):
c.get_auth_keystone = fake_get_auth_keystone( with mock.patch('swiftclient.client.get_auth_keystone',
{}, c.ClientException) fake_get_auth_keystone({}, c.ClientException)):
self.assertRaises(c.ClientException, c.get_auth, self.assertRaises(c.ClientException, c.get_auth,
'http://www.tests.com', 'asdf', 'asdf', 'http://www.tests.com', 'asdf', 'asdf',
os_options={}, os_options={},
auth_version='2.0') auth_version='2.0')
def test_auth_v2_cacert(self): def test_auth_v2_cacert(self):
os_options = {'tenant_name': 'foo'} os_options = {'tenant_name': 'foo'}
c.get_auth_keystone = fake_get_auth_keystone(
os_options, None)
auth_url_secure = 'https://www.tests.com' auth_url_secure = 'https://www.tests.com'
auth_url_insecure = 'https://www.tests.com/self-signed-certificate' auth_url_insecure = 'https://www.tests.com/self-signed-certificate'
url, token = c.get_auth(auth_url_secure, 'asdf', 'asdf', with mock.patch('swiftclient.client.get_auth_keystone',
os_options=os_options, auth_version='2.0', fake_get_auth_keystone(os_options, None)):
insecure=False) url, token = c.get_auth(auth_url_secure, 'asdf', 'asdf',
self.assertTrue(url.startswith("http")) os_options=os_options, auth_version='2.0',
self.assertTrue(token) insecure=False)
self.assertTrue(url.startswith("http"))
self.assertTrue(token)
url, token = c.get_auth(auth_url_insecure, 'asdf', 'asdf', url, token = c.get_auth(auth_url_insecure, 'asdf', 'asdf',
os_options=os_options, auth_version='2.0', os_options=os_options, auth_version='2.0',
cacert='ca.pem', insecure=False) cacert='ca.pem', insecure=False)
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
self.assertRaises(c.ClientException, c.get_auth, self.assertRaises(c.ClientException, c.get_auth,
auth_url_insecure, 'asdf', 'asdf', auth_url_insecure, 'asdf', 'asdf',
os_options=os_options, auth_version='2.0') os_options=os_options, auth_version='2.0')
self.assertRaises(c.ClientException, c.get_auth, self.assertRaises(c.ClientException, c.get_auth,
auth_url_insecure, 'asdf', 'asdf', auth_url_insecure, 'asdf', 'asdf',
os_options=os_options, auth_version='2.0', os_options=os_options, auth_version='2.0',
insecure=False) insecure=False)
def test_auth_v2_insecure(self): def test_auth_v2_insecure(self):
os_options = {'tenant_name': 'foo'} os_options = {'tenant_name': 'foo'}
c.get_auth_keystone = fake_get_auth_keystone(
os_options, None)
auth_url_secure = 'https://www.tests.com' auth_url_secure = 'https://www.tests.com'
auth_url_insecure = 'https://www.tests.com/invalid-certificate' auth_url_insecure = 'https://www.tests.com/invalid-certificate'
url, token = c.get_auth(auth_url_secure, 'asdf', 'asdf', with mock.patch('swiftclient.client.get_auth_keystone',
os_options=os_options, auth_version='2.0') fake_get_auth_keystone(os_options, None)):
self.assertTrue(url.startswith("http")) url, token = c.get_auth(auth_url_secure, 'asdf', 'asdf',
self.assertTrue(token) os_options=os_options, auth_version='2.0')
self.assertTrue(url.startswith("http"))
self.assertTrue(token)
url, token = c.get_auth(auth_url_insecure, 'asdf', 'asdf', url, token = c.get_auth(auth_url_insecure, 'asdf', 'asdf',
os_options=os_options, auth_version='2.0', os_options=os_options, auth_version='2.0',
insecure=True) insecure=True)
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
self.assertRaises(c.ClientException, c.get_auth, self.assertRaises(c.ClientException, c.get_auth,
auth_url_insecure, 'asdf', 'asdf', auth_url_insecure, 'asdf', 'asdf',
os_options=os_options, auth_version='2.0') os_options=os_options, auth_version='2.0')
self.assertRaises(c.ClientException, c.get_auth, self.assertRaises(c.ClientException, c.get_auth,
auth_url_insecure, 'asdf', 'asdf', auth_url_insecure, 'asdf', 'asdf',
os_options=os_options, auth_version='2.0', os_options=os_options, auth_version='2.0',
insecure=False) insecure=False)
def test_auth_v2_cert(self): def test_auth_v2_cert(self):
os_options = {'tenant_name': 'foo'} os_options = {'tenant_name': 'foo'}
c.get_auth_keystone = fake_get_auth_keystone(os_options, None)
auth_url_no_sslauth = 'https://www.tests.com' auth_url_no_sslauth = 'https://www.tests.com'
auth_url_sslauth = 'https://www.tests.com/client-certificate' auth_url_sslauth = 'https://www.tests.com/client-certificate'
url, token = c.get_auth(auth_url_no_sslauth, 'asdf', 'asdf', with mock.patch('swiftclient.client.get_auth_keystone',
os_options=os_options, auth_version='2.0') fake_get_auth_keystone(os_options, None)):
self.assertTrue(url.startswith("http")) url, token = c.get_auth(auth_url_no_sslauth, 'asdf', 'asdf',
self.assertTrue(token) os_options=os_options, auth_version='2.0')
self.assertTrue(url.startswith("http"))
self.assertTrue(token)
url, token = c.get_auth(auth_url_sslauth, 'asdf', 'asdf', url, token = c.get_auth(auth_url_sslauth, 'asdf', 'asdf',
os_options=os_options, auth_version='2.0', os_options=os_options, auth_version='2.0',
cert='minnie', cert_key='mickey') cert='minnie', cert_key='mickey')
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
self.assertRaises(c.ClientException, c.get_auth, self.assertRaises(c.ClientException, c.get_auth,
auth_url_sslauth, 'asdf', 'asdf', auth_url_sslauth, 'asdf', 'asdf',
os_options=os_options, auth_version='2.0') os_options=os_options, auth_version='2.0')
self.assertRaises(c.ClientException, c.get_auth, self.assertRaises(c.ClientException, c.get_auth,
auth_url_sslauth, 'asdf', 'asdf', auth_url_sslauth, 'asdf', 'asdf',
os_options=os_options, auth_version='2.0', os_options=os_options, auth_version='2.0',
cert='minnie') cert='minnie')
def test_auth_v3_with_tenant_name(self): def test_auth_v3_with_tenant_name(self):
# check the correct auth version is passed to get_auth_keystone # check the correct auth version is passed to get_auth_keystone
os_options = {'tenant_name': 'asdf'} os_options = {'tenant_name': 'asdf'}
req_args = {'auth_version': '3'} req_args = {'auth_version': '3'}
c.get_auth_keystone = fake_get_auth_keystone(os_options,
required_kwargs=req_args) ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf', with mock.patch('swiftclient.client.get_auth_keystone', ks):
os_options=os_options, url, token = c.get_auth('http://www.test.com', 'asdf', 'asdf',
auth_version="3") os_options=os_options,
auth_version="3")
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)
@ -554,10 +562,13 @@ class TestGetAuth(MockHttpTest):
# check the correct auth version is passed to get_auth_keystone # check the correct auth version is passed to get_auth_keystone
os_options = {'tenant_name': 'asdf'} os_options = {'tenant_name': 'asdf'}
req_args = {'auth_version': '2.0'} req_args = {'auth_version': '2.0'}
c.get_auth_keystone = fake_get_auth_keystone(os_options,
required_kwargs=req_args) ks = fake_get_auth_keystone(os_options, required_kwargs=req_args)
url, token = c.get_keystoneclient_2_0('http://www.test.com', 'asdf', with mock.patch('swiftclient.client.get_auth_keystone', ks):
'asdf', os_options=os_options) url, token = c.get_keystoneclient_2_0('http://www.test.com',
'asdf', 'asdf',
os_options=os_options)
self.assertTrue(url.startswith("http")) self.assertTrue(url.startswith("http"))
self.assertTrue(token) self.assertTrue(token)