test_config_manager.py

# Copyright 2019, Optimizely
# 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 json
import mock
import requests

from optimizely import config_manager
from optimizely import exceptions as optimizely_exceptions
from optimizely import project_config
from optimizely.helpers import enums

from . import base


class StaticConfigManagerTest(base.BaseTest):
    def test_init__invalid_logger_fails(self):
        """ Test that initialization fails if logger is invalid. """
        class InvalidLogger(object):
            pass
        with self.assertRaisesRegexp(optimizely_exceptions.InvalidInputException,
                                     'Provided "logger" is in an invalid format.'):
            config_manager.StaticConfigManager(logger=InvalidLogger())

    def test_init__invalid_error_handler_fails(self):
        """ Test that initialization fails if error_handler is invalid. """
        class InvalidErrorHandler(object):
            pass
        with self.assertRaisesRegexp(optimizely_exceptions.InvalidInputException,
                                     'Provided "error_handler" is in an invalid format.'):
            config_manager.StaticConfigManager(error_handler=InvalidErrorHandler())

    def test_init__invalid_notification_center_fails(self):
        """ Test that initialization fails if notification_center is invalid. """
        class InvalidNotificationCenter(object):
            pass
        with self.assertRaisesRegexp(optimizely_exceptions.InvalidInputException,
                                     'Provided "notification_center" is in an invalid format.'):
            config_manager.StaticConfigManager(notification_center=InvalidNotificationCenter())

    def test_set_config__success(self):
        """ Test set_config when datafile is valid. """
        test_datafile = json.dumps(self.config_dict_with_features)
        mock_logger = mock.Mock()
        mock_notification_center = mock.Mock()

        with mock.patch('optimizely.config_manager.BaseConfigManager._validate_instantiation_options'):
            project_config_manager = config_manager.StaticConfigManager(datafile=test_datafile,
                                                                        logger=mock_logger,
                                                                        notification_center=mock_notification_center)

        project_config_manager._set_config(test_datafile)
        mock_logger.debug.assert_called_with('Received new datafile and updated config. '
                                             'Old revision number: None. New revision number: 1.')
        mock_notification_center.send_notifications.assert_called_once_with('OPTIMIZELY_CONFIG_UPDATE')

    def test_set_config__twice(self):
        """ Test calling set_config twice with same content to ensure config is not updated. """
        test_datafile = json.dumps(self.config_dict_with_features)
        mock_logger = mock.Mock()
        mock_notification_center = mock.Mock()

        with mock.patch('optimizely.config_manager.BaseConfigManager._validate_instantiation_options'):
            project_config_manager = config_manager.StaticConfigManager(datafile=test_datafile,
                                                                        logger=mock_logger,
                                                                        notification_center=mock_notification_center)

        project_config_manager._set_config(test_datafile)
        mock_logger.debug.assert_called_with('Received new datafile and updated config. '
                                             'Old revision number: None. New revision number: 1.')
        self.assertEqual(1, mock_logger.debug.call_count)
        mock_notification_center.send_notifications.assert_called_once_with('OPTIMIZELY_CONFIG_UPDATE')

        mock_logger.reset_mock()
        mock_notification_center.reset_mock()

        # Call set config again and confirm that no new log message denoting config update is there
        project_config_manager._set_config(test_datafile)
        self.assertEqual(0, mock_logger.debug.call_count)
        self.assertEqual(0, mock_notification_center.call_count)

    def test_set_config__schema_validation(self):
        """ Test set_config calls or does not call schema validation based on skip_json_validation value. """

        test_datafile = json.dumps(self.config_dict_with_features)
        mock_logger = mock.Mock()

        # Test that schema is validated.
        # Note: set_config is called in __init__ itself.
        with mock.patch('optimizely.helpers.validator.is_datafile_valid',
                        return_value=True) as mock_validate_datafile:
            config_manager.StaticConfigManager(datafile=test_datafile,
                                               logger=mock_logger)
        mock_validate_datafile.assert_called_once_with(test_datafile)

        # Test that schema is not validated if skip_json_validation option is set to True.
        with mock.patch('optimizely.helpers.validator.is_datafile_valid',
                        return_value=True) as mock_validate_datafile:
            config_manager.StaticConfigManager(datafile=test_datafile,
                                               logger=mock_logger,
                                               skip_json_validation=True)
        mock_validate_datafile.assert_not_called()

    def test_set_config__unsupported_datafile_version(self):
        """ Test set_config when datafile has unsupported version. """

        test_datafile = json.dumps(self.config_dict_with_features)
        mock_logger = mock.Mock()
        mock_notification_center = mock.Mock()

        with mock.patch('optimizely.config_manager.BaseConfigManager._validate_instantiation_options'):
            project_config_manager = config_manager.StaticConfigManager(datafile=test_datafile,
                                                                        logger=mock_logger,
                                                                        notification_center=mock_notification_center)

        invalid_version_datafile = self.config_dict_with_features.copy()
        invalid_version_datafile['version'] = 'invalid_version'
        test_datafile = json.dumps(invalid_version_datafile)

        # Call set_config with datafile having invalid version
        project_config_manager._set_config(test_datafile)
        mock_logger.error.assert_called_once_with('This version of the Python SDK does not support '
                                                  'the given datafile version: "invalid_version".')
        self.assertEqual(0, mock_notification_center.call_count)

    def test_set_config__invalid_datafile(self):
        """ Test set_config when datafile is invalid. """

        test_datafile = json.dumps(self.config_dict_with_features)
        mock_logger = mock.Mock()
        mock_notification_center = mock.Mock()

        with mock.patch('optimizely.config_manager.BaseConfigManager._validate_instantiation_options'):
            project_config_manager = config_manager.StaticConfigManager(datafile=test_datafile,
                                                                        logger=mock_logger,
                                                                        notification_center=mock_notification_center)

        # Call set_config with invalid content
        project_config_manager._set_config('invalid_datafile')
        mock_logger.error.assert_called_once_with('Provided "datafile" is in an invalid format.')
        self.assertEqual(0, mock_notification_center.call_count)

    def test_get_config(self):
        """ Test get_config. """
        test_datafile = json.dumps(self.config_dict_with_features)
        project_config_manager = config_manager.StaticConfigManager(datafile=test_datafile)

        # Assert that config is set.
        self.assertIsInstance(project_config_manager.get_config(), project_config.ProjectConfig)


