Add some better checking for parameters and properties

Signed-off-by: Angus Salkeld <asalkeld@redhat.com>

diff --git a/heat/engine/checkeddict.py b/heat/engine/checkeddict.py
new file mode 100644 (file)
index 0000000..30bbcaf
--- /dev/null
+++ b/heat/engine/checkeddict.py
@@ -0,0 +1,115 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+#
+#    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 collections
+import re
+
+
+class CheckedDict(collections.MutableMapping):
+
+    def __init__(self):
+        self.data = {}
+
+    def addschema(self, key, schema):
+        self.data[key] = schema
+
+    def get_attr(self, key, attr):
+        return self.data[key].get(attr, '')
+
+    def __setitem__(self, key, value):
+        '''Since this function gets called whenever we modify the
+        dictionary (object), we can (and do) validate those keys that we
+        know how to validate.
+        '''
+        def str_to_num(s):
+            try:
+                return int(s)
+            except ValueError:
+                return float(s)
+
+        if not key in self.data:
+            raise KeyError('key %s not found' % key)
+
+        if 'Type' in self.data[key]:
+            if self.data[key]['Type'] == 'String':
+                if not isinstance(value, (basestring, unicode)):
+                    raise ValueError('%s Value must be a string' % \
+                                     (key))
+                if 'MaxLength' in self.data[key]:
+                    if len(value) > int(self.data[key]['MaxLength']):
+                        raise ValueError('%s is too long; MaxLength %s' % \
+                                     (key, self.data[key]['MaxLength']))
+                if 'MinLength' in self.data[key]:
+                    if len(value) < int(self.data[key]['MinLength']):
+                        raise ValueError('%s is too short; MinLength  %s' % \
+                                     (key, self.data[key]['MinLength']))
+                if 'AllowedPattern' in self.data[key]:
+                    rc = re.match('^%s$' % self.data[key]['AllowedPattern'],
+                                  value)
+                    if rc == None:
+                        raise ValueError('Pattern does not match %s' % \
+                                     (key))
+
+            elif self.data[key]['Type'] == 'Number':
+                # just try convert to an int/float, it will throw a ValueError
+                num = str_to_num(value)
+                minn = num
+                maxn = num
+                if 'MaxValue' in self.data[key]:
+                    maxn = str_to_num(self.data[key]['MaxValue'])
+                if 'MinValue' in self.data[key]:
+                    minn = str_to_num(self.data[key]['MinValue'])
+                if num > maxn or num < minn:
+                    raise ValueError('%s is out of range' % key)
+
+            elif self.data[key]['Type'] == 'CommaDelimitedList':
+                sp = value.split(',')
+                if not isinstance(sp, list):
+                    raise ValueError('%s Value must be a list' % (key))
+
+        if 'AllowedValues' in self.data[key]:
+            if not value in self.data[key]['AllowedValues']:
+                raise ValueError('Value must be one of %s' % \
+                                 str(self.data[key]['AllowedValues']))
+
+        self.data[key]['Value'] = value
+
+    def __getitem__(self, key):
+        if not key in self.data:
+            raise KeyError('key %s not found' % key)
+
+        if 'Value' in self.data[key]:
+            return self.data[key]['Value']
+        elif 'Default' in self.data[key]:
+            return self.data[key]['Default']
+        elif 'Required' in self.data[key]:
+            if not self.data[key]['Required']:
+                return None
+            else:
+                raise ValueError('key %s has no value' % key)
+        else:
+            raise ValueError('key %s has no value' % key)
+
+    def __len__(self):
+        return len(self.data)
+
+    def __contains__(self, key):
+        return self.data.__contains__(key)
+
+    def __iter__(self):
+        return self.data.__iter__()
+
+    def __delitem__(self, k):
+        del self.data[k]

diff --git a/heat/tests/unit/test_checkeddict.py b/heat/tests/unit/test_checkeddict.py
new file mode 100644 (file)
index 0000000..9299602
--- /dev/null
+++ b/heat/tests/unit/test_checkeddict.py
@@ -0,0 +1,88 @@
+import sys
+import os
+
+import nose
+import unittest
+import mox
+import json
+
+from nose.plugins.attrib import attr
+from nose import with_setup
+
+from heat.engine import checkeddict
+
+
+@attr(tag=['unit', 'checkeddict'])
+@attr(speed='fast')
+class CheckedDictTest(unittest.TestCase):
+
+    def test_paramerters(self):
+        parms = '''
+{
+  "Parameters" : {
+    "TODOList" : {
+      "Description" : "stuff",
+      "Type" : "CommaDelimitedList"
+    },
+    "SomeNumber" : {
+      "Type" : "Number",
+      "Default" : "56",
+      "MaxValue": "6778",
+      "MinValue": "15.78"
+    },
+    "DBUsername": {
+      "Default": "admin",
+      "NoEcho": "true",
+      "Description" : "The WordPress database admin account username",
+      "Type": "String",
+      "MinLength": "1",
+      "MaxLength": "16",
+      "AllowedPattern" : "[a-zA-Z][a-zA-Z0-9]*",
+      "ConstraintDescription" : "begin with a letter & \
+          contain only alphanumeric characters."
+    },
+    "LinuxDistribution": {
+      "Default": "F16",
+      "Description" : "Distribution of choice",
+      "Type": "String",
+      "AllowedValues" : [ "F16", "F17", "U10", "RHEL-6.1", "RHEL-6.3" ]
+    }
+ }
+}
+'''
+        ps = json.loads(parms)
+        cd = checkeddict.CheckedDict()
+        for p in ps['Parameters']:
+            cd.addschema(p, ps['Parameters'][p])
+
+        # AllowedValues
+        self.assertRaises(ValueError, cd.__setitem__, 'LinuxDistribution',
+                          'f16')
+        # MaxLength
+        self.assertRaises(ValueError, cd.__setitem__, 'DBUsername',
+                          'Farstarststrststrstrstrst144')
+        # MinLength
+        self.assertRaises(ValueError, cd.__setitem__, 'DBUsername', '')
+        # AllowedPattern
+        self.assertRaises(ValueError, cd.__setitem__, 'DBUsername', '4me')
+
+        cd['DBUsername'] = 'wtf'
+        self.assertTrue(cd['DBUsername'] == 'wtf')
+        cd['LinuxDistribution'] = 'U10'
+        self.assertTrue(cd['LinuxDistribution'] == 'U10')
+
+        # int
+        cd['SomeNumber'] = '98'
+        self.assertTrue(cd['SomeNumber'] == '98')
+
+        # float
+        cd['SomeNumber'] = '54.345'
+        self.assertTrue(cd['SomeNumber'] == '54.345')
+
+        # not a num
+        self.assertRaises(ValueError, cd.__setitem__, 'SomeNumber', 'S8')
+        # range errors
+        self.assertRaises(ValueError, cd.__setitem__, 'SomeNumber', '8')
+        self.assertRaises(ValueError, cd.__setitem__, 'SomeNumber', '9048.56')
+        # lists
+        cd['TODOList'] = "'one', 'two', 'three'"