Synnefo » ./kamaki

from kamaki.clients.utils.test import Utils

# Copyright 2011-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.

def _matches(val1, val2, exactMath=True):

    """Case Insensitive match"""

    return (val1.lower() == val2.lower()) if (

        exactMath) else val1.lower().startswith(val2.lower())

def filter_out(d, prefix, exactMatch=False):

    """Remove entries that are prefixed with prefix (case insensitive)

    :param d: (dict) input

    :param prefix: (str) prefix to match input keys against

    :param exactMatch: (bool) key should fully match if True, just prefixed

        with prefix if False

    :returns: (dict) the updated d

    """

    ret = dict()

    for key, val in d.items():

        if not _matches(key, prefix, exactMath=exactMatch):

            ret[key] = val

    return ret

def filter_in(d, prefix, exactMatch=False):

    """Keep only entries of d prefixed with prefix

    :param d: (dict) input

    :param prefix: (str) prefix to match input keys against

    :param exactMatch: (bool) key should fully match if True, just prefixed

        with prefix if False

    :returns: (dict) the updated d

    """

    ret = dict()

    for key, val in d.items():

        if _matches(key, prefix, exactMath=exactMatch):

            ret[key] = val

    return ret

def path4url(*args):

    """

    :param args: (list of str)

    :returns: (str) a path in the form /args[0]/args[1]/...

    """

    r = '/'.join([''] + [arg.decode('utf-8') if (

        isinstance(arg, str)) else '%s' % arg for arg in args])

    while '//' in r:

        r = r.replace('//', '/')

    return ('/%s' % r.strip('/')) if r else ''

def params4url(params):

    """{'key1':'val1', 'key2':None, 'key3':15} --> "?key1=val1&key2&key3=15"

    :param params: (dict) request parameters in the form key:val

    :returns: (str) http-request friendly in the form ?key1=val1&key2=val2&...

    """

    assert(type(params) is dict)

    result = ''

    dlmtr = '?'

    for name in params:

        result += '%s%s' % (dlmtr, name)

        result += '=%s' % params[name] or result

        dlmtr = '&'

    return result

# Copyright 2013 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 mock import patch, call

from unittest import TestCase

from kamaki.clients import utils

def _try(assertfoo, foo, *args):

    try:

        return assertfoo(foo(*args))

    except AssertionError:

        argstr = '( '

        for arg in args:

            argstr += '"%s" ' % arg

        argstr += ')'

        print('::: Method %s failed with args %s' % (foo, argstr))

        raise

filter_examples = [

    ('', dict(), dict(), dict()),

    (

        'key',

        dict(key1='v1', key2='v2', v=dict(key='v'), val1='k1', val2='k2'),

        dict(key1='v1', key2='v2'),

        dict(v=dict(key='v'), val1='k1', val2='k2')),

    (

        'val',

        dict(key1='v1', key2='v2', val=dict(key='v'), val1='k1', val2='k2'),

        dict(val1='k1', val2='k2', val=dict(key='v')),

        dict(key1='v1', key2='v2')),

    (

        'kv',

        dict(kvm='in', mkv='out', kv=''),

        dict(kvm='in', kv=''),

        dict(mkv='out'))]

class Utils(TestCase):

    def assert_dicts_are_equal(self, d1, d2):

        for k, v in d1.items():

            self.assertTrue(k in d2)

            if isinstance(v, dict):

                self.assert_dicts_are_equal(v, d2[k])

            else:

                self.assertEqual(unicode(v), unicode(d2[k]))

    def setUp(self):

        pass

    def tearDown(self):

        pass

    def test__matches(self):

        for args in (

                ('example', 'example'), ('example', 'example', True),

                ('example', 'example', False), ('example0', 'example', False),

                ('example', '', False), ('', ''),

                ('', '', True), ('', '', False)):

            _try(self.assertTrue, utils._matches, *args)

        for args in (

                ('', 'example'), ('example', ''),

                ('example', 'example0'), ('example0', 'example'),

                ('example', 'example0', True), ('example', 'example0', False),

                ('example0', 'example'), ('example0', 'example', True)):

            _try(self.assertFalse, utils._matches, *args)

    def test_filter_out(self):

        for key, src, exp_in, exp_out in filter_examples:

            r = utils.filter_out(src, key)

            self.assert_dicts_are_equal(r, exp_out)

            for k in exp_in:

                self.assertFalse(k in r)

            r = utils.filter_out(src, key, True)

            if key in src:

                expected = dict(src)

                expected.pop(key)

                self.assert_dicts_are_equal(r, expected)

            else:

                self.assert_dicts_are_equal(r, src)

    def test_filter_in(self):

        for key, src, exp_in, exp_out in filter_examples:

            r = utils.filter_in(src, key)

            self.assert_dicts_are_equal(r, exp_in)

            for k in exp_out:

                self.assertFalse(k in r)

            r = utils.filter_in(src, key, True)

            if key in src:

                self.assert_dicts_are_equal(r, {key: src[key]})

            else:

                self.assert_dicts_are_equal(r, dict())

if __name__ == '__main__':

    from sys import argv

    from kamaki.clients.test import runTestCase

    runTestCase(Utils, 'clients.utils methods', argv[1:])

        'kamaki.clients.utils',