dotfiles/run-tests at main · fawaf/dotfiles · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
#!/usr/bin/env python3

"""tests for the setup script dotfile copy logic"""

import pathlib
import shutil
import subprocess
import sys
import tempfile
import unittest

script_dir = pathlib.Path(__file__).parent.absolute()
setup_script = script_dir / "setup"
fixtures_dir = script_dir / "test"
fixtures_config = fixtures_dir / "config.yaml"


def run_setup(home_dir, config_file=fixtures_config, extra_args=None):
    cmd = [
        sys.executable,
        str(setup_script),
        "--config",
        str(config_file),
        "--dotfiles-dir",
        str(fixtures_dir),
        "--home-dir",
        str(home_dir),
        "--no-custom",
        "--no-git",
    ]
    if extra_args:
        cmd.extend(extra_args)
    result = subprocess.run(cmd, capture_output=True, text=True)
    if result.returncode != 0:
        raise AssertionError(
            f"setup failed ({result.returncode}):\n{result.stdout}\n{result.stderr}"
        )
    return result


class SetupTest(unittest.TestCase):
    def setUp(self):
        self.home_dir = pathlib.Path(tempfile.mkdtemp())

    def tearDown(self):
        shutil.rmtree(self.home_dir)

    def read(self, *parts):
        return pathlib.Path(self.home_dir, *parts).read_text()

    def fixture(self, *parts):
        return pathlib.Path(fixtures_dir, *parts).read_text()

    def test_dotfile_file_gets_dot_prefix(self):
        run_setup(self.home_dir)

        self.assertEqual(self.read(".testfile"), self.fixture("testfile"))
        self.assertFalse((self.home_dir / "testfile").exists())

    def test_dotfile_dir_gets_dot_prefix(self):
        run_setup(self.home_dir)

        self.assertEqual(
            self.read(".rootdir/rootfile"), self.fixture("rootdir/rootfile")
        )
        self.assertFalse((self.home_dir / "rootdir").exists())

    def test_regular_file_gets_no_dot_prefix(self):
        run_setup(self.home_dir)

        self.assertEqual(self.read("regularfile"), self.fixture("regularfile"))
        self.assertFalse((self.home_dir / ".regularfile").exists())

    def test_regular_dir_gets_no_dot_prefix(self):
        run_setup(self.home_dir)

        self.assertEqual(
            self.read("zzregulardir/regulardirfile"),
            self.fixture("zzregulardir/regulardirfile"),
        )
        self.assertFalse((self.home_dir / ".zzregulardir").exists())

    def test_regular_dir_merges_into_existing_dir(self):
        existing_dir = self.home_dir / "zzregulardir"
        existing_dir.mkdir()
        existing_file = existing_dir / "existingfile"
        existing_file.write_text("do not remove me")

        run_setup(self.home_dir)

        self.assertEqual(existing_file.read_text(), "do not remove me")
        self.assertEqual(
            self.read("zzregulardir/regulardirfile"),
            self.fixture("zzregulardir/regulardirfile"),
        )
        self.assertFalse((self.home_dir / "zzregulardir.bak").exists())

    def test_regular_file_gets_backed_up(self):
        dest = self.home_dir / "regularfile"
        dest.write_text("old contents")

        run_setup(self.home_dir)

        self.assertEqual(dest.read_text(), self.fixture("regularfile"))
        self.assertEqual(self.read("regularfile.bak"), "old contents")

    def test_dotfile_gets_backed_up(self):
        dest = self.home_dir / ".testfile"
        dest.write_text("old contents")

        run_setup(self.home_dir)

        self.assertEqual(dest.read_text(), self.fixture("testfile"))
        self.assertEqual(self.read(".testfile.bak"), "old contents")

    def test_append_dir_keeps_existing_entries(self):
        existing_dir = self.home_dir / ".appendrootdir"
        existing_dir.mkdir()
        existing_file = existing_dir / "existingfile"
        existing_file.write_text("do not remove me")

        run_setup(self.home_dir)

        self.assertEqual(existing_file.read_text(), "do not remove me")
        self.assertEqual(
            self.read(".appendrootdir/appendrootsubfile"),
            self.fixture("appendrootdir/appendrootsubfile"),
        )

    def test_config_without_regular_files_treats_all_as_dotfiles(self):
        config_file = self.home_dir / "config-without-regular-files.yaml"
        config_file.write_text("append:\n  appendrootdir:\n")

        run_setup(self.home_dir, config_file=config_file)

        self.assertEqual(self.read(".regularfile"), self.fixture("regularfile"))
        self.assertFalse((self.home_dir / "regularfile").exists())

    def test_dry_run_copies_nothing(self):
        run_setup(self.home_dir, extra_args=["--dry-run"])

        self.assertEqual(list(self.home_dir.iterdir()), [])

    def test_second_run_is_idempotent(self):
        run_setup(self.home_dir)
        run_setup(self.home_dir)

        self.assertEqual(self.read(".testfile"), self.fixture("testfile"))
        self.assertEqual(self.read("regularfile"), self.fixture("regularfile"))
        self.assertEqual(
            self.read("zzregulardir/regulardirfile"),
            self.fixture("zzregulardir/regulardirfile"),
        )


if __name__ == "__main__":
    unittest.main(verbosity=2)