nova/nova/tests/functional/api_sample_tests/test_lock_server.py
Surya Seetharaman c541ace518 Microversion 2.73: Support adding the reason behind a server lock
This patch adds a new parameter ``locked_reason`` to
``POST /servers/{server_id}/action`` request where the
action is lock. It enables the user to specify a reason when locking
a server.

The locked_reason will be exposed through ``GET servers/{server_id}``,
``GET /servers/detail``, ``POST /servers/{server_id}/action``  where
the action is rebuild and ``PUT servers/{server_id}`` requests' responses.

The InstanceActionNotification will emit the locked_reason
along with the other instance details. This patch hence changes the
payload object to include the "locked_reason" field.

Note that "locked" will be allowed as a valid filtering/sorting parameter
for ``GET /servers/detail`` and ``GET /servers`` from this new microversion.

Implements blueprint add-locked-reason

Change-Id: I46edd595e7417c584106487123774a73c6dbe65e
2019-05-11 21:48:27 +00:00

77 lines
3.0 KiB
Python

# Copyright 2012 Nebula, Inc.
# Copyright 2013 IBM Corp.
#
# 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 nova.tests.functional.api_sample_tests import test_servers
class LockServerSamplesJsonTest(test_servers.ServersSampleBase):
sample_dir = "os-lock-server"
def setUp(self):
"""setUp Method for LockServer api samples extension
This method creates the server that will be used in each tests
"""
super(LockServerSamplesJsonTest, self).setUp()
self.uuid = self._post_server()
def test_post_lock_server(self):
# Get api samples to lock server request.
response = self._do_post('servers/%s/action' % self.uuid,
'lock-server', {})
self.assertEqual(202, response.status_code)
def test_post_unlock_server(self):
# Get api samples to unlock server request.
self.test_post_lock_server()
response = self._do_post('servers/%s/action' % self.uuid,
'unlock-server', {})
self.assertEqual(202, response.status_code)
class LockServerSamplesJsonTestV273(test_servers.ServersSampleBase):
sample_dir = "os-lock-server"
microversion = '2.73'
scenarios = [('v2_73', {'api_major_version': 'v2.1'})]
def setUp(self):
"""setUp Method for LockServer api samples extension
This method creates the server that will be used in each test
"""
super(LockServerSamplesJsonTestV273, self).setUp()
self.uuid = self._post_server()
def test_post_lock_server(self):
# backwards compatibility.
response = self._do_post('servers/%s/action' % self.uuid,
name='lock-server', subs={})
self.assertEqual(202, response.status_code)
def test_post_lock_server_with_reason(self):
# Get api samples to lock server request.
response = self._do_post('servers/%s/action' % self.uuid,
name='lock-server-with-reason', subs={})
self.assertEqual(202, response.status_code)
def test_post_unlock_server(self):
# Get api samples to unlock server request.
# We first call the previous test to lock the server with reason
# and then unlock it to post a response for unlock.
self.test_post_lock_server_with_reason()
response = self._do_post('servers/%s/action' % self.uuid,
name='unlock-server', subs={})
self.assertEqual(202, response.status_code)