~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_ignores.py

[merge] Storage filename escaping

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2006-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
 
"""Tests for handling of ignore files"""
18
 
 
19
 
from cStringIO import StringIO
20
 
 
21
 
from bzrlib import config, errors, ignores
22
 
from bzrlib.tests import TestCase, TestCaseInTempDir, TestCaseWithTransport
23
 
 
24
 
 
25
 
class TestParseIgnoreFile(TestCase):
26
 
 
27
 
    def test_parse_fancy(self):
28
 
        ignored = ignores.parse_ignore_file(StringIO(
29
 
                './rootdir\n'
30
 
                'randomfile*\n'
31
 
                'path/from/ro?t\n'
32
 
                'unicode\xc2\xb5\n' # u'\xb5'.encode('utf8')
33
 
                'dos\r\n'
34
 
                '\n' # empty line
35
 
                '#comment\n'
36
 
                ' xx \n' # whitespace
37
 
                '!RE:^\.z.*\n'
38
 
                '!!./.zcompdump\n'
39
 
                ))
40
 
        self.assertEqual(set(['./rootdir',
41
 
                          'randomfile*',
42
 
                          'path/from/ro?t',
43
 
                          u'unicode\xb5',
44
 
                          'dos',
45
 
                          ' xx ',
46
 
                          '!RE:^\.z.*',
47
 
                          '!!./.zcompdump',
48
 
                         ]), ignored)
49
 
 
50
 
    def test_parse_empty(self):
51
 
        ignored = ignores.parse_ignore_file(StringIO(''))
52
 
        self.assertEqual(set([]), ignored)
53
 
        
54
 
    def test_parse_non_utf8(self):
55
 
        """Lines with non utf 8 characters should be discarded."""
56
 
        ignored = ignores.parse_ignore_file(StringIO(
57
 
                'utf8filename_a\n'
58
 
                'invalid utf8\x80\n'
59
 
                'utf8filename_b\n'
60
 
                ))
61
 
        self.assertEqual(set([
62
 
                        'utf8filename_a',
63
 
                        'utf8filename_b',
64
 
                       ]), ignored)
65
 
 
66
 
 
67
 
class TestUserIgnores(TestCaseInTempDir):
68
 
 
69
 
    def test_create_if_missing(self):
70
 
        # $HOME should be set to '.'
71
 
        ignore_path = config.user_ignore_config_filename()
72
 
        self.failIfExists(ignore_path)
73
 
        user_ignores = ignores.get_user_ignores()
74
 
        self.assertEqual(set(ignores.USER_DEFAULTS), user_ignores)
75
 
 
76
 
        self.failUnlessExists(ignore_path)
77
 
        f = open(ignore_path, 'rb')
78
 
        try:
79
 
            entries = ignores.parse_ignore_file(f)
80
 
        finally:
81
 
            f.close()
82
 
        self.assertEqual(set(ignores.USER_DEFAULTS), entries)
83
 
 
84
 
    def test_use_existing(self):
85
 
        patterns = ['*.o', '*.py[co]', u'\xe5*']
86
 
        ignores._set_user_ignores(patterns)
87
 
 
88
 
        user_ignores = ignores.get_user_ignores()
89
 
        self.assertEqual(set(patterns), user_ignores)
90
 
 
91
 
    def test_use_empty(self):
92
 
        ignores._set_user_ignores([])
93
 
        ignore_path = config.user_ignore_config_filename()
94
 
        self.check_file_contents(ignore_path, '')
95
 
 
96
 
        self.assertEqual(set([]), ignores.get_user_ignores())
97
 
 
98
 
    def test_set(self):
99
 
        patterns = ['*.py[co]', '*.py[oc]']
100
 
        ignores._set_user_ignores(patterns)
101
 
 
102
 
        self.assertEqual(set(patterns), ignores.get_user_ignores())
103
 
 
104
 
        patterns = ['vim', '*.swp']
105
 
        ignores._set_user_ignores(patterns)
106
 
        self.assertEqual(set(patterns), ignores.get_user_ignores())
107
 
 
108
 
    def test_add(self):
109
 
        """Test that adding will not duplicate ignores"""
110
 
        # Create an empty file
111
 
        ignores._set_user_ignores([])
112
 
 
113
 
        patterns = ['foo', './bar', u'b\xe5z']
114
 
        added = ignores.add_unique_user_ignores(patterns)
115
 
        self.assertEqual(patterns, added)
116
 
        self.assertEqual(set(patterns), ignores.get_user_ignores())
117
 
 
118
 
    def test_add_directory(self):
119
 
        """Test that adding a directory will strip any trailing slash"""
120
 
        # Create an empty file
121
 
        ignores._set_user_ignores([])
122
 
 
123
 
        in_patterns = ['foo/', 'bar/', 'baz\\']
124
 
        added = ignores.add_unique_user_ignores(in_patterns)
125
 
        out_patterns = [ x.rstrip('/\\') for x in in_patterns ]
126
 
        self.assertEqual(out_patterns, added)
127
 
        self.assertEqual(set(out_patterns), ignores.get_user_ignores())
128
 
 
129
 
    def test_add_unique(self):
