mirror of
https://github.com/copier-org/copier.git
synced 2025-05-31 23:25:15 +00:00
cda93273c1
* use a new toolkit for user prompting: questionary (patched). * multiline questions. * conditional questions. * new toolkit for ui tests: pexpect. * fix lots of tests. * fix windows builds with newer poetry-dynamic-versioning. * linters and mypy are now tests, to have faster ci. * update deprecated ci commands. * removed dependencies from old times. * Remove toml 0.5+ syntax (dotted keys) * Use powershell where syntax is compatible * Change skip to xfail * xfail pexpect tests on windows. I'm tired of trying to make it work * more docs * possibly something more.
248 lines
8.3 KiB
Python
248 lines
8.3 KiB
Python
from pathlib import Path
|
|
|
|
import pexpect
|
|
import pytest
|
|
import yaml
|
|
from plumbum import local
|
|
from plumbum.cmd import git
|
|
|
|
from .helpers import COPIER_PATH, Keyboard, build_file_tree
|
|
|
|
DEFAULT = object()
|
|
MARIO_TREE = {
|
|
"copier.yml": """\
|
|
in_love:
|
|
type: bool
|
|
default: yes
|
|
your_name:
|
|
type: str
|
|
default: Mario
|
|
help: If you have a name, tell me now.
|
|
your_enemy:
|
|
type: str
|
|
default: Bowser
|
|
secret: yes
|
|
help: Secret enemy name
|
|
what_enemy_does:
|
|
type: str
|
|
default: "[[ your_enemy ]] hates [[ your_name ]]"
|
|
""",
|
|
"[[ _copier_conf.answers_file ]].tmpl": "[[_copier_answers|to_nice_yaml]]",
|
|
}
|
|
|
|
|
|
@pytest.mark.parametrize("name", [DEFAULT, None, "Luigi"])
|
|
def test_copy_default_advertised(tmp_path_factory, spawn, name):
|
|
"""Test that the questions for the user are OK"""
|
|
template, subproject = (
|
|
tmp_path_factory.mktemp("template"),
|
|
tmp_path_factory.mktemp("subproject"),
|
|
)
|
|
with local.cwd(template):
|
|
build_file_tree(MARIO_TREE)
|
|
git("init")
|
|
git("add", ".")
|
|
git("commit", "-m", "v1")
|
|
git("tag", "v1")
|
|
git("commit", "--allow-empty", "-m", "v2")
|
|
git("tag", "v2")
|
|
with local.cwd(subproject):
|
|
# Copy the v1 template
|
|
args = []
|
|
if name is not DEFAULT:
|
|
args.append(f"--data=your_name={name}")
|
|
else:
|
|
name = "Mario" # Default in the template
|
|
name = str(name)
|
|
tui = spawn(
|
|
[COPIER_PATH, str(template), ".", "--vcs-ref=v1"] + args, timeout=10
|
|
)
|
|
# Check what was captured
|
|
tui.expect_exact(["in_love?", "Format: bool", "(Y/n)"])
|
|
tui.sendline()
|
|
tui.expect_exact(["Yes"])
|
|
if not args:
|
|
tui.expect_exact(
|
|
["If you have a name, tell me now.", "your_name?", "Format: str", name]
|
|
)
|
|
tui.sendline()
|
|
tui.expect_exact(["Secret enemy name", "your_enemy?", "Format: str", "******"])
|
|
tui.sendline()
|
|
tui.expect_exact(["what_enemy_does?", "Format: str", f"Bowser hates {name}"])
|
|
tui.sendline()
|
|
tui.expect_exact(pexpect.EOF)
|
|
assert "_commit: v1" in Path(".copier-answers.yml").read_text()
|
|
# Update subproject
|
|
git("init")
|
|
git("add", ".")
|
|
assert "_commit: v1" in Path(".copier-answers.yml").read_text()
|
|
git("commit", "-m", "v1")
|
|
tui = spawn([COPIER_PATH], timeout=10)
|
|
# Check what was captured
|
|
tui.expect_exact(["in_love?", "Format: bool", "(Y/n)"])
|
|
tui.sendline()
|
|
tui.expect_exact(
|
|
["If you have a name, tell me now.", "your_name?", "Format: str", name]
|
|
)
|
|
tui.sendline()
|
|
tui.expect_exact(["Secret enemy name", "your_enemy?", "Format: str", "Bowser"])
|
|
tui.sendline()
|
|
tui.expect_exact(["what_enemy_does?", "Format: str", f"Bowser hates {name}"])
|
|
tui.sendline()
|
|
tui.expect_exact(["Overwrite", ".copier-answers.yml", "[Y/n]"])
|
|
tui.sendline()
|
|
tui.expect_exact(pexpect.EOF)
|
|
assert "_commit: v2" in Path(".copier-answers.yml").read_text()
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"question_2_when, asks",
|
|
(
|
|
(True, True),
|
|
(False, False),
|
|
("trUe", True),
|
|
("faLse", False),
|
|
("Yes", True),
|
|
("nO", False),
|
|
("Y", True),
|
|
("N", False),
|
|
("on", True),
|
|
("off", False),
|
|
("[[ question_1 ]]", True),
|
|
("[[ not question_1 ]]", False),
|
|
("[% if question_1 %]YES[% endif %]", True),
|
|
("[% if question_1 %]FALSE[% endif %]", False),
|
|
),
|
|
)
|
|
def test_when(tmp_path_factory, question_2_when, spawn, asks):
|
|
"""Test that the 2nd question is skipped or not, properly."""
|
|
template, subproject = (
|
|
tmp_path_factory.mktemp("template"),
|
|
tmp_path_factory.mktemp("subproject"),
|
|
)
|
|
questions = {
|
|
"question_1": {"type": "bool", "default": True},
|
|
"question_2": {"default": "something", "when": question_2_when},
|
|
}
|
|
build_file_tree(
|
|
{
|
|
template / "copier.yml": yaml.dump(questions),
|
|
template
|
|
/ "[[ _copier_conf.answers_file ]].tmpl": "[[ _copier_answers|to_nice_yaml ]]",
|
|
}
|
|
)
|
|
tui = spawn([COPIER_PATH, str(template), str(subproject)], timeout=10)
|
|
tui.expect_exact(["question_1?", "Format: bool", "(Y/n)"])
|
|
tui.sendline()
|
|
if asks:
|
|
tui.expect_exact(["question_2?", "Format: yaml"])
|
|
tui.sendline()
|
|
tui.expect_exact(pexpect.EOF)
|
|
answers = yaml.safe_load((subproject / ".copier-answers.yml").read_text())
|
|
assert answers == {
|
|
"_src_path": str(template),
|
|
"question_1": True,
|
|
"question_2": "something",
|
|
}
|
|
|
|
|
|
def test_placeholder(tmp_path_factory, spawn):
|
|
template, subproject = (
|
|
tmp_path_factory.mktemp("template"),
|
|
tmp_path_factory.mktemp("subproject"),
|
|
)
|
|
build_file_tree(
|
|
{
|
|
template
|
|
/ "copier.yml": yaml.dump(
|
|
{
|
|
"question_1": "answer 1",
|
|
"question_2": {
|
|
"type": "str",
|
|
"help": "write a list of answers",
|
|
"placeholder": "Write something like [[ question_1 ]], but better",
|
|
},
|
|
}
|
|
),
|
|
template
|
|
/ "[[ _copier_conf.answers_file ]].tmpl": "[[ _copier_answers|to_nice_yaml ]]",
|
|
}
|
|
)
|
|
tui = spawn([COPIER_PATH, str(template), str(subproject)], timeout=10)
|
|
tui.expect_exact(["question_1?", "Format: str", "answer 1"])
|
|
tui.sendline()
|
|
tui.expect_exact(
|
|
["question_2?", "Format: yaml", "Write something like answer 1, but better"]
|
|
)
|
|
tui.sendline()
|
|
tui.expect_exact(pexpect.EOF)
|
|
answers = yaml.safe_load((subproject / ".copier-answers.yml").read_text())
|
|
assert answers == {
|
|
"_src_path": str(template),
|
|
"question_1": "answer 1",
|
|
"question_2": None,
|
|
}
|
|
|
|
|
|
@pytest.mark.parametrize("type_", ("str", "yaml", "json"))
|
|
def test_multiline(tmp_path_factory, spawn, type_):
|
|
template, subproject = (
|
|
tmp_path_factory.mktemp("template"),
|
|
tmp_path_factory.mktemp("subproject"),
|
|
)
|
|
build_file_tree(
|
|
{
|
|
template
|
|
/ "copier.yml": yaml.dump(
|
|
{
|
|
"question_1": "answer 1",
|
|
"question_2": {"type": type_},
|
|
"question_3": {"type": type_, "multiline": True},
|
|
"question_4": {
|
|
"type": type_,
|
|
"multiline": "[[ question_1 == 'answer 1' ]]",
|
|
},
|
|
"question_5": {
|
|
"type": type_,
|
|
"multiline": "[[ question_1 != 'answer 1' ]]",
|
|
},
|
|
}
|
|
),
|
|
template
|
|
/ "[[ _copier_conf.answers_file ]].tmpl": "[[ _copier_answers|to_nice_yaml ]]",
|
|
}
|
|
)
|
|
tui = spawn([COPIER_PATH, str(template), str(subproject)], timeout=10)
|
|
tui.expect_exact(["question_1?", "Format: str", "answer 1"])
|
|
tui.sendline()
|
|
tui.expect_exact(["question_2?", f"Format: {type_}"])
|
|
tui.sendline('"answer 2"')
|
|
tui.expect_exact(["question_3?", f"Format: {type_}"])
|
|
tui.sendline('"answer 3"')
|
|
tui.send(Keyboard.Alt + Keyboard.Enter)
|
|
tui.expect_exact(["question_4?", f"Format: {type_}"])
|
|
tui.sendline('"answer 4"')
|
|
tui.send(Keyboard.Alt + Keyboard.Enter)
|
|
tui.expect_exact(["question_5?", f"Format: {type_}"])
|
|
tui.sendline('"answer 5"')
|
|
tui.expect_exact(pexpect.EOF)
|
|
answers = yaml.safe_load((subproject / ".copier-answers.yml").read_text())
|
|
if type_ == "str":
|
|
assert answers == {
|
|
"_src_path": str(template),
|
|
"question_1": "answer 1",
|
|
"question_2": '"answer 2"',
|
|
"question_3": ('"answer 3"\n'),
|
|
"question_4": ('"answer 4"\n'),
|
|
"question_5": ('"answer 5"'),
|
|
}
|
|
else:
|
|
assert answers == {
|
|
"_src_path": str(template),
|
|
"question_1": "answer 1",
|
|
"question_2": ("answer 2"),
|
|
"question_3": ("answer 3"),
|
|
"question_4": ("answer 4"),
|
|
"question_5": ("answer 5"),
|
|
}
|