~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/treeshape.py

Turn completion assertions into separate methods.

Many common assertions used to be expressed as arguments to the complete
method.  This makes the checks more explicit, and the code easier to read.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2010 Canonical Ltd
2
 
#
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.
7
 
#
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.
12
 
#
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
16
 
 
17
 
 
18
 
"""Test helper for constructing and testing directories.
19
 
 
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,
22
 
etc.
23
 
"""
24
 
 
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
28
 
# comparison.
29
 
 
30
 
import os
31
 
import stat
32
 
 
33
 
from bzrlib.trace import warning
34
 
from bzrlib.osutils import pathjoin
35
 
 
36
 
def build_tree_contents(template):
37
 
    """Reconstitute some files from a text description.
38
 
 
39
 
    Each element of template is a tuple.  The first element is a filename,
40
 
    with an optional ending character indicating the type.
41
 
 
42
 
    The template is built relative to the Python process's current
43
 
    working directory.
44
 
 
45
 
    ('foo/',) will build a directory.
46
 
    ('foo', 'bar') will write 'bar' to 'foo'
47
 
    ('foo@', 'linktarget') will raise an error
48
 
    """
49
 
    for tt in template:
50
 
        name = tt[0]
51
 
        if name[-1] == '/':
52
 
            os.mkdir(name)
53
 
        elif name[-1] == '@':
54
 
            os.symlink(tt[1], tt[0][:-1])
55
 
        else:
56
 
            f = file(name, 'wb')
57
 
            try:
58
 
                f.write(tt[1])
59
 
            finally:
60
 
                f.close()
61
 
 
62
 
 
63
 
def capture_tree_contents(top):
64
 
    """Make a Python datastructure description of a tree.
65
 
 
66
 
    If top is an absolute path the descriptions will be absolute."""
67
 
    for dirpath, dirnames, filenames in os.walk(top):
68
 
        yield (dirpath + '/', )
69
 
        filenames.sort()
70
 
        for fn in filenames:
71
 
            fullpath = pathjoin(dirpath, fn)
72
 
            if (fullpath[-1] in '@/'):
73
 
                raise AssertionError(fullpath)
74
 
            info = os.lstat(fullpath)
75
 
            if stat.S_ISLNK(info.st_mode):
76
 
                yield (fullpath + '@', os.readlink(fullpath))
77
 
            elif stat.S_ISREG(info.st_mode):
78
 
                yield (fullpath, file(fullpath, 'rb').read())
79
 
            else:
80
 
                warning("can't capture file %s with mode %#o",
81
 
                        fullpath, info.st_mode)
82
 
                pass