mirror of
https://github.com/copier-org/copier.git
synced 2025-05-05 23:42:55 +00:00
eb3bb5e67a
Before this patch, an answers file could remember answers to questions that were not present in the questionary. STR: 1. In one project, apply one template that has a `.copier-answers.yml` file. 2. Now apply another template that has a different default value in `_answers_file`. 3. The second answers file would contain answers to the 1st template too. @moduon MT-616
537 lines
17 KiB
Python
537 lines
17 KiB
Python
import json
|
|
from collections import deque
|
|
from pathlib import Path
|
|
from textwrap import dedent
|
|
|
|
import pexpect
|
|
import pytest
|
|
import yaml
|
|
from plumbum import local
|
|
from plumbum.cmd import git
|
|
|
|
from copier import copy, run_auto, run_update
|
|
|
|
from .helpers import (
|
|
BRACKET_ENVOPS_JSON,
|
|
COPIER_PATH,
|
|
SUFFIX_TMPL,
|
|
Keyboard,
|
|
build_file_tree,
|
|
)
|
|
|
|
|
|
@pytest.fixture(scope="module")
|
|
def template_path(tmp_path_factory) -> str:
|
|
root = tmp_path_factory.mktemp("template")
|
|
build_file_tree(
|
|
{
|
|
root
|
|
/ "copier.yml": f"""\
|
|
_templates_suffix: {SUFFIX_TMPL}
|
|
_envops: {BRACKET_ENVOPS_JSON}
|
|
love_me:
|
|
help: I need to know it. Do you love me?
|
|
type: bool
|
|
your_name:
|
|
help: Please tell me your name.
|
|
type: str
|
|
your_age:
|
|
help: How old are you?
|
|
type: int
|
|
your_height:
|
|
help: What's your height?
|
|
type: float
|
|
more_json_info:
|
|
multiline: true
|
|
type: json
|
|
anything_else:
|
|
multiline: true
|
|
help: Wanna give me any more info?
|
|
|
|
# In choices, the user will always write the choice index (1, 2, 3...)
|
|
choose_list:
|
|
help: You see the value of the list items
|
|
default: first
|
|
choices:
|
|
- first
|
|
- second
|
|
- third
|
|
choose_tuple:
|
|
help: You see the 1st tuple item, but I get the 2nd item as a result
|
|
default: second
|
|
choices:
|
|
- [one, first]
|
|
- [two, second]
|
|
- [three, third]
|
|
choose_dict:
|
|
help: You see the dict key, but I get the dict value
|
|
default: third
|
|
choices:
|
|
one: first
|
|
two: second
|
|
three: third
|
|
choose_number:
|
|
help: This must be a number
|
|
default: null
|
|
type: float
|
|
choices:
|
|
- -1.1
|
|
- 0
|
|
- 1
|
|
|
|
# Simplified format is still supported
|
|
minutes_under_water: 10
|
|
optional_value: null
|
|
""",
|
|
root
|
|
/ "results.txt.tmpl": """\
|
|
love_me: [[love_me|tojson]]
|
|
your_name: [[your_name|tojson]]
|
|
your_age: [[your_age|tojson]]
|
|
your_height: [[your_height|tojson]]
|
|
more_json_info: [[more_json_info|tojson]]
|
|
anything_else: [[anything_else|tojson]]
|
|
choose_list: [[choose_list|tojson]]
|
|
choose_tuple: [[choose_tuple|tojson]]
|
|
choose_dict: [[choose_dict|tojson]]
|
|
choose_number: [[choose_number|tojson]]
|
|
minutes_under_water: [[minutes_under_water|tojson]]
|
|
optional_value: [[optional_value|tojson]]
|
|
""",
|
|
}
|
|
)
|
|
return str(root)
|
|
|
|
|
|
def test_api(tmp_path, template_path):
|
|
"""Test copier correctly processes advanced questions and answers through API."""
|
|
copy(
|
|
template_path,
|
|
tmp_path,
|
|
{
|
|
"love_me": False,
|
|
"your_name": "LeChuck",
|
|
"your_age": 220,
|
|
"your_height": 1.9,
|
|
"more_json_info": ["bad", "guy"],
|
|
"anything_else": {"hates": "all"},
|
|
},
|
|
defaults=True,
|
|
overwrite=True,
|
|
)
|
|
results_file = tmp_path / "results.txt"
|
|
assert results_file.read_text() == dedent(
|
|
"""\
|
|
love_me: false
|
|
your_name: "LeChuck"
|
|
your_age: 220
|
|
your_height: 1.9
|
|
more_json_info: ["bad", "guy"]
|
|
anything_else: {"hates": "all"}
|
|
choose_list: "first"
|
|
choose_tuple: "second"
|
|
choose_dict: "third"
|
|
choose_number: null
|
|
minutes_under_water: 10
|
|
optional_value: null
|
|
"""
|
|
)
|
|
|
|
|
|
def test_cli_interactive(tmp_path, spawn, template_path):
|
|
"""Test copier correctly processes advanced questions and answers through CLI."""
|
|
invalid = ["Invalid input"]
|
|
tui = spawn(COPIER_PATH + ("copy", template_path, str(tmp_path)), timeout=10)
|
|
deque(
|
|
map(
|
|
tui.expect_exact,
|
|
["I need to know it. Do you love me?", "love_me", "Format: bool"],
|
|
)
|
|
)
|
|
tui.send("y")
|
|
deque(
|
|
map(tui.expect_exact, ["Please tell me your name.", "your_name", "Format: str"])
|
|
)
|
|
tui.sendline("Guybrush Threpwood")
|
|
q = ["How old are you?", "your_age", "Format: int"]
|
|
tui.expect_exact(q)
|
|
tui.sendline("wrong your_age")
|
|
tui.expect_exact(invalid + q)
|
|
tui.send((Keyboard.Alt + Keyboard.Backspace) * 2)
|
|
tui.sendline("22")
|
|
q = ["What's your height?", "your_height", "Format: float"]
|
|
tui.expect_exact(q)
|
|
tui.sendline("wrong your_height")
|
|
tui.expect_exact(invalid + q)
|
|
tui.send((Keyboard.Alt + Keyboard.Backspace) * 2)
|
|
tui.sendline("1.56")
|
|
q = ["more_json_info", "Format: json"]
|
|
tui.expect_exact(q)
|
|
tui.sendline('{"objective":')
|
|
tui.expect_exact(invalid + q)
|
|
tui.sendline('"be a pirate"}')
|
|
tui.send(Keyboard.Esc + Keyboard.Enter)
|
|
q = ["Wanna give me any more info?", "anything_else", "Format: yaml"]
|
|
tui.expect_exact(q)
|
|
tui.sendline("- Want some grog?")
|
|
tui.expect_exact(invalid + q)
|
|
tui.sendline("- I'd love it")
|
|
tui.send(Keyboard.Esc + Keyboard.Enter)
|
|
deque(
|
|
map(
|
|
tui.expect_exact,
|
|
[
|
|
"You see the value of the list items",
|
|
"choose_list",
|
|
"Format: str",
|
|
"first",
|
|
"second",
|
|
"third",
|
|
],
|
|
)
|
|
)
|
|
tui.sendline()
|
|
deque(
|
|
map(
|
|
tui.expect_exact,
|
|
[
|
|
"You see the 1st tuple item, but I get the 2nd item as a result",
|
|
"choose_tuple",
|
|
"one",
|
|
"two",
|
|
"three",
|
|
],
|
|
)
|
|
)
|
|
tui.sendline()
|
|
deque(
|
|
map(
|
|
tui.expect_exact,
|
|
[
|
|
"You see the dict key, but I get the dict value",
|
|
"choose_dict",
|
|
"one",
|
|
"two",
|
|
"three",
|
|
],
|
|
)
|
|
)
|
|
tui.sendline()
|
|
deque(
|
|
map(
|
|
tui.expect_exact,
|
|
["This must be a number", "choose_number", "-1.1", "0", "1"],
|
|
)
|
|
)
|
|
tui.sendline()
|
|
deque(map(tui.expect_exact, ["minutes_under_water", "Format: int", "10"]))
|
|
tui.send(Keyboard.Backspace)
|
|
tui.sendline()
|
|
deque(map(tui.expect_exact, ["optional_value", "Format: yaml"]))
|
|
tui.sendline()
|
|
tui.expect_exact(pexpect.EOF)
|
|
results_file = tmp_path / "results.txt"
|
|
assert results_file.read_text() == dedent(
|
|
"""\
|
|
love_me: true
|
|
your_name: "Guybrush Threpwood"
|
|
your_age: 22
|
|
your_height: 1.56
|
|
more_json_info: {"objective": "be a pirate"}
|
|
anything_else: ["Want some grog?", "I\\u0027d love it"]
|
|
choose_list: "first"
|
|
choose_tuple: "second"
|
|
choose_dict: "third"
|
|
choose_number: -1.1
|
|
minutes_under_water: 1
|
|
optional_value: null
|
|
"""
|
|
)
|
|
|
|
|
|
def test_api_str_data(tmp_path, template_path):
|
|
"""Test copier when all data comes as a string.
|
|
|
|
This happens i.e. when using the --data CLI argument.
|
|
"""
|
|
copy(
|
|
template_path,
|
|
tmp_path,
|
|
data={
|
|
"love_me": "false",
|
|
"your_name": "LeChuck",
|
|
"your_age": "220",
|
|
"your_height": "1.9",
|
|
"more_json_info": '["bad", "guy"]',
|
|
"anything_else": "{'hates': 'all'}",
|
|
"choose_number": "0",
|
|
},
|
|
defaults=True,
|
|
overwrite=True,
|
|
)
|
|
results_file = tmp_path / "results.txt"
|
|
assert results_file.read_text() == dedent(
|
|
"""\
|
|
love_me: "false"
|
|
your_name: "LeChuck"
|
|
your_age: "220"
|
|
your_height: "1.9"
|
|
more_json_info: "[\\"bad\\", \\"guy\\"]"
|
|
anything_else: "{\\u0027hates\\u0027: \\u0027all\\u0027}"
|
|
choose_list: "first"
|
|
choose_tuple: "second"
|
|
choose_dict: "third"
|
|
choose_number: "0"
|
|
minutes_under_water: 10
|
|
optional_value: null
|
|
"""
|
|
)
|
|
|
|
|
|
def test_cli_interatively_with_flag_data_and_type_casts(
|
|
tmp_path: Path, spawn, template_path
|
|
):
|
|
"""Assert how choices work when copier is invoked with --data interactively."""
|
|
invalid = "Invalid input"
|
|
tui = spawn(
|
|
COPIER_PATH
|
|
+ (
|
|
"--data=choose_list=second",
|
|
"--data=choose_dict=first",
|
|
"--data=choose_tuple=third",
|
|
"--data=choose_number=1",
|
|
"copy",
|
|
template_path,
|
|
str(tmp_path),
|
|
),
|
|
timeout=10,
|
|
)
|
|
deque(
|
|
map(
|
|
tui.expect_exact,
|
|
["I need to know it. Do you love me?", "love_me", "Format: bool"],
|
|
)
|
|
)
|
|
tui.send("y")
|
|
deque(
|
|
map(
|
|
tui.expect_exact,
|
|
["Please tell me your name.", "your_name", "Format: str"],
|
|
)
|
|
)
|
|
tui.sendline("Guybrush Threpwood")
|
|
deque(map(tui.expect_exact, ["How old are you?", "your_age", "Format: int"]))
|
|
tui.send("wrong your_age")
|
|
tui.expect_exact(invalid)
|
|
tui.sendline() # Does nothing, "wrong your_age still on screen"
|
|
tui.send((Keyboard.Alt + Keyboard.Backspace) * 2)
|
|
tui.sendline("22")
|
|
deque(
|
|
map(tui.expect_exact, ["What's your height?", "your_height", "Format: float"])
|
|
)
|
|
tui.send("wrong your_height")
|
|
tui.expect_exact(invalid)
|
|
tui.send((Keyboard.Alt + Keyboard.Backspace) * 2)
|
|
tui.sendline("1.56")
|
|
deque(map(tui.expect_exact, ["more_json_info", "Format: json"]))
|
|
tui.sendline('{"objective":')
|
|
tui.expect_exact(invalid)
|
|
tui.sendline('"be a pirate"}')
|
|
tui.send(Keyboard.Esc + Keyboard.Enter)
|
|
deque(
|
|
map(
|
|
tui.expect_exact,
|
|
["Wanna give me any more info?", "anything_else", "Format: yaml"],
|
|
)
|
|
)
|
|
tui.sendline("- Want some grog?")
|
|
tui.sendline("- I'd love it")
|
|
tui.send(Keyboard.Esc + Keyboard.Enter)
|
|
deque(map(tui.expect_exact, ["minutes_under_water", "Format: int", "10"]))
|
|
tui.sendline()
|
|
deque(map(tui.expect_exact, ["optional_value", "Format: yaml"]))
|
|
tui.sendline()
|
|
tui.expect_exact(pexpect.EOF)
|
|
results_file = tmp_path / "results.txt"
|
|
assert results_file.read_text() == dedent(
|
|
"""\
|
|
love_me: true
|
|
your_name: "Guybrush Threpwood"
|
|
your_age: 22
|
|
your_height: 1.56
|
|
more_json_info: {"objective": "be a pirate"}
|
|
anything_else: ["Want some grog?", "I\\u0027d love it"]
|
|
choose_list: "second"
|
|
choose_tuple: "third"
|
|
choose_dict: "first"
|
|
choose_number: 1
|
|
minutes_under_water: 10
|
|
optional_value: null
|
|
"""
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"has_2_owners, owner2", ((True, "example2"), (False, "example"))
|
|
)
|
|
def test_tui_inherited_default(tmp_path_factory, spawn, has_2_owners, owner2):
|
|
"""Make sure a template inherits default as expected."""
|
|
src, dst = map(tmp_path_factory.mktemp, ("src", "dst"))
|
|
build_file_tree(
|
|
{
|
|
src
|
|
/ "copier.yaml": """\
|
|
owner1:
|
|
type: str
|
|
has_2_owners:
|
|
type: bool
|
|
default: false
|
|
owner2:
|
|
type: str
|
|
default: "{{ owner1 }}"
|
|
when: "{{ has_2_owners }}"
|
|
""",
|
|
src
|
|
/ "{{ _copier_conf.answers_file }}.jinja": "{{ _copier_answers|to_nice_yaml }}",
|
|
src / "answers.json.jinja": "{{ _copier_answers|to_nice_json }}",
|
|
}
|
|
)
|
|
_git = git["-C", src]
|
|
_git("init")
|
|
_git("add", "--all")
|
|
_git("commit", "--message", "init template")
|
|
_git("tag", "1")
|
|
tui = spawn(
|
|
COPIER_PATH + ("copy", str(src), str(dst)),
|
|
timeout=10,
|
|
)
|
|
deque(map(tui.expect_exact, ["owner1?", "Format: str"]))
|
|
tui.sendline("example")
|
|
deque(map(tui.expect_exact, ["has_2_owners?", "Format: bool", "(y/N)"]))
|
|
tui.send("y" if has_2_owners else "n")
|
|
if has_2_owners:
|
|
deque(map(tui.expect_exact, ["owner2?", "Format: str", "example"]))
|
|
tui.sendline("2")
|
|
tui.expect_exact(pexpect.EOF)
|
|
result = {
|
|
"_commit": "1",
|
|
"_src_path": str(src),
|
|
"has_2_owners": has_2_owners,
|
|
"owner1": "example",
|
|
"owner2": owner2,
|
|
}
|
|
assert json.load((dst / "answers.json").open()) == result
|
|
_git = git["-C", dst]
|
|
_git("init")
|
|
_git("add", "--all")
|
|
_git("commit", "--message", "init project")
|
|
# After a forced update, answers stay the same
|
|
run_update(dst, defaults=True, overwrite=True)
|
|
assert json.load((dst / "answers.json").open()) == result
|
|
|
|
|
|
def test_selection_type_cast(tmp_path_factory, spawn):
|
|
"""Selection question with different types, properly casted."""
|
|
src, dst = map(tmp_path_factory.mktemp, ("src", "dst"))
|
|
build_file_tree(
|
|
{
|
|
src
|
|
/ "copier.yaml": """\
|
|
postgres1: &pg
|
|
type: yaml
|
|
default: 10
|
|
help: Which PostgreSQL version do you want to deploy?
|
|
choices:
|
|
I will use an external PostgreSQL server: null
|
|
"9.6": 9.6
|
|
"10": 10
|
|
postgres2: *pg
|
|
postgres3: *pg
|
|
nulls1: &nulls
|
|
type: yaml
|
|
choices:
|
|
- [same as key, null]
|
|
- [yaml-casted to a real null, "null"]
|
|
- [becomes array, "[one, 2, -3.0]"]
|
|
nulls2: *nulls
|
|
nulls3: *nulls
|
|
""",
|
|
src / "answers.json.jinja": "{{ _copier_answers|to_json }}",
|
|
}
|
|
)
|
|
tui = spawn(
|
|
COPIER_PATH + ("copy", str(src), str(dst)),
|
|
timeout=10,
|
|
)
|
|
tui.expect_exact("Which PostgreSQL version do you want to deploy?")
|
|
tui.expect_exact("postgres1?")
|
|
tui.expect_exact("Format: yaml")
|
|
tui.sendline(Keyboard.Down)
|
|
tui.expect_exact("Which PostgreSQL version do you want to deploy?")
|
|
tui.expect_exact("postgres2?")
|
|
tui.expect_exact("Format: yaml")
|
|
tui.sendline(Keyboard.Up)
|
|
tui.expect_exact("Which PostgreSQL version do you want to deploy?")
|
|
tui.expect_exact("postgres3?")
|
|
tui.expect_exact("Format: yaml")
|
|
tui.sendline()
|
|
tui.expect_exact("nulls1?")
|
|
tui.expect_exact("Format: yaml")
|
|
tui.sendline()
|
|
tui.expect_exact("nulls2?")
|
|
tui.expect_exact("Format: yaml")
|
|
tui.sendline(Keyboard.Down)
|
|
tui.expect_exact("nulls3?")
|
|
tui.expect_exact("Format: yaml")
|
|
tui.sendline(Keyboard.Down + Keyboard.Down)
|
|
tui.expect_exact(pexpect.EOF)
|
|
assert json.loads((dst / "answers.json").read_bytes()) == {
|
|
"_src_path": str(src),
|
|
"nulls1": "same as key",
|
|
"nulls2": None,
|
|
"nulls3": ["one", 2, -3.0],
|
|
"postgres1": "I will use an external PostgreSQL server",
|
|
"postgres2": 9.6,
|
|
"postgres3": 10,
|
|
}
|
|
|
|
|
|
def test_multi_template_answers(tmp_path_factory):
|
|
tpl1, tpl2, dst = map(tmp_path_factory.mktemp, map(str, range(3)))
|
|
# Build 2 templates with different questions and answers file defaults
|
|
build_file_tree(
|
|
{
|
|
tpl1 / "copier.yml": "q1: a1",
|
|
tpl1
|
|
/ "{{ _copier_conf.answers_file }}.jinja": "{{ _copier_answers|to_nice_yaml }}",
|
|
tpl2 / "copier.yml": "{_answers_file: two.yml, q2: a2}",
|
|
tpl2
|
|
/ "{{ _copier_conf.answers_file }}.jinja": "{{ _copier_answers|to_nice_yaml }}",
|
|
}
|
|
)
|
|
# Make them git-tracked
|
|
for tpl in (tpl1, tpl2):
|
|
git("-C", tpl, "init")
|
|
git("-C", tpl, "add", "-A")
|
|
git("-C", tpl, "commit", "-m1")
|
|
with local.cwd(dst):
|
|
# Apply template 1
|
|
run_auto(str(tpl1), overwrite=True, defaults=True)
|
|
git("init")
|
|
git("add", "-A")
|
|
git("commit", "-m1")
|
|
# Apply template 2
|
|
run_auto(str(tpl2), overwrite=True, defaults=True)
|
|
git("init")
|
|
git("add", "-A")
|
|
git("commit", "-m2")
|
|
# Check contents
|
|
answers1 = yaml.safe_load(Path(".copier-answers.yml").open())
|
|
assert answers1["_src_path"] == str(tpl1)
|
|
assert answers1["q1"] == "a1"
|
|
assert "q2" not in answers1
|
|
answers2 = yaml.safe_load(Path("two.yml").open())
|
|
assert answers2["_src_path"] == str(tpl2)
|
|
assert answers2["q2"] == "a2"
|
|
assert "q1" not in answers2
|