1
 
# Copyright (C) 2005 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 bzrlib.trace import warning
 
34
 
from bzrlib.osutils import pathjoin
 
36
 
def build_tree_contents(template):
 
37
 
    """Reconstitute some files from a text description.
 
39
 
    Each element of template is a tuple.  The first element is a filename,
 
40
 
    with an optional ending character indicating the type.
 
42
 
    The template is built relative to the Python process's current
 
50
 
            raise NotImplementedError('symlinks not handled yet')
 
59
 
def capture_tree_contents(top):
 
60
 
    """Make a Python datastructure description of a tree.
 
62
 
    If top is an absolute path the descriptions will be absolute."""
 
63
 
    for dirpath, dirnames, filenames in os.walk(top):
 
64
 
        yield (dirpath + '/', )
 
67
 
            fullpath = pathjoin(dirpath, fn)
 
68
 
            if (fullpath[-1] in '@/'):
 
69
 
                raise AssertionError(fullpath)
 
70
 
            info = os.lstat(fullpath)
 
71
 
            if stat.S_ISLNK(info.st_mode):
 
72
 
                yield (fullpath + '@', os.readlink(fullpath))
 
73
 
            elif stat.S_ISREG(info.st_mode):
 
74
 
                yield (fullpath, file(fullpath, 'rb').read())
 
76
 
                warning("can't capture file %s with mode %#o",
 
77
 
                        fullpath, info.st_mode)