From: Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; GET filter parameter will be splited in two types: 1. flag_filter: pass to libvirt api and filter when resource query. flag_filters start with "_" 2. field_filter: take effect in filter out final result. field_filters are keys of dict returned by 'GET' Then we can call it like: GET /collection?filter_field=value Signed-off-by: Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; --- src/kimchi/control/base.py | 31 ++++++++++++++++++++++++------- src/kimchi/control/storagepools.py | 4 ++-- src/kimchi/control/storagevolumes.py | 2 +- 3 files changed, 27 insertions(+), 10 deletions(-) diff --git a/src/kimchi/control/base.py b/src/kimchi/control/base.py index 185c8d8..55678b1 100644 --- a/src/kimchi/control/base.py +++ b/src/kimchi/control/base.py @@ -212,10 +212,10 @@ class Collection(object): return res.get() - def _get_resources(self): + def _get_resources(self, flag_filter): try: get_list = getattr(self.model, model_fn(self, 'get_list')) - idents = get_list(*self.model_args) + idents = get_list(*self.model_args, **flag_filter) res_list = [] for ident in idents: # internal text, get_list changes ident to unicode for sorted @@ -234,19 +234,36 @@ class Collection(object): args = self.resource_args + [ident.decode("utf-8")] return self.resource(self.model, *args) - def get(self): - resources = self._get_resources() + def filter_data(self, resources, fields_filter): data = [] for res in resources: - data.append(res.data) + if all(key in res.data and res.data[key] == val \ + for key, val in fields_filter.iteritems()): + data.append(res.data) + return data + + def get(self, filter_params): + def _split_filter(params): + flag_filter = dict() + fields_filter = params + for key, val in params.items(): + if key.startswith('_'): + flag_filter[key] = fields_filter.pop(key) + return flag_filter, fields_filter + + flag_filter, fields_filter = _split_filter(filter_params) + resources = self._get_resources(flag_filter) + data = self.filter_data(resources, fields_filter) return kimchi.template.render(get_class_name(self), data) @cherrypy.expose - def index(self, *args): + def index(self, *args, **kwargs): method = validate_method(('GET', 'POST')) if method == 'GET': try: - return self.get() + filter_params = cherrypy.request.params + validate_params(filter_params, self, 'get_list') + return self.get(filter_params) except InvalidOperation, param: error = "Invalid operation: '%s'" % param raise cherrypy.HTTPError(400, error) diff --git a/src/kimchi/control/storagepools.py b/src/kimchi/control/storagepools.py index 06b7196..35e7664 100644 --- a/src/kimchi/control/storagepools.py +++ b/src/kimchi/control/storagepools.py @@ -63,9 +63,9 @@ class StoragePools(Collection): return resp - def _get_resources(self): + def _get_resources(self, filter_params): try: - res_list = super(StoragePools, self)._get_resources() + res_list = super(StoragePools, self)._get_resources(filter_params) # Append reserved pools isos = getattr(self, ISO_POOL_NAME) isos.lookup() diff --git a/src/kimchi/control/storagevolumes.py b/src/kimchi/control/storagevolumes.py index d541807..cd15bcc 100644 --- a/src/kimchi/control/storagevolumes.py +++ b/src/kimchi/control/storagevolumes.py @@ -70,7 +70,7 @@ class IsoVolumes(Collection): super(IsoVolumes, self).__init__(model) self.pool = pool - def get(self): + def get(self, filter_params): res_list = [] try: get_list = getattr(self.model, model_fn(self, 'get_list'))

From: Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; Add a testcase to test GET param passing and demo how GET param work with current model implementation,which means: 1. change the API.json 2. wrap its model implementation to accept parameters Signed-off-by: Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; --- tests/test_rest.py | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/tests/test_rest.py b/tests/test_rest.py index a8e5842..dd2747b 100644 --- a/tests/test_rest.py +++ b/tests/test_rest.py @@ -1240,6 +1240,29 @@ class RestTests(unittest.TestCase): self.assertIn('net_recv_rate', stats) self.assertIn('net_sent_rate', stats) + def test_get_param(self): + req = json.dumps({'name': 'test', 'cdrom': '/nonexistent.iso'}) + self.request('/templates', req, 'POST') + + # Create a VM + req = json.dumps({'name': 'test-vm1', 'template': '/templates/test'}) + resp = self.request('/vms', req, 'POST') + self.assertEquals(201, resp.status) + req = json.dumps({'name': 'test-vm2', 'template': '/templates/test'}) + resp = self.request('/vms', req, 'POST') + self.assertEquals(201, resp.status) + + resp = request(host, port, '/vms') + self.assertEquals(200, resp.status) + res = json.loads(resp.read()) + self.assertEquals(2, len(res)) + + resp = request(host, port, '/vms?name=test-vm1') + self.assertEquals(200, resp.status) + res = json.loads(resp.read()) + self.assertEquals(1, len(res)) + self.assertEquals('test-vm1', res[0]['name']) + class HttpsRestTests(RestTests): """

