2 from __future__ import absolute_import, print_function
3 import errno, glob, grp, pwd, stat, tempfile, subprocess
7 from bup import git, metadata
9 from bup.compat import range
10 from bup.helpers import clear_errors, detect_fakeroot, is_superuser, resolve_parent
11 from bup.repo import LocalRepo
12 from bup.xstat import utime, lutime
13 from buptest import no_lingering_errors, test_tempdir
14 import bup.helpers as helpers
18 bup_tmp = os.path.realpath(b'../../../t/tmp')
19 bup_path = top_dir + b'/bup'
20 start_dir = os.getcwd()
25 cmd_str = b' '.join(cmd)
26 print(cmd_str, file=sys.stderr)
27 rc = subprocess.call(cmd)
29 print('terminated by signal', - rc, file=sys.stderr)
32 print('returned exit status', rc, file=sys.stderr)
35 print('subprocess call failed:', e, file=sys.stderr)
40 assert(sys.platform.startswith('linux'))
41 # Set up testfs with user_xattr, etc.
42 if subprocess.call([b'modprobe', b'loop']) != 0:
44 subprocess.call([b'umount', b'testfs'])
45 ex(b'dd', b'if=/dev/zero', b'of=testfs.img', b'bs=1M', b'count=32')
46 ex(b'mke2fs', b'-F', b'-j', b'-m', b'0', b'testfs.img')
47 ex(b'rm', b'-rf', b'testfs')
49 ex(b'mount', b'-o', b'loop,acl,user_xattr', b'testfs.img', b'testfs')
50 # Hide, so that tests can't create risks.
51 os.chown(b'testfs', 0, 0)
52 os.chmod(b'testfs', 0o700)
57 subprocess.call([b'umount', b'testfs'])
58 helpers.unlink(b'testfs.img')
62 def test_clean_up_archive_path():
63 with no_lingering_errors():
64 cleanup = metadata._clean_up_path_for_archive
65 WVPASSEQ(cleanup(b'foo'), b'foo')
66 WVPASSEQ(cleanup(b'/foo'), b'foo')
67 WVPASSEQ(cleanup(b'///foo'), b'foo')
68 WVPASSEQ(cleanup(b'/foo/bar'), b'foo/bar')
69 WVPASSEQ(cleanup(b'foo/./bar'), b'foo/bar')
70 WVPASSEQ(cleanup(b'/foo/./bar'), b'foo/bar')
71 WVPASSEQ(cleanup(b'/foo/./bar/././baz'), b'foo/bar/baz')
72 WVPASSEQ(cleanup(b'/foo/./bar///././baz'), b'foo/bar/baz')
73 WVPASSEQ(cleanup(b'//./foo/./bar///././baz/.///'), b'foo/bar/baz/')
74 WVPASSEQ(cleanup(b'./foo/./.bar'), b'foo/.bar')
75 WVPASSEQ(cleanup(b'./foo/.'), b'foo')
76 WVPASSEQ(cleanup(b'./foo/..'), b'.')
77 WVPASSEQ(cleanup(b'//./..//.../..//.'), b'.')
78 WVPASSEQ(cleanup(b'//./..//..././/.'), b'...')
79 WVPASSEQ(cleanup(b'/////.'), b'.')
80 WVPASSEQ(cleanup(b'/../'), b'.')
81 WVPASSEQ(cleanup(b''), b'.')
85 def test_risky_path():
86 with no_lingering_errors():
87 risky = metadata._risky_path
88 WVPASS(risky(b'/foo'))
89 WVPASS(risky(b'///foo'))
90 WVPASS(risky(b'/../foo'))
91 WVPASS(risky(b'../foo'))
92 WVPASS(risky(b'foo/..'))
93 WVPASS(risky(b'foo/../'))
94 WVPASS(risky(b'foo/../bar'))
96 WVFAIL(risky(b'foo/'))
97 WVFAIL(risky(b'foo///'))
98 WVFAIL(risky(b'./foo'))
99 WVFAIL(risky(b'foo/.'))
100 WVFAIL(risky(b'./foo/.'))
101 WVFAIL(risky(b'foo/bar'))
102 WVFAIL(risky(b'foo/./bar'))
106 def test_clean_up_extract_path():
107 with no_lingering_errors():
108 cleanup = metadata._clean_up_extract_path
109 WVPASSEQ(cleanup(b'/foo'), b'foo')
110 WVPASSEQ(cleanup(b'///foo'), b'foo')
111 WVFAIL(cleanup(b'/../foo'))
112 WVFAIL(cleanup(b'../foo'))
113 WVFAIL(cleanup(b'foo/..'))
114 WVFAIL(cleanup(b'foo/../'))
115 WVFAIL(cleanup(b'foo/../bar'))
116 WVPASSEQ(cleanup(b'foo'), b'foo')
117 WVPASSEQ(cleanup(b'foo/'), b'foo/')
118 WVPASSEQ(cleanup(b'foo///'), b'foo///')
119 WVPASSEQ(cleanup(b'./foo'), b'./foo')
120 WVPASSEQ(cleanup(b'foo/.'), b'foo/.')
121 WVPASSEQ(cleanup(b'./foo/.'), b'./foo/.')
122 WVPASSEQ(cleanup(b'foo/bar'), b'foo/bar')
123 WVPASSEQ(cleanup(b'foo/./bar'), b'foo/./bar')
124 WVPASSEQ(cleanup(b'/'), b'.')
125 WVPASSEQ(cleanup(b'./'), b'./')
126 WVPASSEQ(cleanup(b'///foo/bar'), b'foo/bar')
127 WVPASSEQ(cleanup(b'///foo/bar'), b'foo/bar')
131 def test_metadata_method():
132 with no_lingering_errors():
133 with test_tempdir(b'bup-tmetadata-') as tmpdir:
134 bup_dir = tmpdir + b'/bup'
135 data_path = tmpdir + b'/foo'
137 ex(b'touch', data_path + b'/file')
138 ex(b'ln', b'-s', b'file', data_path + b'/symlink')
139 test_time1 = 13 * 1000000000
140 test_time2 = 42 * 1000000000
141 utime(data_path + b'/file', (0, test_time1))
142 lutime(data_path + b'/symlink', (0, 0))
143 utime(data_path, (0, test_time2))
144 ex(bup_path, b'-d', bup_dir, b'init')
145 ex(bup_path, b'-d', bup_dir, b'index', b'-v', data_path)
146 ex(bup_path, b'-d', bup_dir, b'save', b'-tvvn', b'test', data_path)
147 git.check_repo_or_die(bup_dir)
149 resolved = vfs.resolve(repo,
150 b'/test/latest' + resolve_parent(data_path),
152 leaf_name, leaf_item = resolved[-1]
154 WVPASS(m.mtime == test_time2)
155 WVPASS(leaf_name == b'foo')
156 contents = tuple(vfs.contents(repo, leaf_item))
157 WVPASS(len(contents) == 3)
158 WVPASSEQ(frozenset(name for name, item in contents),
159 frozenset((b'.', b'file', b'symlink')))
160 for name, item in contents:
163 WVPASS(m.mtime == test_time1)
164 elif name == b'symlink':
166 WVPASSEQ(m.symlink_target, b'file')
172 if helpers.saved_errors:
173 return str(helpers.saved_errors[0])
178 def test_from_path_error():
179 if is_superuser() or detect_fakeroot():
181 with no_lingering_errors():
182 with test_tempdir(b'bup-tmetadata-') as tmpdir:
183 path = tmpdir + b'/foo'
185 m = metadata.from_path(path, archive_path=path, save_symlinks=True)
186 WVPASSEQ(m.path, path)
187 os.chmod(path, 0o000)
188 metadata.from_path(path, archive_path=path, save_symlinks=True)
189 if metadata.get_linux_file_attr:
190 print('saved_errors:', helpers.saved_errors, file=sys.stderr)
191 WVPASS(len(helpers.saved_errors) == 1)
192 errmsg = _first_err()
193 WVPASS(errmsg.startswith('read Linux attr'))
197 def _linux_attr_supported(path):
198 # Expects path to denote a regular file or a directory.
199 if not metadata.get_linux_file_attr:
202 metadata.get_linux_file_attr(path)
204 if e.errno in (errno.ENOTTY, errno.ENOSYS, errno.EOPNOTSUPP):
212 def test_apply_to_path_restricted_access():
213 if is_superuser() or detect_fakeroot():
215 if sys.platform.startswith('cygwin'):
216 return # chmod 000 isn't effective.
217 with no_lingering_errors():
218 with test_tempdir(b'bup-tmetadata-') as tmpdir:
219 parent = tmpdir + b'/foo'
220 path = parent + b'/bar'
224 m = metadata.from_path(path, archive_path=path, save_symlinks=True)
225 WVPASSEQ(m.path, path)
226 os.chmod(parent, 0o000)
227 m.apply_to_path(path)
228 print('saved_errors:', helpers.saved_errors, file=sys.stderr)
229 expected_errors = ['utime: ']
230 if m.linux_attr and _linux_attr_supported(tmpdir):
231 expected_errors.append('Linux chattr: ')
232 if metadata.xattr and m.linux_xattr:
233 expected_errors.append("xattr.set '")
234 WVPASS(len(helpers.saved_errors) == len(expected_errors))
235 for i in range(len(expected_errors)):
236 WVPASS(str(helpers.saved_errors[i]).startswith(expected_errors[i]))
241 def test_restore_over_existing_target():
242 with no_lingering_errors():
243 with test_tempdir(b'bup-tmetadata-') as tmpdir:
244 path = tmpdir + b'/foo'
246 dir_m = metadata.from_path(path, archive_path=path, save_symlinks=True)
248 open(path, 'w').close()
249 file_m = metadata.from_path(path, archive_path=path, save_symlinks=True)
250 # Restore dir over file.
251 WVPASSEQ(dir_m.create_path(path, create_symlinks=True), None)
252 WVPASS(stat.S_ISDIR(os.stat(path).st_mode))
253 # Restore dir over dir.
254 WVPASSEQ(dir_m.create_path(path, create_symlinks=True), None)
255 WVPASS(stat.S_ISDIR(os.stat(path).st_mode))
256 # Restore file over dir.
257 WVPASSEQ(file_m.create_path(path, create_symlinks=True), None)
258 WVPASS(stat.S_ISREG(os.stat(path).st_mode))
259 # Restore file over file.
260 WVPASSEQ(file_m.create_path(path, create_symlinks=True), None)
261 WVPASS(stat.S_ISREG(os.stat(path).st_mode))
262 # Restore file over non-empty dir.
265 open(path + b'/bar', 'w').close()
266 WVEXCEPT(Exception, file_m.create_path, path, create_symlinks=True)
267 # Restore dir over non-empty dir.
268 os.remove(path + b'/bar')
269 os.mkdir(path + b'/bar')
270 WVEXCEPT(Exception, dir_m.create_path, path, create_symlinks=True)
273 from bup.metadata import posix1e
276 def POSIX1E_ACL_SUPPORT_IS_MISSING():
280 from bup.metadata import xattr
282 def remove_selinux(attrs):
283 return list(filter(lambda i: not i in (b'security.selinux', ),
287 def test_handling_of_incorrect_existing_linux_xattrs():
288 if not is_superuser() or detect_fakeroot():
289 WVMSG('skipping test -- not superuser')
291 if not setup_testfs():
292 WVMSG('unable to load loop module; skipping dependent tests')
294 for f in glob.glob(b'testfs/*'):
297 open(path, 'w').close()
298 xattr.set(path, b'foo', b'bar', namespace=xattr.NS_USER)
299 m = metadata.from_path(path, archive_path=path, save_symlinks=True)
300 xattr.set(path, b'baz', b'bax', namespace=xattr.NS_USER)
301 m.apply_to_path(path, restore_numeric_ids=False)
302 WVPASSEQ(remove_selinux(xattr.list(path)), [b'user.foo'])
303 WVPASSEQ(xattr.get(path, b'user.foo'), b'bar')
304 xattr.set(path, b'foo', b'baz', namespace=xattr.NS_USER)
305 m.apply_to_path(path, restore_numeric_ids=False)
306 WVPASSEQ(remove_selinux(xattr.list(path)), [b'user.foo'])
307 WVPASSEQ(xattr.get(path, b'user.foo'), b'bar')
308 xattr.remove(path, b'foo', namespace=xattr.NS_USER)
309 m.apply_to_path(path, restore_numeric_ids=False)
310 WVPASSEQ(remove_selinux(xattr.list(path)), [b'user.foo'])
311 WVPASSEQ(xattr.get(path, b'user.foo'), b'bar')