Hide old images

konan-abhi · konan-abhi · commit a308c4440653 · 2018-07-25T16:37:56.000Z
Added new boolean column "os_hidden" in images table. Images where
"os_hidden" = True will be omitted from the image list presented
to the user. This will apply to all image visibilities. However,
the images will continue to be discoverable. User can use
filter "os_hidden=true" in GET v2/images call to see all hidden
images.

Implements: blueprint hidden-images
Change-Id: If8f02ca94fdb8e1ac7a81853cd392988900172d1
diff --git a/glance/api/authorization.py b/glance/api/authorization.py
@@ -315,6 +315,7 @@ def __init__(self, base, context):
     min_disk = _immutable_attr('base', 'min_disk')
     min_ram = _immutable_attr('base', 'min_ram')
     protected = _immutable_attr('base', 'protected')
+    os_hidden = _immutable_attr('base', 'os_hidden')
     locations = _immutable_attr('base', 'locations', proxy=ImmutableLocations)
     checksum = _immutable_attr('base', 'checksum')
     owner = _immutable_attr('base', 'owner')
diff --git a/glance/api/v2/images.py b/glance/api/v2/images.py
@@ -169,6 +169,14 @@ def index(self, req, marker=None, limit=None, sort_key=None,
             filters = {}
         filters['deleted'] = False
 
+        os_hidden = filters.get('os_hidden', 'false').lower()
+        if os_hidden not in ['true', 'false']:
+            message = _("Invalid value '%s' for 'os_hidden' filter."
+                        " Valid values are 'true' or 'false'.") % os_hidden
+            raise webob.exc.HTTPBadRequest(explanation=message)
+        # ensure the type of os_hidden is boolean
+        filters['os_hidden'] = os_hidden == 'true'
+
         protected = filters.get('protected')
         if protected is not None:
             if protected not in ['true', 'false']:
@@ -443,7 +451,7 @@ class RequestDeserializer(wsgi.JSONRequestDeserializer):
     _base_properties = ('checksum', 'created_at', 'container_format',
                         'disk_format', 'id', 'min_disk', 'min_ram', 'name',
                         'size', 'virtual_size', 'status', 'tags', 'owner',
-                        'updated_at', 'visibility', 'protected')
+                        'updated_at', 'visibility', 'protected', 'os_hidden')
     _available_sort_keys = ('name', 'status', 'container_format',
                             'disk_format', 'size', 'id', 'created_at',
                             'updated_at')
@@ -876,7 +884,7 @@ def _get_image_locations(image):
             attributes = ['name', 'disk_format', 'container_format',
                           'visibility', 'size', 'virtual_size', 'status',
                           'checksum', 'protected', 'min_ram', 'min_disk',
-                          'owner']
+                          'owner', 'os_hidden']
             for key in attributes:
                 image_view[key] = getattr(image, key)
             image_view['id'] = image.image_id
@@ -999,6 +1007,11 @@ def get_base_properties():
             'type': 'boolean',
             'description': _('If true, image will not be deletable.'),
         },
+        'os_hidden': {
+            'type': 'boolean',
+            'description': _('If true, image will not appear in default '
+                             'image list response.'),
+        },
         'checksum': {
             'type': ['null', 'string'],
             'readOnly': True,
diff --git a/glance/db/__init__.py b/glance/db/__init__.py
@@ -136,7 +136,8 @@ def _format_image_from_db(self, db_image, db_tags):
             size=db_image['size'],
             virtual_size=db_image['virtual_size'],
             extra_properties=properties,
-            tags=db_tags
+            tags=db_tags,
+            os_hidden=db_image['os_hidden'],
         )
 
     def _format_image_to_db(self, image):
@@ -168,6 +169,7 @@ def _format_image_to_db(self, image):
             'virtual_size': image.virtual_size,
             'visibility': image.visibility,
             'properties': dict(image.extra_properties),
+            'os_hidden': image.os_hidden
         }
 
     def add(self, image):
diff --git a/glance/db/simple/api.py b/glance/db/simple/api.py
@@ -230,6 +230,7 @@ def _image_format(image_id, **values):
         'updated_at': dt,
         'deleted_at': None,
         'deleted': False,
+        'os_hidden': False
     }
 
     locations = values.pop('locations', None)
