ricsdl-package/tests/backend/test_fake_dict_db.py

   1 # Copyright (c) 2019 AT&T Intellectual Property.
   2 # Copyright (c) 2018-2019 Nokia.
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 #     http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13 # See the License for the specific language governing permissions and
  14 # limitations under the License.
  15
  16 #
  17 # This source code is part of the near-RT RIC (RAN Intelligent Controller)
  18 # platform project (RICP).
  19 #
  20
  21
  22 from unittest.mock import Mock
  23 import pytest
  24 import ricsdl.backend
  25 from ricsdl.configuration import _Configuration
  26 from ricsdl.configuration import DbBackendType
  27
  28
  29 @pytest.fixture()
  30 def fake_dict_backend_fixture(request):
  31     request.cls.ns = 'some-ns'
  32     request.cls.dm = {'abc': b'1', 'bcd': b'2'}
  33     request.cls.new_dm = {'abc': b'3', 'bcd': b'2'}
  34     request.cls.remove_dm = {'bcd': b'2'}
  35     request.cls.key = 'abc'
  36     request.cls.keys = ['abc', 'bcd']
  37     request.cls.old_data = b'1'
  38     request.cls.new_data = b'3'
  39     request.cls.keypattern = r'*bc*'
  40     request.cls.group = 'some-group'
  41     request.cls.groupmember = b'm1'
  42     request.cls.groupmembers = set([b'm1', b'm2'])
  43     request.cls.new_groupmembers = set(b'm3')
  44     request.cls.all_groupmembers = request.cls.groupmembers | request.cls.new_groupmembers
  45
  46     request.cls.configuration = Mock()
  47     mock_conf_params = _Configuration.Params(db_host=None,
  48                                              db_port=None,
  49                                              db_sentinel_port=None,
  50                                              db_sentinel_master_name=None,
  51                                              db_type=DbBackendType.FAKE_DICT)
  52     request.cls.configuration.get_params.return_value = mock_conf_params
  53     request.cls.db = ricsdl.backend.get_backend_instance(request.cls.configuration)
  54
  55
  56 @pytest.mark.usefixtures('fake_dict_backend_fixture')
  57 class TestFakeDictBackend:
  58     def test_set_function_success(self):
  59         self.db.set(self.ns, self.dm)
  60         ret = self.db.get(self.ns, self.keys)
  61         assert ret == self.dm
  62
  63     def test_set_if_function_success(self):
  64         self.db.set(self.ns, self.dm)
  65         ret = self.db.set_if(self.ns, self.key, self.old_data, self.new_data)
  66         assert ret is True
  67         ret = self.db.get(self.ns, self.keys)
  68         assert ret == self.new_dm
  69
  70     def test_set_if_function_returns_false_if_existing_key_value_not_expected(self):
  71         self.db.set_if(self.ns, self.key, self.old_data, self.new_data)
  72         self.db.set(self.ns, self.new_dm)
  73         ret = self.db.set_if(self.ns, self.key, self.old_data, self.new_data)
  74         assert ret is False
  75
  76     def test_set_if_not_exists_function_success(self):
  77         ret = self.db.set_if_not_exists(self.ns, self.key, self.new_data)
  78         assert ret is True
  79         ret = self.db.get(self.ns, self.keys)
  80         assert ret == {self.key: self.new_data}
  81
  82     def test_set_if_not_exists_function_returns_false_if_key_already_exists(self):
  83         self.db.set(self.ns, self.dm)
  84         ret = self.db.set_if_not_exists(self.ns, self.key, self.new_data)
  85         assert ret is False
  86
  87     def test_find_keys_function_success(self):
  88         self.db.set(self.ns, self.dm)
  89         ret = self.db.find_keys(self.ns, self.keypattern)
  90         assert ret == self.keys
  91
  92     def test_find_keys_function_returns_empty_list_when_no_matching_keys_found(self):
  93         ret = self.db.find_keys(self.ns, self.keypattern)
  94         assert ret == []
  95
  96     def test_find_and_get_function_success(self):
  97         self.db.set(self.ns, self.dm)
  98         ret = self.db.find_and_get(self.ns, self.keypattern)
  99         assert ret == self.dm
 100
 101     def test_find_and_get_function_returns_empty_dict_when_no_matching_keys_exist(self):
 102         ret = self.db.find_and_get(self.ns, self.keypattern)
 103         assert ret == dict()
 104
 105     def test_remove_function_success(self):
 106         self.db.set(self.ns, self.dm)
 107         self.db.remove(self.ns, self.keys)
 108         ret = self.db.get(self.ns, self.keys)
 109         assert ret == dict()
 110
 111     def test_remove_if_function_success(self):
 112         self.db.set(self.ns, self.dm)
 113         ret = self.db.remove_if(self.ns, self.key, self.old_data)
 114         assert ret is True
 115         ret = self.db.get(self.ns, self.keys)
 116         assert ret == self.remove_dm
 117
 118     def test_remove_if_function_returns_false_if_data_does_not_match(self):
 119         ret = self.db.remove_if(self.ns, self.key, self.old_data)
 120         assert ret is False
 121         self.db.set(self.ns, self.dm)
 122         ret = self.db.remove_if(self.ns, self.key, self.new_data)
 123         assert ret is False
 124
 125     def test_add_member_function_success(self):
 126         self.db.add_member(self.ns, self.group, self.groupmembers)
 127         ret = self.db.get_members(self.ns, self.group)
 128         assert ret == self.groupmembers
 129
 130         self.db.add_member(self.ns, self.group, self.new_groupmembers)
 131         ret = self.db.get_members(self.ns, self.group)
 132         assert ret == self.all_groupmembers
 133
 134     def test_remove_member_function_success(self):
 135         self.db.remove_member(self.ns, self.group, self.groupmembers)
 136         self.db.add_member(self.ns, self.group, self.groupmembers)
 137         self.db.remove_member(self.ns, self.group, self.groupmembers)
 138         ret = self.db.get_members(self.ns, self.group)
 139         assert ret == set()
 140
 141     def test_remove_group_function_success(self):
 142         self.db.remove_group(self.ns, self.group)
 143         ret = self.db.get_members(self.ns, self.group)
 144         assert ret == set()
 145
 146     def test_is_member_function_success(self):
 147         ret = self.db.is_member(self.ns, self.group, b'not member')
 148         assert ret is False
 149         self.db.add_member(self.ns, self.group, self.groupmembers)
 150         ret = self.db.is_member(self.ns, self.group, self.groupmember)
 151         assert ret is True
 152         ret = self.db.is_member(self.ns, self.group, b'not member')
 153         assert ret is False
 154
 155     def test_group_size_function_success(self):
 156         ret = self.db.group_size(self.ns, self.group)
 157         assert ret == 0
 158         self.db.add_member(self.ns, self.group, self.groupmembers)
 159         ret = self.db.group_size(self.ns, self.group)
 160         assert ret == len(self.groupmembers)
 161
 162     def test_fake_dict_backend_object_string_representation(self):
 163         assert str(self.db) == str({'DB type': 'FAKE DB'})
 164
 165 @pytest.fixture()
 166 def fake_dict_backend_lock_fixture(request):
 167     request.cls.ns = 'some-ns'
 168     request.cls.lockname = 'some-lock-name'
 169     request.cls.expiration = 10
 170     request.cls.retry_interval = 0.1
 171     request.cls.retry_timeout = 1
 172
 173     request.cls.configuration = Mock()
 174     mock_conf_params = _Configuration.Params(db_host=None,
 175                                              db_port=None,
 176                                              db_sentinel_port=None,
 177                                              db_sentinel_master_name=None,
 178                                              db_type=DbBackendType.FAKE_DICT)
 179     request.cls.configuration.get_params.return_value = mock_conf_params
 180     request.cls.lock = ricsdl.backend.get_backend_lock_instance(request.cls.configuration,
 181                                                                 request.cls.ns,
 182                                                                 request.cls.lockname,
 183                                                                 request.cls.expiration,
 184                                                                 Mock())
 185
 186
 187 @pytest.mark.usefixtures('fake_dict_backend_lock_fixture')
 188 class TestFakeDictBackendLock:
 189     def test_acquire_function_success(self):
 190         ret = self.lock.acquire(self.retry_interval, self.retry_timeout)
 191         assert ret is True
 192
 193     def test_acquire_function_returns_false_if_lock_is_not_acquired(self):
 194         self.lock.acquire(self.retry_interval, self.retry_timeout)
 195         ret = self.lock.acquire(self.retry_interval, self.retry_timeout)
 196         assert ret is False
 197
 198     def test_release_function_success(self):
 199         self.lock.acquire(self.retry_interval, self.retry_timeout)
 200         ret = self.lock.acquire(self.retry_interval, self.retry_timeout)
 201         assert ret is False
 202         self.lock.release()
 203         ret = self.lock.acquire(self.retry_interval, self.retry_timeout)
 204         assert ret is True
 205
 206     def test_get_validity_time_function_success(self):
 207         ret = self.lock.get_validity_time()
 208         assert ret == self.expiration
 209
 210     def test_fake_dict_backend_lock_object_string_representation(self):
 211         expected_lock_info = {'lock DB type': 'FAKE DB',
 212                               'lock namespace': 'some-ns',
 213                               'lock name': 'some-lock-name',
 214                               'lock status': 'unlocked'}
 215         assert str(self.lock) == str(expected_lock_info)