Synnefo » ./kamaki

# -*- coding: utf-8 -*-

# Copyright 2012 GRNET S.A. All rights reserved.

#

# Redistribution and use in source and binary forms, with or

# without modification, are permitted provided that the following

# conditions are met:

#

#   1. Redistributions of source code must retain the above

#      copyright notice, this list of conditions and the following

#      disclaimer.

#

#   2. Redistributions in binary form must reproduce the above

#      copyright notice, this list of conditions and the following

#      disclaimer in the documentation and/or other materials

#      provided with the distribution.

#

# THIS SOFTWARE IS PROVIDED BY GRNET S.A. ``AS IS'' AND ANY EXPRESS

# OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GRNET S.A OR

# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

# USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED

# AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN

# ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE

# POSSIBILITY OF SUCH DAMAGE.

#

# The views and conclusions contained in the software and

# documentation are those of the authors and should not be

# interpreted as representing official policies, either expressed

# or implied, of GRNET S.A.

from random import random, choice, randint

from math import log

from inspect import isclass

from kamaki.clients.commissioning.utils.argmap import (

    argmap_decode,

    argmap_check,

    argmap_unpack_dict,

    argmap_unpack_list)

try:

    from collections import OrderedDict

except ImportError:

    from kamaki.clients.commissioning.utils.ordereddict import OrderedDict

def shorts(s):

    if not isinstance(s, unicode):

        s = str(s)

    if len(s) <= 64:

        return s

    return s[:61] + '...'

class CanonifyException(Exception):

    pass

class SpecifyException(Exception):

    pass

class Canonical(object):

    _random_choice = None

    def __init__(self, *args, **kw):

        self.args = []

        named_args = []

        for a in args:

            if isinstance(a, tuple) and len(a) == 2:

                named_args.append(a)

            else:

                self.args.append(a)

        ordered_dict = OrderedDict(named_args)

        self.name = kw.pop('classname', self.__class__.__name__)

        random_choice = kw.pop('random', None)

        if random_choice is not None:

            self.random_choice = random_choice

        opts = {}

        for k, v in kw.items():

            if not isinstance(v, Canonical):

                if isclass(v) and issubclass(v, Canonical):

                    m = ("argument '%s': value '%s' is a Canonical _class_. "

                         "Perhaps you meant to specify a Canonical _instance_"

                         % (k, v))

                    raise SpecifyException(m)

                opts[k] = v

                del kw[k]

        self.opts = opts

        ordered_dict.update(kw)

        self.kw = ordered_dict

        self.init()

        if 'default' in opts:

            item = opts['default']

            if item is None:

                opts['null'] = 1

            else:

                opts['default'] = self._check(item)

    def init(self):

        return

    def __call__(self, item):

        return self.check(item)

    def check(self, item):

        if argmap_check(item):

            item = self._unpack(item)

        opts = self.opts

        if item is None and 'default' in opts:

            item = opts['default']

        can_be_null = opts.get('null', False)

        if item is None and can_be_null:

            return None

        return self._check(item)

    def _check(self, item):

        return item

    def _unpack(self, item):

        return argmap_unpack_list(item)

    def create(self):

        return None

    def random(self, **kw):

        random_choice = self._random_choice

        if random_choice is None:

            return None

        if callable(random_choice):

            return random_choice(kw)

        if isinstance(random_choice, str):

            return getattr(self, random_choice)(kw)

        return choice(random_choice)

    def tostring(self, depth=0, showopts=0, multiline=0):

        depth += 1

        if not multiline:

            argdepth = ''

            owndepth = ''

            joinchar = ','

            padchar = ''

        else:

            argdepth = '    ' * depth

            owndepth = '    ' * (depth - 1)

            joinchar = ',\n'

            padchar = '\n'

        args = [a.tostring(

                    depth=depth,

                    showopts=showopts,

                    multiline=multiline) for a in self.args]

        args += [("%s=%s" % (k, v.tostring(

                                depth=depth,

                                showopts=showopts,

                                multiline=multiline)))

                            for k, v in self.kw.items()]

        if showopts:

            args += [("%s=%s" % (k, str(v))) for k, v in self.opts.items()]

        if len(args) == 0:

            string = "%s(%s)" % (self.name, ','.join(args))

        else:

            string = "%s(%s" % (self.name, padchar)

            for arg in args:

                string += argdepth + arg + joinchar

            string = string[:-1] + padchar

            string += owndepth + ")"

        return string

    __str__ = tostring

    def __repr__(self):

        return self.tostring(multiline=0, showopts=1)

    def show(self):

        showable = self.opts.get('show', True)

        return self._show() if showable else ''

    def _show(self):

        return self.name

class Null(Canonical):

    def _check(self, item):

        return None

Nothing = Null()

