Remove unnecessary checks for encrypted types

Change I6ba62a58ac62a3b7bfb2b9d4d18b37ef458b616c makes it unnecessary
to explicitly check that a volume is encrypted prior to invoking the
volume_encryption_metadata_get function. This change cleans up the
single existing invocation of that function in the API contrib
modules. The unit tests are also updated to reflect this change.

Change-Id: I3b8aef67bd6e70f570a39c90175ae6ceaedc4386

diff --git a/cinder/api/contrib/volume_encryption_metadata.py b/cinder/api/contrib/volume_encryption_metadata.py
index 532d40b7f03a35b161a11d6b78c2f1fb97177fea..6ce2100bbb626c7e47dcf714c07af5b4fdd77e97 100644 (file)
--- a/cinder/api/contrib/volume_encryption_metadata.py
+++ b/cinder/api/contrib/volume_encryption_metadata.py
@@ -19,7 +19,6 @@ from cinder.api import extensions
 from cinder.api.openstack import wsgi
 from cinder.api import xmlutil
 from cinder import db
-from cinder.volume import volume_types
 
 authorize = extensions.extension_authorizer('volume',
                                             'volume_encryption_metadata')
@@ -34,29 +33,12 @@ class VolumeEncryptionMetadataTemplate(xmlutil.TemplateBuilder):
 class VolumeEncryptionMetadataController(wsgi.Controller):
     """The volume encryption metadata API extension."""
 
-    def _get_volume_encryption_metadata(self, context, volume_id):
-        return db.volume_encryption_metadata_get(context, volume_id)
-
-    def _is_volume_type_encrypted(self, context, volume_id):
-        volume_ref = db.volume_get(context, volume_id)
-        volume_type_id = volume_ref['volume_type_id']
-        return volume_types.is_encrypted(context, volume_type_id)
-
-    def _get_metadata(self, req, volume_id):
-        context = req.environ['cinder.context']
-        authorize(context)
-        if self._is_volume_type_encrypted(context, volume_id):
-            return self._get_volume_encryption_metadata(context, volume_id)
-        else:
-            return {
-                'encryption_key_id': None,
-                # Additional metadata defaults could go here.
-            }
-
     @wsgi.serializers(xml=VolumeEncryptionMetadataTemplate)
     def index(self, req, volume_id):
         """Returns the encryption metadata for a given volume."""
-        return self._get_metadata(req, volume_id)
+        context = req.environ['cinder.context']
+        authorize(context)
+        return db.volume_encryption_metadata_get(context, volume_id)
 
     @wsgi.serializers(xml=VolumeEncryptionMetadataTemplate)
     def show(self, req, volume_id, id):

diff --git a/cinder/tests/unit/api/contrib/test_volume_encryption_metadata.py b/cinder/tests/unit/api/contrib/test_volume_encryption_metadata.py
index a6678cec67f1e778795222497df1282bf05cf286..fab674eb3fa0e516b2b2a4445f1ae6fee98e4843 100644 (file)
--- a/cinder/tests/unit/api/contrib/test_volume_encryption_metadata.py
+++ b/cinder/tests/unit/api/contrib/test_volume_encryption_metadata.py
@@ -22,7 +22,6 @@ from cinder import context
 from cinder import db
 from cinder import test
 from cinder.tests.unit.api import fakes
-from cinder.volume import volume_types
 
 
 def return_volume_type_encryption_metadata(context, volume_type_id):
@@ -48,7 +47,8 @@ class VolumeEncryptionMetadataTest(test.TestCase):
                        status='creating',
                        availability_zone='fake_az',
                        host='fake_host',
-                       size=1):
+                       size=1,
+                       encryption_key_id='fake_key'):
         """Create a volume object."""
         volume = {
             'size': size,
@@ -60,7 +60,7 @@ class VolumeEncryptionMetadataTest(test.TestCase):
             'attach_status': 'detached',
             'availability_zone': availability_zone,
             'host': host,
-            'encryption_key_id': 'fake_key',
+            'encryption_key_id': encryption_key_id,
         }
         return db.volume_create(context, volume)['id']
 
@@ -77,8 +77,6 @@ class VolumeEncryptionMetadataTest(test.TestCase):
                         self.volume_id)
 
     def test_index(self):
-        self.stubs.Set(volume_types, 'is_encrypted', lambda *a, **kw: True)
-
         req = webob.Request.blank('/v2/fake/volumes/%s/encryption'
                                   % self.volume_id)
         res = req.get_response(fakes.wsgi_app(fake_auth_context=self.ctxt))
@@ -95,8 +93,6 @@ class VolumeEncryptionMetadataTest(test.TestCase):
         self.assertEqual(expected, res_dict)
 
     def test_index_bad_tenant_id(self):
-        self.stubs.Set(volume_types, 'is_encrypted', lambda *a, **kw: True)
-
         req = webob.Request.blank('/v2/%s/volumes/%s/encryption'
                                   % ('bad-tenant-id', self.volume_id))
         res = req.get_response(fakes.wsgi_app(fake_auth_context=self.ctxt))
