Function test_gitignore_file_unignored

tests/test_updatediff.py:1883–1943

(
    tmp_path_factory: pytest.TempPathFactory,
)

def test_gitignore_file_unignored(
    tmp_path_factory: pytest.TempPathFactory,
) -> None:
    env_file = ".env"
    gitignore_file = ".gitignore"

    # Template in v1 has a file with a single line;
    # in v2 it changes that line.
    # Meanwhile, downstream project made the same change.
    src, dst = map(tmp_path_factory.mktemp, ("src", "dst"))

    # First, create the template with an initial file
    build_file_tree(
        {
            (src / gitignore_file): "",
            (src / env_file): "",
            (src / "{{_copier_conf.answers_file}}.jinja"): (
                "{{_copier_answers|to_nice_yaml}}"
            ),
        }
    )

    with local.cwd(src):
        git_init("hello template")
        git("tag", "v1")

    # Generate the project a first time, assert the file exists
    run_copy(str(src), dst)
    for f in (env_file, gitignore_file):
        assert (dst / f).exists()
    assert load_answersfile_data(dst).get("_commit") == "v1"

    # Start versioning the generated project
    with local.cwd(dst):
        git_init("hello project")

    # Add a file to the `.gitignore` file
    with local.cwd(src):
        Path(gitignore_file).write_text(env_file)
        git("commit", "-am", "ignore file")
        git("tag", "v2")

    # Update the generated project
    run_update(dst_path=dst, overwrite=True)
    assert load_answersfile_data(dst).get("_commit") == "v2"

    # Commit project changes.
    with local.cwd(dst):
        git("commit", "-am", "update to template v2")

    # Remove the file previously added to `.gitignore`
    with local.cwd(src):
        Path(gitignore_file).write_text("")
        git("commit", "-am", "un-ignore file")
        git("tag", "v3")

    # Update the generated project.
    # This would fail if `git add` was called without the `--force` flag;