"""
Tests for SettingsService
"""
import unittest
from unittest import TestCase, mock
from unittest.mock import Mock, patch

import ddt
import pytest
from config_models.models import ConfigurationModel
from django.conf import settings
from django.test.utils import override_settings
from opaque_keys.edx.locator import BlockUsageLocator, CourseLocator
from xblock.fields import ScopeIds
from xblock.runtime import Mixologist

from openedx.core.djangolib.testing.utils import skip_unless_lms
from openedx.core.lib.teams_config import TeamsConfig
from xmodule.capa.xqueue_interface import XQueueInterface
from xmodule.services import ConfigurationService, SettingsService, TeamsConfigurationService, XQueueService


class _DummyBlock:
    """ Dummy Xblock class """
    pass  # lint-amnesty, pylint: disable=unnecessary-pass


class DummyConfig(ConfigurationModel):
    """
    Dummy Configuration
    """
    class Meta:
        app_label = 'xmoduletestservices'


class DummyUnexpected:
    """
    Dummy Unexpected Class
    """
    pass  # lint-amnesty, pylint: disable=unnecessary-pass


@ddt.ddt
class TestSettingsService(unittest.TestCase):
    """ Test SettingsService """

    xblock_setting_key1 = 'dummy_block'
    xblock_setting_key2 = 'other_dummy_block'

    def setUp(self):
        """ Setting up tests """
        super().setUp()
        self.settings_service = SettingsService()
        self.xblock_mock = mock.Mock()
        self.xblock_mock.block_settings_key = self.xblock_setting_key1
        self.xblock_mock.unmixed_class = mock.Mock()
        self.xblock_mock.unmixed_class.__name__ = self.xblock_setting_key2

    def test_get_given_none_throws_value_error(self):
        """  Test that given None throws value error """
        with pytest.raises(ValueError):
            self.settings_service.get_settings_bucket(None)

    @override_settings()
    def test_get_return_default_if_xblock_settings_is_missing(self):
        """ Test that returns default (or None if default not set) if XBLOCK_SETTINGS is not set """
        # Per django docs, using override_settings() plus 'del' is how to test the absence of a setting:
        del settings.XBLOCK_SETTINGS
        # precondition check
        assert self.settings_service.get_settings_bucket(self.xblock_mock, 'zzz') == 'zzz'

    @override_settings()
    def test_get_return_empty_dictionary_if_xblock_settings_and_default_is_missing(self):
        """ Test that returns default (or None if default not set) if XBLOCK_SETTINGS is not set """
        # Per django docs, using override_settings() plus 'del' is how to test the absence of a setting:
        del settings.XBLOCK_SETTINGS
        # precondition check
        assert self.settings_service.get_settings_bucket(self.xblock_mock) == {}

    @override_settings(XBLOCK_SETTINGS={xblock_setting_key2: {'b': 1}})
    def test_get_returns_none_or_default_if_bucket_not_found(self):
        """ Test if settings service returns default if setting not found """
        assert settings.XBLOCK_SETTINGS == {self.xblock_setting_key2: {'b': 1}}
        assert self.settings_service.get_settings_bucket(self.xblock_mock) == {}
        assert self.settings_service.get_settings_bucket(self.xblock_mock, 123) == 123

    @override_settings(XBLOCK_SETTINGS={xblock_setting_key1: 42})
    def test_get_returns_correct_value(self):
        """ Test if settings service returns correct bucket """
        assert settings.XBLOCK_SETTINGS == {self.xblock_setting_key1: 42}
        assert self.settings_service.get_settings_bucket(self.xblock_mock) == 42

    @override_settings(XBLOCK_SETTINGS={xblock_setting_key2: "I'm a setting"})
    def test_get_respects_block_settings_key(self):
        """ Test if settings service respects block_settings_key value """
        assert settings.XBLOCK_SETTINGS == {self.xblock_setting_key2: "I'm a setting"}
        self.xblock_mock.block_settings_key = self.xblock_setting_key2
        assert self.settings_service.get_settings_bucket(self.xblock_mock) == "I'm a setting"

    @override_settings(XBLOCK_SETTINGS={_DummyBlock.__name__: [1, 2, 3]})
    def test_get_uses_class_name_if_block_settings_key_is_not_set(self):
        """ Test if settings service uses class name if block_settings_key attribute does not exist """
        mixologist = Mixologist([])
        block = mixologist.mix(_DummyBlock)
        assert settings.XBLOCK_SETTINGS == {'_DummyBlock': [1, 2, 3]}
        assert self.settings_service.get_settings_bucket(block) == [1, 2, 3]