class Integer(Canonical):

    def _check(self, item):

        try:

            num = long(item)

        except ValueError:

            try:

                num = long(item, 16)

            except Exception:

                m = "%s: cannot convert '%s' to long" % (self, shorts(item))

                raise CanonifyException(m)

        except TypeError:

            m = "%s: cannot convert '%s' to long" % (self, shorts(item))

            raise CanonifyException(m)

        optget = self.opts.get

        minimum = optget('minimum', None)

        maximum = optget('maximum', None)

        if minimum is not None and num < minimum:

            m = "%s: %d < minimum=%d" % (self, num, minimum)

            raise CanonifyException(m)

        if maximum is not None and num > maximum:

            m = "%s: %d > maximum=%d" % (self, num, maximum)

            raise CanonifyException(m)

        return num

    def _random_choice(self, kw):

        optget = self.opts.get

        kwget = kw.get

        minimum = kwget('minimum', optget('minimum', -4294967296L))

        maximum = kwget('maximum', optget('maximum', 4294967295L))

        r = random()

        if r < 0.1:

            return minimum

        if r < 0.2:

            return maximum

        if minimum <= 0 and maximum >= 0 and r < 0.3:

            return 0L

        return long(minimum + r * (maximum - minimum))

Serial = Integer(classname='Serial', null=True)

class Text(Canonical):

    re = None

    matcher = None

    choices = None

    def init(self):

        opts = self.opts

        if 'regex' in opts:

            pat = opts['regex']

            re = self.re

            if re is None:

                import re

                self.re = re

            self.matcher = re.compile(pat, re.UNICODE)

            self.pat = pat

        if 'choices' in opts:

            opts['choices'] = dict((unicode(x), unicode(x))

                                    for x in opts['choices'])

    def _check(self, item):

        if not isinstance(item, unicode):

            # require non-unicode items to be utf8

            item = str(item)

            try:

                item = item.decode('utf8')

            except UnicodeDecodeError, e:

                item = item.decode('latin1')

                m = "%s: non-unicode '%s' is not utf8" % (self, shorts(item))

                raise CanonifyException(m)

        opts = self.opts

        if 'choices' in opts:

            choices = opts['choices']

            try:

                unknown = item not in choices

            except TypeError, e:

                m = "%s: unhashable type '%s'" % (self.name, shorts(item))

                raise CanonifyException(m, e)

            if unknown:

                m = "%s: '%s' not in choices" % (self.name, shorts(item))

                raise CanonifyException(m)

            return choices[item]

        optget = opts.get

        itemlen = len(item)

        maxlen = optget('maxlen', None)

        if maxlen is not None and itemlen > maxlen:

            m = "%s: len('%s') > maxlen=%d" % (self, shorts(item), maxlen)

            raise CanonifyException(m)

        minlen = optget('minlen', None)

        if minlen is not None and itemlen < minlen:

            m = "%s: len('%s') < minlen=%d" % (self, shorts(item), minlen)

            raise CanonifyException(m)

        matcher = self.matcher

        if matcher is not None:

            match = matcher.match(item)

            if ((not match) or (match.start(), match.end()) != (0, itemlen)):

                    m = ("%s: '%s' does not match '%s'"

                            % (self, shorts(item), self.pat))

                    raise CanonifyException(m)

        return item

    default_alphabet = '0123456789αβγδεζ'.decode('utf8')

    def _random_choice(self, kw):

        opts = self.opts

        if 'regex' in opts:

            m = 'Unfortunately, random for regex strings not supported'

            raise ValueError(m)

        optget = opts.get

        kwget = kw.get

        minlen = kwget('minlen', optget('minlen', 0))

        maxlen = kwget('maxlen', optget('maxlen', 32))

        alphabet = kwget('alphabet', self.default_alphabet)

        z = maxlen - minlen

        if z < 1:

            z = 1

        g = log(z, 2)

        r = random() * g

        z = minlen + int(2 ** r)

        s = u''

        for _ in xrange(z):

            s += choice(alphabet)

        return s

