functional: Add and use 'GlanceFixture'

This rather beefy (but also quite simple) patch replaces the
'stub_out_image_service' call and associated cleanup in all functional
tests with a new 'GlanceFixture', based on the old 'FakeImageService'.
The use of a fixture means we don't have to worry about teardown and
allows us to stub Glance in the same manners as Cinder, Neutron,
Placement etc.

Unit test cleanup is handled in a later patch.

Change-Id: I6daea47988181dfa6dde3d9c42004c0ecf6ae87a
Signed-off-by: Stephen Finucane <[email protected]>

Author: stephenfin

nova/tests/fixtures.py

@@ -15,9 +15,11 @@
 #    under the License.
 
 """Fixtures for Nova tests."""
+
 import collections
 from contextlib import contextmanager
 import copy
+import datetime
 import logging as std_logging
 import os
 import random
@@ -56,6 +58,7 @@
 from nova.network import model as network_model
 from nova import objects
 from nova.objects import base as obj_base
+from nova.objects import fields as obj_fields
 from nova.objects import service as service_obj
 import nova.privsep
 from nova import quota as nova_quota
@@ -2046,6 +2049,318 @@ def setUp(self):
             lambda *args, **kwargs: mock.MagicMock()))
 
 
+class GlanceFixture(fixtures.Fixture):
+    """A fixture for simulating Glance."""
+
+    # NOTE(justinsb): The OpenStack API can't upload an image?
+    # So, make sure we've got one..
+    timestamp = datetime.datetime(2011, 1, 1, 1, 2, 3)
+
+    image1 = {
+        'id': '155d900f-4e14-4e4c-a73d-069cbf4541e6',
+        'name': 'fakeimage123456',
+        'created_at': timestamp,
+        'updated_at': timestamp,
+        'deleted_at': None,
+        'deleted': False,
+        'status': 'active',
+        'is_public': False,
+        'container_format': 'raw',
+        'disk_format': 'raw',
+        'size': '25165824',
+        'min_ram': 0,
+        'min_disk': 0,
+        'protected': False,
+        'visibility': 'public',
+        'tags': ['tag1', 'tag2'],
+        'properties': {
+            'kernel_id': 'nokernel',
+            'ramdisk_id': 'nokernel',
+            'architecture': obj_fields.Architecture.X86_64,
+        },
+    }
+
+    image2 = {
+        'id': 'a2459075-d96c-40d5-893e-577ff92e721c',
+        'name': 'fakeimage123456',
+        'created_at': timestamp,
+        'updated_at': timestamp,
+        'deleted_at': None,
+        'deleted': False,
+        'status': 'active',
+        'is_public': True,
+        'container_format': 'ami',
+        'disk_format': 'ami',
+        'size': '58145823',
+        'min_ram': 0,
+        'min_disk': 0,
+        'protected': False,
+        'visibility': 'public',
+        'tags': [],
+        'properties': {
+            'kernel_id': 'nokernel',
+            'ramdisk_id': 'nokernel',
+        },
+    }
+
+    image3 = {
+        'id': '76fa36fc-c930-4bf3-8c8a-ea2a2420deb6',
+        'name': 'fakeimage123456',
+        'created_at': timestamp,
+        'updated_at': timestamp,
+        'deleted_at': None,
+        'deleted': False,
+        'status': 'active',
+        'is_public': True,
+        'container_format': 'bare',
+        'disk_format': 'raw',
+        'size': '83594576',
+        'min_ram': 0,
+        'min_disk': 0,
+        'protected': False,
+        'visibility': 'public',
+        'tags': ['tag3', 'tag4'],
+        'properties': {
+            'kernel_id': 'nokernel',
+            'ramdisk_id': 'nokernel',
+            'architecture': obj_fields.Architecture.X86_64,
+        },
+    }
+
+    image4 = {
+        'id': 'cedef40a-ed67-4d10-800e-17455edce175',
+        'name': 'fakeimage123456',
+        'created_at': timestamp,
+        'updated_at': timestamp,
+        'deleted_at': None,
+        'deleted': False,
+        'status': 'active',
+        'is_public': True,
+        'container_format': 'ami',
+        'disk_format': 'ami',
+        'size': '84035174',
+        'min_ram': 0,
+        'min_disk': 0,
+        'protected': False,
+        'visibility': 'public',
+        'tags': [],
+        'properties': {
+            'kernel_id': 'nokernel',
+            'ramdisk_id': 'nokernel',
+        },
+    }
+
+    image5 = {
+        'id': 'c905cedb-7281-47e4-8a62-f26bc5fc4c77',
+        'name': 'fakeimage123456',
+        'created_at': timestamp,
+        'updated_at': timestamp,
+        'deleted_at': None,
+        'deleted': False,
+        'status': 'active',
+        'is_public': True,
+        'container_format': 'ami',
+        'disk_format': 'ami',
+        'size': '26360814',
+        'min_ram': 0,
+        'min_disk': 0,
+        'protected': False,
+        'visibility': 'public',
+        'tags': [],
+        'properties': {
+            'kernel_id': '155d900f-4e14-4e4c-a73d-069cbf4541e6',
+            'ramdisk_id': None,
+        },
+    }
+
+    auto_disk_config_disabled_image = {
+        'id': 'a440c04b-79fa-479c-bed1-0b816eaec379',
+        'name': 'fakeimage6',
+        'created_at': timestamp,
+        'updated_at': timestamp,
+        'deleted_at': None,
+        'deleted': False,
+        'status': 'active',
+        'is_public': False,
+        'container_format': 'ova',
+        'disk_format': 'vhd',
+        'size': '49163826',
+        'min_ram': 0,
+        'min_disk': 0,
+        'protected': False,
+        'visibility': 'public',
+        'tags': [],
+        'properties': {
+            'kernel_id': 'nokernel',
+            'ramdisk_id': 'nokernel',
+            'architecture': obj_fields.Architecture.X86_64,
+            'auto_disk_config': 'False',
+        },
+    }
+
+    auto_disk_config_enabled_image = {
+        'id': '70a599e0-31e7-49b7-b260-868f441e862b',
+        'name': 'fakeimage7',
+        'created_at': timestamp,
+        'updated_at': timestamp,
+        'deleted_at': None,
+        'deleted': False,
+        'status': 'active',
+        'is_public': False,
+        'container_format': 'ova',
+        'disk_format': 'vhd',
+        'size': '74185822',
+        'min_ram': 0,
+        'min_disk': 0,
+        'protected': False,
+        'visibility': 'public',
+        'tags': [],
+        'properties': {
+            'kernel_id': 'nokernel',
+            'ramdisk_id': 'nokernel',
+            'architecture': obj_fields.Architecture.X86_64,
+            'auto_disk_config': 'True',
+        },
+    }
+
+    def __init__(self, test):
+        super().__init__()
+        self.test = test
+        self.images = {}
+
+    def setUp(self):
+        super().setUp()
+
+        self.test.useFixture(
+            ConfPatcher(group='glance', api_servers=['http://localhost:9292'])
+        )
+        self.test.stub_out(
+            'nova.image.glance.API.get_remote_image_service',
+            lambda context, image_href: (self, image_href))
+        self.test.stub_out(
+            'nova.image.glance.get_default_image_service',
+            lambda: self)
+
+        self.create(None, self.image1)
+        self.create(None, self.image2)
+        self.create(None, self.image3)
+        self.create(None, self.image4)
+        self.create(None, self.image5)
+        self.create(None, self.auto_disk_config_disabled_image)
+        self.create(None, self.auto_disk_config_enabled_image)
+
+        self._imagedata = {}
+
+    # TODO(bcwaldon): implement optional kwargs such as limit, sort_dir
+    def detail(self, context, **kwargs):
+        """Return list of detailed image information."""
+        return copy.deepcopy(list(self.images.values()))
+
+    def download(
+        self, context, image_id, data=None, dst_path=None, trusted_certs=None,
+    ):
+        self.show(context, image_id)
+        if data:
+            data.write(self._imagedata.get(image_id, b''))
+        elif dst_path:
+            with open(dst_path, 'wb') as data:
+                data.write(self._imagedata.get(image_id, b''))
+
+    def show(
+        self, context, image_id, include_locations=False, show_deleted=True,
+    ):
+        """Get data about specified image.
+
+        Returns a dict containing image data for the given opaque image id.
+        """
+        image = self.images.get(str(image_id))
+        if image:
+            return copy.deepcopy(image)
+
+        LOG.warning(
+            'Unable to find image id %s.  Have images: %s',
+            image_id, self.images)
+        raise exception.ImageNotFound(image_id=image_id)
+
+    def create(self, context, metadata, data=None):
+        """Store the image data and return the new image id.
+
+        :raises: Duplicate if the image already exist.
+
+        """
+        image_id = str(metadata.get('id', uuidutils.generate_uuid()))
+        metadata['id'] = image_id
+        if image_id in self.images:
+            raise exception.CouldNotUploadImage(image_id=image_id)
+
+        image_meta = copy.deepcopy(metadata)
+
+        # Glance sets the size value when an image is created, so we
+        # need to do that here to fake things out if it's not provided
+        # by the caller. This is needed to avoid a KeyError in the
+        # image-size API.
+        if 'size' not in image_meta:
+            image_meta['size'] = None
+
+        # Similarly, Glance provides the status on the image once it's created
+        # and this is checked in the compute API when booting a server from
+        # this image, so we just fake it out to be 'active' even though this
+        # is mostly a lie on a newly created image.
+        if 'status' not in metadata:
+            image_meta['status'] = 'active'
+
+        # The owner of the image is by default the request context project_id.
+        if context and 'owner' not in image_meta.get('properties', {}):
+            # Note that normally "owner" is a top-level field in an image
+            # resource in glance but we have to fake this out for the images
+            # proxy API by throwing it into the generic "properties" dict.
+            image_meta.get('properties', {})['owner'] = context.project_id
+
+        self.images[image_id] = image_meta
+
+        if data:
+            self._imagedata[image_id] = data.read()
+
+        return self.images[image_id]
+
+    def update(self, context, image_id, metadata, data=None,
+               purge_props=False):
+        """Replace the contents of the given image with the new data.
+
+        :raises: ImageNotFound if the image does not exist.
+        """
+        if not self.images.get(image_id):
+            raise exception.ImageNotFound(image_id=image_id)
+
+        if purge_props:
+            self.images[image_id] = copy.deepcopy(metadata)
+        else:
+            image = self.images[image_id]
+
+            try:
+                image['properties'].update(metadata.pop('properties'))
+            except KeyError:
+                pass
+
+            image.update(metadata)
+
+        return self.images[image_id]
+
+    def delete(self, context, image_id):
+        """Delete the given image.
+
+        :raises: ImageNotFound if the image does not exist.
+        """
+        removed = self.images.pop(image_id, None)
+        if not removed:
+            raise exception.ImageNotFound(image_id=image_id)
+
+    def get_location(self, context, image_id):
+        if image_id in self.images:
+            return 'fake_location'
+        return None
+
+
 class CinderFixture(fixtures.Fixture):
     """A fixture to volume operations with the new Cinder attach/detach API"""
 

