barbican/functionaltests/api/v1/functional/test_consumers.py

# Copyright (c) 2014 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.
import json

from functionaltests.api import base
from functionaltests.api.v1.behaviors import secret_behaviors
from functionaltests.api.v1.models import secret_models

create_secret_data = {
    "name": "AES key",
    "expiration": "2018-02-28T19:14:44.180394",
    "algorithm": "aes",
    "bit_length": 256,
    "mode": "cbc",
    "payload": "gF6+lLoF3ohA9aPRpt+6bQ==",
    "payload_content_type": "application/octet-stream",
    "payload_content_encoding": "base64",
}

create_consumer_data = {
    "name": "consumername",
    "URL": "consumerURL"
}

create_consumer_data_for_delete = {
    "name": "consumername2",
    "URL": "consumerURL2"
}

create_consumer_data_for_recreate = {
    "name": "consumername3",
    "URL": "consumerURL3"
}

create_consumer_data_for_idempotency = {
    "name": "consumername4",
    "URL": "consumerURL4"
}

create_container_data = {
    "name": "containername",
    "type": "generic",
    "secret_refs": [
        {
            "name": "secret1",
        },
        {
            "name": "secret2",
        }
    ]
}


class ConsumersTestCase(base.TestCase):

    def _create_a_secret(self):
        secret_model = secret_models.SecretModel(**create_secret_data)
        resp, secret_ref = self.secret_behaviors.create_secret(secret_model)
        self.assertEqual(resp.status_code, 201)
        self.assertIsNotNone(secret_ref)

        return secret_ref

    def setUp(self):
        super(ConsumersTestCase, self).setUp()
        self.secret_behaviors = secret_behaviors.SecretBehaviors(self.client)

        # Set up two secrets
        secret_ref_1 = self._create_a_secret()
        secret_ref_2 = self._create_a_secret()

        # Create a container with our secrets
        create_container_data['secret_refs'][0]['secret_ref'] = secret_ref_1
        create_container_data['secret_refs'][1]['secret_ref'] = secret_ref_2
        container_json_data = json.dumps(create_container_data)
        resp = self.client.post(
            'containers', container_json_data)
        self.assertEqual(resp.status_code, 201)

        returned_data = resp.json()
        container_ref = returned_data['container_ref']
        self.assertIsNotNone(container_ref)
        self.container_id = container_ref.split('/')[-1]

    def tearDown(self):
        self.secret_behaviors.delete_all_created_secrets()
        super(ConsumersTestCase, self).tearDown()

    def test_create_consumer(self):
        """Covers consumer creation.

        All of the data needed to create the consumer is provided in a
        single POST.
        """
        json_data = json.dumps(create_consumer_data)
        resp = self.client.post(
            'containers/{0}/consumers'.format(self.container_id),
            json_data)
        self.assertEqual(resp.status_code, 200)

        returned_data = resp.json()
        consumer_data = returned_data['consumers']
        self.assertIsNotNone(consumer_data)
        self.assertIn(create_consumer_data, consumer_data)

    def test_delete_consumer(self):
        """Covers consumer deletion.

        A consumer is first created, and then the consumer is deleted and
        verified to no longer exist.
        """
        json_data = json.dumps(create_consumer_data_for_delete)

        # Register the consumer once
        resp = self.client.post(
            'containers/{0}/consumers'.format(self.container_id),
            json_data)
        self.assertEqual(resp.status_code, 200)

        returned_data = resp.json()
        consumer_data = returned_data['consumers']
        self.assertIsNotNone(consumer_data)
        self.assertIn(create_consumer_data_for_delete, consumer_data)

        # Delete the consumer
        resp = self.client.delete(
            'containers/{0}/consumers'.format(self.container_id),
            json_data)
        self.assertEqual(resp.status_code, 200)

        returned_data = resp.json()
        consumer_data = returned_data['consumers']
        self.assertIsNotNone(consumer_data)
        self.assertNotIn(create_consumer_data_for_delete, consumer_data)

    def test_recreate_consumer(self):
        """Covers consumer recreation."""
        json_data = json.dumps(create_consumer_data_for_recreate)

        # Register the consumer once
        resp = self.client.post(
            'containers/{0}/consumers'.format(self.container_id),
            json_data)
        self.assertEqual(resp.status_code, 200)

        returned_data = resp.json()
        consumer_data = returned_data['consumers']
        self.assertIsNotNone(consumer_data)
        self.assertIn(create_consumer_data_for_recreate, consumer_data)

        # Delete the consumer
        resp = self.client.delete(
            'containers/{0}/consumers'.format(self.container_id),
            json_data)
        self.assertEqual(resp.status_code, 200)

        returned_data = resp.json()
        consumer_data = returned_data['consumers']
        self.assertIsNotNone(consumer_data)
        self.assertNotIn(create_consumer_data_for_recreate, consumer_data)

        # Register the consumer again
        resp = self.client.post(
            'containers/{0}/consumers'.format(self.container_id),
            json_data)
        self.assertEqual(resp.status_code, 200)

        returned_data = resp.json()
        consumer_data = returned_data['consumers']
        self.assertIsNotNone(consumer_data)
        self.assertIn(create_consumer_data_for_recreate, consumer_data)

    def test_create_consumer_is_idempotent(self):
        """Covers checking that create consumer is idempotent."""
        json_data = json.dumps(create_consumer_data_for_idempotency)

        # Register the consumer once
        resp = self.client.post(
            'containers/{0}/consumers'.format(self.container_id),
            json_data)
        self.assertEqual(resp.status_code, 200)

        returned_data = resp.json()
        consumer_data = returned_data['consumers']
        self.assertIsNotNone(consumer_data)
        self.assertIn(create_consumer_data_for_idempotency, consumer_data)

        # Register the consumer again, without deleting it first
        resp = self.client.post(
            'containers/{0}/consumers'.format(self.container_id),
            json_data)
        self.assertEqual(resp.status_code, 200)

        returned_data = resp.json()
        consumer_data = returned_data['consumers']
        self.assertIsNotNone(consumer_data)
        self.assertIn(create_consumer_data_for_idempotency, consumer_data)
        count = consumer_data.count(create_consumer_data_for_idempotency)
        self.assertEqual(1, count)