@@ -108,8 +104,6 @@ class VolumeEncryptionMetadataTest(test.TestCase):
         self.assertEqual(expected, res_dict)
 
     def test_index_bad_volume_id(self):
-        self.stubs.Set(volume_types, 'is_encrypted', lambda *a, **kw: True)
-
         bad_volume_id = 'bad_volume_id'
         req = webob.Request.blank('/v2/fake/volumes/%s/encryption'
                                   % bad_volume_id)
@@ -124,8 +118,6 @@ class VolumeEncryptionMetadataTest(test.TestCase):
         self.assertEqual(expected, res_dict)
 
     def test_show_key(self):
-        self.stubs.Set(volume_types, 'is_encrypted', lambda *a, **kw: True)
-
         req = webob.Request.blank('/v2/fake/volumes/%s/encryption/'
                                   'encryption_key_id' % self.volume_id)
         res = req.get_response(fakes.wsgi_app(fake_auth_context=self.ctxt))
@@ -134,8 +126,6 @@ class VolumeEncryptionMetadataTest(test.TestCase):
         self.assertEqual('fake_key', res.body)
 
     def test_show_control(self):
-        self.stubs.Set(volume_types, 'is_encrypted', lambda *a, **kw: True)
-
         req = webob.Request.blank('/v2/fake/volumes/%s/encryption/'
                                   'control_location' % self.volume_id)
         res = req.get_response(fakes.wsgi_app(fake_auth_context=self.ctxt))
@@ -144,8 +134,6 @@ class VolumeEncryptionMetadataTest(test.TestCase):
         self.assertEqual('front-end', res.body)
 
     def test_show_provider(self):
-        self.stubs.Set(volume_types, 'is_encrypted', lambda *a, **kw: True)
-
         req = webob.Request.blank('/v2/fake/volumes/%s/encryption/'
                                   'provider' % self.volume_id)
         res = req.get_response(fakes.wsgi_app(fake_auth_context=self.ctxt))
@@ -155,8 +143,6 @@ class VolumeEncryptionMetadataTest(test.TestCase):
                          res.body)
 
     def test_show_bad_tenant_id(self):
-        self.stubs.Set(volume_types, 'is_encrypted', lambda *a, **kw: True)
-
         req = webob.Request.blank('/v2/%s/volumes/%s/encryption/'
                                   'encryption_key_id' % ('bad-tenant-id',
                                                          self.volume_id))
@@ -169,8 +155,6 @@ class VolumeEncryptionMetadataTest(test.TestCase):
         self.assertEqual(expected, res_dict)
 
     def test_show_bad_volume_id(self):
-        self.stubs.Set(volume_types, 'is_encrypted', lambda *a, **kw: True)
-
         bad_volume_id = 'bad_volume_id'
         req = webob.Request.blank('/v2/fake/volumes/%s/encryption/'
                                   'encryption_key_id' % bad_volume_id)
@@ -185,8 +169,6 @@ class VolumeEncryptionMetadataTest(test.TestCase):
         self.assertEqual(expected, res_dict)
 
     def test_retrieve_key_admin(self):
-        self.stubs.Set(volume_types, 'is_encrypted', lambda *a, **kw: True)
-
         ctxt = context.RequestContext('fake', 'fake', is_admin=True)
 
         req = webob.Request.blank('/v2/fake/volumes/%s/encryption/'
@@ -197,19 +179,27 @@ class VolumeEncryptionMetadataTest(test.TestCase):
         self.assertEqual('fake_key', res.body)
 
     def test_show_volume_not_encrypted_type(self):
-        self.stubs.Set(volume_types, 'is_encrypted', lambda *a, **kw: False)
+        self.stubs.Set(db.sqlalchemy.api, 'volume_type_encryption_get',
+                       lambda *args, **kwargs: None)
+
+        volume_id = self._create_volume(self.ctxt, encryption_key_id=None)
+        self.addCleanup(db.volume_destroy, self.ctxt.elevated(), volume_id)
 
         req = webob.Request.blank('/v2/fake/volumes/%s/encryption/'
-                                  'encryption_key_id' % self.volume_id)
+                                  'encryption_key_id' % volume_id)
         res = req.get_response(fakes.wsgi_app(fake_auth_context=self.ctxt))
         self.assertEqual(200, res.status_code)
         self.assertEqual(0, len(res.body))
 
     def test_index_volume_not_encrypted_type(self):
-        self.stubs.Set(volume_types, 'is_encrypted', lambda *a, **kw: False)
+        self.stubs.Set(db.sqlalchemy.api, 'volume_type_encryption_get',
+                       lambda *args, **kwargs: None)
+
+        volume_id = self._create_volume(self.ctxt, encryption_key_id=None)
+        self.addCleanup(db.volume_destroy, self.ctxt.elevated(), volume_id)
 
         req = webob.Request.blank('/v2/fake/volumes/%s/encryption'
-                                  % self.volume_id)
+                                  % volume_id)
         res = req.get_response(fakes.wsgi_app(fake_auth_context=self.ctxt))
 
         self.assertEqual(200, res.status_code)