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
b'unicode\xc2\xb5\n' # u'\xb5'.encode('utf8')
44
b' xx \n' # whitespace
48
self.assertEqual({u'./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
with open(ignore_path, 'rb') as f:
86
entries = ignores.parse_ignore_file(f)
87
self.assertEqual(set(ignores.USER_DEFAULTS), entries)
89
def test_use_existing(self):
90
patterns = [u'*.o', u'*.py[co]', u'\xe5*']
91
ignores._set_user_ignores(patterns)
93
user_ignores = ignores.get_user_ignores()
94
self.assertEqual(set(patterns), user_ignores)
96
def test_use_empty(self):
97
ignores._set_user_ignores([])
98
ignore_path = config.user_ignore_config_filename()
99
self.check_file_contents(ignore_path, b'')
101
self.assertEqual(set([]), ignores.get_user_ignores())
104
patterns = ['*.py[co]', '*.py[oc]']
105
ignores._set_user_ignores(patterns)
107
self.assertEqual(set(patterns), ignores.get_user_ignores())
109
patterns = ['vim', '*.swp']
110
ignores._set_user_ignores(patterns)
111
self.assertEqual(set(patterns), ignores.get_user_ignores())
114
"""Test that adding will not duplicate ignores"""
115
# Create an empty file
116
ignores._set_user_ignores([])
118
patterns = ['foo', './bar', u'b\xe5z']
119
added = ignores.add_unique_user_ignores(patterns)
120
self.assertEqual(patterns, added)
121
self.assertEqual(set(patterns), ignores.get_user_ignores())
123
def test_add_directory(self):
124
"""Test that adding a directory will strip any trailing slash"""
125
# Create an empty file
126
ignores._set_user_ignores([])
128
in_patterns = ['foo/', 'bar/', 'baz\\']
129
added = ignores.add_unique_user_ignores(in_patterns)
130
out_patterns = [x.rstrip('/\\') for x in in_patterns]
131
self.assertEqual(out_patterns, added)
132
self.assertEqual(set(out_patterns), ignores.get_user_ignores())
134
def test_add_unique(self):
135
"""Test that adding will not duplicate ignores"""
136
ignores._set_user_ignores(
137
['foo', './bar', u'b\xe5z', 'dir1/', 'dir3\\'])
139
added = ignores.add_unique_user_ignores(
140
['xxx', './bar', 'xxx', 'dir1/', 'dir2/', 'dir3\\'])
141
self.assertEqual(['xxx', 'dir2'], added)
142
self.assertEqual({'foo', './bar', u'b\xe5z',
143
'xxx', 'dir1', 'dir2', 'dir3'},
144
ignores.get_user_ignores())
147
class TestRuntimeIgnores(TestCase):
150
super(TestRuntimeIgnores, self).setUp()
152
# For the purposes of these tests, we must have no
154
self.overrideAttr(ignores, '_runtime_ignores', set())
157
"""Test that we can add an entry to the list."""
158
self.assertEqual(set(), ignores.get_runtime_ignores())
160
ignores.add_runtime_ignores(['foo'])
161
self.assertEqual({'foo'}, ignores.get_runtime_ignores())
163
def test_add_duplicate(self):
164
"""Adding the same ignore twice shouldn't add a new entry."""
165
ignores.add_runtime_ignores(['foo', 'bar'])
166
self.assertEqual({'foo', 'bar'}, ignores.get_runtime_ignores())
168
ignores.add_runtime_ignores(['bar'])
169
self.assertEqual({'foo', 'bar'}, ignores.get_runtime_ignores())
172
class TestTreeIgnores(TestCaseWithTransport):
174
def assertPatternsEquals(self, patterns):
175
with open(".bzrignore", "rb") as f:
176
contents = f.read().decode("utf-8").splitlines()
177
self.assertEqual(sorted(patterns), sorted(contents))
179
def test_new_file(self):
180
tree = self.make_branch_and_tree(".")
181
ignores.tree_ignores_add_patterns(tree, [u"myentry"])
182
self.assertTrue(tree.has_filename(".bzrignore"))
183
self.assertPatternsEquals(["myentry"])
185
def test_add_to_existing(self):
186
tree = self.make_branch_and_tree(".")
187
self.build_tree_contents([('.bzrignore', b"myentry1\n")])
188
tree.add([".bzrignore"])
189
ignores.tree_ignores_add_patterns(tree, [u"myentry2", u"foo"])
190
self.assertPatternsEquals(["myentry1", "myentry2", "foo"])
192
def test_adds_ending_newline(self):
193
tree = self.make_branch_and_tree(".")
194
self.build_tree_contents([('.bzrignore', b"myentry1")])
195
tree.add([".bzrignore"])
196
ignores.tree_ignores_add_patterns(tree, [u"myentry2"])
197
self.assertPatternsEquals(["myentry1", "myentry2"])
198
with open(".bzrignore") as f:
200
self.assertTrue(text.endswith(('\r\n', '\n', '\r')))
202
def test_does_not_add_dupe(self):
203
tree = self.make_branch_and_tree(".")
204
self.build_tree_contents([('.bzrignore', b"myentry\n")])
205
tree.add([".bzrignore"])
206
ignores.tree_ignores_add_patterns(tree, [u"myentry"])
207
self.assertPatternsEquals(["myentry"])
209
def test_non_ascii(self):
210
tree = self.make_branch_and_tree(".")
211
self.build_tree_contents([('.bzrignore',
212
u"myentry\u1234\n".encode('utf-8'))])
213
tree.add([".bzrignore"])
214
ignores.tree_ignores_add_patterns(tree, [u"myentry\u5678"])
215
self.assertPatternsEquals([u"myentry\u1234", u"myentry\u5678"])
218
tree = self.make_branch_and_tree(".")
219
self.build_tree_contents([('.bzrignore', b"myentry1\r\n")])
220
tree.add([".bzrignore"])
221
ignores.tree_ignores_add_patterns(tree, ["myentry2", "foo"])
222
with open('.bzrignore', 'rb') as f:
223
self.assertEqual(f.read(), b'myentry1\r\nmyentry2\r\nfoo\r\n')
224
self.assertPatternsEquals(["myentry1", "myentry2", "foo"])