nova/nova/tests/unit/objects/test_keypair.py
Chris Dent def4b17934 Use nova.db.api directly
nova/db/__init__.py was importing * from nova.db.api. This meant that
any time any code anywhere within the nova.db package was imported
then nova.db.api was too, leading to a cascade of imports that may
not have been desired. Also, in general, code in __init__.py is a pain.

Therefore, this change adjusts code that so that either:

* nova.db.api is used directly
* nova.db.api is imported as 'db'

In either case, the functionality remains the same.

The primary goal of this change was to make it possible to import the
model files without having to import the db api. Moving the model files
to a different place in the directory hierarchy was considered, but
given that "code in __init__.py is a pain" this mode was chosen.

This looks like a very large change, but it is essentially adjusting
package names, many in mocks.

Change-Id: Ic1fd7c87ceda05eeb96735da2a415ef37060bb1a
2018-07-10 14:56:27 +00:00

236 lines
10 KiB
Python

# Copyright 2013 IBM Corp.
#
# 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 copy
import mock
from oslo_utils import timeutils
from nova import exception
from nova.objects import keypair
from nova.tests.unit.objects import test_objects
NOW = timeutils.utcnow().replace(microsecond=0)
fake_keypair = {
'created_at': NOW,
'updated_at': None,
'deleted_at': None,
'deleted': False,
'id': 123,
'name': 'foo-keypair',
'type': 'ssh',
'user_id': 'fake-user',
'fingerprint': 'fake-fingerprint',
'public_key': 'fake\npublic\nkey',
}
class _TestKeyPairObject(object):
@mock.patch('nova.db.api.key_pair_get')
@mock.patch('nova.objects.KeyPair._get_from_db')
def test_get_by_name_main(self, mock_api_get, mock_kp_get):
mock_api_get.side_effect = exception.KeypairNotFound(user_id='foo',
name='foo')
mock_kp_get.return_value = fake_keypair
keypair_obj = keypair.KeyPair.get_by_name(self.context, 'fake-user',
'foo-keypair')
self.compare_obj(keypair_obj, fake_keypair)
mock_kp_get.assert_called_once_with(self.context, 'fake-user',
'foo-keypair')
mock_api_get.assert_called_once_with(self.context, 'fake-user',
'foo-keypair')
@mock.patch('nova.objects.KeyPair._create_in_db')
def test_create(self, mock_kp_create):
mock_kp_create.return_value = fake_keypair
keypair_obj = keypair.KeyPair(context=self.context)
keypair_obj.name = 'foo-keypair'
keypair_obj.public_key = 'keydata'
keypair_obj.user_id = 'fake-user'
keypair_obj.create()
self.compare_obj(keypair_obj, fake_keypair)
mock_kp_create.assert_called_once_with(self.context,
{'name': 'foo-keypair', 'public_key': 'keydata',
'user_id': 'fake-user'})
@mock.patch('nova.objects.KeyPair._create_in_db')
def test_recreate_fails(self, mock_kp_create):
mock_kp_create.return_value = fake_keypair
keypair_obj = keypair.KeyPair(context=self.context)
keypair_obj.name = 'foo-keypair'
keypair_obj.public_key = 'keydata'
keypair_obj.user_id = 'fake-user'
keypair_obj.create()
self.assertRaises(exception.ObjectActionError, keypair_obj.create)
mock_kp_create.assert_called_once_with(self.context,
{'name': 'foo-keypair', 'public_key': 'keydata',
'user_id': 'fake-user'})
@mock.patch('nova.objects.KeyPair._destroy_in_db')
def test_destroy(self, mock_kp_destroy):
keypair_obj = keypair.KeyPair(context=self.context)
keypair_obj.id = 123
keypair_obj.user_id = 'fake-user'
keypair_obj.name = 'foo-keypair'
keypair_obj.destroy()
mock_kp_destroy.assert_called_once_with(
self.context, 'fake-user', 'foo-keypair')
@mock.patch('nova.objects.KeyPair._destroy_in_db')
def test_destroy_by_name(self, mock_kp_destroy):
keypair.KeyPair.destroy_by_name(self.context, 'fake-user',
'foo-keypair')
mock_kp_destroy.assert_called_once_with(
self.context, 'fake-user', 'foo-keypair')
@mock.patch('nova.db.api.key_pair_get_all_by_user')
@mock.patch('nova.db.api.key_pair_count_by_user')
@mock.patch('nova.objects.KeyPairList._get_from_db')
@mock.patch('nova.objects.KeyPairList._get_count_from_db')
def test_get_by_user(self, mock_api_count, mock_api_get, mock_kp_count,
mock_kp_get):
mock_kp_get.return_value = [fake_keypair]
mock_kp_count.return_value = 1
mock_api_get.return_value = [fake_keypair]
mock_api_count.return_value = 1
keypairs = keypair.KeyPairList.get_by_user(self.context, 'fake-user')
self.assertEqual(2, len(keypairs))
self.compare_obj(keypairs[0], fake_keypair)
self.compare_obj(keypairs[1], fake_keypair)
self.assertEqual(2, keypair.KeyPairList.get_count_by_user(self.context,
'fake-user'))
mock_kp_get.assert_called_once_with(self.context, 'fake-user',
limit=None, marker=None)
mock_kp_count.assert_called_once_with(self.context, 'fake-user')
mock_api_get.assert_called_once_with(self.context, 'fake-user',
limit=None, marker=None)
mock_api_count.assert_called_once_with(self.context, 'fake-user')
def test_obj_make_compatible(self):
keypair_obj = keypair.KeyPair(context=self.context)
fake_keypair_copy = dict(fake_keypair)
keypair_obj.obj_make_compatible(fake_keypair_copy, '1.1')
self.assertNotIn('type', fake_keypair_copy)
@mock.patch('nova.db.api.key_pair_get_all_by_user')
@mock.patch('nova.objects.KeyPairList._get_from_db')
def test_get_by_user_limit(self, mock_api_get, mock_kp_get):
api_keypair = copy.deepcopy(fake_keypair)
api_keypair['name'] = 'api_kp'
mock_api_get.return_value = [api_keypair]
mock_kp_get.return_value = [fake_keypair]
keypairs = keypair.KeyPairList.get_by_user(self.context, 'fake-user',
limit=1)
self.assertEqual(1, len(keypairs))
self.compare_obj(keypairs[0], api_keypair)
mock_api_get.assert_called_once_with(self.context, 'fake-user',
limit=1, marker=None)
self.assertFalse(mock_kp_get.called)
@mock.patch('nova.db.api.key_pair_get_all_by_user')
@mock.patch('nova.objects.KeyPairList._get_from_db')
def test_get_by_user_marker(self, mock_api_get, mock_kp_get):
api_kp_name = 'api_kp'
mock_api_get.side_effect = exception.MarkerNotFound(marker=api_kp_name)
mock_kp_get.return_value = [fake_keypair]
keypairs = keypair.KeyPairList.get_by_user(self.context, 'fake-user',
marker=api_kp_name)
self.assertEqual(1, len(keypairs))
self.compare_obj(keypairs[0], fake_keypair)
mock_api_get.assert_called_once_with(self.context, 'fake-user',
limit=None,
marker=api_kp_name)
mock_kp_get.assert_called_once_with(self.context, 'fake-user',
limit=None,
marker=api_kp_name)
@mock.patch('nova.db.api.key_pair_get_all_by_user')
@mock.patch('nova.objects.KeyPairList._get_from_db')
def test_get_by_user_limit_and_marker_api(self, mock_api_get, mock_kp_get):
first_api_kp_name = 'first_api_kp'
api_keypair = copy.deepcopy(fake_keypair)
api_keypair['name'] = 'api_kp'
mock_api_get.return_value = [api_keypair]
mock_kp_get.return_value = [fake_keypair]
keypairs = keypair.KeyPairList.get_by_user(self.context, 'fake-user',
limit=5,
marker=first_api_kp_name)
self.assertEqual(2, len(keypairs))
self.compare_obj(keypairs[0], api_keypair)
self.compare_obj(keypairs[1], fake_keypair)
mock_api_get.assert_called_once_with(self.context, 'fake-user',
limit=5,
marker=first_api_kp_name)
mock_kp_get.assert_called_once_with(self.context, 'fake-user',
limit=4, marker=None)
@mock.patch('nova.db.api.key_pair_get_all_by_user')
@mock.patch('nova.objects.KeyPairList._get_from_db')
def test_get_by_user_limit_and_marker_main(self, mock_api_get,
mock_kp_get):
first_main_kp_name = 'first_main_kp'
mock_api_get.side_effect = exception.MarkerNotFound(
marker=first_main_kp_name)
mock_kp_get.return_value = [fake_keypair]
keypairs = keypair.KeyPairList.get_by_user(self.context, 'fake-user',
limit=5,
marker=first_main_kp_name)
self.assertEqual(1, len(keypairs))
self.compare_obj(keypairs[0], fake_keypair)
mock_api_get.assert_called_once_with(self.context, 'fake-user',
limit=5,
marker=first_main_kp_name)
mock_kp_get.assert_called_once_with(self.context, 'fake-user',
limit=5, marker=first_main_kp_name)
@mock.patch('nova.db.api.key_pair_get_all_by_user')
@mock.patch('nova.objects.KeyPairList._get_from_db')
def test_get_by_user_limit_and_marker_invalid_marker(
self, mock_api_get, mock_kp_get):
kp_name = 'unknown_kp'
mock_api_get.side_effect = exception.MarkerNotFound(marker=kp_name)
mock_kp_get.side_effect = exception.MarkerNotFound(marker=kp_name)
self.assertRaises(exception.MarkerNotFound,
keypair.KeyPairList.get_by_user,
self.context, 'fake-user',
limit=5, marker=kp_name)
class TestMigrationObject(test_objects._LocalTest,
_TestKeyPairObject):
pass
class TestRemoteMigrationObject(test_objects._RemoteTest,
_TestKeyPairObject):
pass