@@ -258,6 +259,7 @@ def _filter_images(images, filters, context,
         status = None
 
     visibility = filters.pop('visibility', None)
+    os_hidden = filters.pop('os_hidden', False)
 
     for image in images:
         member = image_member_find(context, image_id=image['id'],
@@ -267,6 +269,7 @@ def _filter_images(images, filters, context,
         image_is_public = image['visibility'] == 'public'
         image_is_community = image['visibility'] == 'community'
         image_is_shared = image['visibility'] == 'shared'
+        image_is_hidden = image['os_hidden'] == True
         acts_as_admin = context.is_admin and not admin_as_user
         can_see = (image_is_public
                    or image_is_community
@@ -299,6 +302,10 @@ def _filter_images(images, filters, context,
             if not image_is_public == is_public:
                 continue
 
+        if os_hidden:
+            if image_is_hidden:
+                continue
+
         to_add = True
         for k, value in six.iteritems(filters):
             key = k
@@ -727,7 +734,8 @@ def image_create(context, image_values, v1_mode=False):
                         'virtual_size', 'checksum', 'locations', 'owner',
                         'protected', 'is_public', 'container_format',
                         'disk_format', 'created_at', 'updated_at', 'deleted',
-                        'deleted_at', 'properties', 'tags', 'visibility'])
+                        'deleted_at', 'properties', 'tags', 'visibility',
+                        'os_hidden'])
 
     incorrect_keys = set(image_values.keys()) - allowed_keys
     if incorrect_keys:
diff --git a/glance/db/sqlalchemy/alembic_migrations/data_migrations/rocky_migrate01_empty.py b/glance/db/sqlalchemy/alembic_migrations/data_migrations/rocky_migrate01_empty.py
@@ -0,0 +1,26 @@
+# Copyright (C) 2018 RedHat Inc.
+# 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.
+
+
+def has_migrations(engine):
+    """Returns true if at least one data row can be migrated."""
+
+    return False
+
+
+def migrate(engine):
+    """Return the number of rows migrated."""
+
+    return 0
diff --git a/glance/db/sqlalchemy/alembic_migrations/versions/rocky_contract01_empty.py b/glance/db/sqlalchemy/alembic_migrations/versions/rocky_contract01_empty.py
@@ -0,0 +1,25 @@
+# Copyright (C) 2018 RedHat Inc.
+# 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.
+
+
+# revision identifiers, used by Alembic.
+revision = 'rocky_contract01'
+down_revision = 'queens_contract01'
+branch_labels = None
+depends_on = 'rocky_expand01'
+
+
+def upgrade():
+    pass
diff --git a/glance/db/sqlalchemy/alembic_migrations/versions/rocky_expand01_add_os_hidden.py b/glance/db/sqlalchemy/alembic_migrations/versions/rocky_expand01_add_os_hidden.py
@@ -0,0 +1,32 @@
+# Copyright (C) 2018 RedHat Inc.
+# 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.
+
+"""add os_hidden column to images table"""
+
+from alembic import op
+from sqlalchemy import Boolean, Column, sql
+
+# revision identifiers, used by Alembic.
+revision = 'rocky_expand01'
+down_revision = 'queens_expand01'
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    h_col = Column('os_hidden', Boolean, default=False, nullable=False,
+                   server_default=sql.expression.false())
+    op.add_column('images', h_col)
+    op.create_index('os_hidden_image_idx', 'images', ['os_hidden'])
diff --git a/glance/db/sqlalchemy/api.py b/glance/db/sqlalchemy/api.py
@@ -460,6 +460,10 @@ def _make_conditions_from_filters(filters, is_public=None):
         else:
             image_conditions.append(models.Image.visibility != 'public')
 
+    if 'os_hidden' in filters:
+        os_hidden = filters.pop('os_hidden')
+        image_conditions.append(models.Image.os_hidden == os_hidden)
+
     if 'checksum' in filters:
         checksum = filters.pop('checksum')
         image_conditions.append(models.Image.checksum == checksum)
diff --git a/glance/db/sqlalchemy/models.py b/glance/db/sqlalchemy/models.py
@@ -119,7 +119,8 @@ class Image(BASE, GlanceBase):
                       Index('ix_images_deleted', 'deleted'),
                       Index('owner_image_idx', 'owner'),
                       Index('created_at_image_idx', 'created_at'),
-                      Index('updated_at_image_idx', 'updated_at'))
+                      Index('updated_at_image_idx', 'updated_at'),
+                      Index('os_hidden_image_idx', 'os_hidden'))
 
     id = Column(String(36), primary_key=True,
                 default=lambda: str(uuid.uuid4()))
