summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJ08nY2017-07-27 00:36:17 +0200
committerJ08nY2017-07-27 00:36:17 +0200
commit7db8f0e3df2bdabe0b7a08a6dde7ebd3ecd7c5e7 (patch)
tree589e1bbdf72149f79a1bb2e5cfe9d7be6e9fd318 /src
parent2bfd77342291d9713a3bbbbf27ba0c5e8049ee45 (diff)
downloadmailman-pgp-7db8f0e3df2bdabe0b7a08a6dde7ebd3ecd7c5e7.tar.gz
mailman-pgp-7db8f0e3df2bdabe0b7a08a6dde7ebd3ecd7c5e7.tar.zst
mailman-pgp-7db8f0e3df2bdabe0b7a08a6dde7ebd3ecd7c5e7.zip
Diffstat (limited to 'src')
-rw-r--r--src/mailman_pgp/config/__init__.py13
-rw-r--r--src/mailman_pgp/config/schema.cfg47
-rw-r--r--src/mailman_pgp/config/tests/test_validator.py104
-rw-r--r--src/mailman_pgp/config/validator.py67
-rw-r--r--src/mailman_pgp/testing/layers.py1
5 files changed, 232 insertions, 0 deletions
diff --git a/src/mailman_pgp/config/__init__.py b/src/mailman_pgp/config/__init__.py
index fcf5e55..f1d7249 100644
--- a/src/mailman_pgp/config/__init__.py
+++ b/src/mailman_pgp/config/__init__.py
@@ -21,8 +21,11 @@ from configparser import ConfigParser
from mailman.config import config as mailman_config
from mailman.utilities.modules import expand_path
+from pkg_resources import resource_string
from public.public import public
+from mailman_pgp.config.validator import ConfigValidator
+
@public
class Config(ConfigParser):
@@ -38,6 +41,16 @@ class Config(ConfigParser):
self.name = name
self.read(expand_path(
dict(mailman_config.plugin_configs)[self.name].configuration))
+ self.validate()
+
+ def validate(self):
+ """
+
+ """
+ validator = ConfigValidator(
+ resource_string('mailman_pgp.config',
+ 'schema.cfg').decode('utf-8'))
+ validator.validate(self)
config = Config()
diff --git a/src/mailman_pgp/config/schema.cfg b/src/mailman_pgp/config/schema.cfg
new file mode 100644
index 0000000..085ab0a
--- /dev/null
+++ b/src/mailman_pgp/config/schema.cfg
@@ -0,0 +1,47 @@
+# Copyright (C) 2017 Jan Jancar
+#
+# This file is a part of the Mailman PGP plugin.
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU 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 General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <http://www.gnu.org/licenses/>.
+
+# Schema of the mailman_pgp config.
+
+[db]
+url: pathlib.Path
+
+
+[keydirs]
+user_keydir: pathlib.Path
+
+list_keydir: pathlib.Path
+
+archive_keydir: pathlib.Path
+
+
+[keypairs]
+autogenerate: lazr.config.as_boolean
+
+primary_key: ((RSA|DSA):\d{3,4}|ECDSA:(nistp256|nistp384|nistp521|brainpoolP256r1|brainpoolP384r1|brainpoolP512r1|secp256k1))
+
+sub_key: (RSA:\d{3,4}|ECDH:(nistp256|nistp384|nistp521|brainpoolP256r1|brainpoolP384r1|brainpoolP512r1|secp256k1))
+
+shred: lazr.config.as_boolean
+
+
+[queues]
+in: str
+
+
+[misc]
+change_request_lifetime: lazr.config.as_timedelta
diff --git a/src/mailman_pgp/config/tests/test_validator.py b/src/mailman_pgp/config/tests/test_validator.py
new file mode 100644
index 0000000..44ee497
--- /dev/null
+++ b/src/mailman_pgp/config/tests/test_validator.py
@@ -0,0 +1,104 @@
+# Copyright (C) 2017 Jan Jancar
+#
+# This file is a part of the Mailman PGP plugin.
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU 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 General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <http://www.gnu.org/licenses/>.
+
+""""""
+from unittest import TestCase
+
+from pkg_resources import resource_string, resource_filename
+
+from mailman_pgp.config import ConfigValidator, Config
+from mailman_pgp.testing.layers import PGPLayer
+
+
+class TestConfigs(TestCase):
+ layer = PGPLayer
+
+ def setUp(self):
+ self.validator = ConfigValidator(
+ resource_string('mailman_pgp.config',
+ 'schema.cfg').decode('utf-8'))
+
+ def test_default_config(self):
+ cfg = Config()
+ cfg.read(resource_filename('mailman_pgp.config', 'mailman_pgp.cfg'))
+ self.validator.validate(cfg)
+
+ def test_testing_config(self):
+ cfg = Config()
+ cfg.read(resource_filename('mailman_pgp.testing', 'mailman_pgp.cfg'))
+ self.validator.validate(cfg)
+
+
+class TestValidator(TestCase):
+ layer = PGPLayer
+
+ def test_builtins(self):
+ schema = """\
+ [test]
+ test_option: int
+ """
+ validator = ConfigValidator(schema)
+ valid = Config()
+ valid.read_string("""\
+ [test]
+ test_option: 5
+ """)
+ invalid = Config()
+ invalid.read_string("""\
+ [test]
+ test_option: xyz
+ """)
+ validator.validate(valid)
+ self.assertRaises(ValueError, validator.validate, invalid)
+
+ def test_callable(self):
+ schema = """\
+ [test]
+ test_option: lazr.config.as_boolean
+ """
+ validator = ConfigValidator(schema)
+ valid = Config()
+ valid.read_string("""\
+ [test]
+ test_option: yes
+ """)
+ invalid = Config()
+ invalid.read_string("""\
+ [test]
+ test_option: xyz
+ """)
+ validator.validate(valid)
+ self.assertRaises(ValueError, validator.validate, invalid)
+
+ def test_regex(self):
+ schema = """\
+ [test]
+ test_option: 29*4
+ """
+ validator = ConfigValidator(schema)
+ valid = Config()
+ valid.read_string("""\
+ [test]
+ test_option: 2999999994
+ """)
+ invalid = Config()
+ invalid.read_string("""\
+ [test]
+ test_option: xyz
+ """)
+ validator.validate(valid)
+ self.assertRaises(ValueError, validator.validate, invalid)
diff --git a/src/mailman_pgp/config/validator.py b/src/mailman_pgp/config/validator.py
new file mode 100644
index 0000000..a232e0e
--- /dev/null
+++ b/src/mailman_pgp/config/validator.py
@@ -0,0 +1,67 @@
+# Copyright (C) 2017 Jan Jancar
+#
+# This file is a part of the Mailman PGP plugin.
+#
+# This program is free software; you can redistribute it and/or modify it under
+# the terms of the GNU 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 General Public License for
+# more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <http://www.gnu.org/licenses/>.
+
+""""""
+import re
+from configparser import ConfigParser
+from mailman.utilities.modules import find_name
+import builtins
+
+class ConfigValidator:
+ """"""
+
+ def __init__(self, schema):
+ self.schema = ConfigParser()
+ self.schema.read_string(schema)
+
+ def validate(self, cfg):
+ """
+
+ :param cfg:
+ :type cfg: ConfigParser
+ """
+ for section in self.schema.sections():
+ assert cfg.has_section(section)
+ for option in self.schema.options(section):
+ assert cfg.has_option(section, option)
+ self._check_option(cfg.get(section, option),
+ self.schema.get(section, option))
+
+ def _check_option(self, value, schema):
+ call = None
+ try:
+ call = getattr(builtins, schema)
+ except:
+ try:
+ call = find_name(schema)
+ except:
+ try:
+ def call(value):
+ match = re.search(schema, value)
+ if match is None:
+ raise ValueError
+ return match
+ except:
+ pass
+
+ if call is None:
+ raise ValueError
+ else:
+ return call(value)
+
+
+
diff --git a/src/mailman_pgp/testing/layers.py b/src/mailman_pgp/testing/layers.py
index 34f6b1a..29a5c1d 100644
--- a/src/mailman_pgp/testing/layers.py
+++ b/src/mailman_pgp/testing/layers.py
@@ -63,6 +63,7 @@ def reset_pgp_soft():
class PGPLayer:
pass
+
# It's weird that ws have to do this, but for some reason nose2 test layers
# don't work when ws create a mixin class with the two classmethods
# and subclass both it and the respective Mailman Core test layer.