mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-09-30 21:29:01 +00:00
15b219e235
This is a very large refactoring which aims at making Tutor both more extendable and more generic. Historically, the Tutor plugin system was designed as an ad-hoc solution to allow developers to modify their own Open edX platforms without having to fork Tutor. The plugin API was simple, but limited, because of its ad-hoc nature. As a consequence, there were many things that plugin developers could not do, such as extending different parts of the CLI or adding custom template filters. Here, we refactor the whole codebase to make use of a generic plugin system. This system was inspired by the Wordpress plugin API and the Open edX "hooks and filters" API. The various components are added to a small core thanks to a set of actions and filters. Actions are callback functions that can be triggered at different points of the application lifecycle. Filters are functions that modify some data. Both actions and filters are collectively named as "hooks". Hooks can optionally be created within a certain context, which makes it easier to keep track of which application created which callback. This new hooks system allows us to provide a Python API that developers can use to extend their applications. The API reference is added to the documentation, along with a new plugin development tutorial. The plugin v0 API remains supported for backward compatibility of existing plugins. Done: - Do not load commands from plugins which are not enabled. - Load enabled plugins once on start. - Implement contexts for actions and filters, which allow us to keep track of the source of every hook. - Migrate patches - Migrate commands - Migrate plugin detection - Migrate templates_root - Migrate config - Migrate template environment globals and filters - Migrate hooks to tasks - Generate hook documentation - Generate patch reference documentation - Add the concept of action priority Close #499.
106 lines
4.1 KiB
Python
106 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 hooks, interactive
|
|
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(tutor_config.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(tutor_config.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 = interactive.load_user_config(rootdir, interactive=True)
|
|
|
|
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(tutor_config.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(tutor_config.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)
|