@@ -138,6 +139,8 @@ class Image(BASE, GlanceBase):
     owner = Column(String(255))
     protected = Column(Boolean, nullable=False, default=False,
                        server_default=sql.expression.false())
+    os_hidden = Column(Boolean, nullable=False, default=False,
+                       server_default=sql.expression.false())
 
 
 class ImageProperty(BASE, GlanceBase):
diff --git a/glance/domain/__init__.py b/glance/domain/__init__.py
@@ -71,7 +71,8 @@ def _check_reserved(self, properties):
     def new_image(self, image_id=None, name=None, visibility='shared',
                   min_disk=0, min_ram=0, protected=False, owner=None,
                   disk_format=None, container_format=None,
-                  extra_properties=None, tags=None, **other_args):
+                  extra_properties=None, tags=None, os_hidden=False,
+                  **other_args):
         extra_properties = extra_properties or {}
         self._check_readonly(other_args)
         self._check_unexpected(other_args)
@@ -89,6 +90,7 @@ def new_image(self, image_id=None, name=None, visibility='shared',
                      min_ram=min_ram, protected=protected,
                      owner=owner, disk_format=disk_format,
                      container_format=container_format,
+                     os_hidden=os_hidden,
                      extra_properties=extra_properties, tags=tags or [])
 
 
@@ -119,6 +121,7 @@ def __init__(self, image_id, status, created_at, updated_at, **kwargs):
         self.updated_at = updated_at
         self.name = kwargs.pop('name', None)
         self.visibility = kwargs.pop('visibility', 'shared')
+        self.os_hidden = kwargs.pop('os_hidden', False)
         self.min_disk = kwargs.pop('min_disk', 0)
         self.min_ram = kwargs.pop('min_ram', 0)
         self.protected = kwargs.pop('protected', False)
diff --git a/glance/domain/proxy.py b/glance/domain/proxy.py
@@ -172,6 +172,7 @@ def __init__(self, base, member_repo_proxy_class=None,
     min_disk = _proxy('base', 'min_disk')
     min_ram = _proxy('base', 'min_ram')
     protected = _proxy('base', 'protected')
+    os_hidden = _proxy('base', 'os_hidden')
     locations = _proxy('base', 'locations')
     checksum = _proxy('base', 'checksum')
     owner = _proxy('base', 'owner')
diff --git a/glance/tests/functional/db/migrations/test_rocky_expand01.py b/glance/tests/functional/db/migrations/test_rocky_expand01.py
@@ -0,0 +1,39 @@
+#    Copyright (c) 2018 RedHat, Inc.
+#    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.
+
+from oslo_db.sqlalchemy import test_base
+from oslo_db.sqlalchemy import utils as db_utils
+
+from glance.tests.functional.db import test_migrations
+
+
+class TestRockyExpand01Mixin(test_migrations.AlembicMigrationsMixin):
+
+    def _get_revisions(self, config):
+        return test_migrations.AlembicMigrationsMixin._get_revisions(
+            self, config, head='rocky_expand01')
+
+    def _pre_upgrade_rocky_expand01(self, engine):
+        images = db_utils.get_table(engine, 'images')
+        self.assertNotIn('os_hidden', images.c)
+
+    def _check_rocky_expand01(self, engine, data):
+        # check that after migration, 'os_hidden' column is introduced
+        images = db_utils.get_table(engine, 'images')
+        self.assertIn('os_hidden', images.c)
+        self.assertFalse(images.c.os_hidden.nullable)
+
+
+class TestRockyExpand01MySQL(TestRockyExpand01Mixin,
+                             test_base.MySQLOpportunisticTestCase):
+    pass
diff --git a/glance/tests/functional/v2/test_images.py b/glance/tests/functional/v2/test_images.py
diff --git a/glance/tests/functional/v2/test_schemas.py b/glance/tests/functional/v2/test_schemas.py
diff --git a/glance/tests/unit/test_policy.py b/glance/tests/unit/test_policy.py
diff --git a/glance/tests/unit/v2/test_images_resource.py b/glance/tests/unit/v2/test_images_resource.py
diff --git a/glance/tests/unit/v2/test_schemas_resource.py b/glance/tests/unit/v2/test_schemas_resource.py
