ricsdl-package/tests/test_configuration.py

# Copyright (c) 2019 AT&T Intellectual Property.
# Copyright (c) 2018-2022 Nokia.
#
# 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.

#
# This source code is part of the near-RT RIC (RAN Intelligent Controller)
# platform project (RICP).
#


import pytest
from ricsdl.configuration import _Configuration
from ricsdl.configuration import DbBackendType


@pytest.fixture()
def config_fixture(request, monkeypatch):
    monkeypatch.setenv('DBAAS_SERVICE_HOST', 'service-ricplt-dbaas-tcp-cluster-0.ricplt')
    monkeypatch.setenv('DBAAS_SERVICE_PORT', '10000,10001')
    monkeypatch.setenv('DBAAS_SERVICE_SENTINEL_PORT', '11000,11001')
    monkeypatch.setenv('DBAAS_MASTER_NAME', 'my-master-0,my-master-1')
    monkeypatch.setenv('DBAAS_CLUSTER_ADDR_LIST', 'service-ricplt-dbaas-tcp-cluster-0.ricplt,service-ricplt-dbaas-tcp-cluster-1.ricplt')
    request.cls.config = _Configuration(fake_db_backend=None)

@pytest.fixture
def fake_db_config_fixture(request, monkeypatch):
    monkeypatch.delenv('DBAAS_SERVICE_HOST', raising=False)
    monkeypatch.delenv('DBAAS_SERVICE_PORT', raising=False)
    monkeypatch.delenv('DBAAS_SERVICE_SENTINEL_PORT', raising=False)
    monkeypatch.delenv('DBAAS_MASTER_NAME', raising=False)
    monkeypatch.delenv('DBAAS_CLUSTER_ADDR_LIST', raising=False)
    request.cls.config = _Configuration(fake_db_backend='dict')

