From a220aa15b056914df1b9debc95322d01a0e408e8 Mon Sep 17 00:00:00 2001 From: Alessio Ababilov Date: Wed, 29 Aug 2012 19:16:37 +0300 Subject: API extension for fpinging instances It may be interesting for a cloud user or administrator to perform a simple instance monitoring. A ping could be an acceptable solution: it is fast and quite reliable. A limit for ping is 1 time a minute by default. API calls. GET /os-fping?[all_tenants=1]&[include=uuid[,uuid...][&exclude=...] Performs fping for all VM in the current project and returns results. If `all_tenants` is requested, data for all projects is returned. By default, `all_tenants` is allowed only for admins. `include` and `exclude` are parameters specifying VM masks. Consider that VM list is `VM_all`, then if `include` is set, the result will be `VM_all * VM_include`. if `include` is set, the result will be `VM_all - VM_exclude`. `exclude` is ignored if `include` is specified. GET /os-fping/ Performs a check for single instance. Configuration flags. fping_path - full path to fping Implement blueprint fping-instances-ext Change-Id: I7d942270aa52bd6216eda0d7ae366ef0195d52a8 --- .../api/openstack/compute/contrib/test_fping.py | 94 ++++++++++++++++++++++ .../all_extensions/extensions-get-resp.json.tpl | 8 ++ .../all_extensions/extensions-get-resp.xml.tpl | 3 + .../integrated/api_samples/limit-get-resp.json.tpl | 13 +++ .../integrated/api_samples/limit-get-resp.xml.tpl | 3 + .../os-used-limits/usedlimits-get-resp.json.tpl | 13 +++ .../os-used-limits/usedlimits-get-resp.xml.tpl | 3 + nova/tests/policy.json | 2 + 8 files changed, 139 insertions(+) create mode 100644 nova/tests/api/openstack/compute/contrib/test_fping.py (limited to 'nova/tests') diff --git a/nova/tests/api/openstack/compute/contrib/test_fping.py b/nova/tests/api/openstack/compute/contrib/test_fping.py new file mode 100644 index 000000000..9a838162a --- /dev/null +++ b/nova/tests/api/openstack/compute/contrib/test_fping.py @@ -0,0 +1,94 @@ +# Copyright 2011 Grid Dynamics +# Copyright 2011 OpenStack LLC. +# All Rights Reserved. +# +# 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.api.openstack.compute.contrib import fping +from nova.api.openstack import extensions +from nova import exception +from nova import test +from nova.tests.api.openstack import fakes +import nova.utils + + +FAKE_UUID = fakes.FAKE_UUID + + +def execute(*cmd, **args): + return "".join(["%s is alive" % ip for ip in cmd[1:]]) + + +class FpingTest(test.TestCase): + + def setUp(self): + super(FpingTest, self).setUp() + self.flags(verbose=True, use_ipv6=False) + return_server = fakes.fake_instance_get() + return_servers = fakes.fake_instance_get_all_by_filters() + self.stubs.Set(nova.db, "instance_get_all_by_filters", + return_servers) + self.stubs.Set(nova.db, "instance_get_by_uuid", + return_server) + self.stubs.Set(nova.db, "instance_get_all_by_project", + return_servers) + self.stubs.Set(nova.utils, "execute", + execute) + self.stubs.Set(fping.FpingController, "check_fping", + lambda self: None) + self.ext_mgr = extensions.ExtensionManager() + self.ext_mgr.extensions = {} + self.controller = fping.FpingController(self.ext_mgr) + + def test_fping_index(self): + req = fakes.HTTPRequest.blank("/v2/1234/os-fping") + res_dict = self.controller.index(req) + self.assertTrue("servers" in res_dict) + for srv in res_dict["servers"]: + for key in "project_id", "id", "alive": + self.assertTrue(key in srv) + + def test_fping_index_policy(self): + req = fakes.HTTPRequest.blank("/v2/1234/os-fping?all_tenants=1") + self.assertRaises(exception.NotAuthorized, self.controller.index, req) + req = fakes.HTTPRequest.blank("/v2/1234/os-fping?all_tenants=1") + req.environ["nova.context"].is_admin = True + res_dict = self.controller.index(req) + self.assertTrue("servers" in res_dict) + + def test_fping_index_include(self): + req = fakes.HTTPRequest.blank("/v2/1234/os-fping") + res_dict = self.controller.index(req) + ids = [srv["id"] for srv in res_dict["servers"]] + req = fakes.HTTPRequest.blank("/v2/1234/os-fping?include=%s" % ids[0]) + res_dict = self.controller.index(req) + self.assertEqual(len(res_dict["servers"]), 1) + self.assertEqual(res_dict["servers"][0]["id"], ids[0]) + + def test_fping_index_exclude(self): + req = fakes.HTTPRequest.blank("/v2/1234/os-fping") + res_dict = self.controller.index(req) + ids = [srv["id"] for srv in res_dict["servers"]] + req = fakes.HTTPRequest.blank("/v2/1234/os-fping?exclude=%s" % + ",".join(ids[1:])) + res_dict = self.controller.index(req) + self.assertEqual(len(res_dict["servers"]), 1) + self.assertEqual(res_dict["servers"][0]["id"], ids[0]) + + def test_fping_show(self): + req = fakes.HTTPRequest.blank("/v2/1234/os-fping/%s" % FAKE_UUID) + res_dict = self.controller.show(req, FAKE_UUID) + self.assertTrue("server" in res_dict) + srv = res_dict["server"] + for key in "project_id", "id", "alive": + self.assertTrue(key in srv) diff --git a/nova/tests/integrated/api_samples/all_extensions/extensions-get-resp.json.tpl b/nova/tests/integrated/api_samples/all_extensions/extensions-get-resp.json.tpl index 34f305967..ed2c27492 100644 --- a/nova/tests/integrated/api_samples/all_extensions/extensions-get-resp.json.tpl +++ b/nova/tests/integrated/api_samples/all_extensions/extensions-get-resp.json.tpl @@ -216,6 +216,14 @@ "namespace": "http://docs.openstack.org/compute/ext/services/api/v2", "updated": "%(timestamp)s" }, + { + "alias": "os-fping", + "description": "%(text)s", + "links": [], + "name": "Fping", + "namespace": "http://docs.openstack.org/compute/ext/fping/api/v1.1", + "updated": "%(timestamp)s" + }, { "alias": "os-hypervisors", "description": "%(text)s", diff --git a/nova/tests/integrated/api_samples/all_extensions/extensions-get-resp.xml.tpl b/nova/tests/integrated/api_samples/all_extensions/extensions-get-resp.xml.tpl index 44aa5ee81..e3d454966 100644 --- a/nova/tests/integrated/api_samples/all_extensions/extensions-get-resp.xml.tpl +++ b/nova/tests/integrated/api_samples/all_extensions/extensions-get-resp.xml.tpl @@ -81,6 +81,9 @@ %(text)s + + %(text)s + %(text)s diff --git a/nova/tests/integrated/api_samples/limit-get-resp.json.tpl b/nova/tests/integrated/api_samples/limit-get-resp.json.tpl index 7763dd683..a86d5faa2 100644 --- a/nova/tests/integrated/api_samples/limit-get-resp.json.tpl +++ b/nova/tests/integrated/api_samples/limit-get-resp.json.tpl @@ -66,6 +66,19 @@ ], "regex": ".*changes-since.*", "uri": "*changes-since*" + }, + { + "limit": [ + { + "next-available": "%(timestamp)s", + "remaining": 12, + "unit": "HOUR", + "value": 12, + "verb": "GET" + } + ], + "regex": "^/os-fping", + "uri": "*/os-fping" } ] } diff --git a/nova/tests/integrated/api_samples/limit-get-resp.xml.tpl b/nova/tests/integrated/api_samples/limit-get-resp.xml.tpl index 860499f8d..6f92bcee6 100644 --- a/nova/tests/integrated/api_samples/limit-get-resp.xml.tpl +++ b/nova/tests/integrated/api_samples/limit-get-resp.xml.tpl @@ -12,6 +12,9 @@ + + + diff --git a/nova/tests/integrated/api_samples/os-used-limits/usedlimits-get-resp.json.tpl b/nova/tests/integrated/api_samples/os-used-limits/usedlimits-get-resp.json.tpl index 3eef6c68b..78ddbb5af 100644 --- a/nova/tests/integrated/api_samples/os-used-limits/usedlimits-get-resp.json.tpl +++ b/nova/tests/integrated/api_samples/os-used-limits/usedlimits-get-resp.json.tpl @@ -71,6 +71,19 @@ ], "regex": ".*changes-since.*", "uri": "*changes-since*" + }, + { + "limit": [ + { + "next-available": "%(timestamp)s", + "remaining": 12, + "unit": "HOUR", + "value": 12, + "verb": "GET" + } + ], + "regex": "^/os-fping", + "uri": "*/os-fping" } ] } diff --git a/nova/tests/integrated/api_samples/os-used-limits/usedlimits-get-resp.xml.tpl b/nova/tests/integrated/api_samples/os-used-limits/usedlimits-get-resp.xml.tpl index b8e0396e8..75526473a 100644 --- a/nova/tests/integrated/api_samples/os-used-limits/usedlimits-get-resp.xml.tpl +++ b/nova/tests/integrated/api_samples/os-used-limits/usedlimits-get-resp.xml.tpl @@ -12,6 +12,9 @@ + + + diff --git a/nova/tests/policy.json b/nova/tests/policy.json index bf94d4e49..85bf5b583 100644 --- a/nova/tests/policy.json +++ b/nova/tests/policy.json @@ -104,6 +104,8 @@ "compute_extension:floating_ip_dns": "", "compute_extension:floating_ip_pools": "", "compute_extension:floating_ips": "", + "compute_extension:fping": "", + "compute_extension:fping:all_tenants": "is_admin:True", "compute_extension:hosts": "", "compute_extension:hypervisors": "", "compute_extension:instance_usage_audit_log": "", -- cgit