From: Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; Update API.md to specify storage server api. Signed-off-by: Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; --- docs/API.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/docs/API.md b/docs/API.md index f872eab..8b1e971 100644 --- a/docs/API.md +++ b/docs/API.md @@ -495,6 +495,29 @@ creation. not tested yet * **POST**: *See Configuration Actions* +**Actions (POST):** + +*No actions defined* + +### Collection: Storage Servers + +**URI:** /storageservers + +**Methods:** + +* **GET**: Retrieve a summarized list of used storage servers. + * Parameters: + * _target_type: Filter server list with given type, currently support 'netfs'. + +### Resource: Storage Server + +**URI:** /storageservers/*:host* + +**Methods:** + +* **GET**: Retrieve description of a Storage Server + * host: IP or host name of storage server + ### Collection: Distros **URI:** /config/distros

From: Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; Add storage server collection and resource to report used storage server. Signed-off-by: Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; --- src/kimchi/API.json | 11 ++++++++++ src/kimchi/control/storageservers.py | 41 ++++++++++++++++++++++++++++++++++++ src/kimchi/root.py | 2 ++ 3 files changed, 54 insertions(+) create mode 100644 src/kimchi/control/storageservers.py diff --git a/src/kimchi/API.json b/src/kimchi/API.json index 46818d4..9b86164 100644 --- a/src/kimchi/API.json +++ b/src/kimchi/API.json @@ -237,6 +237,17 @@ }, "additionalProperties": false }, + "storageservers_get_list": { + "type": "object", + "properties": { + "_target_type": { + "description": "List storage servers of given type", + "type": "string", + "pattern": "^netfs$" + } + }, + "additionalProperties": false + }, "template_update": { "type": "object", "properties": { diff --git a/src/kimchi/control/storageservers.py b/src/kimchi/control/storageservers.py new file mode 100644 index 0000000..c692fae --- /dev/null +++ b/src/kimchi/control/storageservers.py @@ -0,0 +1,41 @@ +# +# Project Kimchi +# +# Copyright IBM, Corp. 2014 +# +# Authors: +# Royce Lv <lvroyce(a)linux.vnet.ibm.com&gt; +# +# This library is free software; you can redistribute it and/or +# modify it under the terms of the GNU Lesser General Public +# License as published by the Free Software Foundation; either +# version 2.1 of the License, or (at your option) any later version. +# +# This library is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# Lesser General Public License for more details. +# +# You should have received a copy of the GNU Lesser General Public +# License along with this library; if not, write to the Free Software +# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + +from kimchi.control.base import Collection, Resource +from kimchi.control.utils import get_class_name, model_fn +import kimchi.template + + +class StorageServers(Collection): + def __init__(self, model): + super(StorageServers, self).__init__(model) + self.resource = StorageServer + + +class StorageServer(Resource): + def __init__(self, model, ident): + super(StorageServer, self).__init__(model, ident) + self.storagetargets = StorageTargets(self.model, self.ident.decode("utf-8")) + + @property + def data(self): + return self.info diff --git a/src/kimchi/root.py b/src/kimchi/root.py index 3cc6321..ec531c0 100644 --- a/src/kimchi/root.py +++ b/src/kimchi/root.py @@ -36,6 +36,7 @@ from kimchi.control.interfaces import Interfaces from kimchi.control.networks import Networks from kimchi.control.plugins import Plugins from kimchi.control.storagepools import StoragePools +from kimchi.control.storageserver import StorageServers

from kimchi.control.tasks import Tasks from kimchi.control.templates import Templates from kimchi.control.utils import parse_request @@ -60,6 +61,7 @@ class Root(Resource): self.vms = VMs(model) self.templates = Templates(model) self.storagepools = StoragePools(model) + self.storageservers = StorageServers(model) self.interfaces = Interfaces(model) self.networks = Networks(model) self.tasks = Tasks(model)