dragonflow/dragonflow/tests/unit/test_redis_db.py

# Copyright (c) 2015 OpenStack Foundation.
# All Rights Reserved.
#
#    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 mock

from dragonflow.common import exceptions
from dragonflow.db.drivers import redis_db_driver
from dragonflow.tests import base as tests_base


class TestRedisDB(tests_base.BaseTestCase):

    def setUp(self):
        super(TestRedisDB, self).setUp()
        self.RedisDbDriver = redis_db_driver.RedisDbDriver()

    def test_set_key(self):
        client = mock.Mock()
        self.RedisDbDriver._get_client = mock.Mock(return_value=client)
        client.execute_command.return_value = 1
        redis_mgt = mock.Mock()
        redis_mgt.get_ip_by_key.return_value = '0.0.0.0:1000'
        self.RedisDbDriver.redis_mgt = redis_mgt
        result = self.RedisDbDriver.set_key('table', 'key', 'value', 'topic')
        self.assertEqual(1, result)

        client.execute_command.return_value = None
        result = self.RedisDbDriver.set_key('table', 'key', 'value', 'topic')
        self.assertEqual(0, result)

    def test_get_method(self):
        client = mock.Mock()
        self.RedisDbDriver._get_client = mock.Mock(return_value=client)
        self.RedisDbDriver._sync_master_list = mock.Mock()
        self.RedisDbDriver.clients[0] = client
        client.keys.return_value = ['a']
        client.mget.return_value = ['value']
        client.execute_command.return_value = 'value'
        redis_mgt = mock.Mock()
        self.RedisDbDriver.redis_mgt = redis_mgt
        redis_mgt.get_ip_by_key.return_value = '0.0.0.0:1000'

        # test get_key
        result = self.RedisDbDriver.get_key('table', 'key')
        self.assertEqual('value', result)
        redis_mgt.get_ip_by_key.assert_called_with('a')

        result = self.RedisDbDriver.get_key('table', 'key', '')
        self.assertEqual('value', result)
        redis_mgt.get_ip_by_key.assert_called_with('a')

        result = self.RedisDbDriver.get_key('table', 'key', 'topic')
        self.assertEqual('value', result)
        local_key = '{table.topic}.key'
        redis_mgt.get_ip_by_key.assert_called_with(local_key)

        with mock.patch(
            'dragonflow.db.drivers.redis_db_driver.RedisDbDriver._execute_cmd',
            return_value=None,
        ):
            self.assertRaises(
                exceptions.DBKeyNotFound,
                self.RedisDbDriver.get_key,
                'table', 'key', 'topic',
            )

        with mock.patch(
            'dragonflow.db.drivers.redis_db_driver.RedisDbDriver._execute_cmd',
            side_effect=RuntimeError,
        ):
            self.assertRaises(
                exceptions.DBKeyNotFound,
                self.RedisDbDriver.get_key,
                'table', 'key', 'topic',
            )

        # test get_all_entries
        result = self.RedisDbDriver.get_all_entries('table')
        self.assertEqual(['value'], result)
        redis_mgt.get_ip_by_key.assert_called_with('a')

        result = self.RedisDbDriver.get_all_entries('table', '')
        self.assertEqual(['value'], result)
        redis_mgt.get_ip_by_key.assert_called_with('a')

        result = self.RedisDbDriver.get_all_entries('table', 'topic')
        self.assertEqual(['value'], result)
        local_key = '{table.topic}.*'
        redis_mgt.get_ip_by_key.assert_called_with(local_key)

        # test get_all_key
        client.keys.return_value = ['{table.*}.key']
        result = self.RedisDbDriver.get_all_keys('table')
        self.assertEqual(['key'], result)
        local_key = '{table.*}.*'
        client.keys.assert_called_with(local_key)

        result = self.RedisDbDriver.get_all_keys('table', '')
        self.assertEqual(['key'], result)
        client.keys.assert_called_with(local_key)

        result = self.RedisDbDriver.get_all_keys('table', 'topic')
        self.assertEqual(['key'], result)
        local_key = '{table.topic}.*'
        redis_mgt.get_ip_by_key.assert_called_with(local_key)

    def test_delete_key(self):
        client = mock.Mock()
        self.RedisDbDriver._get_client = mock.Mock(return_value=client)
        client.execute_command.return_value = 1
        redis_mgt = mock.Mock()
        self.RedisDbDriver.redis_mgt = redis_mgt
        redis_mgt.get_ip_by_key.return_value = '0.0.0.0:1000'
        result = self.RedisDbDriver.delete_key('table', 'key', 'topic')
        self.assertEqual(1, result)

        client.execute_command.return_value = None
        result = self.RedisDbDriver.delete_key('table', 'key', 'topic')
        self.assertEqual(0, result)

    def test_allocate_unique_key(self):
        client = mock.Mock()
        self.RedisDbDriver._update_client = mock.Mock(return_value=client)
        client.incr.return_value = 1
        result = self.RedisDbDriver.allocate_unique_key('fake_table')
        self.assertEqual(1, result)