← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/treeshape.py

X-ref "Publishing your branch" section from the discussion of branch
locations.  A question was posed on IRC suggesting a need for this.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/treeshape.py
 
1
# Copyright (C) 2005 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
 
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
    for tt in template:
 
46
        name = tt[0]
 
47
        if name[-1] == '/':
 
48
            os.mkdir(name)
 
49
        elif name[-1] == '@':
 
50
            raise NotImplementedError('symlinks not handled yet')
 
51
        else:
 
52
            f = file(name, 'wb')
 
53
            try:
 
54
                f.write(tt[1])
 
55
            finally:
 
56
                f.close()
 
57
 
 
58
 
 
59
def capture_tree_contents(top):
 
60
    """Make a Python datastructure description of a tree.
 
61
    
 
62
    If top is an absolute path the descriptions will be absolute."""
 
63
    for dirpath, dirnames, filenames in os.walk(top):
 
64
        yield (dirpath + '/', )
 
65
        filenames.sort()
 
66
        for fn in filenames:
 
67
            fullpath = pathjoin(dirpath, fn)
 
68
            assert not (fullpath[-1] in '@/')
 
69
            info = os.lstat(fullpath)
 
70
            if stat.S_ISLNK(info.st_mode):
 
71
                yield (fullpath + '@', os.readlink(fullpath))
 
72
            elif stat.S_ISREG(info.st_mode):
 
73
                yield (fullpath, file(fullpath, 'rb').read())
 
74
            else:
 
75
                warning("can't capture file %s with mode %#o",
 
76
                        fullpath, info.st_mode)
 
77
                pass