130
 
        """Test that adding will not duplicate ignores"""
131
 
        ignores._set_user_ignores(
132
 
            ['foo', './bar', u'b\xe5z', 'dir1/', 'dir3\\'])
133
 
 
134
 
        added = ignores.add_unique_user_ignores(
135
 
            ['xxx', './bar', 'xxx', 'dir1/', 'dir2/', 'dir3\\'])
136
 
        self.assertEqual(['xxx', 'dir2'], added)
137
 
        self.assertEqual(set(['foo', './bar', u'b\xe5z',
138
 
                              'xxx', 'dir1', 'dir2', 'dir3']),
139
 
                         ignores.get_user_ignores())
140
 
 
141
 
 
142
 
class TestRuntimeIgnores(TestCase):
143
 
 
144
 
    def setUp(self):
145
 
        TestCase.setUp(self)
146
 
 
147
 
        # For the purposes of these tests, we must have no
148
 
        # runtime ignores
149
 
        self.overrideAttr(ignores, '_runtime_ignores', set())
150
 
 
151
 
    def test_add(self):
152
 
        """Test that we can add an entry to the list."""
153
 
        self.assertEqual(set(), ignores.get_runtime_ignores())
154
 
 
155
 
        ignores.add_runtime_ignores(['foo'])
156
 
        self.assertEqual(set(['foo']), ignores.get_runtime_ignores())
157
 
 
158
 
    def test_add_duplicate(self):
159
 
        """Adding the same ignore twice shouldn't add a new entry."""
160
 
        ignores.add_runtime_ignores(['foo', 'bar'])
161
 
        self.assertEqual(set(['foo', 'bar']), ignores.get_runtime_ignores())
162
 
 
163
 
        ignores.add_runtime_ignores(['bar'])
164
 
        self.assertEqual(set(['foo', 'bar']), ignores.get_runtime_ignores())
165
 
 
166
 
 
167
 
class TestTreeIgnores(TestCaseWithTransport):
168
 
    
169
 
    def assertPatternsEquals(self, patterns):
170
 
        contents = open(".bzrignore", 'rU').read().strip().split('\n')
171
 
        self.assertEquals(sorted(patterns), sorted(contents))
172
 
 
173
 
    def test_new_file(self):
174
 
        tree = self.make_branch_and_tree(".")
175
 
        ignores.tree_ignores_add_patterns(tree, ["myentry"])
176
 
        self.assertTrue(tree.has_filename(".bzrignore"))
177
 
        self.assertPatternsEquals(["myentry"])
178
 
 
179
 
    def test_add_to_existing(self):
180
 
        tree = self.make_branch_and_tree(".")
181
 
        self.build_tree_contents([('.bzrignore', "myentry1\n")])
182
 
        tree.add([".bzrignore"])
183
 
        ignores.tree_ignores_add_patterns(tree, ["myentry2", "foo"])
184
 
        self.assertPatternsEquals(["myentry1", "myentry2", "foo"])
185
 
 
186
 
    def test_adds_ending_newline(self):
187
 
        tree = self.make_branch_and_tree(".")
188
 
        self.build_tree_contents([('.bzrignore', "myentry1")])
189
 
        tree.add([".bzrignore"])
190
 
        ignores.tree_ignores_add_patterns(tree, ["myentry2"])
191
 
        self.assertPatternsEquals(["myentry1", "myentry2"])
192
 
        text = open(".bzrignore", 'r').read()
193
 
        self.assertTrue(text.endswith('\r\n') or
194
 
                        text.endswith('\n') or
195
 
                        text.endswith('\r'))
196
 
 
197
 
    def test_does_not_add_dupe(self):
198
 
        tree = self.make_branch_and_tree(".")
199
 
        self.build_tree_contents([('.bzrignore', "myentry\n")])
200
 
        tree.add([".bzrignore"])
201
 
        ignores.tree_ignores_add_patterns(tree, ["myentry"])
202
 
        self.assertPatternsEquals(["myentry"])
203
 
 
204
 
    def test_non_ascii(self):
205
 
        tree = self.make_branch_and_tree(".")
206
 
        self.build_tree_contents([('.bzrignore',
207
 
                                   u"myentry\u1234\n".encode('utf-8'))])
208
 
        tree.add([".bzrignore"])
209
 
        ignores.tree_ignores_add_patterns(tree, [u"myentry\u5678"])
210
 
        self.assertPatternsEquals([u"myentry\u1234".encode('utf-8'),
211
 
                                   u"myentry\u5678".encode('utf-8')])
212
 
 
213
 
    def test_crlf(self):
214
 
        tree = self.make_branch_and_tree(".")
215
 
        self.build_tree_contents([('.bzrignore', "myentry1\r\n")])
216
 
        tree.add([".bzrignore"])
217
 
        ignores.tree_ignores_add_patterns(tree, ["myentry2", "foo"])
218
 
        self.assertEquals(open('.bzrignore', 'rb').read(), 'myentry1\r\nmyentry2\r\nfoo\r\n')
219
 
        self.assertPatternsEquals(["myentry1", "myentry2", "foo"])