From 066664763f16318076e34d702cce746b2fd4afca Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Sat, 20 Jul 2019 16:53:25 +0300 Subject: Change: move exceptions to exceptions.py, rename persitent.py --- ick2/__init__.py | 6 ++-- ick2/exceptions.py | 18 +++++++++- ick2/persistent.py | 66 ---------------------------------- ick2/persistent_tests.py | 92 ------------------------------------------------ ick2/resource.py | 58 ++++++++++++++++++++++++++++++ ick2/store.py | 10 +----- 6 files changed, 79 insertions(+), 171 deletions(-) delete mode 100644 ick2/persistent.py delete mode 100644 ick2/persistent_tests.py create mode 100644 ick2/resource.py (limited to 'ick2') diff --git a/ick2/__init__.py b/ick2/__init__.py index 7229a5f..2720d61 100644 --- a/ick2/__init__.py +++ b/ick2/__init__.py @@ -17,10 +17,8 @@ from .version import __version__, __version_info__ from .logging import setup_logging, log from .store import ( MemoryStore, - Conflict, ) -from .persistent import ( - NotFound, +from .resource import ( Resource, resource_from_dict, ) @@ -50,7 +48,9 @@ from .buildsm import ( ) from .exceptions import ( BadUpdate, + NotFound, ExistsAlready, + Conflict, IckException, MethodNotAllowed, ClientIdMissing, diff --git a/ick2/exceptions.py b/ick2/exceptions.py index 3af7ff0..bd394af 100644 --- a/ick2/exceptions.py +++ b/ick2/exceptions.py @@ -1,4 +1,4 @@ -# Copyright (C) 2017-2018 Lars Wirzenius +# Copyright (C) 2017-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 @@ -18,12 +18,28 @@ class IckException(Exception): pass +class NotFound(Exception): + + def __init__(self, kind, name): + super().__init__( + 'Resource {}:{} not found'.format( + kind or "unknown", name or "unknown")) + + class ExistsAlready(IckException): def __init__(self, name): super().__init__('Resource {} already exists'.format(name)) +class Conflict(IckException): + + def __init__(self, rid, expected, got): + super().__init__( + 'Update conflict for {}: expected revision {}, got {}'.format( + rid, expected, got)) + + class BadUpdate(IckException): def __init__(self, how): diff --git a/ick2/persistent.py b/ick2/persistent.py deleted file mode 100644 index 33903fe..0000000 --- a/ick2/persistent.py +++ /dev/null @@ -1,66 +0,0 @@ -# Copyright (C) 2018-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 os -import urllib.parse - - -import yaml - - -import ick2 - - -class NotFound(Exception): # pragma: no cover - - def __init__(self, kind, name): - super().__init__( - 'Resource {}:{} not found'.format( - kind or "unknown", name or "unknown")) - - -class Resource: # pragma: no cover - - def __init__(self, as_dict=None): - self._dict = copy.deepcopy(as_dict or {}) - - def as_dict(self): - return copy.deepcopy(self._dict) - - def __getitem__(self, key): - return self._dict[key] - - def __setitem__(self, key, value): - self._dict[key] = value - - def __contains__(self, key): - return key in self._dict - - def __len__(self): - return len(self._dict) - - def get(self, key, default=None): - return self._dict.get(key, default) - - def from_dict(self, as_dict): - self._dict.clear() - for key in as_dict: - self[key] = as_dict[key] - - -def resource_from_dict(as_dict): # pragma: no cover - return Resource(as_dict) diff --git a/ick2/persistent_tests.py b/ick2/persistent_tests.py deleted file mode 100644 index 961742f..0000000 --- a/ick2/persistent_tests.py +++ /dev/null @@ -1,92 +0,0 @@ -# Copyright (C) 2018-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 PersistentStateTestsMixIn: - - def get_token(self): - raise NotImplementedError() - - def test_has_no_resources_initially(self): - token = self.get_token() - self.assertEqual(self.state.get_resource_names(token, 'silly'), []) - - def test_has_no_resource_initially(self): - token = self.get_token() - with self.assertRaises(ick2.NotFound): - self.state.get_resource(token, 'silly', '#1') - - def test_creates_resource(self): - as_dict = {'foo': 'bar'} - r = ick2.resource_from_dict(as_dict) - - token = self.get_token() - self.state.write_resource(token, 'silly', '#1', r) - self.assertTrue(self.state.has_resource(token, 'silly', '#1')) - self.assertEqual(self.state.get_resource_names(token, 'silly'), ['#1']) - - r2 = self.state.get_resource(token, 'silly', '#1') - self.assertTrue(isinstance(r2, ick2.Resource)) - self.assertEqual(r.as_dict(), r2.as_dict()) - - def test_updates_resource(self): - as_dict = {'foo': 'bar'} - r = ick2.resource_from_dict(as_dict) - - as_dict = {'foo': 'yo'} - r2 = ick2.resource_from_dict(as_dict) - - token = self.get_token() - self.state.write_resource(token, 'silly', '#1', r) - self.state.update_resource(token, 'silly', '#1', r2) - - self.assertTrue(self.state.has_resource(token, 'silly', '#1')) - self.assertEqual(self.state.get_resource_names(token, 'silly'), ['#1']) - - actual = self.state.get_resource(token, 'silly', '#1') - self.assertTrue(isinstance(actual, ick2.Resource)) - self.assertEqual(actual.as_dict(), r2.as_dict()) - - def test_removes_resource(self): - as_dict = {'foo': 'bar'} - r = ick2.resource_from_dict(as_dict) - - token = self.get_token() - self.state.write_resource(token, 'silly', '#1', r) - self.state.remove_resource(token, 'silly', '#1') - self.assertFalse(self.state.has_resource(token, 'silly', '#1')) - self.assertEqual(self.state.get_resource_names(token, 'silly'), []) - - def test_raises_error_removing_nonexistent_resource_kind(self): - token = self.get_token() - with self.assertRaises(ick2.NotFound): - self.state.remove_resource(token, 'silly', '#1') - - def test_raises_error_removing_nonexistent_resource(self): - as_dict = {'foo': 'bar'} - r = ick2.resource_from_dict(as_dict) - - token = self.get_token() - self.state.write_resource(token, 'silly', '#1', r) - with self.assertRaises(ick2.NotFound): - self.state.remove_resource(token, 'silly', '#2') diff --git a/ick2/resource.py b/ick2/resource.py new file mode 100644 index 0000000..ca02d30 --- /dev/null +++ b/ick2/resource.py @@ -0,0 +1,58 @@ +# Copyright (C) 2018-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 os +import urllib.parse + + +import yaml + + +import ick2 + + +class Resource: # pragma: no cover + + def __init__(self, as_dict=None): + self._dict = copy.deepcopy(as_dict or {}) + + def as_dict(self): + return copy.deepcopy(self._dict) + + def __getitem__(self, key): + return self._dict[key] + + def __setitem__(self, key, value): + self._dict[key] = value + + def __contains__(self, key): + return key in self._dict + + def __len__(self): + return len(self._dict) + + def get(self, key, default=None): + return self._dict.get(key, default) + + def from_dict(self, as_dict): + self._dict.clear() + for key in as_dict: + self[key] = as_dict[key] + + +def resource_from_dict(as_dict): # pragma: no cover + return Resource(as_dict) diff --git a/ick2/store.py b/ick2/store.py index 2d93daf..5c01f89 100644 --- a/ick2/store.py +++ b/ick2/store.py @@ -68,18 +68,10 @@ class MemoryStore(StoreInterface): 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) + raise ick2.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)) -- cgit v1.2.1