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
18
"""Black-box tests for bzr diff."""
27
from bzrlib.diff import (
29
format_registry as diff_format_registry,
31
from bzrlib.tests import (
36
def subst_dates(string):
37
"""Replace date strings with constant values."""
38
return re.sub(r'\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [-\+]\d{4}',
39
'YYYY-MM-DD HH:MM:SS +ZZZZ', string)
42
class DiffBase(tests.TestCaseWithTransport):
43
"""Base class with common setup method"""
45
def make_example_branch(self):
46
tree = self.make_branch_and_tree('.')
47
self.build_tree_contents([
49
('goodbye', 'baz\n')])
57
class TestDiff(DiffBase):
60
tree = self.make_example_branch()
61
self.build_tree_contents([('hello', 'hello world!')])
62
tree.commit(message='fixing hello')
63
output = self.run_bzr('diff -r 2..3', retcode=1)[0]
64
self.assertTrue('\n+hello world!' in output)
65
output = self.run_bzr('diff -c 3', retcode=1)[0]
66
self.assertTrue('\n+hello world!' in output)
67
output = self.run_bzr('diff -r last:3..last:1', retcode=1)[0]
68
self.assertTrue('\n+baz' in output)
69
output = self.run_bzr('diff -c last:2', retcode=1)[0]
70
self.assertTrue('\n+baz' in output)
71
self.build_tree(['moo'])
76
def test_diff_prefix(self):
77
"""diff --prefix appends to filenames in output"""
78
self.make_example_branch()
79
self.build_tree_contents([('hello', 'hello world!\n')])
80
out, err = self.run_bzr('diff --prefix old/:new/', retcode=1)
81
self.assertEqual(err, '')
82
self.assertEqualDiff(subst_dates(out), '''\
83
=== modified file 'hello'
84
--- old/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
85
+++ new/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
92
def test_diff_illegal_prefix_value(self):
93
# There was an error in error reporting for this option
94
out, err = self.run_bzr('diff --prefix old/', retcode=3)
95
self.assertContainsRe(err,
96
'--prefix expects two values separated by a colon')
98
def test_diff_p1(self):
99
"""diff -p1 produces lkml-style diffs"""
100
self.make_example_branch()
101
self.build_tree_contents([('hello', 'hello world!\n')])
102
out, err = self.run_bzr('diff -p1', retcode=1)
103
self.assertEqual(err, '')
104
self.assertEqualDiff(subst_dates(out), '''\
105
=== modified file 'hello'
106
--- old/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
107
+++ new/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
114
def test_diff_p0(self):
115
"""diff -p0 produces diffs with no prefix"""
116
self.make_example_branch()
117
self.build_tree_contents([('hello', 'hello world!\n')])
118
out, err = self.run_bzr('diff -p0', retcode=1)
119
self.assertEqual(err, '')
120
self.assertEqualDiff(subst_dates(out), '''\
121
=== modified file 'hello'
122
--- hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
123
+++ hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
130
def test_diff_nonexistent(self):
131
# Get an error from a file that does not exist at all
133
self.make_example_branch()
134
out, err = self.run_bzr('diff does-not-exist', retcode=3,
135
error_regexes=('not versioned.*does-not-exist',))
137
def test_diff_illegal_revision_specifiers(self):
138
out, err = self.run_bzr('diff -r 1..23..123', retcode=3,
139
error_regexes=('one or two revision specifiers',))
141
def test_diff_using_and_format(self):
142
out, err = self.run_bzr('diff --format=default --using=mydi', retcode=3,
143
error_regexes=('are mutually exclusive',))
145
def test_diff_nonexistent_revision(self):
146
out, err = self.run_bzr('diff -r 123', retcode=3,
147
error_regexes=("Requested revision: '123' does not "
148
"exist in branch:",))
150
def test_diff_nonexistent_dotted_revision(self):
151
out, err = self.run_bzr('diff -r 1.1', retcode=3)
152
self.assertContainsRe(err,
153
"Requested revision: '1.1' does not exist in branch:")
155
def test_diff_nonexistent_dotted_revision_change(self):
156
out, err = self.run_bzr('diff -c 1.1', retcode=3)
157
self.assertContainsRe(err,
158
"Requested revision: '1.1' does not exist in branch:")
160
def test_diff_unversioned(self):
161
# Get an error when diffing a non-versioned file.
163
self.make_example_branch()
164
self.build_tree(['unversioned-file'])
165
out, err = self.run_bzr('diff unversioned-file', retcode=3)
166
self.assertContainsRe(err, 'not versioned.*unversioned-file')
168
# TODO: What should diff say for a file deleted in working tree?
170
def example_branches(self):
171
branch1_tree = self.make_branch_and_tree('branch1')
172
self.build_tree(['branch1/file'], line_endings='binary')
173
self.build_tree(['branch1/file2'], line_endings='binary')
174
branch1_tree.add('file')
175
branch1_tree.add('file2')
176
branch1_tree.commit(message='add file and file2')
177
branch2_tree = branch1_tree.bzrdir.sprout('branch2').open_workingtree()
178
self.build_tree_contents([('branch2/file', 'new content\n')])
179
branch2_tree.commit(message='update file')
180
return branch1_tree, branch2_tree
182
def check_b2_vs_b1(self, cmd):
183
# Compare branch2 vs branch1 using cmd and check the result
184
out, err = self.run_bzr(cmd, retcode=1)
185
self.assertEqual('', err)
186
self.assertEqual("=== modified file 'file'\n"
187
"--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
188
"+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
191
"+contents of branch1/file\n"
192
"\n", subst_dates(out))
194
def check_b1_vs_b2(self, cmd):
195
# Compare branch1 vs branch2 using cmd and check the result
196
out, err = self.run_bzr(cmd, retcode=1)
197
self.assertEqual('', err)
198
self.assertEqualDiff("=== modified file 'file'\n"
199
"--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
200
"+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
202
"-contents of branch1/file\n"
204
"\n", subst_dates(out))
206
def check_no_diffs(self, cmd):
207
# Check that running cmd returns an empty diff
208
out, err = self.run_bzr(cmd, retcode=0)
209
self.assertEqual('', err)
210
self.assertEqual('', out)
212
def test_diff_branches(self):
213
self.example_branches()
214
# should open branch1 and diff against branch2,
215
self.check_b2_vs_b1('diff -r branch:branch2 branch1')
216
# Compare two working trees using various syntax forms
217
self.check_b2_vs_b1('diff --old branch2 --new branch1')
218
self.check_b2_vs_b1('diff --old branch2 branch1')
219
self.check_b2_vs_b1('diff branch2 --new branch1')
220
# Test with a selected file that was changed
221
self.check_b2_vs_b1('diff --old branch2 --new branch1 file')
222
self.check_b2_vs_b1('diff --old branch2 branch1/file')
223
self.check_b2_vs_b1('diff branch2/file --new branch1')
224
# Test with a selected file that was not changed
225
self.check_no_diffs('diff --old branch2 --new branch1 file2')
226
self.check_no_diffs('diff --old branch2 branch1/file2')
227
self.check_no_diffs('diff branch2/file2 --new branch1')
229
def test_diff_branches_no_working_trees(self):
230
branch1_tree, branch2_tree = self.example_branches()
231
# Compare a working tree to a branch without a WT
232
dir1 = branch1_tree.bzrdir
233
dir1.destroy_workingtree()
234
self.assertFalse(dir1.has_workingtree())
235
self.check_b2_vs_b1('diff --old branch2 --new branch1')
236
self.check_b2_vs_b1('diff --old branch2 branch1')
237
self.check_b2_vs_b1('diff branch2 --new branch1')
238
# Compare a branch without a WT to one with a WT
239
self.check_b1_vs_b2('diff --old branch1 --new branch2')
240
self.check_b1_vs_b2('diff --old branch1 branch2')
241
self.check_b1_vs_b2('diff branch1 --new branch2')
242
# Compare a branch with a WT against another without a WT
243
dir2 = branch2_tree.bzrdir
244
dir2.destroy_workingtree()
245
self.assertFalse(dir2.has_workingtree())
246
self.check_b1_vs_b2('diff --old branch1 --new branch2')
247
self.check_b1_vs_b2('diff --old branch1 branch2')
248
self.check_b1_vs_b2('diff branch1 --new branch2')
250
def test_diff_revno_branches(self):
251
self.example_branches()
252
branch2_tree = workingtree.WorkingTree.open_containing('branch2')[0]
253
self.build_tree_contents([('branch2/file', 'even newer content')])
254
branch2_tree.commit(message='update file once more')
256
out, err = self.run_bzr('diff -r revno:1:branch2..revno:1:branch1',
258
self.assertEqual('', err)
259
self.assertEqual('', out)
260
out, err = self.run_bzr('diff -r revno:2:branch2..revno:1:branch1',
262
self.assertEqual('', err)
263
self.assertEqualDiff("=== modified file 'file'\n"
264
"--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
265
"+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
268
"+contents of branch1/file\n"
269
"\n", subst_dates(out))
271
def example_branch2(self):
272
branch1_tree = self.make_branch_and_tree('branch1')
273
self.build_tree_contents([('branch1/file1', 'original line\n')])
274
branch1_tree.add('file1')
275
branch1_tree.commit(message='first commit')
276
self.build_tree_contents([('branch1/file1', 'repo line\n')])
277
branch1_tree.commit(message='second commit')
280
def test_diff_to_working_tree(self):
281
self.example_branch2()
282
self.build_tree_contents([('branch1/file1', 'new line')])
283
output = self.run_bzr('diff -r 1.. branch1', retcode=1)
284
self.assertContainsRe(output[0], '\n\\-original line\n\\+new line\n')
286
def test_diff_to_working_tree_in_subdir(self):
287
self.example_branch2()
288
self.build_tree_contents([('branch1/file1', 'new line')])
289
os.mkdir('branch1/dir1')
290
output = self.run_bzr('diff -r 1..', retcode=1,
291
working_dir='branch1/dir1')
292
self.assertContainsRe(output[0], '\n\\-original line\n\\+new line\n')
294
def test_diff_across_rename(self):
295
"""The working tree path should always be considered for diffing"""
296
tree = self.make_example_branch()
297
self.run_bzr('diff -r 0..1 hello', retcode=1)
298
tree.rename_one('hello', 'hello1')
299
self.run_bzr('diff hello1', retcode=1)
300
self.run_bzr('diff -r 0..1 hello1', retcode=1)
302
def test_diff_to_branch_no_working_tree(self):
303
branch1_tree = self.example_branch2()
304
dir1 = branch1_tree.bzrdir
305
dir1.destroy_workingtree()
306
self.assertFalse(dir1.has_workingtree())
307
output = self.run_bzr('diff -r 1.. branch1', retcode=1)
308
self.assertContainsRe(output[0], '\n\\-original line\n\\+repo line\n')
310
def test_custom_format(self):
311
class BooDiffTree(DiffTree):
313
def show_diff(self, specific_files, extra_trees=None):
314
self.to_file.write("BOO!\n")
315
return super(BooDiffTree, self).show_diff(specific_files,
318
diff_format_registry.register("boo", BooDiffTree, "Scary diff format")
319
self.addCleanup(diff_format_registry.remove, "boo")
320
self.make_example_branch()
321
self.build_tree_contents([('hello', 'hello world!\n')])
322
output = self.run_bzr('diff --format=boo', retcode=1)
323
self.assertTrue("BOO!" in output[0])
324
output = self.run_bzr('diff -Fboo', retcode=1)
325
self.assertTrue("BOO!" in output[0])
328
class TestCheckoutDiff(TestDiff):
330
def make_example_branch(self):
331
tree = super(TestCheckoutDiff, self).make_example_branch()
332
tree = tree.branch.create_checkout('checkout')
336
def example_branch2(self):
337
tree = super(TestCheckoutDiff, self).example_branch2()
338
os.mkdir('checkouts')
339
tree = tree.branch.create_checkout('checkouts/branch1')
340
os.chdir('checkouts')
343
def example_branches(self):
344
branch1_tree, branch2_tree = super(TestCheckoutDiff,
345
self).example_branches()
346
os.mkdir('checkouts')
347
branch1_tree = branch1_tree.branch.create_checkout('checkouts/branch1')
348
branch2_tree = branch2_tree.branch.create_checkout('checkouts/branch2')
349
os.chdir('checkouts')
350
return branch1_tree, branch2_tree
353
class TestDiffLabels(DiffBase):
355
def test_diff_label_removed(self):
356
tree = super(TestDiffLabels, self).make_example_branch()
357
tree.remove('hello', keep_files=False)
358
diff = self.run_bzr('diff', retcode=1)
359
self.assertTrue("=== removed file 'hello'" in diff[0])
361
def test_diff_label_added(self):
362
tree = super(TestDiffLabels, self).make_example_branch()
363
self.build_tree_contents([('barbar', 'barbar')])
365
diff = self.run_bzr('diff', retcode=1)
366
self.assertTrue("=== added file 'barbar'" in diff[0])
368
def test_diff_label_modified(self):
369
super(TestDiffLabels, self).make_example_branch()
370
self.build_tree_contents([('hello', 'barbar')])
371
diff = self.run_bzr('diff', retcode=1)
372
self.assertTrue("=== modified file 'hello'" in diff[0])
374
def test_diff_label_renamed(self):
375
tree = super(TestDiffLabels, self).make_example_branch()
376
tree.rename_one('hello', 'gruezi')
377
diff = self.run_bzr('diff', retcode=1)
378
self.assertTrue("=== renamed file 'hello' => 'gruezi'" in diff[0])
381
class TestExternalDiff(DiffBase):
383
def test_external_diff(self):
384
"""Test that we can spawn an external diff process"""
385
self.disable_missing_extensions_warning()
386
# We have to use run_bzr_subprocess, because we need to
387
# test writing directly to stdout, (there was a bug in
388
# subprocess.py that we had to workaround).
389
# However, if 'diff' may not be available
390
self.make_example_branch()
391
out, err = self.run_bzr_subprocess(
392
'diff -Oprogress_bar=none -r 1 --diff-options -ub',
393
universal_newlines=True,
395
if 'Diff is not installed on this machine' in err:
396
raise tests.TestSkipped("No external 'diff' is available")
397
self.assertEqual('', err)
398
# We have to skip the stuff in the middle, because it depends
400
self.assertStartsWith(out, "=== added file 'goodbye'\n"
401
"--- goodbye\t1970-01-01 00:00:00 +0000\n"
403
self.assertEndsWith(out, "\n@@ -0,0 +1 @@\n"
406
def test_external_diff_options_and_using(self):
407
"""Test that the options are passed correctly to an external diff process"""
408
self.requireFeature(features.diff_feature)
409
self.make_example_branch()
410
self.build_tree_contents([('hello', 'Foo\n')])
411
out, err = self.run_bzr('diff --diff-options -i --using diff',
413
self.assertEqual("=== modified file 'hello'\n", out)
414
self.assertEqual('', err)
417
class TestDiffOutput(DiffBase):
419
def test_diff_output(self):
420
# check that output doesn't mangle line-endings
421
self.make_example_branch()
422
self.build_tree_contents([('hello', 'hello world!\n')])
423
output = self.run_bzr_subprocess('diff', retcode=1)[0]
424
self.assertTrue('\n+hello world!\n' in output)