From d5b24ef15c93b5e70355e0f35a2e8bccd7510170 Mon Sep 17 00:00:00 2001 From: Flavio Percoco Date: Fri, 3 Jan 2014 14:46:31 +0100 Subject: [PATCH] Add shard support to the client The patch adds Shard support of the client. This will allow users to create and delete shards from Marconi. The API requires the Marconi instance to be and admin instance. However, there are no checks, restrictions, yet. This patch doesn't implement Shards listing. As soon as the MessageIterator lands, it'll be possible to reuse that code for the ShardsIterator. Partially-Implements blueprint: shard-management Partially-Implements blueprint: python-marconiclient-v1 Change-Id: I932c98d68a4a81b710dbea75a6bac123b7afaa08 --- marconiclient/queues/v1/api.py | 18 ++++++ marconiclient/queues/v1/client.py | 13 ++++ marconiclient/queues/v1/core.py | 35 +++++++++++ marconiclient/queues/v1/shard.py | 51 ++++++++++++++++ marconiclient/tests/queues/shard.py | 77 ++++++++++++++++++++++++ tests/functional/queues/v1/test_shard.py | 26 ++++++++ tests/unit/queues/v1/test_core.py | 21 +++++++ tests/unit/queues/v1/test_shard.py | 25 ++++++++ 8 files changed, 266 insertions(+) create mode 100644 marconiclient/queues/v1/shard.py create mode 100644 marconiclient/tests/queues/shard.py create mode 100644 tests/functional/queues/v1/test_shard.py create mode 100644 tests/unit/queues/v1/test_shard.py diff --git a/marconiclient/queues/v1/api.py b/marconiclient/queues/v1/api.py index 62c4ea80..6f2aff07 100644 --- a/marconiclient/queues/v1/api.py +++ b/marconiclient/queues/v1/api.py @@ -143,4 +143,22 @@ class V1(api.Api): 'claim_id': {'type': 'string'}, } }, + + 'shard_create': { + 'ref': 'shards/{shard_name}', + 'method': 'PUT', + 'required': ['shard_name'], + 'properties': { + 'shard_name': {'type': 'string'}, + } + }, + + 'shard_delete': { + 'ref': 'shards/{shard_name}', + 'method': 'DELETE', + 'required': ['shard_name'], + 'properties': { + 'shard_name': {'type': 'string'}, + } + }, } diff --git a/marconiclient/queues/v1/client.py b/marconiclient/queues/v1/client.py index ac7bc590..d4534d0e 100644 --- a/marconiclient/queues/v1/client.py +++ b/marconiclient/queues/v1/client.py @@ -16,6 +16,7 @@ import uuid from marconiclient.queues.v1 import queues +from marconiclient.queues.v1 import shard from marconiclient import transport from marconiclient.transport import request @@ -99,3 +100,15 @@ class Client(object): req.ref = ref return trans.send(req).deserialized_content + + # ADMIN API + def shard(self, ref, **kwargs): + """Returns a shard instance + + :param ref: Shard's reference name. + :type ref: `six.text_type` + + :returns: A shard instance + :rtype: `shard.Shard` + """ + return shard.Shard(self, ref, **kwargs) diff --git a/marconiclient/queues/v1/core.py b/marconiclient/queues/v1/core.py index 11b1e9bf..a26b2703 100644 --- a/marconiclient/queues/v1/core.py +++ b/marconiclient/queues/v1/core.py @@ -232,3 +232,38 @@ def message_delete(transport, request, queue_name, message_id, callback=None): request.params['message_id'] = message_id transport.send(request) + + +def shard_create(transport, request, shard_name, shard_data): + """Creates a shard called `shard_name` + + :param transport: Transport instance to use + :type transport: `transport.base.Transport` + :param request: Request instance ready to be sent. + :type request: `transport.request.Request` + :param shard_name: Shard reference name. + :type shard_name: `six.text_type` + :param shard_data: Shard's properties, i.e: weight, uri, options. + :type shard_data: `dict` + """ + + request.operation = 'shard_create' + request.params['shard_name'] = shard_name + request.content = json.dumps(shard_data) + transport.send(request) + + +def shard_delete(transport, request, shard_name): + """Deletes the shard `shard_name` + + :param transport: Transport instance to use + :type transport: `transport.base.Transport` + :param request: Request instance ready to be sent. + :type request: `transport.request.Request` + :param shard_name: Shard reference name. + :type shard_name: `six.text_type` + """ + + request.operation = 'shard_delete' + request.params['shard_name'] = shard_name + transport.send(request) diff --git a/marconiclient/queues/v1/shard.py b/marconiclient/queues/v1/shard.py new file mode 100644 index 00000000..c26b5125 --- /dev/null +++ b/marconiclient/queues/v1/shard.py @@ -0,0 +1,51 @@ +# Copyright (c) 2014 Red Hat, Inc. +# +# 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 marconiclient.queues.v1 import core + + +class Shard(object): + + def __init__(self, client, name, + weight=None, uri=None, + auto_create=True, **options): + self.client = client + + self.uri = uri + self.name = name + self.weight = weight + self.options = options + + if auto_create: + self.ensure_exists() + + def ensure_exists(self): + """Ensures shard exists + + This method is not race safe, + the shard could've been deleted + right after it was called. + """ + req, trans = self.client._request_and_transport() + + data = {'uri': self.uri, + 'weight': self.weight, + 'options': self.options} + + core.shard_create(trans, req, self.name, data) + + def delete(self): + req, trans = self.client._request_and_transport() + core.shard_delete(trans, req, self.name) diff --git a/marconiclient/tests/queues/shard.py b/marconiclient/tests/queues/shard.py new file mode 100644 index 00000000..a4a66132 --- /dev/null +++ b/marconiclient/tests/queues/shard.py @@ -0,0 +1,77 @@ +# Copyright (c) 2014 Red Hat, Inc. +# +# 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. + +import mock + +from marconiclient.tests.queues import base +from marconiclient.transport import response + + +class QueuesV1ShardUnitTest(base.QueuesTestBase): + + def test_shard_create(self): + shard_data = {'weight': 10, + 'uri': 'sqlite://'} + + with mock.patch.object(self.transport, 'send', + autospec=True) as send_method: + + resp = response.Response(None, None) + send_method.return_value = resp + + # NOTE(flaper87): This will call + # ensure exists in the client instance + # since auto_create's default is True + shard = self.client.shard('test', **shard_data) + self.assertEqual(shard.name, 'test') + self.assertEqual(shard.weight, 10) + + def test_shard_delete(self): + shard_data = {'weight': 10, + 'uri': 'sqlite://'} + + with mock.patch.object(self.transport, 'send', + autospec=True) as send_method: + + resp = response.Response(None, None) + send_method.return_value = resp + + # NOTE(flaper87): This will call + # ensure exists in the client instance + # since auto_create's default is True + shard = self.client.shard('test', **shard_data) + shard.delete() + + # NOTE(flaper87): Nothing to assert here, + # just checking our way down to the transport + # doesn't crash. + + +class QueuesV1ShardFunctionalTest(base.QueuesTestBase): + + def test_shard_create(self): + shard_data = {'weight': 10, + 'uri': 'sqlite://'} + + shard = self.client.shard('test', **shard_data) + self.assertEqual(shard.name, 'test') + self.assertEqual(shard.weight, 10) + + def test_shard_delete(self): + shard_data = {'weight': 10, + 'uri': 'sqlite://'} + + shard = self.client.shard('test', **shard_data) + shard.delete() diff --git a/tests/functional/queues/v1/test_shard.py b/tests/functional/queues/v1/test_shard.py new file mode 100644 index 00000000..7de6d73c --- /dev/null +++ b/tests/functional/queues/v1/test_shard.py @@ -0,0 +1,26 @@ +# Copyright (c) 2014 Red Hat, Inc. +# +# 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 marconiclient.tests.queues import shard +from marconiclient.transport import http + + +class QueuesV1ShardHttpFunctionalTest(shard.QueuesV1ShardFunctionalTest): + + is_functional = True + transport_cls = http.HttpTransport + url = 'http://127.0.0.1:8888/v1' + version = 1 diff --git a/tests/unit/queues/v1/test_core.py b/tests/unit/queues/v1/test_core.py index ab38de22..35f2a02f 100644 --- a/tests/unit/queues/v1/test_core.py +++ b/tests/unit/queues/v1/test_core.py @@ -166,3 +166,24 @@ class TestV1Core(base.TestBase): req = request.Request() core.message_delete(self.transport, req, 'test', 'message_id') + + # ADMIN API + def test_shard_create(self): + with mock.patch.object(self.transport, 'send', + autospec=True) as send_method: + resp = response.Response(None, None) + send_method.return_value = resp + + req = request.Request() + core.shard_create(self.transport, req, + 'test_shard', {'uri': 'sqlite://', + 'weight': 0}) + + def test_shard_delete(self): + with mock.patch.object(self.transport, 'send', + autospec=True) as send_method: + resp = response.Response(None, None) + send_method.return_value = resp + + req = request.Request() + core.shard_delete(self.transport, req, 'test_shard') diff --git a/tests/unit/queues/v1/test_shard.py b/tests/unit/queues/v1/test_shard.py new file mode 100644 index 00000000..82a30ed5 --- /dev/null +++ b/tests/unit/queues/v1/test_shard.py @@ -0,0 +1,25 @@ +# Copyright (c) 2014 Red Hat, Inc. +# +# 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 marconiclient.tests.queues import shard +from marconiclient.transport import http + + +class QueuesV1ShardHttpUnitTest(shard.QueuesV1ShardUnitTest): + + transport_cls = http.HttpTransport + url = 'http://127.0.0.1:8888/v1' + version = 1