nova/tests/functional/api_sample_tests/test_aggregates.py

@@ -16,7 +16,6 @@
 from oslo_serialization import jsonutils
 
 from nova.tests.functional.api_sample_tests import api_sample_base
-from nova.tests.unit.image import fake as fake_image
 
 
 class AggregatesSampleJsonTest(api_sample_base.ApiSampleTestBaseV21):
@@ -132,7 +131,7 @@ class AggregatesV2_81_SampleJsonTest(AggregatesV2_41_SampleJsonTest):
 
     def test_images(self):
         agg_id = self._test_aggregate_create()
-        image = fake_image.get_valid_image_id()
+        image = self.glance.auto_disk_config_enabled_image['id']
         response = self._do_post('os-aggregates/%s/images' % agg_id,
                                  'aggregate-images-post-req',
                                  {'image_id': image})

nova/tests/functional/api_sample_tests/test_create_backup.py

@@ -15,8 +15,8 @@
 
 import mock
 
+from nova.tests import fixtures
 from nova.tests.functional.api_sample_tests import test_servers
-from nova.tests.unit.image import fake
 
 
 class CreateBackupSamplesJsonTest(test_servers.ServersSampleBase):
@@ -30,7 +30,7 @@ def setUp(self):
         super(CreateBackupSamplesJsonTest, self).setUp()
         self.uuid = self._post_server()
 
-    @mock.patch.object(fake._FakeImageService, 'detail', return_value=[])
+    @mock.patch.object(fixtures.GlanceFixture, 'detail', return_value=[])
     def test_post_backup_server(self, mock_method):
         # Get api samples to backup server request.
         response = self._do_post('servers/%s/action' % self.uuid,