Files
nova/nova/tests/functional/api_sample_tests/test_remote_consoles.py
Michael Still cbc263f6bc libvirt: allow direct SPICE connections to qemu
This patch adds a new console type, "spice-direct", which provides
the connection information required to talk the native SPICE protocol
directly to qemu on the hypervisor. This is intended to be fronted
by a proxy which will handle authentication separately.

A new microversion is introduced which adds the type "spice-direct"
to the existing "spice" protocol.

An example request:

POST /servers/<uuid>/remote-consoles
{
  "remote_console": {
    "protocol": "spice",
    "type": "spice-direct"
  }
}

An example response:

{
  "remote_console": {
    "protocol": "spice",
    "type": "spice-direct",
    "url": "http://localhost:13200/nova?token=XXX";
  }
}

This token can then be used to lookup connection details for the
console using a request like this:

GET /os-console-auth-tokens/<consoletoken>

Which returns something like this:

{
  "console": {
    "instance_uuid": <uuid>,
    "host": <hypervisor>,
    "port": <a TCP port number>,
    "tls_port": <another TCP port number>,
    "internal_access_path": null
  }
}

APIImpact

Change-Id: I1e701cbabc0e2c435685e31465159eec09e3b1a0
2025-02-22 08:25:38 +11:00

148 lines
6.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 unittest import mock
from nova.compute import api as compute
from nova import exception
from nova.tests.functional.api_sample_tests import test_servers
HTTP_RE = r'(https?://)([\w\d:#@%/;$()~_?\+-=\\.&](#!)?)*'
class ConsolesSampleJsonTests(test_servers.ServersSampleBase):
microversion = None
sample_dir = "os-remote-consoles"
def setUp(self):
super(ConsolesSampleJsonTests, self).setUp()
self.api.microversion = self.microversion
self.flags(enabled=True, group='vnc')
self.flags(enabled=True, group='spice')
self.flags(enabled=True, group='serial_console')
def test_get_vnc_console(self):
uuid = self._post_server()
response = self._do_post('servers/%s/action' % uuid,
'get-vnc-console-post-req',
{'action': 'os-getVNCConsole'})
self._verify_response('get-vnc-console-post-resp', {'url': HTTP_RE},
response, 200)
@mock.patch.object(compute.API, 'get_vnc_console')
def test_get_vnc_console_instance_invalid_state(self,
mock_get_vnc_console):
uuid = self._post_server()
def fake_get_vnc_console(*args, **kwargs):
raise exception.InstanceInvalidState(
attr='fake_attr', state='fake_state', method='fake_method',
instance_uuid=uuid)
mock_get_vnc_console.side_effect = fake_get_vnc_console
response = self._do_post('servers/%s/action' % uuid,
'get-vnc-console-post-req',
{'action': 'os-getVNCConsole'})
self.assertEqual(409, response.status_code)
def test_get_spice_console(self):
uuid = self._post_server()
response = self._do_post('servers/%s/action' % uuid,
'get-spice-console-post-req',
{'action': 'os-getSPICEConsole'})
self._verify_response('get-spice-console-post-resp', {'url': HTTP_RE},
response, 200)
def test_get_rdp_console_bad_request(self):
"""Ensure http 400 error is return from RDP console request"""
uuid = self._post_server()
response = self._do_post('servers/%s/action' % uuid,
'get-rdp-console-post-req',
{'action': 'os-getRDPConsole'})
self.assertEqual(400, response.status_code)
def test_get_serial_console(self):
uuid = self._post_server()
response = self._do_post('servers/%s/action' % uuid,
'get-serial-console-post-req',
{'action': 'os-getSerialConsole'})
self._verify_response('get-serial-console-post-resp', {'url': HTTP_RE},
response, 200)
class ConsolesV26SampleJsonTests(test_servers.ServersSampleBase):
microversion = '2.6'
sample_dir = "os-remote-consoles"
# NOTE(gmann): microversion tests do not need to run for v2 API
# so defining scenarios only for v2.6 which will run the original tests
# by appending '(v2_6)' in test_id.
scenarios = [('v2_6', {'api_major_version': 'v2.1'})]
def test_create_console(self):
uuid = self._post_server()
body = {'protocol': 'vnc', 'type': 'novnc'}
response = self._do_post('servers/%s/remote-consoles' % uuid,
'create-vnc-console-req', body)
self._verify_response('create-vnc-console-resp', {'url': HTTP_RE},
response, 200)
def test_create_rdp_console_bad_request(self):
"""Ensure http 400 error is return from RDP console request"""
uuid = self._post_server()
body = {'protocol': 'rdp', 'type': 'rdp-html5'}
response = self._do_post('servers/%s/remote-consoles' % uuid,
'create-rdp-console-req', body)
self.assertEqual(400, response.status_code)
class ConsolesV28SampleJsonTests(test_servers.ServersSampleBase):
sample_dir = "os-remote-consoles"
microversion = '2.8'
scenarios = [('v2_8', {'api_major_version': 'v2.1'})]
def setUp(self):
super(ConsolesV28SampleJsonTests, self).setUp()
self.flags(enabled=True, group='mks')
def test_create_mks_console(self):
uuid = self._post_server()
body = {'protocol': 'mks', 'type': 'webmks'}
response = self._do_post('servers/%s/remote-consoles' % uuid,
'create-mks-console-req', body)
self._verify_response('create-mks-console-resp', {'url': HTTP_RE},
response, 200)
class ConsolesV299SampleJsonTests(test_servers.ServersSampleBase):
sample_dir = "os-remote-consoles"
microversion = '2.99'
scenarios = [('v2_99', {'api_major_version': 'v2.1'})]
def setUp(self):
super(ConsolesV299SampleJsonTests, self).setUp()
self.flags(enabled=True, group='spice')
def test_create_spice_direct_console(self):
uuid = self._post_server()
body = {'protocol': 'spice', 'type': 'spice-direct'}
response = self._do_post('servers/%s/remote-consoles' % uuid,
'create-spice-direct-console-req', body)
self._verify_response(
'create-spice-direct-console-resp', {'url': HTTP_RE},
response, 200)