class Bytes(Canonical):

    re = None

    matcher = None

    choices = None

    def init(self):

        opts = self.opts

        if 'regex' in opts:

            pat = opts['regex']

            re = self.re

            if re is None:

                import re

                self.re = re

            self.matcher = re.compile(pat)

            self.pat = pat

        if 'choices' in opts:

            opts['choices'] = dict((str(x), str(x))

                                    for x in opts['choices'])

    def _check(self, item):

        if isinstance(item, unicode):

            # convert unicode to utf8

            item = item.encode('utf8')

        opts = self.opts

        if 'choices' in opts:

            choices = opts['choices']

            try:

                unknown = item not in choices

            except TypeError, e:

                m = "%s: unhashable type '%s'" % (self.name, shorts(item))

                raise CanonifyException(m, e)

            if unknown:

                m = "%s: '%s' not in choices" % (self.name, shorts(item))

                raise CanonifyException(m)

            return choices[item]

        optget = opts.get

        itemlen = len(item)

        maxlen = optget('maxlen', None)

        if maxlen is not None and itemlen > maxlen:

            m = "%s: len('%s') > maxlen=%d" % (self, shorts(item), maxlen)

            raise CanonifyException(m)

        minlen = optget('minlen', None)

        if minlen is not None and itemlen < minlen:

            m = "%s: len('%s') < minlen=%d" % (self, shorts(item), minlen)

            raise CanonifyException(m)

        matcher = self.matcher

        if matcher is not None:

            match = matcher.match(item)

            if ((not match) or (match.start(), match.end()) != (0, itemlen)):

                    m = ("%s: '%s' does not match '%s'"

                            % (self, shorts(item), self.pat))

                    raise CanonifyException(m)

        return item

    default_alphabet = '0123456789abcdef'

    def _random_choice(self, kw):

        opts = self.opts

        if 'regex' in opts:

            m = 'Unfortunately, random for regex strings not supported'

            raise ValueError(m)

        optget = opts.get

        kwget = kw.get

        minlen = kwget('minlen', optget('minlen', 0))

        maxlen = kwget('maxlen', optget('maxlen', 32))

        alphabet = kwget('alphabet', self.default_alphabet)

        z = maxlen - minlen

        if z < 1:

            z = 1

        g = log(z, 2)

        r = random() * g

        z = minlen + int(2 ** r)

        s = u''

        for _ in xrange(z):

            s += choice(alphabet)

        return s

class ListOf(Canonical):

    def init(self):

        args = self.args

        kw = self.kw

        if not (args or kw):

            raise SpecifyException("ListOf requires one or more arguments")

        if args and kw:

            m = ("ListOf requires either positional "

                 "or keyword arguments, but not both")

            raise SpecifyException(m)

        if args:

            if len(args) > 1:

                self.canonical = Tuple(*args)

            else:

                self.canonical = args[0]

        else:

            self.canonical = Args(**kw)

    def _check(self, item):

        if item is None:

            item = ()

        try:

            items = iter(item)

        except TypeError:

            m = "%s: %s is not iterable" % (self, shorts(item))

            raise CanonifyException(m)

        canonical = self.canonical

        canonified = []

        append = canonified.append

        for item in items:

            item = canonical(item)

            append(item)

        if not canonified and self.opts.get('nonempty', False):

            m = "%s: must be nonempty" % (self,)

            raise CanonifyException(m)

        return canonified

    def _random_choice(self, kw):

        z = randint(1, 4)

        get_random = self.canonical.random

        return [get_random() for _ in xrange(z)]

    def _show(self):

        return '[ ' + self.canonical.show() + ' ... ]'

class Args(Canonical):

    def _unpack(self, item):

        arglist = argmap_unpack_dict(item)

        keys = self.kw.keys()

        arglen = len(arglist)

        if arglen != len(keys):

            m = "inconsistent number of parameters: %s != %s" % (

            arglen, len(keys))

            raise CanonifyException(m)

        position = 0

        named_args = OrderedDict()

        for k, v in arglist:

            if k is not None:

                named_args[k] = v

            else:

                # find the right position

                for i in range(position, arglen):

                    key = keys[i]

                    if not key in named_args.keys():

                        position = i + 1

                        break

                else:

                    m = "Formal arguments exhausted"

                    raise AssertionError(m)

                named_args[key] = v

        return named_args

    def _check(self, item):

        try:

            OrderedDict(item).items()

        except (TypeError, ValueError):

            m = "%s: %s is not dict-able" % (self, shorts(item))

            raise CanonifyException(m)

        canonified = OrderedDict()

        try:

            for n, c in self.kw.items():

                t = item[n] if n in item else None

                canonified[n] = c.check(t)

        except KeyError:

            m = ("%s: Argument '%s' not found in '%s'"

                 % (self, shorts(n), shorts(item)))

            raise CanonifyException(m)

        return canonified

    def _show(self):

        strings = [x for x in [c.show() for n, c in self.kw.items()] if x]

        return ' '.join(strings)

    def _random_choice(self, kw):

        args = {}

        for n, c in self.kw.items():

            args[n] = c.random()

        return args

class Tuple(Canonical):

    def _check(self, item):

        try:

            items = list(item)

        except TypeError:

            m = "%s: %s is not iterable" % (self, shorts(item))

            raise CanonifyException(m)

        canonicals = self.args

        zi = len(items)

        zc = len(canonicals)

        if zi != zc:

            m = "%s: expecting %d elements, not %d (%s)" % (

                self,

                zc,

                zi,

                str(items))

            raise CanonifyException(m)

        g = (canonical(element) for canonical, element in zip(self.args, item))

        return tuple(g)

    def __add__(self, other):

        oargs = other.args if isinstance(other, Tuple) else (other,)

        args = self.args + oargs

        return self.__class__(*args)

    def _random_choice(self, kw):

        return tuple(c.random() for c in self.args)

    def _show(self):

        canonicals = self.args

        strings = [x for x in [c.show() for c in canonicals] if x]

        return '[ ' + ' '.join(strings) + ' ]'

