83c4fb6a7e
The oslo team has decided to drop the "oslo." namespacing as it was causing a lot of trouble. So, as described [1], the namespace was dropped in favor of the "oslo_" imports that will be used. [1] http://blog.nemebean.com/content/whys-and-hows-oslo-namespace-change Change-Id: Ieb88098a2a64069787f3b548af3f35312127be43
330 lines
12 KiB
Python
330 lines
12 KiB
Python
# Copyright (c) 2013 Rackspace, 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_utils import timeutils
|
|
|
|
from barbicanclient.test import test_client
|
|
from barbicanclient import secrets, base
|
|
|
|
|
|
class SecretData(object):
|
|
def __init__(self):
|
|
self.name = 'Self destruction sequence'
|
|
self.payload = 'the magic words are squeamish ossifrage'
|
|
self.payload_content_type = 'text/plain'
|
|
self.content = 'text/plain'
|
|
self.algorithm = 'AES'
|
|
self.created = str(timeutils.utcnow())
|
|
|
|
self.secret_dict = {'name': self.name,
|
|
'status': 'ACTIVE',
|
|
'algorithm': self.algorithm,
|
|
'created': self.created}
|
|
|
|
def get_dict(self, secret_ref=None, content_types_dict=None):
|
|
secret = self.secret_dict
|
|
if secret_ref:
|
|
secret['secret_ref'] = secret_ref
|
|
if content_types_dict:
|
|
secret['content_types'] = content_types_dict
|
|
return secret
|
|
|
|
|
|
class WhenTestingSecrets(test_client.BaseEntityResource):
|
|
|
|
def setUp(self):
|
|
self._setUp('secrets')
|
|
|
|
self.secret = SecretData()
|
|
|
|
self.manager = secrets.SecretManager(self.api)
|
|
|
|
def test_should_entity_str(self):
|
|
secret_obj = self.manager.create(name=self.secret.name)
|
|
self.assertIn(self.secret.name, str(secret_obj))
|
|
|
|
def test_should_entity_repr(self):
|
|
secret_obj = self.manager.create(name=self.secret.name)
|
|
self.assertIn('name="{0}"'.format(self.secret.name), repr(secret_obj))
|
|
|
|
def test_should_store_via_constructor(self):
|
|
self.api._post.return_value = {'secret_ref': self.entity_href}
|
|
|
|
secret = self.manager.create(name=self.secret.name,
|
|
payload=self.secret.payload,
|
|
payload_content_type=self.secret.content)
|
|
secret_href = secret.store()
|
|
self.assertEqual(self.entity_href, secret_href)
|
|
|
|
# Verify the correct URL was used to make the call.
|
|
args, kwargs = self.api._post.call_args
|
|
entity_resp = args[0]
|
|
self.assertEqual(self.entity, entity_resp)
|
|
|
|
# Verify that correct information was sent in the call.
|
|
secret_req = args[1]
|
|
self.assertEqual(self.secret.name, secret_req['name'])
|
|
self.assertEqual(self.secret.payload, secret_req['payload'])
|
|
self.assertEqual(self.secret.payload_content_type,
|
|
secret_req['payload_content_type'])
|
|
|
|
def test_should_store_via_attributes(self):
|
|
self.api._post.return_value = {'secret_ref': self.entity_href}
|
|
|
|
secret = self.manager.create()
|
|
secret.name = self.secret.name
|
|
secret.payload = self.secret.payload
|
|
secret.payload_content_type = self.secret.content
|
|
secret_href = secret.store()
|
|
self.assertEqual(self.entity_href, secret_href)
|
|
|
|
# Verify the correct URL was used to make the call.
|
|
args, kwargs = self.api._post.call_args
|
|
entity_resp = args[0]
|
|
self.assertEqual(self.entity, entity_resp)
|
|
|
|
# Verify that correct information was sent in the call.
|
|
secret_req = args[1]
|
|
self.assertEqual(self.secret.name, secret_req['name'])
|
|
self.assertEqual(self.secret.payload, secret_req['payload'])
|
|
self.assertEqual(self.secret.payload_content_type,
|
|
secret_req['payload_content_type'])
|
|
|
|
def test_should_be_immutable_after_submit(self):
|
|
self.api._post.return_value = {'secret_ref': self.entity_href}
|
|
|
|
secret = self.manager.create(name=self.secret.name,
|
|
payload=self.secret.payload,
|
|
payload_content_type=self.secret.content)
|
|
secret_href = secret.store()
|
|
|
|
self.assertEqual(self.entity_href, secret_href)
|
|
|
|
# Verify that attributes are immutable after store.
|
|
attributes = [
|
|
"name", "expiration", "algorithm", "bit_length", "mode", "payload",
|
|
"payload_content_type", "payload_content_encoding"
|
|
]
|
|
for attr in attributes:
|
|
try:
|
|
setattr(secret, attr, "test")
|
|
self.fail("didn't raise an ImmutableException exception")
|
|
except base.ImmutableException:
|
|
pass
|
|
|
|
def test_should_not_be_able_to_set_generated_attributes(self):
|
|
secret = self.manager.create()
|
|
|
|
# Verify that generated attributes cannot be set.
|
|
attributes = [
|
|
"secret_ref", "created", "updated", "content_types", "status"
|
|
]
|
|
for attr in attributes:
|
|
try:
|
|
setattr(secret, attr, "test")
|
|
self.fail("didn't raise an AttributeError exception")
|
|
except AttributeError:
|
|
pass
|
|
|
|
def test_should_get_lazy(self):
|
|
self.api._get.return_value = self.secret.get_dict(self.entity_href)
|
|
|
|
secret = self.manager.get(secret_ref=self.entity_href)
|
|
self.assertIsInstance(secret, secrets.Secret)
|
|
self.assertEqual(self.entity_href, secret.secret_ref)
|
|
|
|
# Verify GET wasn't called yet
|
|
self.assertFalse(self.api._get.called)
|
|
|
|
# Check an attribute to trigger lazy-load
|
|
self.assertEqual(self.secret.name, secret.name)
|
|
|
|
# Verify the correct URL was used to make the GET call
|
|
args, kwargs = self.api._get.call_args
|
|
url = args[0]
|
|
self.assertEqual(self.entity_href, url)
|
|
|
|
def test_should_get_payload_only(self):
|
|
self.api._get.return_value = self.secret.get_dict(self.entity_href)
|
|
self.api._get_raw.return_value = self.secret.payload
|
|
|
|
secret = self.manager.get(
|
|
secret_ref=self.entity_href,
|
|
payload_content_type=self.secret.payload_content_type
|
|
)
|
|
self.assertIsInstance(secret, secrets.Secret)
|
|
self.assertEqual(self.entity_href, secret.secret_ref)
|
|
|
|
# Verify `get` wasn't called yet (metadata)
|
|
self.assertFalse(self.api._get.called)
|
|
|
|
# Verify `get_raw` wasn't called yet (payload)
|
|
self.assertFalse(self.api._get_raw.called)
|
|
|
|
# GET payload (with payload_content_type)
|
|
self.assertEqual(self.secret.payload, secret.payload)
|
|
|
|
# Verify `get` still wasn't called (metadata)
|
|
self.assertFalse(self.api._get.called)
|
|
|
|
# Verify `get_raw` was called (payload)
|
|
self.assertTrue(self.api._get_raw.called)
|
|
|
|
# Verify the correct URL was used to make the `get_raw` call
|
|
args, kwargs = self.api._get_raw.call_args
|
|
url = args[0]
|
|
self.assertEqual(self.entity_href, url)
|
|
|
|
def test_should_fetch_metadata_to_get_payload_if_no_content_type_set(self):
|
|
content_types_dict = {'default': 'application/octet-stream'}
|
|
self.api._get.return_value = self.secret.get_dict(
|
|
self.entity_href, content_types_dict=content_types_dict)
|
|
self.api._get_raw.return_value = self.secret.payload
|
|
|
|
secret = self.manager.get(secret_ref=self.entity_href)
|
|
self.assertIsInstance(secret, secrets.Secret)
|
|
self.assertEqual(self.entity_href, secret.secret_ref)
|
|
|
|
# Verify `get` wasn't called yet (metadata)
|
|
self.assertFalse(self.api._get.called)
|
|
|
|
# Verify `get_raw` wasn't called yet (payload)
|
|
self.assertFalse(self.api._get_raw.called)
|
|
|
|
# GET payload (with no payload_content_type) trigger lazy-load
|
|
self.assertEqual(self.secret.payload, secret.payload)
|
|
|
|
# Verify `get` was called (metadata)
|
|
self.assertTrue(self.api._get.called)
|
|
|
|
# Verify `get_raw` was called (payload)
|
|
self.assertTrue(self.api._get_raw.called)
|
|
|
|
# Verify the correct URL was used to make the `get` calls
|
|
args, kwargs = self.api._get.call_args
|
|
url = args[0]
|
|
self.assertEqual(self.entity_href, url)
|
|
|
|
args, kwargs = self.api._get_raw.call_args
|
|
url = args[0]
|
|
self.assertEqual(self.entity_href, url)
|
|
|
|
def test_should_decrypt_with_content_type(self):
|
|
self.api._get.return_value = self.secret.get_dict(self.entity_href)
|
|
|
|
decrypted = 'decrypted text here'
|
|
self.api._get_raw.return_value = decrypted
|
|
|
|
secret = self.manager.get(
|
|
secret_ref=self.entity_href,
|
|
payload_content_type='application/octet-stream'
|
|
)
|
|
secret_payload = secret.payload
|
|
self.assertEqual(decrypted, secret_payload)
|
|
|
|
# Verify the correct URL was used to make the call.
|
|
args, kwargs = self.api._get_raw.call_args
|
|
url = args[0]
|
|
self.assertEqual(self.entity_href, url)
|
|
|
|
# Verify that correct information was sent in the call.
|
|
headers = args[1]
|
|
self.assertEqual('application/octet-stream', headers['Accept'])
|
|
|
|
def test_should_decrypt_without_content_type(self):
|
|
content_types_dict = {'default': 'application/octet-stream'}
|
|
self.api._get.return_value = self.secret.get_dict(self.entity_href,
|
|
content_types_dict)
|
|
decrypted = 'decrypted text here'
|
|
self.api._get_raw.return_value = decrypted
|
|
|
|
secret = self.manager.get(secret_ref=self.entity_href)
|
|
secret_payload = secret.payload
|
|
self.assertEqual(decrypted, secret_payload)
|
|
|
|
# Verify the correct URL was used to make the call.
|
|
args, kwargs = self.api._get.call_args
|
|
url = args[0]
|
|
self.assertEqual(self.entity_href, url)
|
|
|
|
# Verify the correct URL was used to make the call.
|
|
args, kwargs = self.api._get_raw.call_args
|
|
url = args[0]
|
|
self.assertEqual(self.entity_href, url)
|
|
|
|
# Verify that correct information was sent in the call.
|
|
headers = args[1]
|
|
self.assertEqual('application/octet-stream', headers['Accept'])
|
|
|
|
def test_should_delete(self):
|
|
self.manager.delete(secret_ref=self.entity_href)
|
|
|
|
# Verify the correct URL was used to make the call.
|
|
args, kwargs = self.api._delete.call_args
|
|
url = args[0]
|
|
self.assertEqual(self.entity_href, url)
|
|
|
|
def test_should_get_list(self):
|
|
secret_resp = self.secret.get_dict(self.entity_href)
|
|
self.api._get.return_value = {"secrets":
|
|
[secret_resp for v in range(3)]}
|
|
|
|
secrets_list = self.manager.list(limit=10, offset=5)
|
|
self.assertTrue(len(secrets_list) == 3)
|
|
self.assertIsInstance(secrets_list[0], secrets.Secret)
|
|
self.assertEqual(self.entity_href, secrets_list[0].secret_ref)
|
|
|
|
# Verify the correct URL was used to make the call.
|
|
args, kwargs = self.api._get.call_args
|
|
url = args[0]
|
|
self.assertEqual(self.entity_base[:-1], url)
|
|
|
|
# Verify that correct information was sent in the call.
|
|
params = args[1]
|
|
self.assertEqual(10, params['limit'])
|
|
self.assertEqual(5, params['offset'])
|
|
|
|
def test_should_fail_get_invalid_secret(self):
|
|
self.assertRaises(ValueError, self.manager.get,
|
|
**{'secret_ref': '12345'})
|
|
|
|
def test_should_fail_decrypt_no_content_types(self):
|
|
self.api._get.return_value = self.secret.get_dict(self.entity_href)
|
|
secret = self.manager.get(secret_ref=self.entity_href)
|
|
try:
|
|
secret.payload
|
|
self.fail("didn't raise a ValueError exception")
|
|
except ValueError:
|
|
pass
|
|
|
|
def test_should_fail_decrypt_no_default_content_type(self):
|
|
content_types_dict = {'no-default': 'application/octet-stream'}
|
|
self.api._get.return_value = self.secret.get_dict(self.entity_href,
|
|
content_types_dict)
|
|
secret = self.manager.get(secret_ref=self.entity_href)
|
|
try:
|
|
secret.payload
|
|
self.fail("didn't raise a ValueError exception")
|
|
except ValueError:
|
|
pass
|
|
|
|
def test_should_fail_delete_no_href(self):
|
|
self.assertRaises(ValueError, self.manager.delete, None)
|
|
|
|
def test_should_get_total(self):
|
|
self.api._get.return_value = {'total': 1}
|
|
total = self.manager.total()
|
|
self.assertEqual(total, 1)
|