1
# Copyright (C) 2005, 2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
"""Test helper for constructing and testing directories.
20
This module transforms filesystem directories to and from Python lists.
21
As a Python list the descriptions can be stored in test cases, compared,
25
# TODO: Script to write a description of a directory for testing
26
# TODO: Helper that compares two structures and raises a helpful error
27
# where they differ. Option to ignore some files or directories in the
33
from ..trace import warning
34
from ..osutils import pathjoin
37
def build_tree_contents(template):
38
"""Reconstitute some files from a text description.
40
Each element of template is a tuple. The first element is a filename,
41
with an optional ending character indicating the type.
43
The template is built relative to the Python process's current
46
('foo/',) will build a directory.
47
('foo', 'bar') will write 'bar' to 'foo'
48
('foo@', 'linktarget') will raise an error
55
os.symlink(tt[1], tt[0][:-1])
57
with open(name, 'w' + ('b' if isinstance(tt[1], bytes) else '')) as f:
61
def capture_tree_contents(top):
62
"""Make a Python datastructure description of a tree.
64
If top is an absolute path the descriptions will be absolute."""
65
for dirpath, dirnames, filenames in os.walk(top):
66
yield (dirpath + '/', )
69
fullpath = pathjoin(dirpath, fn)
70
if (fullpath[-1] in '@/'):
71
raise AssertionError(fullpath)
72
info = os.lstat(fullpath)
73
if stat.S_ISLNK(info.st_mode):
74
yield (fullpath + '@', os.readlink(fullpath))
75
elif stat.S_ISREG(info.st_mode):
76
with open(fullpath, 'rb') as f:
78
yield (fullpath, file_bytes)
80
warning("can't capture file %s with mode %#o",
81
fullpath, info.st_mode)