1
# Copyright (C) 2006-2012, 2016 Canonical Ltd
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.
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.
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
17
"""Tests for handling of ignore files"""
19
from cStringIO import StringIO
25
from bzrlib.tests import (
28
TestCaseWithTransport,
32
class TestParseIgnoreFile(TestCase):
34
def test_parse_fancy(self):
35
ignored = ignores.parse_ignore_file(StringIO(
39
'unicode\xc2\xb5\n' # u'\xb5'.encode('utf8')
47
self.assertEqual(set(['./rootdir',
57
def test_parse_empty(self):
58
ignored = ignores.parse_ignore_file(StringIO(''))
59
self.assertEqual(set([]), ignored)
61
def test_parse_non_utf8(self):
62
"""Lines with non utf 8 characters should be discarded."""
63
ignored = ignores.parse_ignore_file(StringIO(
68
self.assertEqual(set([
74
class TestUserIgnores(TestCaseInTempDir):
76
def test_create_if_missing(self):
77
# $HOME should be set to '.'
78
ignore_path = config.user_ignore_config_filename()
79
self.assertPathDoesNotExist(ignore_path)
80
user_ignores = ignores.get_user_ignores()
81
self.assertEqual(set(ignores.USER_DEFAULTS), user_ignores)
83
self.assertPathExists(ignore_path)
84
f = open(ignore_path, 'rb')
86
entries = ignores.parse_ignore_file(f)
89
self.assertEqual(set(ignores.USER_DEFAULTS), entries)
91
def test_use_existing(self):
92
patterns = ['*.o', '*.py[co]', u'\xe5*']
93
ignores._set_user_ignores(patterns)
95
user_ignores = ignores.get_user_ignores()
96
self.assertEqual(set(patterns), user_ignores)
98
def test_use_empty(self):
99
ignores._set_user_ignores([])
100
ignore_path = config.user_ignore_config_filename()
101
self.check_file_contents(ignore_path, '')
103
self.assertEqual(set([]), ignores.get_user_ignores())
106
patterns = ['*.py[co]', '*.py[oc]']
107
ignores._set_user_ignores(patterns)
109
self.assertEqual(set(patterns), ignores.get_user_ignores())
111
patterns = ['vim', '*.swp']
112
ignores._set_user_ignores(patterns)
113
self.assertEqual(set(patterns), ignores.get_user_ignores())
116
"""Test that adding will not duplicate ignores"""
117
# Create an empty file
118
ignores._set_user_ignores([])
120
patterns = ['foo', './bar', u'b\xe5z']
121
added = ignores.add_unique_user_ignores(patterns)
122
self.assertEqual(patterns, added)
123
self.assertEqual(set(patterns), ignores.get_user_ignores())
125
def test_add_directory(self):
126
"""Test that adding a directory will strip any trailing slash"""
127
# Create an empty file
128
ignores._set_user_ignores([])
130
in_patterns = ['foo/', 'bar/', 'baz\\']
131
added = ignores.add_unique_user_ignores(in_patterns)
132
out_patterns = [ x.rstrip('/\\') for x in in_patterns ]
133
self.assertEqual(out_patterns, added)
134
self.assertEqual(set(out_patterns), ignores.get_user_ignores())
136
def test_add_unique(self):
137
"""Test that adding will not duplicate ignores"""
138
ignores._set_user_ignores(
139
['foo', './bar', u'b\xe5z', 'dir1/', 'dir3\\'])
141
added = ignores.add_unique_user_ignores(
142
['xxx', './bar', 'xxx', 'dir1/', 'dir2/', 'dir3\\'])
143
self.assertEqual(['xxx', 'dir2'], added)
144
self.assertEqual(set(['foo', './bar', u'b\xe5z',
145
'xxx', 'dir1', 'dir2', 'dir3']),
146
ignores.get_user_ignores())
149
class TestRuntimeIgnores(TestCase):
152
super(TestRuntimeIgnores, self).setUp()
154
# For the purposes of these tests, we must have no
156
self.overrideAttr(ignores, '_runtime_ignores', set())
159
"""Test that we can add an entry to the list."""
160
self.assertEqual(set(), ignores.get_runtime_ignores())
162
ignores.add_runtime_ignores(['foo'])
163
self.assertEqual(set(['foo']), ignores.get_runtime_ignores())
165
def test_add_duplicate(self):
166
"""Adding the same ignore twice shouldn't add a new entry."""
167
ignores.add_runtime_ignores(['foo', 'bar'])
168
self.assertEqual(set(['foo', 'bar']), ignores.get_runtime_ignores())
170
ignores.add_runtime_ignores(['bar'])
171
self.assertEqual(set(['foo', 'bar']), ignores.get_runtime_ignores())
174
class TestTreeIgnores(TestCaseWithTransport):
176
def assertPatternsEquals(self, patterns):
177
contents = open(".bzrignore", 'rU').read().strip().split('\n')
178
self.assertEqual(sorted(patterns), sorted(contents))
180
def test_new_file(self):
181
tree = self.make_branch_and_tree(".")
182
ignores.tree_ignores_add_patterns(tree, ["myentry"])
183
self.assertTrue(tree.has_filename(".bzrignore"))
184
self.assertPatternsEquals(["myentry"])
186
def test_add_to_existing(self):
187
tree = self.make_branch_and_tree(".")
188
self.build_tree_contents([('.bzrignore', "myentry1\n")])
189
tree.add([".bzrignore"])
190
ignores.tree_ignores_add_patterns(tree, ["myentry2", "foo"])
191
self.assertPatternsEquals(["myentry1", "myentry2", "foo"])
193
def test_adds_ending_newline(self):
194
tree = self.make_branch_and_tree(".")
195
self.build_tree_contents([('.bzrignore', "myentry1")])
196
tree.add([".bzrignore"])
197
ignores.tree_ignores_add_patterns(tree, ["myentry2"])
198
self.assertPatternsEquals(["myentry1", "myentry2"])
199
text = open(".bzrignore", 'r').read()
200
self.assertTrue(text.endswith('\r\n') or
201
text.endswith('\n') or
204
def test_does_not_add_dupe(self):
205
tree = self.make_branch_and_tree(".")
206
self.build_tree_contents([('.bzrignore', "myentry\n")])
207
tree.add([".bzrignore"])
208
ignores.tree_ignores_add_patterns(tree, ["myentry"])
209
self.assertPatternsEquals(["myentry"])
211
def test_non_ascii(self):
212
tree = self.make_branch_and_tree(".")
213
self.build_tree_contents([('.bzrignore',
214
u"myentry\u1234\n".encode('utf-8'))])
215
tree.add([".bzrignore"])
216
ignores.tree_ignores_add_patterns(tree, [u"myentry\u5678"])
217
self.assertPatternsEquals([u"myentry\u1234".encode('utf-8'),
218
u"myentry\u5678".encode('utf-8')])
221
tree = self.make_branch_and_tree(".")
222
self.build_tree_contents([('.bzrignore', "myentry1\r\n")])
223
tree.add([".bzrignore"])
224
ignores.tree_ignores_add_patterns(tree, ["myentry2", "foo"])
225
self.assertEqual(open('.bzrignore', 'rb').read(), 'myentry1\r\nmyentry2\r\nfoo\r\n')
226
self.assertPatternsEquals(["myentry1", "myentry2", "foo"])