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"""
23
from ..sixish import (
29
TestCaseWithTransport,
33
class TestParseIgnoreFile(TestCase):
35
def test_parse_fancy(self):
36
ignored = ignores.parse_ignore_file(BytesIO(
40
'unicode\xc2\xb5\n' # u'\xb5'.encode('utf8')
48
self.assertEqual({'./rootdir',
58
def test_parse_empty(self):
59
ignored = ignores.parse_ignore_file(BytesIO(b''))
60
self.assertEqual(set([]), ignored)
62
def test_parse_non_utf8(self):
63
"""Lines with non utf 8 characters should be discarded."""
64
ignored = ignores.parse_ignore_file(BytesIO(
75
class TestUserIgnores(TestCaseInTempDir):
77
def test_create_if_missing(self):
78
# $HOME should be set to '.'
79
ignore_path = config.user_ignore_config_filename()
80
self.assertPathDoesNotExist(ignore_path)
81
user_ignores = ignores.get_user_ignores()
82
self.assertEqual(set(ignores.USER_DEFAULTS), user_ignores)
84
self.assertPathExists(ignore_path)
85
f = open(ignore_path, 'rb')
87
entries = ignores.parse_ignore_file(f)
90
self.assertEqual(set(ignores.USER_DEFAULTS), entries)
92
def test_use_existing(self):
93
patterns = ['*.o', '*.py[co]', u'\xe5*']
94
ignores._set_user_ignores(patterns)
96
user_ignores = ignores.get_user_ignores()
97
self.assertEqual(set(patterns), user_ignores)
99
def test_use_empty(self):
100
ignores._set_user_ignores([])
101
ignore_path = config.user_ignore_config_filename()
102
self.check_file_contents(ignore_path, '')
104
self.assertEqual(set([]), ignores.get_user_ignores())
107
patterns = ['*.py[co]', '*.py[oc]']
108
ignores._set_user_ignores(patterns)
110
self.assertEqual(set(patterns), ignores.get_user_ignores())
112
patterns = ['vim', '*.swp']
113
ignores._set_user_ignores(patterns)
114
self.assertEqual(set(patterns), ignores.get_user_ignores())
117
"""Test that adding will not duplicate ignores"""
118
# Create an empty file
119
ignores._set_user_ignores([])
121
patterns = ['foo', './bar', u'b\xe5z']
122
added = ignores.add_unique_user_ignores(patterns)
123
self.assertEqual(patterns, added)
124
self.assertEqual(set(patterns), ignores.get_user_ignores())
126
def test_add_directory(self):
127
"""Test that adding a directory will strip any trailing slash"""
128
# Create an empty file
129
ignores._set_user_ignores([])
131
in_patterns = ['foo/', 'bar/', 'baz\\']
132
added = ignores.add_unique_user_ignores(in_patterns)
133
out_patterns = [ x.rstrip('/\\') for x in in_patterns ]
134
self.assertEqual(out_patterns, added)
135
self.assertEqual(set(out_patterns), ignores.get_user_ignores())
137
def test_add_unique(self):
138
"""Test that adding will not duplicate ignores"""
139
ignores._set_user_ignores(
140
['foo', './bar', u'b\xe5z', 'dir1/', 'dir3\\'])
142
added = ignores.add_unique_user_ignores(
143
['xxx', './bar', 'xxx', 'dir1/', 'dir2/', 'dir3\\'])
144
self.assertEqual(['xxx', 'dir2'], added)
145
self.assertEqual({'foo', './bar', u'b\xe5z',
146
'xxx', 'dir1', 'dir2', 'dir3'},
147
ignores.get_user_ignores())
150
class TestRuntimeIgnores(TestCase):
153
super(TestRuntimeIgnores, self).setUp()
155
# For the purposes of these tests, we must have no
157
self.overrideAttr(ignores, '_runtime_ignores', set())
160
"""Test that we can add an entry to the list."""
161
self.assertEqual(set(), ignores.get_runtime_ignores())
163
ignores.add_runtime_ignores(['foo'])
164
self.assertEqual({'foo'}, ignores.get_runtime_ignores())
166
def test_add_duplicate(self):
167
"""Adding the same ignore twice shouldn't add a new entry."""
168
ignores.add_runtime_ignores(['foo', 'bar'])
169
self.assertEqual({'foo', 'bar'}, ignores.get_runtime_ignores())
171
ignores.add_runtime_ignores(['bar'])
172
self.assertEqual({'foo', 'bar'}, ignores.get_runtime_ignores())
175
class TestTreeIgnores(TestCaseWithTransport):
177
def assertPatternsEquals(self, patterns):
178
contents = open(".bzrignore", 'rU').read().strip().split('\n')
179
self.assertEqual(sorted(patterns), sorted(contents))
181
def test_new_file(self):
182
tree = self.make_branch_and_tree(".")
183
ignores.tree_ignores_add_patterns(tree, ["myentry"])
184
self.assertTrue(tree.has_filename(".bzrignore"))
185
self.assertPatternsEquals(["myentry"])
187
def test_add_to_existing(self):
188
tree = self.make_branch_and_tree(".")
189
self.build_tree_contents([('.bzrignore', "myentry1\n")])
190
tree.add([".bzrignore"])
191
ignores.tree_ignores_add_patterns(tree, ["myentry2", "foo"])
192
self.assertPatternsEquals(["myentry1", "myentry2", "foo"])
194
def test_adds_ending_newline(self):
195
tree = self.make_branch_and_tree(".")
196
self.build_tree_contents([('.bzrignore', "myentry1")])
197
tree.add([".bzrignore"])
198
ignores.tree_ignores_add_patterns(tree, ["myentry2"])
199
self.assertPatternsEquals(["myentry1", "myentry2"])
200
text = open(".bzrignore", 'r').read()
201
self.assertTrue(text.endswith('\r\n') or
202
text.endswith('\n') or
205
def test_does_not_add_dupe(self):
206
tree = self.make_branch_and_tree(".")
207
self.build_tree_contents([('.bzrignore', "myentry\n")])
208
tree.add([".bzrignore"])
209
ignores.tree_ignores_add_patterns(tree, ["myentry"])
210
self.assertPatternsEquals(["myentry"])
212
def test_non_ascii(self):
213
tree = self.make_branch_and_tree(".")
214
self.build_tree_contents([('.bzrignore',
215
u"myentry\u1234\n".encode('utf-8'))])
216
tree.add([".bzrignore"])
217
ignores.tree_ignores_add_patterns(tree, [u"myentry\u5678"])
218
self.assertPatternsEquals([u"myentry\u1234".encode('utf-8'),
219
u"myentry\u5678".encode('utf-8')])
222
tree = self.make_branch_and_tree(".")
223
self.build_tree_contents([('.bzrignore', "myentry1\r\n")])
224
tree.add([".bzrignore"])
225
ignores.tree_ignores_add_patterns(tree, ["myentry2", "foo"])
226
self.assertEqual(open('.bzrignore', 'rb').read(), 'myentry1\r\nmyentry2\r\nfoo\r\n')
227
self.assertPatternsEquals(["myentry1", "myentry2", "foo"])