Merge "Expose a get_spice_console RPC API method"

11 files changed, 234 insertions, 0 deletions

diff --git a/nova/tests/api/openstack/compute/contrib/test_consoles.py b/nova/tests/api/openstack/compute/contrib/test_consoles.py
index d251c6b75..cf044dfcd 100644
--- a/nova/tests/api/openstack/compute/contrib/test_consoles.py
+++ b/nova/tests/api/openstack/compute/contrib/test_consoles.py
@@ -26,19 +26,36 @@ def fake_get_vnc_console(self, _context, _instance, _console_type):
     return {'url': 'http://fake'}
 
 
+def fake_get_spice_console(self, _context, _instance, _console_type):
+    return {'url': 'http://fake'}
+
+
 def fake_get_vnc_console_invalid_type(self, _context,
                                       _instance, _console_type):
     raise exception.ConsoleTypeInvalid(console_type=_console_type)
 
 
+def fake_get_spice_console_invalid_type(self, _context,
+                                      _instance, _console_type):
+    raise exception.ConsoleTypeInvalid(console_type=_console_type)
+
+
 def fake_get_vnc_console_not_ready(self, _context, instance, _console_type):
     raise exception.InstanceNotReady(instance_id=instance["uuid"])
 
 
+def fake_get_spice_console_not_ready(self, _context, instance, _console_type):
+    raise exception.InstanceNotReady(instance_id=instance["uuid"])
+
+
 def fake_get_vnc_console_not_found(self, _context, instance, _console_type):
     raise exception.InstanceNotFound(instance_id=instance["uuid"])
 
 
+def fake_get_spice_console_not_found(self, _context, instance, _console_type):
+    raise exception.InstanceNotFound(instance_id=instance["uuid"])
+
+
 def fake_get(self, context, instance_uuid):
     return {'uuid': instance_uuid}
 
@@ -53,6 +70,8 @@ class ConsolesExtensionTest(test.TestCase):
         super(ConsolesExtensionTest, self).setUp()
         self.stubs.Set(compute_api.API, 'get_vnc_console',
                        fake_get_vnc_console)
