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"""
25
from ..sixish import (
31
TestCaseWithTransport,
35
class TestParseIgnoreFile(TestCase):
37
def test_parse_fancy(self):
38
ignored = ignores.parse_ignore_file(BytesIO(
42
b'unicode\xc2\xb5\n' # u'\xb5'.encode('utf8')
46
b' xx \n' # whitespace
50
self.assertEqual({u'./rootdir',
60
def test_parse_empty(self):
61
ignored = ignores.parse_ignore_file(BytesIO(b''))
62
self.assertEqual(set([]), ignored)
64
def test_parse_non_utf8(self):
65
"""Lines with non utf 8 characters should be discarded."""
66
ignored = ignores.parse_ignore_file(BytesIO(
77
class TestUserIgnores(TestCaseInTempDir):
79
def test_create_if_missing(self):
80
# $HOME should be set to '.'
81
ignore_path = bedding.user_ignore_config_path()
82
self.assertPathDoesNotExist(ignore_path)
83
user_ignores = ignores.get_user_ignores()
84
self.assertEqual(set(ignores.USER_DEFAULTS), user_ignores)
86
self.assertPathExists(ignore_path)
87
with open(ignore_path, 'rb') as f:
88
entries = ignores.parse_ignore_file(f)
89
self.assertEqual(set(ignores.USER_DEFAULTS), entries)
91
def test_create_with_intermediate_missing(self):
92
# $HOME should be set to '.'
93
ignore_path = bedding.user_ignore_config_path()
94
self.assertPathDoesNotExist(ignore_path)
95
os.mkdir('empty-home')
97
config_path = os.path.join(self.test_dir, 'empty-home', '.config')
98
self.overrideEnv('BRZ_HOME', config_path)
99
self.assertPathDoesNotExist(config_path)
101
user_ignores = ignores.get_user_ignores()
102
self.assertEqual(set(ignores.USER_DEFAULTS), user_ignores)
104
ignore_path = bedding.user_ignore_config_path()
105
self.assertPathDoesNotExist(ignore_path)
107
def test_use_existing(self):
108
patterns = [u'*.o', u'*.py[co]', u'\xe5*']
109
ignores._set_user_ignores(patterns)
111
user_ignores = ignores.get_user_ignores()
112
self.assertEqual(set(patterns), user_ignores)
114
def test_use_empty(self):
115
ignores._set_user_ignores([])
116
ignore_path = bedding.user_ignore_config_path()
117
self.check_file_contents(ignore_path, b'')
119
self.assertEqual(set([]), ignores.get_user_ignores())
122
patterns = ['*.py[co]', '*.py[oc]']
123
ignores._set_user_ignores(patterns)
125
self.assertEqual(set(patterns), ignores.get_user_ignores())
127
patterns = ['vim', '*.swp']
128
ignores._set_user_ignores(patterns)
129
self.assertEqual(set(patterns), ignores.get_user_ignores())
132
"""Test that adding will not duplicate ignores"""
133
# Create an empty file
134
ignores._set_user_ignores([])
136
patterns = ['foo', './bar', u'b\xe5z']
137
added = ignores.add_unique_user_ignores(patterns)
138
self.assertEqual(patterns, added)
139
self.assertEqual(set(patterns), ignores.get_user_ignores())
141
def test_add_directory(self):
142
"""Test that adding a directory will strip any trailing slash"""
143
# Create an empty file
144
ignores._set_user_ignores([])
146
in_patterns = ['foo/', 'bar/', 'baz\\']
147
added = ignores.add_unique_user_ignores(in_patterns)
148
out_patterns = [x.rstrip('/\\') for x in in_patterns]
149
self.assertEqual(out_patterns, added)
150
self.assertEqual(set(out_patterns), ignores.get_user_ignores())
152
def test_add_unique(self):
153
"""Test that adding will not duplicate ignores"""
154
ignores._set_user_ignores(
155
['foo', './bar', u'b\xe5z', 'dir1/', 'dir3\\'])
157
added = ignores.add_unique_user_ignores(
158
['xxx', './bar', 'xxx', 'dir1/', 'dir2/', 'dir3\\'])
159
self.assertEqual(['xxx', 'dir2'], added)
160
self.assertEqual({'foo', './bar', u'b\xe5z',
161
'xxx', 'dir1', 'dir2', 'dir3'},
162
ignores.get_user_ignores())
165
class TestRuntimeIgnores(TestCase):
168
super(TestRuntimeIgnores, self).setUp()
170
# For the purposes of these tests, we must have no
172
self.overrideAttr(ignores, '_runtime_ignores', set())
175
"""Test that we can add an entry to the list."""
176
self.assertEqual(set(), ignores.get_runtime_ignores())
178
ignores.add_runtime_ignores(['foo'])
179
self.assertEqual({'foo'}, ignores.get_runtime_ignores())
181
def test_add_duplicate(self):
182
"""Adding the same ignore twice shouldn't add a new entry."""
183
ignores.add_runtime_ignores(['foo', 'bar'])
184
self.assertEqual({'foo', 'bar'}, ignores.get_runtime_ignores())
186
ignores.add_runtime_ignores(['bar'])
187
self.assertEqual({'foo', 'bar'}, ignores.get_runtime_ignores())
190
class TestTreeIgnores(TestCaseWithTransport):
192
def assertPatternsEquals(self, patterns):
193
with open(".bzrignore", "rb") as f:
194
contents = f.read().decode("utf-8").splitlines()
195
self.assertEqual(sorted(patterns), sorted(contents))
197
def test_new_file(self):
198
tree = self.make_branch_and_tree(".")
199
ignores.tree_ignores_add_patterns(tree, [u"myentry"])
200
self.assertTrue(tree.has_filename(".bzrignore"))
201
self.assertPatternsEquals(["myentry"])
203
def test_add_to_existing(self):
204
tree = self.make_branch_and_tree(".")
205
self.build_tree_contents([('.bzrignore', b"myentry1\n")])
206
tree.add([".bzrignore"])
207
ignores.tree_ignores_add_patterns(tree, [u"myentry2", u"foo"])
208
self.assertPatternsEquals(["myentry1", "myentry2", "foo"])
210
def test_adds_ending_newline(self):
211
tree = self.make_branch_and_tree(".")
212
self.build_tree_contents([('.bzrignore', b"myentry1")])
213
tree.add([".bzrignore"])
214
ignores.tree_ignores_add_patterns(tree, [u"myentry2"])
215
self.assertPatternsEquals(["myentry1", "myentry2"])
216
with open(".bzrignore") as f:
218
self.assertTrue(text.endswith(('\r\n', '\n', '\r')))
220
def test_does_not_add_dupe(self):
221
tree = self.make_branch_and_tree(".")
222
self.build_tree_contents([('.bzrignore', b"myentry\n")])
223
tree.add([".bzrignore"])
224
ignores.tree_ignores_add_patterns(tree, [u"myentry"])
225
self.assertPatternsEquals(["myentry"])
227
def test_non_ascii(self):
228
tree = self.make_branch_and_tree(".")
229
self.build_tree_contents([('.bzrignore',
230
u"myentry\u1234\n".encode('utf-8'))])
231
tree.add([".bzrignore"])
232
ignores.tree_ignores_add_patterns(tree, [u"myentry\u5678"])
233
self.assertPatternsEquals([u"myentry\u1234", u"myentry\u5678"])
236
tree = self.make_branch_and_tree(".")
237
self.build_tree_contents([('.bzrignore', b"myentry1\r\n")])
238
tree.add([".bzrignore"])
239
ignores.tree_ignores_add_patterns(tree, ["myentry2", "foo"])
240
with open('.bzrignore', 'rb') as f:
241
self.assertEqual(f.read(), b'myentry1\r\nmyentry2\r\nfoo\r\n')
242
self.assertPatternsEquals(["myentry1", "myentry2", "foo"])