class TestConfigurationService(unittest.TestCase):
    """
    Tests for ConfigurationService
    """

    def test_given_unexpected_class_throws_value_error(self):
        """
        Test that instantiating ConfigurationService raises exception on passing
        a class which is not subclass of ConfigurationModel.
        """
        with pytest.raises(ValueError):
            ConfigurationService(DummyUnexpected)

    def test_configuration_service(self):
        """
        Test the correct configuration on instantiating ConfigurationService.
        """
        config_service = ConfigurationService(DummyConfig)
        assert config_service.configuration == DummyConfig


class MockConfigurationService(TeamsConfigurationService):
    """
    Mock ConfigurationService for testing.
    """
    def __init__(self, course, **kwargs):  # lint-amnesty, pylint: disable=unused-argument
        super().__init__()
        self._course = course

    def get_course(self, course_id):
        return self._course


class ConfigurationServiceBaseClass(TestCase):
    """
    Base test class for testing the ConfigurationService.
    """

    def setUp(self):
        super().setUp()

        self.teams_config = TeamsConfig(
            {'max_size': 2, 'topics': [{'id': 'topic', 'name': 'Topic', 'description': 'A Topic'}]}
        )
        self.course = mock.Mock(
            id=CourseLocator('org_0', 'course_0', 'run_0'),
            teams_configuration=self.teams_config
        )
        self.configuration_service = MockConfigurationService(self.course)


class TestTeamsConfigurationService(ConfigurationServiceBaseClass):
    """
    Test operations of the teams configuration service
    """

    def test_get_teamsconfiguration(self):
        teams_config = self.configuration_service.get_teams_configuration(self.course.id)
        assert teams_config == self.teams_config


@pytest.mark.django_db
@skip_unless_lms
class XQueueServiceTest(TestCase):
    """Test the XQueue service methods."""

    def setUp(self):
        super().setUp()
        location = BlockUsageLocator(
            CourseLocator("test_org", "test_course", "test_run"),
            "problem",
            "ExampleProblem",
        )
        self.block = Mock(scope_ids=ScopeIds("user1", "mock_problem", location, location))
        self.block.max_score = Mock(return_value=10)  # Mock max_score method
        self.service = XQueueService(self.block)

    def test_interface(self):
        """Test that the `XQUEUE_INTERFACE` settings are passed from the service to the interface."""
        assert isinstance(self.service.interface, XQueueInterface)
        assert self.service.interface.url == "http://sandbox-xqueue.edx.org"
        assert self.service.interface.auth["username"] == "lms"
        assert self.service.interface.auth["password"] == "***REMOVED***"
        assert self.service.interface.session.auth.username == "anant"
        assert self.service.interface.session.auth.password == "agarwal"

    @patch("xmodule.services.XQueueService.use_edx_submissions_for_xqueue", return_value=True)
    def test_construct_callback_with_flag_enabled(self, mock_flag):  # pylint: disable=unused-argument
        """Test construct_callback when the waffle flag is enabled."""
        self.service = XQueueService(self.block)
        usage_id = self.block.scope_ids.usage_id
        course_id = str(usage_id.course_key)
        callback_url = f"courses/{course_id}/xqueue/user1/{usage_id}"

        assert self.service.construct_callback() == f"{settings.LMS_ROOT_URL}/{callback_url}/score_update"
        assert self.service.construct_callback("alt_dispatch") == (
            f"{settings.LMS_ROOT_URL}/{callback_url}/alt_dispatch"
        )

        custom_callback_url = "http://alt.url"
        with override_settings(XQUEUE_INTERFACE={**settings.XQUEUE_INTERFACE, "callback_url": custom_callback_url}):
            assert self.service.construct_callback() == f"{custom_callback_url}/{callback_url}/score_update"

    @patch("xmodule.services.XQueueService.use_edx_submissions_for_xqueue", return_value=False)
    def test_construct_callback_with_flag_disabled(self, mock_flag):  # pylint: disable=unused-argument
        """Test construct_callback when the waffle flag is disabled."""
        self.service = XQueueService(self.block)
        usage_id = self.block.scope_ids.usage_id
        callback_url = f"courses/{usage_id.context_key}/xqueue/user1/{usage_id}"

        assert self.service.construct_callback() == f"{settings.LMS_ROOT_URL}/{callback_url}/score_update"
        assert self.service.construct_callback("alt_dispatch") == f"{settings.LMS_ROOT_URL}/{callback_url}/alt_dispatch"

        custom_callback_url = "http://alt.url"
        with override_settings(XQUEUE_INTERFACE={**settings.XQUEUE_INTERFACE, "callback_url": custom_callback_url}):
            assert self.service.construct_callback() == f"{custom_callback_url}/{callback_url}/score_update"

    def test_default_queuename(self):
        """Check the format of the default queue name."""
        assert self.service.default_queuename == "test_org-test_course"

    def test_waittime(self):
        """Check that the time between requests is retrieved correctly from the settings."""
        assert self.service.waittime == 5

        with override_settings(XQUEUE_WAITTIME_BETWEEN_REQUESTS=15):
            assert self.service.waittime == 15