class TestConfiguration:
    def test_get_params_function_returns_read_configuration(self, config_fixture):
        expected_config = _Configuration.Params(db_host='service-ricplt-dbaas-tcp-cluster-0.ricplt',
                                                db_ports=['10000','10001'],
                                                db_sentinel_ports=['11000','11001'],
                                                db_sentinel_master_names=['my-master-0','my-master-1'],
                                                db_cluster_addrs=['service-ricplt-dbaas-tcp-cluster-0.ricplt','service-ricplt-dbaas-tcp-cluster-1.ricplt'],
                                                db_type=DbBackendType.REDIS)
        assert expected_config == self.config.get_params()

    def test_get_params_function_can_return_fake_db_configuration(self, fake_db_config_fixture):
        expected_config = _Configuration.Params(db_host='', db_ports=[],
                                                db_sentinel_ports=[],
                                                db_sentinel_master_names=[],
                                                db_cluster_addrs=[],
                                                db_type=DbBackendType.FAKE_DICT)
        assert expected_config == self.config.get_params()

    def test_get_event_separator_function_return_expected_separator(self, config_fixture):
        assert "___" == _Configuration.get_event_separator()

    def test_get_params_function_can_raise_exception_if_wrong_fake_db_type(self):
        with pytest.raises(ValueError, match=r"Configuration error"):
            _Configuration(fake_db_backend='bad value')


    def test_configuration_object_string_representation(self, config_fixture):
        expected_config_info = {'DB host': 'service-ricplt-dbaas-tcp-cluster-0.ricplt',
                                'DB ports': ['10000','10001'],
                                'DB master sentinels': ['my-master-0','my-master-1'],
                                'DB sentinel ports': ['11000','11001'],
                                'DB cluster addresses': ['service-ricplt-dbaas-tcp-cluster-0.ricplt','service-ricplt-dbaas-tcp-cluster-1.ricplt'],
                                'DB type': 'REDIS'}
        assert str(self.config) == str(expected_config_info)

    def test_configuration_object_string_representation_if_fake_db(self, fake_db_config_fixture):
        expected_config_info = {'DB host': '',
                                'DB ports': [],
                                'DB master sentinels': [],
                                'DB sentinel ports': [],
                                'DB cluster addresses': [],
                                'DB type': 'FAKE_DICT'}
        assert str(self.config) == str(expected_config_info)

    def test_complete_configuration_if_less_ports_than_addresses(self, monkeypatch):
        monkeypatch.setenv('DBAAS_SERVICE_HOST', 'service-ricplt-dbaas-tcp-cluster-0.ricplt')
        monkeypatch.setenv('DBAAS_SERVICE_PORT', '10000')
        monkeypatch.setenv('DBAAS_CLUSTER_ADDR_LIST', 'service-ricplt-dbaas-tcp-cluster-0.ricplt,service-ricplt-dbaas-tcp-cluster-1.ricplt')

        expected_config = _Configuration.Params(db_host='service-ricplt-dbaas-tcp-cluster-0.ricplt',
                                                db_ports=['10000','10000'],
                                                db_sentinel_ports=[],
                                                db_sentinel_master_names=[],
                                                db_cluster_addrs=['service-ricplt-dbaas-tcp-cluster-0.ricplt','service-ricplt-dbaas-tcp-cluster-1.ricplt'],
                                                db_type=DbBackendType.REDIS)
        assert expected_config == _Configuration(fake_db_backend=None).get_params()

    def test_complete_configuration_if_less_sentinel_ports_than_addresses(self, monkeypatch):
        monkeypatch.setenv('DBAAS_SERVICE_HOST', 'service-ricplt-dbaas-tcp-cluster-0.ricplt')
        monkeypatch.setenv('DBAAS_SERVICE_PORT', '10000,10001')
        monkeypatch.setenv('DBAAS_SERVICE_SENTINEL_PORT', '11000')
        monkeypatch.setenv('DBAAS_MASTER_NAME', 'my-master-0,my-master-1')
        monkeypatch.setenv('DBAAS_CLUSTER_ADDR_LIST', 'service-ricplt-dbaas-tcp-cluster-0.ricplt,service-ricplt-dbaas-tcp-cluster-1.ricplt')

        expected_config = _Configuration.Params(db_host='service-ricplt-dbaas-tcp-cluster-0.ricplt',
                                                db_ports=['10000','10001'],
                                                db_sentinel_ports=['11000','11000'],
                                                db_sentinel_master_names=['my-master-0','my-master-1'],
                                                db_cluster_addrs=['service-ricplt-dbaas-tcp-cluster-0.ricplt','service-ricplt-dbaas-tcp-cluster-1.ricplt'],
                                                db_type=DbBackendType.REDIS)
        assert expected_config == _Configuration(fake_db_backend=None).get_params()

    def test_complete_configuration_if_less_sentinel_names_than_addresses(self, monkeypatch):
        monkeypatch.setenv('DBAAS_SERVICE_HOST', 'service-ricplt-dbaas-tcp-cluster-0.ricplt')
        monkeypatch.setenv('DBAAS_SERVICE_PORT', '10000,10001')
        monkeypatch.setenv('DBAAS_SERVICE_SENTINEL_PORT', '11000,11001')
        monkeypatch.setenv('DBAAS_MASTER_NAME', 'my-master-0')
        monkeypatch.setenv('DBAAS_CLUSTER_ADDR_LIST', 'service-ricplt-dbaas-tcp-cluster-0.ricplt,service-ricplt-dbaas-tcp-cluster-1.ricplt')

        expected_config = _Configuration.Params(db_host='service-ricplt-dbaas-tcp-cluster-0.ricplt',
                                                db_ports=['10000','10001'],
                                                db_sentinel_ports=['11000','11001'],
                                                db_sentinel_master_names=['my-master-0','my-master-0'],
                                                db_cluster_addrs=['service-ricplt-dbaas-tcp-cluster-0.ricplt','service-ricplt-dbaas-tcp-cluster-1.ricplt'],
                                                db_type=DbBackendType.REDIS)
        assert expected_config == _Configuration(fake_db_backend=None).get_params()