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 _set_user_ignore_content(self, ignores):
26
"""Create user ignore file and set its content to ignores."""
27
config.ensure_config_dir_exists()
28
user_ignore_file = config.user_ignore_config_filename()
29
f = open(user_ignore_file, 'wb')
35
def test_is_ignored(self):
36
tree = self.make_branch_and_tree('.')
37
# this will break if a tree changes the ignored format. That is fine
38
# because at the moment tree format is orthogonal to user data, and
39
# .bzrignore is user data so must not be changed by a tree format.
40
self.build_tree_contents([
41
('.bzrignore', './rootdir\n'
49
'RE:dir2/.*\.wombat\n'
53
'unicode\xc2\xb5\n' # u'\xb5'.encode('utf8')
59
# We set user ignore file to contain '' to avoid patterns from
60
# user ignore being used instead of bzrignore. For .e.g. If we
61
# don't do this 'foo.~1~' will match '*~' default user ignore
62
# pattern instead of '*.~*' from bzr ignore as we expect below.
63
self._set_user_ignore_content('')
64
# is_ignored returns the matching ignore regex when a path is ignored.
65
# we check some expected matches for each rule, and one or more
66
# relevant not-matches that look plausible as cases for bugs.
67
self.assertEqual('./rootdir', tree.is_ignored('rootdir'))
68
self.assertEqual(None, tree.is_ignored('foo/rootdir'))
69
self.assertEqual(None, tree.is_ignored('rootdirtrailer'))
71
self.assertEqual('randomfile*', tree.is_ignored('randomfile'))
72
self.assertEqual('randomfile*', tree.is_ignored('randomfiles'))
73
self.assertEqual('randomfile*', tree.is_ignored('foo/randomfiles'))
74
self.assertEqual(None, tree.is_ignored('randomfil'))
75
self.assertEqual(None, tree.is_ignored('foo/randomfil'))
77
self.assertEqual("path/from/ro?t", tree.is_ignored('path/from/root'))
78
self.assertEqual("path/from/ro?t", tree.is_ignored('path/from/roat'))
79
self.assertEqual(None, tree.is_ignored('roat'))
81
self.assertEqual('**/piffle.py', tree.is_ignored('piffle.py'))
82
self.assertEqual('**/piffle.py', tree.is_ignored('a/piffle.py'))
83
self.assertEqual(None, tree.is_ignored('b/piffle.py')) # exclusion
84
self.assertEqual('**/piffle.py', tree.is_ignored('foo/bar/piffle.py'))
85
self.assertEqual(None, tree.is_ignored('p/iffle.py'))
87
self.assertEqual(u'unicode\xb5', tree.is_ignored(u'unicode\xb5'))
88
self.assertEqual(u'unicode\xb5', tree.is_ignored(u'subdir/unicode\xb5'))
89
self.assertEqual(None, tree.is_ignored(u'unicode\xe5'))
90
self.assertEqual(None, tree.is_ignored(u'unicode'))
91
self.assertEqual(None, tree.is_ignored(u'\xb5'))
93
self.assertEqual('dos', tree.is_ignored('dos'))
94
self.assertEqual(None, tree.is_ignored('dosfoo'))
96
self.assertEqual('*bar', tree.is_ignored('foobar'))
97
self.assertEqual('*bar', tree.is_ignored(r'foo\nbar'))
98
self.assertEqual('*bar', tree.is_ignored('bar'))
99
self.assertEqual('*bar', tree.is_ignored('.bar'))
101
self.assertEqual(None, tree.is_ignored('bazbar')) # exclusion
103
self.assertEqual('?foo', tree.is_ignored('afoo'))
104
self.assertEqual('?foo', tree.is_ignored('.foo'))
106
self.assertEqual('*.~*', tree.is_ignored('blah.py.~1~'))
108
self.assertEqual('dir1/*f1', tree.is_ignored('dir1/foof1'))
109
self.assertEqual('dir1/*f1', tree.is_ignored('dir1/f1'))
110
self.assertEqual('dir1/*f1', tree.is_ignored('dir1/.f1'))
112
self.assertEqual('dir1/?f2', tree.is_ignored('dir1/ff2'))
113
self.assertEqual('dir1/?f2', tree.is_ignored('dir1/.f2'))
115
self.assertEqual('RE:dir2/.*\.wombat', tree.is_ignored('dir2/foo.wombat'))
116
self.assertEqual(None, tree.is_ignored('dir2/foo'))
118
# Blank lines and comments should be ignored
119
self.assertEqual(None, tree.is_ignored(''))
120
self.assertEqual(None, tree.is_ignored('test/'))
122
self.assertEqual(None, tree.is_ignored('#comment'))
124
# Whitespace should not be stripped
125
self.assertEqual(' xx ', tree.is_ignored(' xx '))
126
self.assertEqual(' xx ', tree.is_ignored('subdir/ xx '))
127
self.assertEqual(None, tree.is_ignored('xx'))
128
self.assertEqual(None, tree.is_ignored('xx '))
129
self.assertEqual(None, tree.is_ignored(' xx'))
130
self.assertEqual(None, tree.is_ignored('subdir/xx '))
132
def test_global_ignored(self):
133
tree = self.make_branch_and_tree('.')
135
config.ensure_config_dir_exists()
136
user_ignore_file = config.user_ignore_config_filename()
137
self._set_user_ignore_content(
142
'\r\n' #Blank dos line
143
' * \n' #Trailing and suffix spaces
144
'crlf\r\n' # dos style line
145
'*\xc3\xa5*\n' # u'\xe5'.encode('utf8')
149
self.assertEqual('./.shelf', tree.is_ignored('.shelf'))
150
self.assertEqual(None, tree.is_ignored('foo/.shelf'))
153
self.assertEqual('*.py[co]', tree.is_ignored('foo.pyc'))
154
self.assertEqual('*.py[co]', tree.is_ignored('foo.pyo'))
155
self.assertEqual(None, tree.is_ignored('foo.py'))
158
self.assertEqual('*.py[co]', tree.is_ignored('bar/foo.pyc'))
159
self.assertEqual('*.py[co]', tree.is_ignored('bar/foo.pyo'))
160
self.assertEqual(None, tree.is_ignored('bar/foo.py'))
163
self.assertEqual(u'*\xe5*', tree.is_ignored(u'b\xe5gfors'))
164
self.assertEqual(u'*\xe5*', tree.is_ignored(u'\xe5gfors'))
165
self.assertEqual(u'*\xe5*', tree.is_ignored(u'\xe5'))
166
self.assertEqual(u'*\xe5*', tree.is_ignored(u'b\xe5'))
167
self.assertEqual(u'*\xe5*', tree.is_ignored(u'b/\xe5'))
170
self.assertEqual(' * ', tree.is_ignored(' bbb '))
171
self.assertEqual(' * ', tree.is_ignored('subdir/ bbb '))
172
self.assertEqual(None, tree.is_ignored('bbb '))
173
self.assertEqual(None, tree.is_ignored(' bbb'))
176
self.assertEqual('crlf', tree.is_ignored('crlf'))
177
self.assertEqual('crlf', tree.is_ignored('subdir/crlf'))
179
# Comment line should be ignored
180
self.assertEqual(None, tree.is_ignored('# comment line'))
182
# Blank line should also be ignored
183
self.assertEqual(None, tree.is_ignored(''))
184
self.assertEqual(None, tree.is_ignored('baz/'))
186
def test_mixed_is_ignored(self):
187
tree = self.make_branch_and_tree('.')
188
ignores._set_user_ignores(['*.py[co]', './.shelf'])
189
self.build_tree_contents([('.bzrignore', './rootdir\n*.swp\n')])
191
self.assertEqual('*.py[co]', tree.is_ignored('foo.pyc'))
192
self.assertEqual('./.shelf', tree.is_ignored('.shelf'))
193
self.assertEqual('./rootdir', tree.is_ignored('rootdir'))
194
self.assertEqual('*.swp', tree.is_ignored('foo.py.swp'))
195
self.assertEqual('*.swp', tree.is_ignored('.foo.py.swp'))
196
self.assertEqual(None, tree.is_ignored('.foo.py.swo'))
198
def test_runtime_ignores(self):
199
tree = self.make_branch_and_tree('.')
200
self.build_tree_contents([('.bzrignore', '')])
201
ignores._set_user_ignores([])
203
orig_runtime = ignores._runtime_ignores
205
ignores._runtime_ignores = set()
206
self.assertEqual(None, tree.is_ignored('foobar.py'))
208
tree._flush_ignore_list_cache()
209
ignores.add_runtime_ignores(['./foobar.py'])
210
self.assertEqual(set(['./foobar.py']), ignores.get_runtime_ignores())
211
self.assertEqual('./foobar.py', tree.is_ignored('foobar.py'))
213
ignores._runtime_ignores = orig_runtime
215
def test_ignore_caching(self):
216
tree = self.make_branch_and_tree('.')
217
self.build_tree(['ignoreme'])
219
self.assertEqual(None, tree.is_ignored('ignoreme'))
221
# Bug #129694 specifically references WorkingTree.unknowns()
224
self.build_tree_contents([('.bzrignore', 'ignoreme')])
225
self.assertEqual('ignoreme', tree.is_ignored('ignoreme'))