+        self.stubs.Set(compute_api.API, 'get_spice_console',
+                       fake_get_spice_console)
         self.stubs.Set(compute_api.API, 'get', fake_get)
         self.flags(
             osapi_compute_extension=[
@@ -132,3 +151,76 @@ class ConsolesExtensionTest(test.TestCase):
 
         res = req.get_response(self.app)
         self.assertEqual(res.status_int, 400)
+
+    def test_get_spice_console(self):
+        body = {'os-getSPICEConsole': {'type': 'spice-html5'}}
+        req = webob.Request.blank('/v2/fake/servers/1/action')
+        req.method = "POST"
+        req.body = jsonutils.dumps(body)
+        req.headers["content-type"] = "application/json"
+
+        res = req.get_response(self.app)
+        output = jsonutils.loads(res.body)
+        self.assertEqual(res.status_int, 200)
+        self.assertEqual(output,
+            {u'console': {u'url': u'http://fake', u'type': u'spice-html5'}})
+
+    def test_get_spice_console_not_ready(self):
+        self.stubs.Set(compute_api.API, 'get_spice_console',
+                       fake_get_spice_console_not_ready)
+        body = {'os-getSPICEConsole': {'type': 'spice-html5'}}
+        req = webob.Request.blank('/v2/fake/servers/1/action')
+        req.method = "POST"
+        req.body = jsonutils.dumps(body)
+        req.headers["content-type"] = "application/json"
+
+        res = req.get_response(self.app)
+        output = jsonutils.loads(res.body)
+        self.assertEqual(res.status_int, 409)
+
+    def test_get_spice_console_no_type(self):
+        self.stubs.Set(compute_api.API, 'get_spice_console',
+                       fake_get_spice_console_invalid_type)
+        body = {'os-getSPICEConsole': {}}
+        req = webob.Request.blank('/v2/fake/servers/1/action')
+        req.method = "POST"
+        req.body = jsonutils.dumps(body)
+        req.headers["content-type"] = "application/json"
+
+        res = req.get_response(self.app)
+        self.assertEqual(res.status_int, 400)
+
+    def test_get_spice_console_no_instance(self):
+        self.stubs.Set(compute_api.API, 'get', fake_get_not_found)
+        body = {'os-getSPICEConsole': {'type': 'spice-html5'}}
+        req = webob.Request.blank('/v2/fake/servers/1/action')
+        req.method = "POST"
+        req.body = jsonutils.dumps(body)
+        req.headers["content-type"] = "application/json"
+
+        res = req.get_response(self.app)
+        self.assertEqual(res.status_int, 404)
+
+    def test_get_spice_console_no_instance_on_console_get(self):
+        self.stubs.Set(compute_api.API, 'get_spice_console',
+                       fake_get_spice_console_not_found)
+        body = {'os-getSPICEConsole': {'type': 'spice-html5'}}
+        req = webob.Request.blank('/v2/fake/servers/1/action')
+        req.method = "POST"
+        req.body = jsonutils.dumps(body)
+        req.headers["content-type"] = "application/json"
+
+        res = req.get_response(self.app)
+        self.assertEqual(res.status_int, 404)
+
+    def test_get_spice_console_invalid_type(self):
+        body = {'os-getSPICEConsole': {'type': 'invalid'}}
+        self.stubs.Set(compute_api.API, 'get_spice_console',
+                       fake_get_spice_console_invalid_type)
+        req = webob.Request.blank('/v2/fake/servers/1/action')
+        req.method = "POST"
+        req.body = jsonutils.dumps(body)
+        req.headers["content-type"] = "application/json"
+
+        res = req.get_response(self.app)
+        self.assertEqual(res.status_int, 400)
diff --git a/nova/tests/compute/test_compute.py b/nova/tests/compute/test_compute.py
index 0d9f67231..3740d598e 100644
--- a/nova/tests/compute/test_compute.py
+++ b/nova/tests/compute/test_compute.py
@@ -1335,6 +1335,9 @@ class ComputeTestCase(BaseTestCase):
 
     def test_novnc_vnc_console(self):
         # Make sure we can a vnc console for an instance.
+        self.flags(vnc_enabled=True)
+        self.flags(enabled=False, group='spice')
+
         instance = jsonutils.to_primitive(self._create_fake_instance())
         self.compute.run_instance(self.context, instance=instance)
 
@@ -1347,6 +1350,9 @@ class ComputeTestCase(BaseTestCase):
 
     def test_xvpvnc_vnc_console(self):
         # Make sure we can a vnc console for an instance.
+        self.flags(vnc_enabled=True)
+        self.flags(enabled=False, group='spice')
+
         instance = jsonutils.to_primitive(self._create_fake_instance())
         self.compute.run_instance(self.context, instance=instance)
 
@@ -1357,6 +1363,9 @@ class ComputeTestCase(BaseTestCase):
 
     def test_invalid_vnc_console_type(self):
         # Raise useful error if console type is an unrecognised string.
+        self.flags(vnc_enabled=True)
+        self.flags(enabled=False, group='spice')
+
         instance = jsonutils.to_primitive(self._create_fake_instance())
         self.compute.run_instance(self.context, instance=instance)
 
@@ -1367,6 +1376,9 @@ class ComputeTestCase(BaseTestCase):
 
     def test_missing_vnc_console_type(self):
         # Raise useful error is console type is None.
+        self.flags(vnc_enabled=True)
+        self.flags(enabled=False, group='spice')
+
         instance = jsonutils.to_primitive(self._create_fake_instance())
         self.compute.run_instance(self.context, instance=instance)
 
@@ -1375,6 +1387,47 @@ class ComputeTestCase(BaseTestCase):
                           self.context, None, instance=instance)
         self.compute.terminate_instance(self.context, instance=instance)
 
+    def test_spicehtml5_spice_console(self):
+        # Make sure we can a spice console for an instance.
+        self.flags(vnc_enabled=False)
+        self.flags(enabled=True, group='spice')
+
+        instance = jsonutils.to_primitive(self._create_fake_instance())
+        self.compute.run_instance(self.context, instance=instance)
+
+        # Try with the full instance
+        console = self.compute.get_spice_console(self.context, 'spice-html5',
+                                               instance=instance)
+        self.assert_(console)
+
+        self.compute.terminate_instance(self.context, instance=instance)
+
+    def test_invalid_spice_console_type(self):
+        # Raise useful error if console type is an unrecognised string
+        self.flags(vnc_enabled=False)
+        self.flags(enabled=True, group='spice')
+
+        instance = jsonutils.to_primitive(self._create_fake_instance())
+        self.compute.run_instance(self.context, instance=instance)
+
+        self.assertRaises(exception.ConsoleTypeInvalid,
+                          self.compute.get_spice_console,
+                          self.context, 'invalid', instance=instance)
+        self.compute.terminate_instance(self.context, instance=instance)
+
+    def test_missing_spice_console_type(self):
+        # Raise useful error is console type is None
+        self.flags(vnc_enabled=False)
+        self.flags(enabled=True, group='spice')
+
+        instance = jsonutils.to_primitive(self._create_fake_instance())
+        self.compute.run_instance(self.context, instance=instance)
+
+        self.assertRaises(exception.ConsoleTypeInvalid,
+                          self.compute.get_spice_console,
+                          self.context, None, instance=instance)
+        self.compute.terminate_instance(self.context, instance=instance)
+
     def test_diagnostics(self):
         # Make sure we can get diagnostics for an instance.
         expected_diagnostic = {'cpu0_time': 17300000000,
@@ -5512,6 +5565,50 @@ class ComputeAPITestCase(BaseTestCase):
 
         db.instance_destroy(self.context, instance['uuid'])
 
+    def test_spice_console(self):
+        # Make sure we can a spice console for an instance.
+
+        fake_instance = {'uuid': 'fake_uuid',
+                         'host': 'fake_compute_host'}
+        fake_console_type = "spice-html5"
+        fake_connect_info = {'token': 'fake_token',
+                             'console_type': fake_console_type,
+                             'host': 'fake_console_host',
+                             'port': 'fake_console_port',
+                             'internal_access_path': 'fake_access_path'}
+        fake_connect_info2 = copy.deepcopy(fake_connect_info)
+        fake_connect_info2['access_url'] = 'fake_console_url'
+
+        self.mox.StubOutWithMock(rpc, 'call')
+
+        rpc_msg1 = {'method': 'get_spice_console',
+                    'args': {'instance': fake_instance,
+                             'console_type': fake_console_type},
+                   'version': '2.24'}
+        rpc_msg2 = {'method': 'authorize_console',
+                    'args': fake_connect_info,
+                    'version': '1.0'}
+
+        rpc.call(self.context, 'compute.%s' % fake_instance['host'],
+                rpc_msg1, None).AndReturn(fake_connect_info2)
+        rpc.call(self.context, CONF.consoleauth_topic,
+                rpc_msg2, None).AndReturn(None)
+
+        self.mox.ReplayAll()
+
+        console = self.compute_api.get_spice_console(self.context,
+                fake_instance, fake_console_type)
+        self.assertEqual(console, {'url': 'fake_console_url'})
+
+    def test_get_spice_console_no_host(self):
+        instance = self._create_fake_instance(params={'host': ''})
+
+        self.assertRaises(exception.InstanceNotReady,
+                          self.compute_api.get_spice_console,
+                          self.context, instance, 'spice')
+
+        db.instance_destroy(self.context, instance['uuid'])
+
     def test_get_backdoor_port(self):
         # Test api call to get backdoor_port.
         fake_backdoor_port = 59697
diff --git a/nova/tests/compute/test_rpcapi.py b/nova/tests/compute/test_rpcapi.py
index 00b90ea65..b81e049bf 100644
--- a/nova/tests/compute/test_rpcapi.py
+++ b/nova/tests/compute/test_rpcapi.py
@@ -165,6 +165,11 @@ class ComputeRpcAPITestCase(test.TestCase):
         self._test_compute_api('get_vnc_console', 'call',
                 instance=self.fake_instance, console_type='type')
 
+    def test_get_spice_console(self):
+        self._test_compute_api('get_spice_console', 'call',
+                instance=self.fake_instance, console_type='type',
+                version='2.24')
+
     def test_host_maintenance_mode(self):
         self._test_compute_api('host_maintenance_mode', 'call',
                 host_param='param', mode='mode', host='host')
diff --git a/nova/tests/fake_policy.py b/nova/tests/fake_policy.py
index 15890cdcd..acefa856c 100644
--- a/nova/tests/fake_policy.py
+++ b/nova/tests/fake_policy.py
@@ -42,6 +42,7 @@ policy_data = """
     "compute:unlock": "",
 
     "compute:get_vnc_console": "",
+    "compute:get_spice_console": "",
     "compute:get_console_output": "",
 
     "compute:associate_floating_ip": "",
diff --git a/nova/tests/fakelibvirt.py b/nova/tests/fakelibvirt.py
index 8d9561c7e..a573b7d1c 100644
--- a/nova/tests/fakelibvirt.py
+++ b/nova/tests/fakelibvirt.py
@@ -414,6 +414,7 @@ class Domain(object):
     <input type='tablet' bus='usb'/>
     <input type='mouse' bus='ps2'/>
     <graphics type='vnc' port='-1' autoport='yes'/>
+    <graphics type='spice' port='-1' autoport='yes'/>
     <video>
       <model type='cirrus' vram='9216' heads='1'/>
       <address type='pci' domain='0x0000' bus='0x00' slot='0x02'
diff --git a/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-req.json.tpl b/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-req.json.tpl
new file mode 100644
index 000000000..d04f7c7ae
--- /dev/null
+++ b/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-req.json.tpl
@@ -0,0 +1,5 @@
+{
+    "os-getSPICEConsole": {
+        "type": "spice-html5"
+    }
+}
diff --git a/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-req.xml.tpl b/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-req.xml.tpl
new file mode 100644
index 000000000..c8cd2df9f
--- /dev/null
+++ b/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-req.xml.tpl
@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<os-getSPICEConsole>
+  <type>spice-html5</type>
+</os-getSPICEConsole>
diff --git a/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-resp.json.tpl b/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-resp.json.tpl
new file mode 100644
index 000000000..20e260e9e
--- /dev/null
+++ b/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-resp.json.tpl
@@ -0,0 +1,6 @@
+{
+	"console": {
+		"type": "spice-html5",
+		"url":"%(url)s"
+	}
+}
diff --git a/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-resp.xml.tpl b/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-resp.xml.tpl
new file mode 100644
index 000000000..77e35ae5b
--- /dev/null
+++ b/nova/tests/integrated/api_samples/os-consoles/get-spice-console-post-resp.xml.tpl
@@ -0,0 +1,5 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<console>
+	<type>spice-html5</type>
+	<url>%(url)s</url>
+</console>
diff --git a/nova/tests/integrated/test_api_samples.py b/nova/tests/integrated/test_api_samples.py
index 7c3157872..aa41a8259 100644
--- a/nova/tests/integrated/test_api_samples.py
+++ b/nova/tests/integrated/test_api_samples.py
@@ -2116,6 +2116,11 @@ class ConsolesSampleJsonTests(ServersSampleBase):
     extension_name = ("nova.api.openstack.compute.contrib"
                                      ".consoles.Consoles")
 
+    def setUp(self):
+        super(ConsolesSampleJsonTests, self).setUp()
+        self.flags(vnc_enabled=True)
+        self.flags(enabled=True, group='spice')
+
     def test_get_vnc_console(self):
         uuid = self._post_server()
         response = self._do_post('servers/%s/action' % uuid,
@@ -2128,6 +2133,18 @@ class ConsolesSampleJsonTests(ServersSampleBase):
         return self._verify_response('get-vnc-console-post-resp',
                                        subs, response)
 
+    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.assertEqual(response.status, 200)
+        subs = self._get_regexes()
+        subs["url"] = \
+            "((https?):((//)|(\\\\))+([\w\d:#@%/;$()~_?\+-=\\\.&](#!)?)*)"
+        return self._verify_response('get-spice-console-post-resp',
+                                       subs, response)
+
 
 class ConsolesSampleXmlTests(ConsolesSampleJsonTests):
         ctype = 'xml'
diff --git a/nova/tests/test_fakelibvirt.py b/nova/tests/test_fakelibvirt.py
index fea666f36..32c85a95a 100644
--- a/nova/tests/test_fakelibvirt.py
+++ b/nova/tests/test_fakelibvirt.py
@@ -53,6 +53,7 @@ def get_vm_xml(name="testname", uuid=None, source_type='file',
     </interface>
     <input type='mouse' bus='ps2'/>
     <graphics type='vnc' port='5901' autoport='yes' keymap='en-us'/>
+    <graphics type='spice' port='5901' autoport='yes' keymap='en-us'/>
   </devices>
 </domain>''' % {'name': name,
                 'uuid_tag': uuid_tag,