~bzr-pqm/bzr/bzr.dev

1393.1.34 by Martin Pool
- move tree-shape test helpers into their own file
1
# Copyright (C) 2005 by 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  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
1393.1.35 by Martin Pool
doc
27
# where they differ.  Option to ignore some files or directories in the 
28
# comparison.
1393.1.34 by Martin Pool
- move tree-shape test helpers into their own file
29
30
import os
1393.1.36 by Martin Pool
- capture_tree tool to help in preparing test cases
31
import stat
32
33
from bzrlib.trace import warning
1393.1.34 by Martin Pool
- move tree-shape test helpers into their own file
34
35
def build_tree_contents(template):
36
    """Reconstitute some files from a text description.
37
38
    Each element of template is a tuple.  The first element is a filename,
39
    with an optional ending character indicating the type.
40
41
    The template is built relative to the Python process's current
42
    working directory.
43
    """
44
    for tt in template:
45
        name = tt[0]
46
        if name[-1] == '/':
47
            os.mkdir(name)
48
        elif name[-1] == '@':
49
            raise NotImplementedError('symlinks not handled yet')
50
        else:
51
            f = file(name, 'wb')
52
            try:
53
                f.write(tt[1])
54
            finally:
55
                f.close()
56
57
1393.1.36 by Martin Pool
- capture_tree tool to help in preparing test cases
58
def capture_tree_contents(top):
1393.1.34 by Martin Pool
- move tree-shape test helpers into their own file
59
    """Make a Python datastructure description of a tree.
60
    
61
    If top is an absolute path the descriptions will be absolute."""
62
    for dirpath, dirnames, filenames in os.walk(top):
63
        yield (dirpath + '/', )
64
        filenames.sort()
65
        for fn in filenames:
66
            fullpath = os.path.join(dirpath, fn)
1393.1.36 by Martin Pool
- capture_tree tool to help in preparing test cases
67
            assert fullpath[-1] not in '@/'
68
            info = os.lstat(fullpath)
69
            if stat.S_ISLNK(info.st_mode):
70
                yield (fullpath + '@', os.readlink(fullpath))
71
            elif stat.S_ISREG(info.st_mode):
72
                yield (fullpath, file(fullpath, 'rb').read())
73
            else:
74
                warning("can't capture file %s with mode %#o",
75
                        fullpath, info.st_mode)
76
                pass