openstacksdk/shade/tests/unit/test_create_server.py
David Shrewsbury cfd62e4bbd Add wait_for_server API call.
We need to be able to wait for a server to reach active status.
This was the intended usage of get_active_server(), but it doesn't
do any waiting, which is a bummer.

Change-Id: I5be0b1cf6f1b910b6d861d81fc1083e4793b9e5f
2016-03-14 18:42:13 -04:00

296 lines
12 KiB
Python

# -*- coding: utf-8 -*-
# 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.
"""
test_create_server
----------------------------------
Tests for the `create_server` command.
"""
from mock import patch, Mock
import mock
import os_client_config
from shade import _utils
from shade import meta
from shade import OpenStackCloud
from shade.exc import (OpenStackCloudException, OpenStackCloudTimeout)
from shade.tests import base, fakes
class TestCreateServer(base.TestCase):
def setUp(self):
super(TestCreateServer, self).setUp()
config = os_client_config.OpenStackConfig()
self.client = OpenStackCloud(
cloud_config=config.get_one_cloud(validate=False))
self.client._SERVER_AGE = 0
def test_create_server_with_create_exception(self):
"""
Test that an exception in the novaclient create raises an exception in
create_server.
"""
with patch("shade.OpenStackCloud"):
config = {
"servers.create.side_effect": Exception("exception"),
}
OpenStackCloud.nova_client = Mock(**config)
self.assertRaises(
OpenStackCloudException, self.client.create_server,
'server-name', 'image-id', 'flavor-id')
def test_create_server_with_get_exception(self):
"""
Test that an exception when attempting to get the server instance via
the novaclient raises an exception in create_server.
"""
with patch("shade.OpenStackCloud"):
config = {
"servers.create.return_value": Mock(status="BUILD"),
"servers.get.side_effect": Exception("exception")
}
OpenStackCloud.nova_client = Mock(**config)
self.assertRaises(
OpenStackCloudException, self.client.create_server,
'server-name', 'image-id', 'flavor-id')
def test_create_server_with_server_error(self):
"""
Test that a server error before we return or begin waiting for the
server instance spawn raises an exception in create_server.
"""
build_server = fakes.FakeServer('1234', '', 'BUILD')
error_server = fakes.FakeServer('1234', '', 'ERROR')
with patch("shade.OpenStackCloud"):
config = {
"servers.create.return_value": build_server,
"servers.get.return_value": error_server,
}
OpenStackCloud.nova_client = Mock(**config)
self.assertRaises(
OpenStackCloudException, self.client.create_server,
'server-name', 'image-id', 'flavor-id')
def test_create_server_wait_server_error(self):
"""
Test that a server error while waiting for the server to spawn
raises an exception in create_server.
"""
with patch("shade.OpenStackCloud"):
build_server = fakes.FakeServer('1234', '', 'BUILD')
error_server = fakes.FakeServer('1234', '', 'ERROR')
config = {
"servers.create.return_value": build_server,
"servers.get.return_value": build_server,
"servers.list.side_effect": [
[build_server], [error_server]]
}
OpenStackCloud.nova_client = Mock(**config)
self.assertRaises(
OpenStackCloudException,
self.client.create_server,
'server-name', 'image-id', 'flavor-id', wait=True)
def test_create_server_with_timeout(self):
"""
Test that a timeout while waiting for the server to spawn raises an
exception in create_server.
"""
with patch("shade.OpenStackCloud"):
fake_server = fakes.FakeServer('1234', '', 'BUILD')
config = {
"servers.create.return_value": fake_server,
"servers.get.return_value": fake_server,
"servers.list.return_value": [fake_server],
}
OpenStackCloud.nova_client = Mock(**config)
self.assertRaises(
OpenStackCloudTimeout,
self.client.create_server,
'server-name', 'image-id', 'flavor-id', wait=True, timeout=1)
def test_create_server_no_wait(self):
"""
Test that create_server with no wait and no exception in the
novaclient create call returns the server instance.
"""
with patch("shade.OpenStackCloud"):
fake_server = fakes.FakeServer('1234', '', 'BUILD')
config = {
"servers.create.return_value": fake_server,
"servers.get.return_value": fake_server
}
OpenStackCloud.nova_client = Mock(**config)
self.assertEqual(
_utils.normalize_server(
meta.obj_to_dict(fake_server),
cloud_name=self.client.name,
region_name=self.client.region_name),
self.client.create_server(
name='server-name', image='image=id',
flavor='flavor-id'))
def test_create_server_with_admin_pass_no_wait(self):
"""
Test that a server with an admin_pass passed returns the password
"""
with patch("shade.OpenStackCloud"):
fake_server = fakes.FakeServer('1234', '', 'BUILD')
fake_create_server = fakes.FakeServer('1234', '', 'BUILD',
adminPass='ooBootheiX0edoh')
config = {
"servers.create.return_value": fake_create_server,
"servers.get.return_value": fake_server
}
OpenStackCloud.nova_client = Mock(**config)
self.assertEqual(
_utils.normalize_server(
meta.obj_to_dict(fake_create_server),
cloud_name=self.client.name,
region_name=self.client.region_name),
self.client.create_server(
name='server-name', image='image=id',
flavor='flavor-id', admin_pass='ooBootheiX0edoh'))
@patch.object(OpenStackCloud, "wait_for_server")
@patch.object(OpenStackCloud, "nova_client")
def test_create_server_with_admin_pass_wait(self, mock_nova, mock_wait):
"""
Test that a server with an admin_pass passed returns the password
"""
fake_server = fakes.FakeServer('1234', '', 'BUILD')
fake_server_with_pass = fakes.FakeServer('1234', '', 'BUILD',
adminPass='ooBootheiX0edoh')
mock_nova.servers.create.return_value = fake_server
mock_nova.servers.get.return_value = fake_server
# The wait returns non-password server
mock_wait.return_value = _utils.normalize_server(
meta.obj_to_dict(fake_server), None, None)
server = self.client.create_server(
name='server-name', image='image-id',
flavor='flavor-id', admin_pass='ooBootheiX0edoh', wait=True)
# Assert that we did wait
self.assertTrue(mock_wait.called)
# Even with the wait, we should still get back a passworded server
self.assertEqual(
server,
_utils.normalize_server(meta.obj_to_dict(fake_server_with_pass),
None, None)
)
@patch.object(OpenStackCloud, "get_active_server")
@patch.object(OpenStackCloud, "get_server")
def test_wait_for_server(self, mock_get_server, mock_get_active_server):
"""
Test that waiting for a server returns the server instance when
its status changes to "ACTIVE".
"""
building_server = {'id': 'fake_server_id', 'status': 'BUILDING'}
active_server = {'id': 'fake_server_id', 'status': 'ACTIVE'}
mock_get_server.side_effect = iter([building_server, active_server])
mock_get_active_server.side_effect = iter([
building_server, active_server])
server = self.client.wait_for_server(building_server)
self.assertEqual(2, mock_get_server.call_count)
mock_get_server.assert_has_calls([
mock.call(building_server['id']),
mock.call(active_server['id']),
])
self.assertEqual(2, mock_get_active_server.call_count)
mock_get_active_server.assert_has_calls([
mock.call(server=building_server, reuse=True, auto_ip=True,
ips=None, ip_pool=None, wait=True, timeout=mock.ANY),
mock.call(server=active_server, reuse=True, auto_ip=True,
ips=None, ip_pool=None, wait=True, timeout=mock.ANY),
])
self.assertEqual('ACTIVE', server['status'])
@patch.object(OpenStackCloud, 'wait_for_server')
@patch.object(OpenStackCloud, 'nova_client')
def test_create_server_wait(self, mock_nova, mock_wait):
"""
Test that create_server with a wait actually does the wait.
"""
fake_server = {'id': 'fake_server_id', 'status': 'BUILDING'}
mock_nova.servers.create.return_value = fake_server
self.client.create_server(
'server-name', 'image-id', 'flavor-id', wait=True),
mock_wait.assert_called_once_with(
fake_server, auto_ip=True, ips=None,
ip_pool=None, reuse=True, timeout=180
)
@patch('time.sleep')
def test_create_server_no_addresses(self, mock_sleep):
"""
Test that create_server with a wait throws an exception if the
server doesn't have addresses.
"""
with patch("shade.OpenStackCloud"):
build_server = fakes.FakeServer('1234', '', 'BUILD')
fake_server = fakes.FakeServer('1234', '', 'ACTIVE')
config = {
"servers.create.return_value": build_server,
"servers.get.return_value": [build_server, None],
"servers.list.side_effect": [
[build_server], [fake_server]],
"servers.delete.return_value": None,
}
OpenStackCloud.nova_client = Mock(**config)
self.client._SERVER_AGE = 0
with patch.object(OpenStackCloud, "add_ips_to_server",
return_value=fake_server):
self.assertRaises(
OpenStackCloudException, self.client.create_server,
'server-name', 'image-id', 'flavor-id',
wait=True)
@patch('shade.OpenStackCloud.nova_client')
@patch('shade.OpenStackCloud.get_network')
def test_create_server_network_with_no_nics(self, mock_get_network,
mock_nova):
"""
Verify that if 'network' is supplied, and 'nics' is not, that we
attempt to get the network for the server.
"""
self.client.create_server('server-name', 'image-id', 'flavor-id',
network='network-name')
mock_get_network.assert_called_once_with(name_or_id='network-name')
@patch('shade.OpenStackCloud.nova_client')
@patch('shade.OpenStackCloud.get_network')
def test_create_server_network_with_empty_nics(self,
mock_get_network,
mock_nova):
"""
Verify that if 'network' is supplied, along with an empty 'nics' list,
it's treated the same as if 'nics' were not included.
"""
self.client.create_server('server-name', 'image-id', 'flavor-id',
network='network-name', nics=[])
mock_get_network.assert_called_once_with(name_or_id='network-name')