mirror of
https://github.com/ChristianLight/tutor.git
synced 2024-06-09 01:02:21 +00:00
Move config logic to dedicated non-command module
This commit is contained in:
Régis Behmo
parent
334f3e720e
commit
f5c225231f
|
|
@ -2,7 +2,7 @@ import unittest
|
|||
import unittest.mock
|
||||
import tempfile
|
||||
|
||||
from tutor.commands import config as tutor_config
|
||||
from tutor import config as tutor_config
|
||||
from tutor import env
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ import tempfile
|
|||
import unittest
|
||||
import unittest.mock
|
||||
|
||||
from tutor.commands import config as tutor_config
|
||||
from tutor import config as tutor_config
|
||||
from tutor import env
|
||||
from tutor import exceptions
|
||||
|
||||
|
|
@ -72,7 +72,7 @@ class EnvTests(unittest.TestCase):
|
|||
patches = {"plugin1": "abcd", "plugin2": "efgh"}
|
||||
with unittest.mock.patch.object(
|
||||
env.plugins, "iter_patches", return_value=patches.items()
|
||||
) as mock_iter_patches:
|
||||
):
|
||||
rendered = env.render_str(
|
||||
{}, '{{ patch("location", separator=",\n", suffix=",") }}'
|
||||
)
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
import unittest
|
||||
import unittest.mock
|
||||
|
||||
from tutor.commands import config as tutor_config
|
||||
from tutor import config as tutor_config
|
||||
from tutor import scripts
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
import click
|
||||
|
||||
from . import config as tutor_config
|
||||
from .. import config as tutor_config
|
||||
from .. import env as tutor_env
|
||||
from .. import fmt
|
||||
from .. import opts
|
||||
|
|
|
|||
|
|
@ -1,17 +1,9 @@
|
|||
import json
|
||||
import os
|
||||
import sys
|
||||
|
||||
import click
|
||||
|
||||
from .. import config
|
||||
from .. import exceptions
|
||||
from .. import env
|
||||
from .. import fmt
|
||||
from .. import opts
|
||||
from .. import plugins
|
||||
from .. import serialize
|
||||
from .. import utils
|
||||
from ..__about__ import __version__
|
||||
|
||||
|
||||
@click.group(
|
||||
|
|
@ -30,19 +22,7 @@ def config_command():
|
|||
@opts.key_value
|
||||
def save_command(root, silent1, silent2, set_):
|
||||
silent = silent1 or silent2
|
||||
save(root, silent=silent, keyvalues=set_)
|
||||
|
||||
|
||||
def save(root, silent=False, keyvalues=None):
|
||||
keyvalues = keyvalues or []
|
||||
config, defaults = load_all(root)
|
||||
for k, v in keyvalues:
|
||||
config[k] = v
|
||||
if not silent:
|
||||
load_interactive(config, defaults)
|
||||
save_config(root, config)
|
||||
merge(config, defaults)
|
||||
save_env(root, config)
|
||||
config.save(root, silent=silent, keyvalues=set_)
|
||||
|
||||
|
||||
@click.command(help="Print the project root")
|
||||
|
|
@ -55,344 +35,13 @@ def printroot(root):
|
|||
@opts.root
|
||||
@click.argument("key")
|
||||
def printvalue(root, key):
|
||||
config, defaults = load_all(root)
|
||||
merge(config, defaults)
|
||||
local = config.load(root)
|
||||
try:
|
||||
fmt.echo(config[key])
|
||||
fmt.echo(local[key])
|
||||
except KeyError:
|
||||
raise exceptions.TutorError("Missing configuration value: {}".format(key))
|
||||
|
||||
|
||||
def load(root):
|
||||
"""
|
||||
Load configuration, and generate it interactively if the file does not
|
||||
exist.
|
||||
"""
|
||||
defaults = load_defaults()
|
||||
config = load_current(root, defaults)
|
||||
|
||||
should_update_env = False
|
||||
if not os.path.exists(config_path(root)):
|
||||
load_interactive(config, defaults)
|
||||
should_update_env = True
|
||||
save_config(root, config)
|
||||
|
||||
if not env.is_up_to_date(root):
|
||||
should_update_env = True
|
||||
pre_upgrade_announcement(root)
|
||||
|
||||
if should_update_env:
|
||||
save_env(root, config)
|
||||
|
||||
merge(config, defaults)
|
||||
return config
|
||||
|
||||
|
||||
def merge(config, defaults):
|
||||
"""
|
||||
Merge default values with user configuration.
|
||||
"""
|
||||
for key, value in defaults.items():
|
||||
if key not in config:
|
||||
if isinstance(value, str):
|
||||
config[key] = env.render_str(config, value)
|
||||
else:
|
||||
config[key] = value
|
||||
|
||||
|
||||
def pre_upgrade_announcement(root):
|
||||
"""
|
||||
Inform the user that the current environment is not up-to-date. Crash if running in
|
||||
non-interactive mode.
|
||||
"""
|
||||
fmt.echo_alert(
|
||||
"The current environment stored at {} is not up-to-date: it is at "
|
||||
"v{} while the 'tutor' binary is at v{}.".format(
|
||||
env.base_dir(root), env.version(root), __version__
|
||||
)
|
||||
)
|
||||
if os.isatty(sys.stdin.fileno()):
|
||||
# Interactive mode: ask the user permission to proceed
|
||||
click.confirm(
|
||||
fmt.question(
|
||||
# every patch you take, every change you make, I'll be watching you
|
||||
"Would you like to upgrade the environment? If you do, any change you"
|
||||
" might have made will be overwritten."
|
||||
),
|
||||
default=True,
|
||||
abort=True,
|
||||
)
|
||||
else:
|
||||
# Non-interactive mode with no authorization: abort
|
||||
raise exceptions.TutorError(
|
||||
"Running in non-interactive mode, the environment will not be upgraded"
|
||||
" automatically. To upgrade the environment manually, run:\n"
|
||||
"\n"
|
||||
" tutor config save -y"
|
||||
)
|
||||
|
||||
|
||||
def load_all(root):
|
||||
defaults = load_defaults()
|
||||
current = load_current(root, defaults)
|
||||
return current, defaults
|
||||
|
||||
|
||||
def load_defaults():
|
||||
return serialize.load(env.read("config.yml"))
|
||||
|
||||
|
||||
def load_current(root, defaults):
|
||||
"""
|
||||
Note: this modifies the defaults. TODO this is not that great.
|
||||
"""
|
||||
convert_json2yml(root)
|
||||
config = load_user(root)
|
||||
load_env(config, defaults)
|
||||
load_required(config, defaults)
|
||||
load_plugins(config, defaults)
|
||||
return config
|
||||
|
||||
|
||||
def load_user(root):
|
||||
path = config_path(root)
|
||||
if not os.path.exists(path):
|
||||
return {}
|
||||
|
||||
with open(path) as fi:
|
||||
config = serialize.load(fi.read())
|
||||
upgrade_obsolete(config)
|
||||
return config
|
||||
|
||||
|
||||
def load_env(config, defaults):
|
||||
for k in defaults.keys():
|
||||
env_var = "TUTOR_" + k
|
||||
if env_var in os.environ:
|
||||
config[k] = serialize.parse_value(os.environ[env_var])
|
||||
|
||||
|
||||
def load_required(config, defaults):
|
||||
"""
|
||||
All these keys must be present in the user's config.yml. This includes all important
|
||||
values, such as LMS_HOST, and randomly-generated values, such as passwords.
|
||||
"""
|
||||
for key in [
|
||||
"LMS_HOST",
|
||||
"CMS_HOST",
|
||||
"CONTACT_EMAIL",
|
||||
"SECRET_KEY",
|
||||
"MYSQL_ROOT_PASSWORD",
|
||||
"OPENEDX_MYSQL_PASSWORD",
|
||||
"NOTES_MYSQL_PASSWORD",
|
||||
"NOTES_SECRET_KEY",
|
||||
"NOTES_OAUTH2_SECRET",
|
||||
"XQUEUE_AUTH_PASSWORD",
|
||||
"XQUEUE_MYSQL_PASSWORD",
|
||||
"XQUEUE_SECRET_KEY",
|
||||
"ANDROID_OAUTH2_SECRET",
|
||||
"ID",
|
||||
]:
|
||||
if key not in config:
|
||||
config[key] = env.render_str(config, defaults[key])
|
||||
|
||||
|
||||
def load_plugins(config, defaults):
|
||||
add_config, set_config, defaults_config = plugins.load_config(config)
|
||||
merge(config, add_config)
|
||||
# TODO this might have unexpected consequences if plugins have conflicting configurations. Maybe we should print warning messages.
|
||||
merge(config, set_config)
|
||||
# TODO this modifies defaults, which is ugly.
|
||||
merge(defaults, defaults_config)
|
||||
|
||||
|
||||
def upgrade_obsolete(config):
|
||||
# Openedx-specific mysql passwords
|
||||
if "MYSQL_PASSWORD" in config:
|
||||
config["MYSQL_ROOT_PASSWORD"] = config["MYSQL_PASSWORD"]
|
||||
config["OPENEDX_MYSQL_PASSWORD"] = config["MYSQL_PASSWORD"]
|
||||
config.pop("MYSQL_PASSWORD")
|
||||
if "MYSQL_DATABASE" in config:
|
||||
config["OPENEDX_MYSQL_DATABASE"] = config.pop("MYSQL_DATABASE")
|
||||
if "MYSQL_USERNAME" in config:
|
||||
config["OPENEDX_MYSQL_USERNAME"] = config.pop("MYSQL_USERNAME")
|
||||
|
||||
|
||||
def load_interactive(config, defaults):
|
||||
ask("Your website domain name for students (LMS)", "LMS_HOST", config, defaults)
|
||||
ask("Your website domain name for teachers (CMS)", "CMS_HOST", config, defaults)
|
||||
ask("Your platform name/title", "PLATFORM_NAME", config, defaults)
|
||||
ask("Your public contact email address", "CONTACT_EMAIL", config, defaults)
|
||||
ask_choice(
|
||||
"The default language code for the platform",
|
||||
"LANGUAGE_CODE",
|
||||
config,
|
||||
defaults,
|
||||
[
|
||||
"en",
|
||||
"am",
|
||||
"ar",
|
||||
"az",
|
||||
"bg-bg",
|
||||
"bn-bd",
|
||||
"bn-in",
|
||||
"bs",
|
||||
"ca",
|
||||
"ca@valencia",
|
||||
"cs",
|
||||
"cy",
|
||||
"da",
|
||||
"de-de",
|
||||
"el",
|
||||
"en-uk",
|
||||
"en@lolcat",
|
||||
"en@pirate",
|
||||
"es-419",
|
||||
"es-ar",
|
||||
"es-ec",
|
||||
"es-es",
|
||||
"es-mx",
|
||||
"es-pe",
|
||||
"et-ee",
|
||||
"eu-es",
|
||||
"fa",
|
||||
"fa-ir",
|
||||
"fi-fi",
|
||||
"fil",
|
||||
"fr",
|
||||
"gl",
|
||||
"gu",
|
||||
"he",
|
||||
"hi",
|
||||
"hr",
|
||||
"hu",
|
||||
"hy-am",
|
||||
"id",
|
||||
"it-it",
|
||||
"ja-jp",
|
||||
"kk-kz",
|
||||
"km-kh",
|
||||
"kn",
|
||||
"ko-kr",
|
||||
"lt-lt",
|
||||
"ml",
|
||||
"mn",
|
||||
"mr",
|
||||
"ms",
|
||||
"nb",
|
||||
"ne",
|
||||
"nl-nl",
|
||||
"or",
|
||||
"pl",
|
||||
"pt-br",
|
||||
"pt-pt",
|
||||
"ro",
|
||||
"ru",
|
||||
"si",
|
||||
"sk",
|
||||
"sl",
|
||||
"sq",
|
||||
"sr",
|
||||
"sv",
|
||||
"sw",
|
||||
"ta",
|
||||
"te",
|
||||
"th",
|
||||
"tr-tr",
|
||||
"uk",
|
||||
"ur",
|
||||
"vi",
|
||||
"uz",
|
||||
"zh-cn",
|
||||
"zh-hk",
|
||||
"zh-tw",
|
||||
],
|
||||
)
|
||||
ask_bool(
|
||||
(
|
||||
"Activate SSL/TLS certificates for HTTPS access? Important note:"
|
||||
" this will NOT work in a development environment."
|
||||
),
|
||||
"ACTIVATE_HTTPS",
|
||||
config,
|
||||
defaults,
|
||||
)
|
||||
ask_bool(
|
||||
"Activate Student Notes service (https://open.edx.org/features/student-notes)?",
|
||||
"ACTIVATE_NOTES",
|
||||
config,
|
||||
defaults,
|
||||
)
|
||||
ask_bool(
|
||||
"Activate Xqueue for external grader services (https://github.com/edx/xqueue)?",
|
||||
"ACTIVATE_XQUEUE",
|
||||
config,
|
||||
defaults,
|
||||
)
|
||||
|
||||
|
||||
def ask(question, key, config, defaults):
|
||||
default = env.render_str(config, config.get(key, defaults[key]))
|
||||
config[key] = click.prompt(
|
||||
fmt.question(question), prompt_suffix=" ", default=default, show_default=True
|
||||
)
|
||||
|
||||
|
||||
def ask_bool(question, key, config, defaults):
|
||||
default = config.get(key, defaults[key])
|
||||
config[key] = click.confirm(
|
||||
fmt.question(question), prompt_suffix=" ", default=default
|
||||
)
|
||||
|
||||
|
||||
def ask_choice(question, key, config, defaults, choices):
|
||||
default = config.get(key, defaults[key])
|
||||
answer = click.prompt(
|
||||
fmt.question(question),
|
||||
type=click.Choice(choices),
|
||||
prompt_suffix=" ",
|
||||
default=default,
|
||||
show_choices=False,
|
||||
)
|
||||
config[key] = answer
|
||||
|
||||
|
||||
def convert_json2yml(root):
|
||||
json_path = os.path.join(root, "config.json")
|
||||
if not os.path.exists(json_path):
|
||||
return
|
||||
if os.path.exists(config_path(root)):
|
||||
raise exceptions.TutorError(
|
||||
"Both config.json and config.yml exist in {}: only one of these files must exist to continue".format(
|
||||
root
|
||||
)
|
||||
)
|
||||
with open(json_path) as fi:
|
||||
config = json.load(fi)
|
||||
save_config(root, config)
|
||||
os.remove(json_path)
|
||||
fmt.echo_info(
|
||||
"File config.json detected in {} and converted to config.yml".format(root)
|
||||
)
|
||||
|
||||
|
||||
def save_config(root, config):
|
||||
path = config_path(root)
|
||||
utils.ensure_file_directory_exists(path)
|
||||
with open(path, "w") as of:
|
||||
serialize.dump(config, of)
|
||||
fmt.echo_info("Configuration saved to {}".format(path))
|
||||
|
||||
|
||||
def save_env(root, config):
|
||||
env.render_full(root, config)
|
||||
fmt.echo_info("Environment generated in {}".format(env.base_dir(root)))
|
||||
|
||||
|
||||
def config_path(root):
|
||||
return os.path.join(root, "config.yml")
|
||||
|
||||
|
||||
config_command.add_command(save_command)
|
||||
config_command.add_command(printroot)
|
||||
config_command.add_command(printvalue)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
import click
|
||||
|
||||
from . import config as tutor_config
|
||||
from .. import config as tutor_config
|
||||
from .. import env as tutor_env
|
||||
from .. import fmt
|
||||
from .. import opts
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
import click
|
||||
|
||||
from . import config as tutor_config
|
||||
from .. import config as tutor_config
|
||||
from .. import env as tutor_env
|
||||
|
||||
# from .. import exceptions
|
||||
|
|
@ -81,7 +81,6 @@ def delete(root, yes):
|
|||
"Are you sure you want to delete the platform? All data will be removed.",
|
||||
abort=True,
|
||||
)
|
||||
config = tutor_config.load(root)
|
||||
utils.kubectl(
|
||||
"delete", "-k", tutor_env.pathjoin(root), "--ignore-not-found=true", "--wait"
|
||||
)
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ from textwrap import indent
|
|||
|
||||
import click
|
||||
|
||||
from . import config as tutor_config
|
||||
from .. import config as tutor_config
|
||||
from .. import env as tutor_env
|
||||
from .. import fmt
|
||||
from .. import opts
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
import click
|
||||
|
||||
from . import config as tutor_config
|
||||
from .. import config as tutor_config
|
||||
from .. import opts
|
||||
from .. import plugins
|
||||
|
||||
|
|
|
|||
355
tutor/config.py
Normal file
355
tutor/config.py
Normal file
|
|
@ -0,0 +1,355 @@
|
|||
import json
|
||||
import os
|
||||
import sys
|
||||
|
||||
import click
|
||||
|
||||
from . import exceptions
|
||||
from . import env
|
||||
from . import fmt
|
||||
from . import plugins
|
||||
from . import serialize
|
||||
from . import utils
|
||||
from .__about__ import __version__
|
||||
|
||||
|
||||
def save(root, silent=False, keyvalues=None):
|
||||
keyvalues = keyvalues or []
|
||||
config, defaults = load_all(root)
|
||||
for k, v in keyvalues:
|
||||
config[k] = v
|
||||
if not silent:
|
||||
load_interactive(config, defaults)
|
||||
save_config(root, config)
|
||||
merge(config, defaults)
|
||||
save_env(root, config)
|
||||
|
||||
|
||||
def load(root):
|
||||
"""
|
||||
Load configuration, and generate it interactively if the file does not
|
||||
exist.
|
||||
"""
|
||||
defaults = load_defaults()
|
||||
config = load_current(root, defaults)
|
||||
|
||||
should_update_env = False
|
||||
if not os.path.exists(config_path(root)):
|
||||
load_interactive(config, defaults)
|
||||
should_update_env = True
|
||||
save_config(root, config)
|
||||
|
||||
if not env.is_up_to_date(root):
|
||||
should_update_env = True
|
||||
pre_upgrade_announcement(root)
|
||||
|
||||
if should_update_env:
|
||||
save_env(root, config)
|
||||
|
||||
merge(config, defaults)
|
||||
return config
|
||||
|
||||
|
||||
def merge(config, defaults):
|
||||
"""
|
||||
Merge default values with user configuration.
|
||||
"""
|
||||
for key, value in defaults.items():
|
||||
if key not in config:
|
||||
if isinstance(value, str):
|
||||
config[key] = env.render_str(config, value)
|
||||
else:
|
||||
config[key] = value
|
||||
|
||||
|
||||
def pre_upgrade_announcement(root):
|
||||
"""
|
||||
Inform the user that the current environment is not up-to-date. Crash if running in
|
||||
non-interactive mode.
|
||||
"""
|
||||
fmt.echo_alert(
|
||||
"The current environment stored at {} is not up-to-date: it is at "
|
||||
"v{} while the 'tutor' binary is at v{}.".format(
|
||||
env.base_dir(root), env.version(root), __version__
|
||||
)
|
||||
)
|
||||
if os.isatty(sys.stdin.fileno()):
|
||||
# Interactive mode: ask the user permission to proceed
|
||||
click.confirm(
|
||||
fmt.question(
|
||||
# every patch you take, every change you make, I'll be watching you
|
||||
"Would you like to upgrade the environment? If you do, any change you"
|
||||
" might have made will be overwritten."
|
||||
),
|
||||
default=True,
|
||||
abort=True,
|
||||
)
|
||||
else:
|
||||
# Non-interactive mode with no authorization: abort
|
||||
raise exceptions.TutorError(
|
||||
"Running in non-interactive mode, the environment will not be upgraded"
|
||||
" automatically. To upgrade the environment manually, run:\n"
|
||||
"\n"
|
||||
" tutor config save -y"
|
||||
)
|
||||
|
||||
|
||||
def load_all(root):
|
||||
defaults = load_defaults()
|
||||
current = load_current(root, defaults)
|
||||
return current, defaults
|
||||
|
||||
|
||||
def load_defaults():
|
||||
return serialize.load(env.read("config.yml"))
|
||||
|
||||
|
||||
def load_current(root, defaults):
|
||||
"""
|
||||
Note: this modifies the defaults. TODO this is not that great.
|
||||
"""
|
||||
convert_json2yml(root)
|
||||
config = load_user(root)
|
||||
load_env(config, defaults)
|
||||
load_required(config, defaults)
|
||||
load_plugins(config, defaults)
|
||||
return config
|
||||
|
||||
|
||||
def load_user(root):
|
||||
path = config_path(root)
|
||||
if not os.path.exists(path):
|
||||
return {}
|
||||
|
||||
with open(path) as fi:
|
||||
config = serialize.load(fi.read())
|
||||
upgrade_obsolete(config)
|
||||
return config
|
||||
|
||||
|
||||
def load_env(config, defaults):
|
||||
for k in defaults.keys():
|
||||
env_var = "TUTOR_" + k
|
||||
if env_var in os.environ:
|
||||
config[k] = serialize.parse_value(os.environ[env_var])
|
||||
|
||||
|
||||
def load_required(config, defaults):
|
||||
"""
|
||||
All these keys must be present in the user's config.yml. This includes all important
|
||||
values, such as LMS_HOST, and randomly-generated values, such as passwords.
|
||||
"""
|
||||
for key in [
|
||||
"LMS_HOST",
|
||||
"CMS_HOST",
|
||||
"CONTACT_EMAIL",
|
||||
"SECRET_KEY",
|
||||
"MYSQL_ROOT_PASSWORD",
|
||||
"OPENEDX_MYSQL_PASSWORD",
|
||||
"NOTES_MYSQL_PASSWORD",
|
||||
"NOTES_SECRET_KEY",
|
||||
"NOTES_OAUTH2_SECRET",
|
||||
"XQUEUE_AUTH_PASSWORD",
|
||||
"XQUEUE_MYSQL_PASSWORD",
|
||||
"XQUEUE_SECRET_KEY",
|
||||
"ANDROID_OAUTH2_SECRET",
|
||||
"ID",
|
||||
]:
|
||||
if key not in config:
|
||||
config[key] = env.render_str(config, defaults[key])
|
||||
|
||||
|
||||
def load_plugins(config, defaults):
|
||||
add_config, set_config, defaults_config = plugins.load_config(config)
|
||||
merge(config, add_config)
|
||||
# TODO this might have unexpected consequences if plugins have conflicting configurations. Maybe we should print warning messages.
|
||||
merge(config, set_config)
|
||||
# TODO this modifies defaults, which is ugly.
|
||||
merge(defaults, defaults_config)
|
||||
|
||||
|
||||
def upgrade_obsolete(config):
|
||||
# Openedx-specific mysql passwords
|
||||
if "MYSQL_PASSWORD" in config:
|
||||
config["MYSQL_ROOT_PASSWORD"] = config["MYSQL_PASSWORD"]
|
||||
config["OPENEDX_MYSQL_PASSWORD"] = config["MYSQL_PASSWORD"]
|
||||
config.pop("MYSQL_PASSWORD")
|
||||
if "MYSQL_DATABASE" in config:
|
||||
config["OPENEDX_MYSQL_DATABASE"] = config.pop("MYSQL_DATABASE")
|
||||
if "MYSQL_USERNAME" in config:
|
||||
config["OPENEDX_MYSQL_USERNAME"] = config.pop("MYSQL_USERNAME")
|
||||
|
||||
|
||||
def load_interactive(config, defaults):
|
||||
ask("Your website domain name for students (LMS)", "LMS_HOST", config, defaults)
|
||||
ask("Your website domain name for teachers (CMS)", "CMS_HOST", config, defaults)
|
||||
ask("Your platform name/title", "PLATFORM_NAME", config, defaults)
|
||||
ask("Your public contact email address", "CONTACT_EMAIL", config, defaults)
|
||||
ask_choice(
|
||||
"The default language code for the platform",
|
||||
"LANGUAGE_CODE",
|
||||
config,
|
||||
defaults,
|
||||
[
|
||||
"en",
|
||||
"am",
|
||||
"ar",
|
||||
"az",
|
||||
"bg-bg",
|
||||
"bn-bd",
|
||||
"bn-in",
|
||||
"bs",
|
||||
"ca",
|
||||
"ca@valencia",
|
||||
"cs",
|
||||
"cy",
|
||||
"da",
|
||||
"de-de",
|
||||
"el",
|
||||
"en-uk",
|
||||
"en@lolcat",
|
||||
"en@pirate",
|
||||
"es-419",
|
||||
"es-ar",
|
||||
"es-ec",
|
||||
"es-es",
|
||||
"es-mx",
|
||||
"es-pe",
|
||||
"et-ee",
|
||||
"eu-es",
|
||||
"fa",
|
||||
"fa-ir",
|
||||
"fi-fi",
|
||||
"fil",
|
||||
"fr",
|
||||
"gl",
|
||||
"gu",
|
||||
"he",
|
||||
"hi",
|
||||
"hr",
|
||||
"hu",
|
||||
"hy-am",
|
||||
"id",
|
||||
"it-it",
|
||||
"ja-jp",
|
||||
"kk-kz",
|
||||
"km-kh",
|
||||
"kn",
|
||||
"ko-kr",
|
||||
"lt-lt",
|
||||
"ml",
|
||||
"mn",
|
||||
"mr",
|
||||
"ms",
|
||||
"nb",
|
||||
"ne",
|
||||
"nl-nl",
|
||||
"or",
|
||||
"pl",
|
||||
"pt-br",
|
||||
"pt-pt",
|
||||
"ro",
|
||||
"ru",
|
||||
"si",
|
||||
"sk",
|
||||
"sl",
|
||||
"sq",
|
||||
"sr",
|
||||
"sv",
|
||||
"sw",
|
||||
"ta",
|
||||
"te",
|
||||
"th",
|
||||
"tr-tr",
|
||||
"uk",
|
||||
"ur",
|
||||
"vi",
|
||||
"uz",
|
||||
"zh-cn",
|
||||
"zh-hk",
|
||||
"zh-tw",
|
||||
],
|
||||
)
|
||||
ask_bool(
|
||||
(
|
||||
"Activate SSL/TLS certificates for HTTPS access? Important note:"
|
||||
" this will NOT work in a development environment."
|
||||
),
|
||||
"ACTIVATE_HTTPS",
|
||||
config,
|
||||
defaults,
|
||||
)
|
||||
ask_bool(
|
||||
"Activate Student Notes service (https://open.edx.org/features/student-notes)?",
|
||||
"ACTIVATE_NOTES",
|
||||
config,
|
||||
defaults,
|
||||
)
|
||||
ask_bool(
|
||||
"Activate Xqueue for external grader services (https://github.com/edx/xqueue)?",
|
||||
"ACTIVATE_XQUEUE",
|
||||
config,
|
||||
defaults,
|
||||
)
|
||||
|
||||
|
||||
def ask(question, key, config, defaults):
|
||||
default = env.render_str(config, config.get(key, defaults[key]))
|
||||
config[key] = click.prompt(
|
||||
fmt.question(question), prompt_suffix=" ", default=default, show_default=True
|
||||
)
|
||||
|
||||
|
||||
def ask_bool(question, key, config, defaults):
|
||||
default = config.get(key, defaults[key])
|
||||
config[key] = click.confirm(
|
||||
fmt.question(question), prompt_suffix=" ", default=default
|
||||
)
|
||||
|
||||
|
||||
def ask_choice(question, key, config, defaults, choices):
|
||||
default = config.get(key, defaults[key])
|
||||
answer = click.prompt(
|
||||
fmt.question(question),
|
||||
type=click.Choice(choices),
|
||||
prompt_suffix=" ",
|
||||
default=default,
|
||||
show_choices=False,
|
||||
)
|
||||
config[key] = answer
|
||||
|
||||
|
||||
def convert_json2yml(root):
|
||||
json_path = os.path.join(root, "config.json")
|
||||
if not os.path.exists(json_path):
|
||||
return
|
||||
if os.path.exists(config_path(root)):
|
||||
raise exceptions.TutorError(
|
||||
"Both config.json and config.yml exist in {}: only one of these files must exist to continue".format(
|
||||
root
|
||||
)
|
||||
)
|
||||
with open(json_path) as fi:
|
||||
config = json.load(fi)
|
||||
save_config(root, config)
|
||||
os.remove(json_path)
|
||||
fmt.echo_info(
|
||||
"File config.json detected in {} and converted to config.yml".format(root)
|
||||
)
|
||||
|
||||
|
||||
def save_config(root, config):
|
||||
path = config_path(root)
|
||||
utils.ensure_file_directory_exists(path)
|
||||
with open(path, "w") as of:
|
||||
serialize.dump(config, of)
|
||||
fmt.echo_info("Configuration saved to {}".format(path))
|
||||
|
||||
|
||||
def save_env(root, config):
|
||||
env.render_full(root, config)
|
||||
fmt.echo_info("Environment generated in {}".format(env.base_dir(root)))
|
||||
|
||||
|
||||
def config_path(root):
|
||||
return os.path.join(root, "config.yml")
|
||||
|
|
@ -3,7 +3,8 @@ import pkg_resources
|
|||
from . import exceptions
|
||||
|
||||
"""
|
||||
Tutor plugins are regular python packages that have a 'tutor.plugin.v1' entrypoint. This entrypoint must point to a module or a class that implements I don't know what (yet).
|
||||
Tutor plugins are regular python packages that have a 'tutor.plugin.v1' entrypoint. This
|
||||
entrypoint must point to a module or a class that implements I don't know what (yet).
|
||||
TODO
|
||||
"""
|
||||
|
||||
|
|
@ -102,7 +103,7 @@ def iter_patches(config, name):
|
|||
def load_config(config):
|
||||
"""
|
||||
TODO Return:
|
||||
|
||||
|
||||
add_config (dict): config key/values to add, if they are not already present
|
||||
set_config (dict): config key/values to set and override existing values
|
||||
"""
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ def migrate(runner):
|
|||
fmt.echo_info("Running {} migrations...".format(service))
|
||||
runner.run(service, "init")
|
||||
# TODO it's really ugly to load the config from the runner
|
||||
for plugin_name, service, command in plugins.iter_scripts(runner.config, "init"):
|
||||
for plugin_name, service, _command in plugins.iter_scripts(runner.config, "init"):
|
||||
fmt.echo_info(
|
||||
"Plugin {}: running init for service {}...".format(plugin_name, service)
|
||||
)
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user