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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
from __future__ import with_statement
import os
import shutil
import tempfile
import unittest
from dotfiles import core
from dotfiles.utils import is_link_to
def touch(fname, times=None):
with open(fname, 'a'):
os.utime(fname, times)
class DotfilesTestCase(unittest.TestCase):
def setUp(self):
"""Create a temporary home directory."""
self.homedir = tempfile.mkdtemp()
# Create a repository for the tests to use.
self.repository = os.path.join(self.homedir, 'Dotfiles')
os.mkdir(self.repository)
def tearDown(self):
"""Delete the temporary home directory and its contents."""
shutil.rmtree(self.homedir)
def assertPathEqual(self, path1, path2):
self.assertEqual(
os.path.realpath(path1),
os.path.realpath(path2))
def test_force_sync_directory(self):
"""Test forced sync when the dotfile is a directory.
I installed the lastpass chrome extension which stores a socket in
~/.lastpass. So I added that directory as an external to /tmp and
attempted a forced sync. An error occurred because sync() calls
os.remove() as it mistakenly assumes the dotfile is a file and not
a directory.
"""
os.mkdir(os.path.join(self.homedir, '.lastpass'))
externals = {'.lastpass': '/tmp'}
dotfiles = core.Dotfiles(
homedir=self.homedir, repository=self.repository,
prefix='', ignore=[], externals=externals, packages=[],
dry_run=False)
dotfiles.sync(force=True)
self.assertPathEqual(
os.path.join(self.homedir, '.lastpass'),
'/tmp')
def test_move_repository(self):
"""Test the move() method for a Dotfiles repository."""
touch(os.path.join(self.repository, 'bashrc'))
dotfiles = core.Dotfiles(
homedir=self.homedir, repository=self.repository,
prefix='', ignore=[], force=True, externals={}, packages=[],
dry_run=False)
dotfiles.sync()
# Make sure sync() did the right thing.
self.assertPathEqual(
os.path.join(self.homedir, '.bashrc'),
os.path.join(self.repository, 'bashrc'))
target = os.path.join(self.homedir, 'MyDotfiles')
dotfiles.move(target)
self.assertTrue(os.path.exists(os.path.join(target, 'bashrc')))
self.assertPathEqual(
os.path.join(self.homedir, '.bashrc'),
os.path.join(target, 'bashrc'))
def test_force_sync_directory_symlink(self):
"""Test a forced sync on a directory symlink.
A bug was reported where a user wanted to replace a dotfile repository
with an other one. They had a .vim directory in their home directory
which was obviously also a symbolic link. This caused:
OSError: Cannot call rmtree on a symbolic link
"""
# Create a dotfile symlink to some directory
os.mkdir(os.path.join(self.homedir, 'vim'))
os.symlink(os.path.join(self.homedir, 'vim'),
os.path.join(self.homedir, '.vim'))
# Create a vim directory in the repository. This will cause the above
# symlink to be overwritten on sync.
os.mkdir(os.path.join(self.repository, 'vim'))
# Make sure the symlink points to the correct location.
self.assertPathEqual(
os.path.join(self.homedir, '.vim'),
os.path.join(self.homedir, 'vim'))
dotfiles = core.Dotfiles(
homedir=self.homedir, repository=self.repository,
prefix='', ignore=[], externals={}, packages=[], dry_run=False)
dotfiles.sync(force=True)
# The symlink should now point to the directory in the repository.
self.assertPathEqual(
os.path.join(self.homedir, '.vim'),
os.path.join(self.repository, 'vim'))
def test_glob_ignore_pattern(self):
""" Test that the use of glob pattern matching works in the ignores list.
The following repo dir exists:
myscript.py
myscript.pyc
myscript.pyo
bashrc
bashrc.swp
vimrc
vimrc.swp
install.sh
Using the glob pattern dotfiles should have the following sync result in home:
.myscript.py -> Dotfiles/myscript.py
.bashrc -> Dotfiles/bashrc
.vimrc -> Dotfiles/vimrc
"""
ignore = ['*.swp', '*.py?', 'install.sh']
all_repo_files = (
('myscript.py', '.myscript.py'),
('myscript.pyc', None),
('myscript.pyo', None),
('bashrc', '.bashrc'),
('bashrc.swp', None),
('vimrc', '.vimrc'),
('vimrc.swp', None),
('install.sh', None)
)
all_dotfiles = [f for f in all_repo_files if f[1] is not None]
for original, symlink in all_repo_files:
touch(os.path.join(self.repository, original))
dotfiles = core.Dotfiles(
homedir=self.homedir, repository=self.repository,
prefix='', ignore=ignore, externals={}, packages=[],
dry_run=False)
dotfiles.sync()
# Now check that the files that should have a symlink
# point to the correct file and are the only files that
# exist in the home dir.
self.assertEqual(
sorted(os.listdir(self.homedir)),
sorted([f[1] for f in all_dotfiles] + ['Dotfiles']))
for original, symlink in all_dotfiles:
self.assertPathEqual(
os.path.join(self.repository, original),
os.path.join(self.homedir, symlink))
def test_packages(self):
"""
Test packages.
"""
files = ['foo', 'package/bar']
symlinks = ['.foo', '.package/bar']
join = os.path.join
# Create files
for filename in files:
path = join(self.repository, filename)
dirname = os.path.dirname(path)
if not os.path.exists(dirname):
os.makedirs(dirname)
touch(path)
# Create Dotfiles object
dotfiles = core.Dotfiles(
homedir=self.homedir, repository=self.repository,
prefix='', ignore=[], externals={}, packages=['package'],
dry_run=False)
# Create symlinks in homedir
dotfiles.sync()
# Verify it created what we expect
def check_all(files, symlinks):
self.assertTrue(os.path.isdir(join(self.homedir, '.package')))
for src, dst in zip(files, symlinks):
self.assertTrue(is_link_to(join(self.homedir, dst),
join(self.repository, src)))
check_all(files, symlinks)
# Add files to the repository
new_files = [join(self.homedir, f) for f in ['.bar', '.package/foo']]
for filename in new_files:
path = join(self.homedir, filename)
touch(path)
new_repo_files = ['bar', 'package/foo']
dotfiles.add(new_files)
check_all(files + new_repo_files, symlinks + new_files)
# Remove them from the repository
dotfiles.remove(new_files)
check_all(files, symlinks)
# Move the repository
self.repository = join(self.homedir, 'Dotfiles2')
dotfiles.move(self.repository)
check_all(files, symlinks)
def test_missing_package(self):
"""
Test a non-existent package.
"""
package_file = '.package/bar'
# Create Dotfiles object
dotfiles = core.Dotfiles(
homedir=self.homedir, repository=self.repository,
prefix='', ignore=[], externals={}, packages=['package'],
dry_run=False)
path = os.path.join(self.homedir, package_file)
dirname = os.path.dirname(path)
if not os.path.exists(dirname):
os.makedirs(dirname)
touch(path)
dotfiles.add([os.path.join(self.homedir, package_file)])
def suite():
suite = unittest.TestLoader().loadTestsFromTestCase(DotfilesTestCase)
return suite
if __name__ == '__main__':
unittest.TextTestRunner().run(suite())
|
