mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-06-02 14:20:47 +00:00
336cb79fa8
I stumbled upon a bug that should have been detected by the type checking. Turns out, considering that config is of type Dict[str, Any] means that we can use just any method on all config values -- which is terrible. I discovered this after I set `config["PLUGINS"] = None`: this triggered a crash when I enabled a plugin. We resolve this by making the Config type more explicit. We also take the opportunity to remove a few cast statements.
75 lines
2.8 KiB
Python
75 lines
2.8 KiB
Python
import unittest
|
|
from unittest.mock import Mock, patch
|
|
import tempfile
|
|
|
|
from tutor import config as tutor_config
|
|
from tutor import interactive
|
|
from tutor.types import get_typed, Config
|
|
|
|
|
|
class ConfigTests(unittest.TestCase):
|
|
def test_version(self) -> None:
|
|
defaults = tutor_config.load_defaults()
|
|
self.assertNotIn("TUTOR_VERSION", defaults)
|
|
|
|
def test_merge(self) -> None:
|
|
config1: Config = {"x": "y"}
|
|
config2: Config = {"x": "z"}
|
|
tutor_config.merge(config1, config2)
|
|
self.assertEqual({"x": "y"}, config1)
|
|
|
|
def test_merge_render(self) -> None:
|
|
config: Config = {}
|
|
defaults = tutor_config.load_defaults()
|
|
with patch.object(tutor_config.utils, "random_string", return_value="abcd"):
|
|
tutor_config.merge(config, defaults)
|
|
|
|
self.assertEqual("abcd", config["MYSQL_ROOT_PASSWORD"])
|
|
|
|
@patch.object(tutor_config.fmt, "echo")
|
|
def test_update_twice(self, _: Mock) -> None:
|
|
with tempfile.TemporaryDirectory() as root:
|
|
tutor_config.update(root)
|
|
config1 = tutor_config.load_user(root)
|
|
|
|
tutor_config.update(root)
|
|
config2 = tutor_config.load_user(root)
|
|
|
|
self.assertEqual(config1, config2)
|
|
|
|
@patch.object(tutor_config.fmt, "echo")
|
|
def test_removed_entry_is_added_on_save(self, _: Mock) -> None:
|
|
with tempfile.TemporaryDirectory() as root:
|
|
with patch.object(
|
|
tutor_config.utils, "random_string"
|
|
) as mock_random_string:
|
|
mock_random_string.return_value = "abcd"
|
|
config1, _defaults1 = tutor_config.load_all(root)
|
|
password1 = config1["MYSQL_ROOT_PASSWORD"]
|
|
|
|
config1.pop("MYSQL_ROOT_PASSWORD")
|
|
tutor_config.save_config_file(root, config1)
|
|
|
|
mock_random_string.return_value = "efgh"
|
|
config2, _defaults2 = tutor_config.load_all(root)
|
|
password2 = config2["MYSQL_ROOT_PASSWORD"]
|
|
|
|
self.assertEqual("abcd", password1)
|
|
self.assertEqual("efgh", password2)
|
|
|
|
def test_interactive_load_all(self) -> None:
|
|
with tempfile.TemporaryDirectory() as rootdir:
|
|
config, defaults = interactive.load_all(rootdir, interactive=False)
|
|
|
|
self.assertIn("MYSQL_ROOT_PASSWORD", config)
|
|
self.assertEqual(8, len(get_typed(config, "MYSQL_ROOT_PASSWORD", str)))
|
|
self.assertNotIn("LMS_HOST", config)
|
|
self.assertEqual("www.myopenedx.com", defaults["LMS_HOST"])
|
|
self.assertEqual("studio.{{ LMS_HOST }}", defaults["CMS_HOST"])
|
|
|
|
def test_is_service_activated(self) -> None:
|
|
config: Config = {"RUN_SERVICE1": True, "RUN_SERVICE2": False}
|
|
|
|
self.assertTrue(tutor_config.is_service_activated(config, "service1"))
|
|
self.assertFalse(tutor_config.is_service_activated(config, "service2"))
|