tempest/tests/compute/servers/test_server_metadata.py

# vim: tabstop=4 shiftwidth=4 softtabstop=4

# Copyright 2012 OpenStack, LLC
# 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.

from nose.plugins.attrib import attr

from tempest.common.utils.data_utils import rand_name
from tempest import exceptions
from tempest.tests.compute.base import BaseComputeTest


class ServerMetadataTest(BaseComputeTest):

    @classmethod
    def setUpClass(cls):
        super(ServerMetadataTest, cls).setUpClass()
        cls.client = cls.servers_client

        #Create a server to be used for all read only tests
        name = rand_name('server')
        resp, server = cls.client.create_server(name, cls.image_ref,
                                                cls.flavor_ref, meta={})
        cls.server_id = server['id']

        #Wait for the server to become active
        cls.client.wait_for_server_status(cls.server_id, 'ACTIVE')

    @classmethod
    def tearDownClass(cls):
        cls.client.delete_server(cls.server_id)
        super(ServerMetadataTest, cls).tearDownClass()

    def setUp(self):
        super(ServerMetadataTest, self).setUp()
        meta = {'key1': 'value1', 'key2': 'value2'}
        resp, _ = self.client.set_server_metadata(self.server_id, meta)
        self.assertEqual(resp.status, 200)

    def test_list_server_metadata(self):
        # All metadata key/value pairs for a server should be returned
        resp, resp_metadata = self.client.list_server_metadata(self.server_id)

        #Verify the expected metadata items are in the list
        self.assertEqual(200, resp.status)
        expected = {'key1': 'value1', 'key2': 'value2'}
        self.assertEqual(expected, resp_metadata)

    def test_set_server_metadata(self):
        # The server's metadata should be replaced with the provided values
        #Create a new set of metadata for the server
        req_metadata = {'meta2': 'data2', 'meta3': 'data3'}
        resp, metadata = self.client.set_server_metadata(self.server_id,
                                                         req_metadata)
        self.assertEqual(200, resp.status)

        #Verify the expected values are correct, and that the
        #previous values have been removed
        resp, resp_metadata = self.client.list_server_metadata(self.server_id)
        self.assertEqual(resp_metadata, req_metadata)

    def test_server_create_metadata_key_too_long(self):
        # Attempt to start a server with a meta-data key that is > 255
        # characters

        # Try a few values
        for sz in [256, 257, 511, 1023]:
            key = "k" * sz
            meta = {key: 'data1'}
            name = rand_name('server')
            self.assertRaises(exceptions.OverLimit,
                              self.create_server_with_extras,
                              name, self.image_ref,
                              self.flavor_ref, meta=meta)

        # no teardown - all creates should fail

    def test_update_server_metadata(self):
        # The server's metadata values should be updated to the
        # provided values
        meta = {'key1': 'alt1', 'key3': 'value3'}
        resp, metadata = self.client.update_server_metadata(self.server_id,
                                                            meta)
        self.assertEqual(200, resp.status)

        #Verify the values have been updated to the proper values
        resp, resp_metadata = self.client.list_server_metadata(self.server_id)
        expected = {'key1': 'alt1', 'key2': 'value2', 'key3': 'value3'}
        self.assertEqual(expected, resp_metadata)

    def test_get_server_metadata_item(self):
        # The value for a specic metadata key should be returned
        resp, meta = self.client.get_server_metadata_item(self.server_id,
                                                          'key2')
        self.assertTrue('value2', meta['key2'])

    def test_set_server_metadata_item(self):
        # The item's value should be updated to the provided value
        #Update the metadata value
        meta = {'nova': 'alt'}
        resp, body = self.client.set_server_metadata_item(self.server_id,
                                                          'nova', meta)
        self.assertEqual(200, resp.status)

        #Verify the meta item's value has been updated
        resp, resp_metadata = self.client.list_server_metadata(self.server_id)
        expected = {'key1': 'value1', 'key2': 'value2', 'nova': 'alt'}
        self.assertEqual(expected, resp_metadata)

    def test_delete_server_metadata_item(self):
        # The metadata value/key pair should be deleted from the server
        resp, meta = self.client.delete_server_metadata_item(self.server_id,
                                                             'key1')
        self.assertEqual(204, resp.status)

        #Verify the metadata item has been removed
        resp, resp_metadata = self.client.list_server_metadata(self.server_id)
        expected = {'key2': 'value2'}
        self.assertEqual(expected, resp_metadata)

    @attr(type='negative')
    def test_get_nonexistant_server_metadata_item(self):
        # Negative test: GET on nonexistant server should not succeed
        try:
            resp, meta = self.client.get_server_metadata_item(999, 'test2')
        except Exception:
            pass
        else:
            self.fail('GET on nonexistant server should not succeed')

    @attr(type='negative')
    def test_list_nonexistant_server_metadata(self):
        # Negative test:List metadata on a non existant server should
        # not succeed
        try:
            resp, metadata = self.client.list_server_metadata(999)
        except Exception:
            pass
        else:
            self.fail('List metadata on a non existant server should'
                      'not succeed')

    @attr(type='negative')
    def test_set_nonexistant_server_metadata(self):
        # Negative test: Set metadata on a non existant server should not
        # succeed
        meta = {'meta1': 'data1'}
        try:
            resp, metadata = self.client.set_server_metadata(999, meta)
        except Exception:
            pass
        else:
            self.fail('Set metadata on a non existant server should'
                      'not succeed')

    @attr(type='negative')
    def test_update_nonexistant_server_metadata(self):
        # Negative test: An update should not happen for a nonexistant image
        meta = {'key1': 'value1', 'key2': 'value2'}
        try:
            resp, metadata = self.client.update_server_metadata(999, meta)
        except Exception:
            pass
        else:
            self.fail('An update should not happen for a nonexistant image')

    @attr(type='negative')
    def test_delete_nonexistant_server_metadata_item(self):
        # Negative test: Should not be able to delete metadata item from a
        # nonexistant server
        meta = {'d': 'delvalue'}

        #Delete the metadata item
        try:
            resp, metadata = self.client.delete_server_metadata_item(999, 'd')
        except Exception:
            pass
        else:
            self.fail('A delete should not happen for a nonexistant image')