class Dict(Canonical):

    def _check(self, item):

        try:

            item = dict(item)

        except TypeError:

            m = "%s: '%s' is not dict-able" % (self, shorts(item))

            raise CanonifyException(m)

        canonified = {}

        canonical = self.kw

        for n, c in canonical.items():

            if n not in item:

                m = "%s: key '%s' not found" % (self, shorts(n))

                raise CanonifyException(m)

            canonified[n] = c(item[n])

        strict = self.opts.get('strict', True)

        if strict and len(item) != len(canonical):

            for k in sorted(item.keys()):

                if k not in canonical:

                    break

            m = "%s: unexpected key '%s' (strict mode)" % (self, shorts(k))

            raise CanonifyException(m)

        return canonified

    def _random_choice(self, kw):

        item = {}

        for n, c in self.kw.items():

            item[n] = c.random()

        return item

class Canonifier(object):

    def __init__(self, name, input_canonicals, output_canonicals, doc_strings):

        self.name = name

        self.input_canonicals = dict(input_canonicals)

        self.output_canonicals = dict(output_canonicals)

        self.doc_strings = dict(doc_strings)

    def call_names(self):

        return self.input_canonicals.keys()

    def call_docs(self):

        get_input_canonical = self.input_canonical

        for call_name, call_doc in self.doc_strings.iteritems():

            if not call_doc:

                canonical = get_input_canonical(call_name)

                call_doc = canonical.tostring(showopts=1, multiline=1)

            yield call_name, call_doc

    def get_doc(self, name):

        doc_strings = self.doc_strings

        if name not in doc_strings:

            m = "%s: Invalid method name '%s'" % (self.name, name)

            raise CanonifyException(m)

        docstring = doc_strings[name]

        if not docstring:

            docstring = self.input_canonical(name).tostring()

        return docstring

    def call_attrs(self):

        for call_name, canonical in self.input_canonicals.iteritems():

            yield call_name, canonical.tostring(showopts=1, multiline=1)

    def input_canonical(self, name):

        input_canonicals = self.input_canonicals

        if name not in input_canonicals:

            m = "%s: Invalid input call '%s'" % (self.name, name)

            raise CanonifyException(m)

        return input_canonicals[name]

    def canonify_input(self, name, the_input):

        return self.input_canonical(name)(the_input)

    def output_canonical(self, name):

        output_canonicals = self.output_canonicals

        if name not in output_canonicals:

            m = "%s: Output canonical '%s' does not exist" % (self.name, name)

            raise CanonifyException(m)

        return output_canonicals[name]

    def canonify_output(self, name, the_output):

        return self.output_canonical(name)(the_output)

    def show_input_canonical(self, name):

        return self.input_canonical(name).show()

    def parse(self, method, arglist):

        args, rest = argmap_decode(arglist)

        return self.input_canonical(method).check(args)

class Specificator(object):

    def __new__(cls):

        if cls is Specificator:

            m = "Specificator classes must be subclassed"

            raise SpecifyException(m)

        import inspect

        canonical_inputs = {}

        canonical_outputs = {}

        doc_strings = {}

        for name in dir(cls):

            f = getattr(cls, name)

            if not inspect.ismethod(f) or f.__name__.startswith('_'):

                continue

            doc_strings[name] = f.__doc__

            argspec = inspect.getargspec(f)

            defaults = argspec.defaults

            args = argspec.args

            if args and args[0] == 'self':

                args = args[1:]

            if not defaults:

                defaults = ()

            arglen = len(args)

            deflen = len(defaults)

            if arglen != deflen:

                a = (f.__name__, args[:arglen - deflen])

                m = "Unspecified arguments in '%s': %s" % a

                raise SpecifyException(m)

            args = zip(args, defaults)

            for a, c in args:

                if not isinstance(c, Canonical):

                    m = ("argument '%s=%s' is not an instance of 'Canonical'"

                         % (a, repr(c)))

                    raise SpecifyException(m)

            canonical = Null() if len(args) == 0 else Args(*args)

            canonical_inputs[name] = canonical

            self = object.__new__(cls)

            canonical = f(self)

            if not isinstance(canonical, Canonical):

                m = ("method '%s' does not return a Canonical, but a(n) %s "

                                                    % (name, type(canonical)))

                raise SpecifyException(m)

            canonical_outputs[name] = canonical

        return Canonifier(cls.__name__, canonical_inputs, canonical_outputs,

                          doc_strings)

    def __call__(self):

        return self