mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-11-11 15:51:00 +00:00
33e4f33afe
Now that the mypy bugs have been resolved, we are able to define more precisely and cleanly the types of Actions and Filters. Moreover, can now strongly type named actions and hooks (in consts.py). With such a strong typing, we get early alerts of hooks called with incorrect arguments, which is nothing short of awesome :) This change breaks the hooks API by removing the `context=...` argument. The reason for that is that we cannot insert arbitrary arguments between `P.args, P.kwargs`: https://peps.python.org/pep-0612/#the-components-of-a-paramspec > A function declared as def inner(a: A, b: B, *args: P.args, **kwargs: > P.kwargs) -> R has type Callable[Concatenate[A, B, P], R]. Placing > keyword-only parameters between the *args and **kwargs is forbidden. Getting the documentation to build in nitpicky mode is quite difficult... We need to add `nitpick_ignore` to the docs conf.py, otherwise sphinx complains about many missing class references. This, despite upgrading almost all doc requirements (except docutils).
107 lines
4.1 KiB
Python
107 lines
4.1 KiB
Python
import json
|
|
import os
|
|
import unittest
|
|
from unittest.mock import Mock, patch
|
|
|
|
import click
|
|
|
|
from tests.helpers import PluginsTestCase, temporary_root
|
|
from tutor import config as tutor_config
|
|
from tutor import fmt, hooks, interactive, utils
|
|
from tutor.types import Config, get_typed
|
|
|
|
|
|
class ConfigTests(unittest.TestCase):
|
|
def test_version(self) -> None:
|
|
defaults = tutor_config.get_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_not_render(self) -> None:
|
|
config: Config = {}
|
|
base = tutor_config.get_base()
|
|
with patch.object(utils, "random_string", return_value="abcd"):
|
|
tutor_config.merge(config, base)
|
|
|
|
# Check that merge does not perform a rendering
|
|
self.assertNotEqual("abcd", config["MYSQL_ROOT_PASSWORD"])
|
|
|
|
@patch.object(fmt, "echo")
|
|
def test_update_twice_should_return_same_config(self, _: Mock) -> None:
|
|
with temporary_root() as root:
|
|
config1 = tutor_config.load_minimal(root)
|
|
tutor_config.save_config_file(root, config1)
|
|
config2 = tutor_config.load_minimal(root)
|
|
|
|
self.assertEqual(config1, config2)
|
|
|
|
def test_interactive(self) -> None:
|
|
def mock_prompt(*_args: None, **kwargs: str) -> str:
|
|
return kwargs["default"]
|
|
|
|
with temporary_root() as rootdir:
|
|
with patch.object(click, "prompt", new=mock_prompt):
|
|
with patch.object(click, "confirm", new=mock_prompt):
|
|
config = tutor_config.load_minimal(rootdir)
|
|
interactive.ask_questions(config)
|
|
|
|
self.assertIn("MYSQL_ROOT_PASSWORD", config)
|
|
self.assertEqual(8, len(get_typed(config, "MYSQL_ROOT_PASSWORD", str)))
|
|
self.assertEqual("www.myopenedx.com", config["LMS_HOST"])
|
|
self.assertEqual("studio.www.myopenedx.com", config["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"))
|
|
|
|
@patch.object(fmt, "echo")
|
|
def test_json_config_is_overwritten_by_yaml(self, _: Mock) -> None:
|
|
with temporary_root() as root:
|
|
# Create config from scratch
|
|
config_yml_path = os.path.join(root, tutor_config.CONFIG_FILENAME)
|
|
config_json_path = os.path.join(
|
|
root, tutor_config.CONFIG_FILENAME.replace("yml", "json")
|
|
)
|
|
config = tutor_config.load_full(root)
|
|
|
|
# Save config to json
|
|
with open(config_json_path, "w", encoding="utf-8") as f:
|
|
json.dump(config, f, ensure_ascii=False, indent=4)
|
|
self.assertFalse(os.path.exists(config_yml_path))
|
|
self.assertTrue(os.path.exists(config_json_path))
|
|
|
|
# Reload and compare
|
|
current = tutor_config.load_full(root)
|
|
self.assertTrue(os.path.exists(config_yml_path))
|
|
self.assertFalse(os.path.exists(config_json_path))
|
|
self.assertEqual(config, current)
|
|
|
|
|
|
class ConfigPluginTestCase(PluginsTestCase):
|
|
@patch.object(fmt, "echo")
|
|
def test_removed_entry_is_added_on_save(self, _: Mock) -> None:
|
|
with temporary_root() as root:
|
|
mock_random_string = Mock()
|
|
|
|
hooks.Filters.ENV_TEMPLATE_FILTERS.add_item(
|
|
("random_string", mock_random_string),
|
|
)
|
|
mock_random_string.return_value = "abcd"
|
|
config1 = tutor_config.load_full(root)
|
|
password1 = config1.pop("MYSQL_ROOT_PASSWORD")
|
|
|
|
tutor_config.save_config_file(root, config1)
|
|
|
|
mock_random_string.return_value = "efgh"
|
|
config2 = tutor_config.load_full(root)
|
|
password2 = config2["MYSQL_ROOT_PASSWORD"]
|
|
|
|
self.assertEqual("abcd", password1)
|
|
self.assertEqual("efgh", password2)
|