@mock.patch('requests.get')
class PollingConfigManagerTest(base.BaseTest):
    def test_init__no_sdk_key_no_url__fails(self, _):
        """ Test that initialization fails if there is no sdk_key or url provided. """
        self.assertRaisesRegexp(optimizely_exceptions.InvalidInputException,
                                'Must provide at least one of sdk_key or url.',
                                config_manager.PollingConfigManager, sdk_key=None, url=None)

    def test_get_datafile_url__no_sdk_key_no_url_raises(self, _):
        """ Test that get_datafile_url raises exception if no sdk_key or url is provided. """
        self.assertRaisesRegexp(optimizely_exceptions.InvalidInputException,
                                'Must provide at least one of sdk_key or url.',
                                config_manager.PollingConfigManager.get_datafile_url, None, None, 'url_template')

    def test_get_datafile_url__invalid_url_template_raises(self, _):
        """ Test that get_datafile_url raises if url_template is invalid. """
        # No url_template provided
        self.assertRaisesRegexp(optimizely_exceptions.InvalidInputException,
                                'Invalid url_template None provided',
                                config_manager.PollingConfigManager.get_datafile_url, 'optly_datafile_key', None, None)

        # Incorrect url_template provided
        test_url_template = 'invalid_url_template_without_sdk_key_field_{key}'
        self.assertRaisesRegexp(optimizely_exceptions.InvalidInputException,
                                'Invalid url_template {} provided'.format(test_url_template),
                                config_manager.PollingConfigManager.get_datafile_url,
                                'optly_datafile_key', None, test_url_template)

    def test_get_datafile_url__sdk_key_and_template_provided(self, _):
        """ Test get_datafile_url when sdk_key and template are provided. """
        test_sdk_key = 'optly_key'
        test_url_template = 'www.optimizelydatafiles.com/{sdk_key}.json'
        expected_url = test_url_template.format(sdk_key=test_sdk_key)
        self.assertEqual(expected_url,
                         config_manager.PollingConfigManager.get_datafile_url(test_sdk_key, None, test_url_template))

    def test_get_datafile_url__url_and_template_provided(self, _):
        """ Test get_datafile_url when url and url_template are provided. """
        test_url_template = 'www.optimizelydatafiles.com/{sdk_key}.json'
        test_url = 'www.myoptimizelydatafiles.com/my_key.json'
        self.assertEqual(test_url, config_manager.PollingConfigManager.get_datafile_url(None,
                                                                                        test_url,
                                                                                        test_url_template))

    def test_get_datafile_url__sdk_key_and_url_and_template_provided(self, _):
        """ Test get_datafile_url when sdk_key, url and url_template are provided. """
        test_sdk_key = 'optly_key'
        test_url_template = 'www.optimizelydatafiles.com/{sdk_key}.json'
        test_url = 'www.myoptimizelydatafiles.com/my_key.json'

        # Assert that if url is provided, it is always returned
        self.assertEqual(test_url, config_manager.PollingConfigManager.get_datafile_url(test_sdk_key,
                                                                                        test_url,
                                                                                        test_url_template))

    def test_set_update_interval(self, _):
        """ Test set_update_interval with different inputs. """
        project_config_manager = config_manager.PollingConfigManager(sdk_key='some_key')

        # Assert that if invalid update_interval is set, then exception is raised.
        with self.assertRaisesRegexp(optimizely_exceptions.InvalidInputException,
                                     'Invalid update_interval "invalid interval" provided.'):
            project_config_manager.set_update_interval('invalid interval')

        # Assert that update_interval cannot be set to less than allowed minimum and instead is set to default value.
        project_config_manager.set_update_interval(-4.2)
        self.assertEqual(enums.ConfigManager.DEFAULT_UPDATE_INTERVAL, project_config_manager.update_interval)

        # Assert that if no update_interval is provided, it is set to default value.
        project_config_manager.set_update_interval(None)
        self.assertEqual(enums.ConfigManager.DEFAULT_UPDATE_INTERVAL, project_config_manager.update_interval)

        # Assert that if valid update_interval is provided, it is set to that value.
        project_config_manager.set_update_interval(42)
        self.assertEqual(42, project_config_manager.update_interval)

    def test_set_last_modified(self, _):
        """ Test that set_last_modified sets last_modified field based on header. """
        project_config_manager = config_manager.PollingConfigManager(sdk_key='some_key')

        last_modified_time = 'Test Last Modified Time'
        test_response_headers = {
            'Last-Modified': last_modified_time,
            'Some-Other-Important-Header': 'some_value'
        }
        project_config_manager.set_last_modified(test_response_headers)
        self.assertEqual(last_modified_time, project_config_manager.last_modified)

    def test_fetch_datafile(self, _):
        """ Test that fetch_datafile sets config and last_modified based on response. """
        with mock.patch('optimizely.config_manager.PollingConfigManager.fetch_datafile'):
            project_config_manager = config_manager.PollingConfigManager(sdk_key='some_key')
        expected_datafile_url = 'https://cdn.optimizely.com/datafiles/some_key.json'
        test_headers = {
            'Last-Modified': 'New Time'
        }
        test_datafile = json.dumps(self.config_dict_with_features)
        test_response = requests.Response()
        test_response.status_code = 200
        test_response.headers = test_headers
        test_response._content = test_datafile
        with mock.patch('requests.get', return_value=test_response):
            project_config_manager.fetch_datafile()

        self.assertEqual(test_headers['Last-Modified'], project_config_manager.last_modified)
        self.assertIsInstance(project_config_manager.get_config(), project_config.ProjectConfig)

        # Call fetch_datafile again and assert that request to URL is with If-Modified-Since header.
        with mock.patch('requests.get', return_value=test_response) as mock_requests:
            project_config_manager.fetch_datafile()

        mock_requests.assert_called_once_with(expected_datafile_url,
                                              headers={'If-Modified-Since': test_headers['Last-Modified']},
                                              timeout=enums.ConfigManager.REQUEST_TIMEOUT)
        self.assertEqual(test_headers['Last-Modified'], project_config_manager.last_modified)
        self.assertIsInstance(project_config_manager.get_config(), project_config.ProjectConfig)

    def test_is_running(self, _):
        """ Test that polling thread is running after instance of PollingConfigManager is created. """
        with mock.patch('optimizely.config_manager.PollingConfigManager.fetch_datafile'):
            project_config_manager = config_manager.PollingConfigManager(sdk_key='some_key')
            self.assertTrue(project_config_manager.is_running)