Files
nova/nova/api/openstack/compute/admin_actions.py
T
Stephen Finucane 908d9263ee api: Add response body schemas for server action APIs
At least those that don't return bodies (plus rescue, which is easy)
since they're tedious but simple, thus providing a good test ground for
this effort.

Change-Id: I78003b1d2c1515e5fd5e17405df6a219878bdb8a
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2024-11-22 12:40:45 +00:00

90 lines
3.4 KiB
Python

# Copyright 2011 OpenStack Foundation
#
# 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 webob import exc
from nova.api.openstack import common
from nova.api.openstack.compute.schemas import admin_actions as schema
from nova.api.openstack import wsgi
from nova.api import validation
from nova.compute import api as compute
from nova.compute import instance_actions
from nova.compute import vm_states
from nova import exception
from nova import objects
from nova.policies import admin_actions as aa_policies
_removal_reason = """\
This action only works with the Xen virt driver, which was deprecated in the
20.0.0 (Train) release.
It was removed in the 23.0.0 (Wallaby) release.
"""
class AdminActionsController(wsgi.Controller):
def __init__(self):
super(AdminActionsController, self).__init__()
self.compute_api = compute.API()
@wsgi.expected_errors(410)
@wsgi.action('resetNetwork')
@wsgi.removed('23.0.0', _removal_reason)
@validation.schema(schema.reset_network)
def _reset_network(self, req, id, body):
"""(Removed) Permit admins to reset networking on a server."""
raise exc.HTTPGone()
@wsgi.response(202)
@wsgi.expected_errors((404, 409))
@wsgi.action('injectNetworkInfo')
@validation.schema(schema.inject_network_info)
@validation.response_body_schema(schema.inject_network_info_response)
def _inject_network_info(self, req, id, body):
"""Permit admins to inject network info into a server."""
context = req.environ['nova.context']
instance = common.get_instance(self.compute_api, context, id)
context.can(aa_policies.POLICY_ROOT % 'inject_network_info',
target={'project_id': instance.project_id})
try:
self.compute_api.inject_network_info(context, instance)
except exception.InstanceIsLocked as e:
raise exc.HTTPConflict(explanation=e.format_message())
@wsgi.response(202)
@wsgi.expected_errors(404)
@wsgi.action('os-resetState')
@validation.schema(schema.reset_state)
@validation.response_body_schema(schema.reset_state_response)
def _reset_state(self, req, id, body):
"""Permit admins to reset the state of a server."""
context = req.environ["nova.context"]
instance = common.get_instance(self.compute_api, context, id)
context.can(aa_policies.POLICY_ROOT % 'reset_state',
target={'project_id': instance.project_id})
# Log os-resetState as an instance action
instance_action = objects.InstanceAction.action_start(
context, instance.uuid, instance_actions.RESET_STATE)
# Identify the desired state from the body
state = {
'active': vm_states.ACTIVE,
'error': vm_states.ERROR,
}[body["os-resetState"]["state"]]
instance.vm_state = state
instance.task_state = None
instance.save(admin_state_reset=True)
instance_action.finish()