1
# Copyright (C) 2006, 2007, 2009, 2010 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
from bzrlib import config, ignores, osutils
20
from bzrlib.tests.per_workingtree import TestCaseWithWorkingTree
23
class TestIsIgnored(TestCaseWithWorkingTree):
25
def test_is_ignored(self):
26
tree = self.make_branch_and_tree('.')
27
# this will break if a tree changes the ignored format. That is fine
28
# because at the moment tree format is orthogonal to user data, and
29
# .bzrignore is user data so must not be changed by a tree format.
30
self.build_tree_contents([
31
('.bzrignore', './rootdir\n'
39
'RE:dir2/.*\.wombat\n'
43
'unicode\xc2\xb5\n' # u'\xb5'.encode('utf8')
49
# is_ignored returns the matching ignore regex when a path is ignored.
50
# we check some expected matches for each rule, and one or more
51
# relevant not-matches that look plausible as cases for bugs.
52
self.assertEqual('./rootdir', tree.is_ignored('rootdir'))
53
self.assertEqual(None, tree.is_ignored('foo/rootdir'))
54
self.assertEqual(None, tree.is_ignored('rootdirtrailer'))
56
self.assertEqual('randomfile*', tree.is_ignored('randomfile'))
57
self.assertEqual('randomfile*', tree.is_ignored('randomfiles'))
58
self.assertEqual('randomfile*', tree.is_ignored('foo/randomfiles'))
59
self.assertEqual(None, tree.is_ignored('randomfil'))
60
self.assertEqual(None, tree.is_ignored('foo/randomfil'))
62
self.assertEqual("path/from/ro?t", tree.is_ignored('path/from/root'))
63
self.assertEqual("path/from/ro?t", tree.is_ignored('path/from/roat'))
64
self.assertEqual(None, tree.is_ignored('roat'))
66
self.assertEqual('**/piffle.py', tree.is_ignored('piffle.py'))
67
self.assertEqual('**/piffle.py', tree.is_ignored('a/piffle.py'))
68
self.assertEqual(None, tree.is_ignored('b/piffle.py')) # exclusion
69
self.assertEqual('**/piffle.py', tree.is_ignored('foo/bar/piffle.py'))
70
self.assertEqual(None, tree.is_ignored('p/iffle.py'))
72
self.assertEqual(u'unicode\xb5', tree.is_ignored(u'unicode\xb5'))
73
self.assertEqual(u'unicode\xb5', tree.is_ignored(u'subdir/unicode\xb5'))
74
self.assertEqual(None, tree.is_ignored(u'unicode\xe5'))
75
self.assertEqual(None, tree.is_ignored(u'unicode'))
76
self.assertEqual(None, tree.is_ignored(u'\xb5'))
78
self.assertEqual('dos', tree.is_ignored('dos'))
79
self.assertEqual(None, tree.is_ignored('dosfoo'))
81
self.assertEqual('*bar', tree.is_ignored('foobar'))
82
self.assertEqual('*bar', tree.is_ignored(r'foo\nbar'))
83
self.assertEqual('*bar', tree.is_ignored('bar'))
84
self.assertEqual('*bar', tree.is_ignored('.bar'))
86
self.assertEqual(None, tree.is_ignored('bazbar')) # exclusion
88
self.assertEqual('?foo', tree.is_ignored('afoo'))
89
self.assertEqual('?foo', tree.is_ignored('.foo'))
91
self.assertEqual('*.~*', tree.is_ignored('blah.py.~1~'))
93
self.assertEqual('dir1/*f1', tree.is_ignored('dir1/foof1'))
94
self.assertEqual('dir1/*f1', tree.is_ignored('dir1/f1'))
95
self.assertEqual('dir1/*f1', tree.is_ignored('dir1/.f1'))
97
self.assertEqual('dir1/?f2', tree.is_ignored('dir1/ff2'))
98
self.assertEqual('dir1/?f2', tree.is_ignored('dir1/.f2'))
100
self.assertEqual('RE:dir2/.*\.wombat', tree.is_ignored('dir2/foo.wombat'))
101
self.assertEqual(None, tree.is_ignored('dir2/foo'))
103
# Blank lines and comments should be ignored
104
self.assertEqual(None, tree.is_ignored(''))
105
self.assertEqual(None, tree.is_ignored('test/'))
107
self.assertEqual(None, tree.is_ignored('#comment'))
109
# Whitespace should not be stripped
110
self.assertEqual(' xx ', tree.is_ignored(' xx '))
111
self.assertEqual(' xx ', tree.is_ignored('subdir/ xx '))
112
self.assertEqual(None, tree.is_ignored('xx'))
113
self.assertEqual(None, tree.is_ignored('xx '))
114
self.assertEqual(None, tree.is_ignored(' xx'))
115
self.assertEqual(None, tree.is_ignored('subdir/xx '))
117
def test_global_ignored(self):
118
tree = self.make_branch_and_tree('.')
120
config.ensure_config_dir_exists()
121
user_ignore_file = config.user_ignore_config_filename()
122
f = open(user_ignore_file, 'wb')
128
'\r\n' #Blank dos line
129
' * \n' #Trailing and suffix spaces
130
'crlf\r\n' # dos style line
131
'*\xc3\xa5*\n' # u'\xe5'.encode('utf8')
137
self.assertEqual('./.shelf', tree.is_ignored('.shelf'))
138
self.assertEqual(None, tree.is_ignored('foo/.shelf'))
141
self.assertEqual('*.py[co]', tree.is_ignored('foo.pyc'))
142
self.assertEqual('*.py[co]', tree.is_ignored('foo.pyo'))
143
self.assertEqual(None, tree.is_ignored('foo.py'))
146
self.assertEqual('*.py[co]', tree.is_ignored('bar/foo.pyc'))
147
self.assertEqual('*.py[co]', tree.is_ignored('bar/foo.pyo'))
148
self.assertEqual(None, tree.is_ignored('bar/foo.py'))
151
self.assertEqual(u'*\xe5*', tree.is_ignored(u'b\xe5gfors'))
152
self.assertEqual(u'*\xe5*', tree.is_ignored(u'\xe5gfors'))
153
self.assertEqual(u'*\xe5*', tree.is_ignored(u'\xe5'))
154
self.assertEqual(u'*\xe5*', tree.is_ignored(u'b\xe5'))
155
self.assertEqual(u'*\xe5*', tree.is_ignored(u'b/\xe5'))
158
self.assertEqual(' * ', tree.is_ignored(' bbb '))
159
self.assertEqual(' * ', tree.is_ignored('subdir/ bbb '))
160
self.assertEqual(None, tree.is_ignored('bbb '))
161
self.assertEqual(None, tree.is_ignored(' bbb'))
164
self.assertEqual('crlf', tree.is_ignored('crlf'))
165
self.assertEqual('crlf', tree.is_ignored('subdir/crlf'))
167
# Comment line should be ignored
168
self.assertEqual(None, tree.is_ignored('# comment line'))
170
# Blank line should also be ignored
171
self.assertEqual(None, tree.is_ignored(''))
172
self.assertEqual(None, tree.is_ignored('baz/'))
174
def test_mixed_is_ignored(self):
175
tree = self.make_branch_and_tree('.')
176
ignores._set_user_ignores(['*.py[co]', './.shelf'])
177
self.build_tree_contents([('.bzrignore', './rootdir\n*.swp\n')])
179
self.assertEqual('*.py[co]', tree.is_ignored('foo.pyc'))
180
self.assertEqual('./.shelf', tree.is_ignored('.shelf'))
181
self.assertEqual('./rootdir', tree.is_ignored('rootdir'))
182
self.assertEqual('*.swp', tree.is_ignored('foo.py.swp'))
183
self.assertEqual('*.swp', tree.is_ignored('.foo.py.swp'))
184
self.assertEqual(None, tree.is_ignored('.foo.py.swo'))
186
def test_runtime_ignores(self):
187
tree = self.make_branch_and_tree('.')
188
self.build_tree_contents([('.bzrignore', '')])
189
ignores._set_user_ignores([])
191
orig_runtime = ignores._runtime_ignores
193
ignores._runtime_ignores = set()
194
self.assertEqual(None, tree.is_ignored('foobar.py'))
196
tree._flush_ignore_list_cache()
197
ignores.add_runtime_ignores(['./foobar.py'])
198
self.assertEqual(set(['./foobar.py']), ignores.get_runtime_ignores())
199
self.assertEqual('./foobar.py', tree.is_ignored('foobar.py'))
201
ignores._runtime_ignores = orig_runtime
203
def test_ignore_caching(self):
204
tree = self.make_branch_and_tree('.')
205
self.build_tree(['ignoreme'])
207
self.assertEqual(None, tree.is_ignored('ignoreme'))
209
# Bug #129694 specifically references WorkingTree.unknowns()
212
self.build_tree_contents([('.bzrignore', 'ignoreme')])
213
self.assertEqual('ignoreme', tree.is_ignored('ignoreme'))