From 076d144f0f5883a5c7c7c88f8b177f22d57c078a Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 20 Jul 2019 14:15:23 +0300 Subject: Add: MemoryStore --- ick2/__init__.py | 4 +++ ick2/store.py | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++ ick2/store_tests.py | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 178 insertions(+) create mode 100644 ick2/store.py create mode 100644 ick2/store_tests.py diff --git a/ick2/__init__.py b/ick2/__init__.py index 147d87a..8bfa867 100644 --- a/ick2/__init__.py +++ b/ick2/__init__.py @@ -15,6 +15,10 @@ from .version import __version__, __version_info__ from .logging import setup_logging, log +from .store import ( + MemoryStore, + Conflict, +) from .persistent import ( MemoryPersistentState, MuckPersistentState, diff --git a/ick2/store.py b/ick2/store.py new file mode 100644 index 0000000..2d93daf --- /dev/null +++ b/ick2/store.py @@ -0,0 +1,85 @@ +# Copyright (C) 2019 Lars Wirzenius +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + + +import copy +import uuid + + +import ick2 + + +class StoreInterface: # pragma: no cover + + def create(self, token, obj): + raise NotImplementedError() + + def update(self, token, rid, obj, revision): + raise NotImplementedError() + + def show(self, token, rid): + raise NotImplementedError() + + def delete(self, token, rid): + raise NotImplementedError() + + def search(self, token, cond): + raise NotImplementedError() + + +class MemoryStore(StoreInterface): + + def __init__(self): + self._objs = {} + + def search(self, token, cond): + return list(self._objs.keys()) + + def _new_id(self): + return str(uuid.uuid4()) + + def _set(self, rid, rev, obj): + self._objs[rid] = (rev, copy.deepcopy(obj)) + + def create(self, token, obj): + rid = self._new_id() + rev = self._new_id() + self._set(rid, rev, obj) + return rid, rev + + def show(self, token, rid): + if rid not in self._objs: + raise ick2.NotFound('unknown.type', rid) + rev, obj = self._objs[rid] + return copy.deepcopy(obj), rev + + def update(self, token, rid, obj, revision): + old_obj, old_rev = self.show(token, rid) + if old_rev != revision: + raise Conflict(rid, old_rev, revision) + new_rev = self._new_id() + self._set(rid, new_rev, obj) + return new_rev + + def delete(self, token, rid): + del self._objs[rid] + + +class Conflict(Exception): + + def __init__(self, rid, expected, got): + super().__init__( + 'Update conflict for {}: expected revision {}, got {}'.format( + rid, expected, got)) diff --git a/ick2/store_tests.py b/ick2/store_tests.py new file mode 100644 index 0000000..652f7f2 --- /dev/null +++ b/ick2/store_tests.py @@ -0,0 +1,89 @@ +# Copyright (C) 2019 Lars Wirzenius +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + + +import shutil +import tempfile +import unittest + + +import ick2 + + +class StoreTests(unittest.TestCase): + + def setUp(self): + self.store = ick2.MemoryStore() + self.token = 'dummy-test-token' + self.obj = { + 'foo': 'bar', + } + + def create(self): + return self.store.create(self.token, self.obj) + + def find_all_resources(self): + cond = [ + { + 'where': 'meta', + 'field': 'id', + 'op': '!=', + 'pattern': '', + } + ] + return self.store.search(self.token, cond) + + def test_has_no_resources_initially(self): + self.assertEqual(self.find_all_resources(), []) + + def test_creates_resource(self): + rid, rev = self.create() + self.assertTrue(isinstance(rid, str)) + self.assertTrue(isinstance(rev, str)) + self.assertTrue(rid) + self.assertTrue(rev) + self.assertEqual(self.find_all_resources(), [rid]) + + def test_retrieves_resource(self): + rid, rev = self.create() + obj, rev = self.store.show(self.token, rid) + self.assertEqual(obj, self.obj) + self.assertFalse(obj is self.obj) + + def test_retrieving_nonexistent_resource_raises_error(self): + with self.assertRaises(ick2.NotFound): + self.store.show(self.token, 'wrong.id') + + def test_updating_with_wrong_revision_raises_error(self): + rid, rev = self.create() + with self.assertRaises(ick2.Conflict): + self.store.update(self.token, rid, self.obj, 'wrong.revision') + + def test_updates_resource(self): + rid, rev = self.create() + obj2 = { + 'yo': 'yoyo', + } + rev2 = self.store.update(self.token, rid, obj2, rev) + obj3, rev3 = self.store.show(self.token, rid) + self.assertTrue(rev2) + self.assertNotEqual(rev, rev2) + self.assertEqual(rev2, rev3) + self.assertEqual(obj2, obj3) + + def test_deletes_resource(self): + rid, rev = self.create() + self.store.delete(self.token, rid) + self.assertEqual(self.find_all_resources(), []) -- cgit v1.2.1