1
# Copyright (C) 2006-2010 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.
28
from bzrlib.diff import (
30
format_registry as diff_format_registry,
34
def subst_dates(string):
35
"""Replace date strings with constant values."""
36
return re.sub(r'\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [-\+]\d{4}',
37
'YYYY-MM-DD HH:MM:SS +ZZZZ', string)
40
class DiffBase(tests.TestCaseWithTransport):
41
"""Base class with common setup method"""
43
def make_example_branch(self):
44
tree = self.make_branch_and_tree('.')
45
self.build_tree_contents([
47
('goodbye', 'baz\n')])
55
class TestDiff(DiffBase):
58
tree = self.make_example_branch()
59
self.build_tree_contents([('hello', 'hello world!')])
60
tree.commit(message='fixing hello')
61
output = self.run_bzr('diff -r 2..3', retcode=1)[0]
62
self.assert_('\n+hello world!' in output)
63
output = self.run_bzr('diff -c 3', retcode=1)[0]
64
self.assert_('\n+hello world!' in output)
65
output = self.run_bzr('diff -r last:3..last:1', retcode=1)[0]
66
self.assert_('\n+baz' in output)
67
output = self.run_bzr('diff -c last:2', retcode=1)[0]
68
self.assert_('\n+baz' in output)
69
self.build_tree(['moo'])
74
def test_diff_prefix(self):
75
"""diff --prefix appends to filenames in output"""
76
self.make_example_branch()
77
self.build_tree_contents([('hello', 'hello world!\n')])
78
out, err = self.run_bzr('diff --prefix old/:new/', retcode=1)
79
self.assertEquals(err, '')
80
self.assertEqualDiff(subst_dates(out), '''\
81
=== modified file 'hello'
82
--- old/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
83
+++ new/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
90
def test_diff_illegal_prefix_value(self):
91
# There was an error in error reporting for this option
92
out, err = self.run_bzr('diff --prefix old/', retcode=3)
93
self.assertContainsRe(err,
94
'--prefix expects two values separated by a colon')
96
def test_diff_p1(self):
97
"""diff -p1 produces lkml-style diffs"""
98
self.make_example_branch()
99
self.build_tree_contents([('hello', 'hello world!\n')])
100
out, err = self.run_bzr('diff -p1', retcode=1)
101
self.assertEquals(err, '')
102
self.assertEqualDiff(subst_dates(out), '''\
103
=== modified file 'hello'
104
--- old/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
105
+++ new/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
112
def test_diff_p0(self):
113
"""diff -p0 produces diffs with no prefix"""
114
self.make_example_branch()
115
self.build_tree_contents([('hello', 'hello world!\n')])
116
out, err = self.run_bzr('diff -p0', retcode=1)
117
self.assertEquals(err, '')
118
self.assertEqualDiff(subst_dates(out), '''\
119
=== modified file 'hello'
120
--- hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
121
+++ hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
128
def test_diff_nonexistent(self):
129
# Get an error from a file that does not exist at all
131
self.make_example_branch()
132
out, err = self.run_bzr('diff does-not-exist', retcode=3,
133
error_regexes=('not versioned.*does-not-exist',))
135
def test_diff_illegal_revision_specifiers(self):
136
out, err = self.run_bzr('diff -r 1..23..123', retcode=3,
137
error_regexes=('one or two revision specifiers',))
139
def test_diff_using_and_format(self):
140
out, err = self.run_bzr('diff --format=default --using=mydi', retcode=3,
141
error_regexes=('are mutually exclusive',))
143
def test_diff_nonexistent_revision(self):
144
out, err = self.run_bzr('diff -r 123', retcode=3,
145
error_regexes=("Requested revision: '123' does not "
146
"exist in branch:",))
148
def test_diff_nonexistent_dotted_revision(self):
149
out, err = self.run_bzr('diff -r 1.1', retcode=3)
150
self.assertContainsRe(err,
151
"Requested revision: '1.1' does not exist in branch:")
153
def test_diff_nonexistent_dotted_revision_change(self):
154
out, err = self.run_bzr('diff -c 1.1', retcode=3)
155
self.assertContainsRe(err,
156
"Requested revision: '1.1' does not exist in branch:")
158
def test_diff_diff_options_and_using(self):
159
out, err = self.run_bzr('diff --diff-options -wu --using /usr/bin/diff', retcode=3,
160
error_regexes=('are mutually exclusive.',))
162
def test_diff_unversioned(self):
163
# Get an error when diffing a non-versioned file.
165
self.make_example_branch()
166
self.build_tree(['unversioned-file'])
167
out, err = self.run_bzr('diff unversioned-file', retcode=3)
168
self.assertContainsRe(err, 'not versioned.*unversioned-file')
170
# TODO: What should diff say for a file deleted in working tree?
172
def example_branches(self):
173
branch1_tree = self.make_branch_and_tree('branch1')
174
self.build_tree(['branch1/file'], line_endings='binary')
175
self.build_tree(['branch1/file2'], line_endings='binary')
176
branch1_tree.add('file')
177
branch1_tree.add('file2')
178
branch1_tree.commit(message='add file and file2')
179
branch2_tree = branch1_tree.bzrdir.sprout('branch2').open_workingtree()
180
self.build_tree_contents([('branch2/file', 'new content\n')])
181
branch2_tree.commit(message='update file')
182
return branch1_tree, branch2_tree
184
def check_b2_vs_b1(self, cmd):
185
# Compare branch2 vs branch1 using cmd and check the result
186
out, err = self.run_bzr(cmd, retcode=1)
187
self.assertEquals('', err)
188
self.assertEquals("=== modified file 'file'\n"
189
"--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
190
"+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
193
"+contents of branch1/file\n"
194
"\n", subst_dates(out))
196
def check_b1_vs_b2(self, cmd):
197
# Compare branch1 vs branch2 using cmd and check the result
198
out, err = self.run_bzr(cmd, retcode=1)
199
self.assertEquals('', err)
200
self.assertEqualDiff("=== modified file 'file'\n"
201
"--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
202
"+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
204
"-contents of branch1/file\n"
206
"\n", subst_dates(out))
208
def check_no_diffs(self, cmd):
209
# Check that running cmd returns an empty diff
210
out, err = self.run_bzr(cmd, retcode=0)
211
self.assertEquals('', err)
212
self.assertEquals('', out)
214
def test_diff_branches(self):
215
self.example_branches()
216
# should open branch1 and diff against branch2,
217
self.check_b2_vs_b1('diff -r branch:branch2 branch1')
218
# Compare two working trees using various syntax forms
219
self.check_b2_vs_b1('diff --old branch2 --new branch1')
220
self.check_b2_vs_b1('diff --old branch2 branch1')
221
self.check_b2_vs_b1('diff branch2 --new branch1')
222
# Test with a selected file that was changed
223
self.check_b2_vs_b1('diff --old branch2 --new branch1 file')
224
self.check_b2_vs_b1('diff --old branch2 branch1/file')
225
self.check_b2_vs_b1('diff branch2/file --new branch1')
226
# Test with a selected file that was not changed
227
self.check_no_diffs('diff --old branch2 --new branch1 file2')
228
self.check_no_diffs('diff --old branch2 branch1/file2')
229
self.check_no_diffs('diff branch2/file2 --new branch1')
231
def test_diff_branches_no_working_trees(self):
232
branch1_tree, branch2_tree = self.example_branches()
233
# Compare a working tree to a branch without a WT
234
dir1 = branch1_tree.bzrdir
235
dir1.destroy_workingtree()
236
self.assertFalse(dir1.has_workingtree())
237
self.check_b2_vs_b1('diff --old branch2 --new branch1')
238
self.check_b2_vs_b1('diff --old branch2 branch1')
239
self.check_b2_vs_b1('diff branch2 --new branch1')
240
# Compare a branch without a WT to one with a WT
241
self.check_b1_vs_b2('diff --old branch1 --new branch2')
242
self.check_b1_vs_b2('diff --old branch1 branch2')
243
self.check_b1_vs_b2('diff branch1 --new branch2')
244
# Compare a branch with a WT against another without a WT
245
dir2 = branch2_tree.bzrdir
246
dir2.destroy_workingtree()
247
self.assertFalse(dir2.has_workingtree())
248
self.check_b1_vs_b2('diff --old branch1 --new branch2')
249
self.check_b1_vs_b2('diff --old branch1 branch2')
250
self.check_b1_vs_b2('diff branch1 --new branch2')
252
def test_diff_revno_branches(self):
253
self.example_branches()
254
branch2_tree = workingtree.WorkingTree.open_containing('branch2')[0]
255
self.build_tree_contents([('branch2/file', 'even newer content')])
256
branch2_tree.commit(message='update file once more')
258
out, err = self.run_bzr('diff -r revno:1:branch2..revno:1:branch1',
260
self.assertEquals('', err)
261
self.assertEquals('', out)
262
out, err = self.run_bzr('diff -r revno:2:branch2..revno:1:branch1',
264
self.assertEquals('', err)
265
self.assertEqualDiff("=== modified file 'file'\n"
266
"--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
267
"+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
270
"+contents of branch1/file\n"
271
"\n", subst_dates(out))
273
def example_branch2(self):
274
branch1_tree = self.make_branch_and_tree('branch1')
275
self.build_tree_contents([('branch1/file1', 'original line\n')])
276
branch1_tree.add('file1')
277
branch1_tree.commit(message='first commit')
278
self.build_tree_contents([('branch1/file1', 'repo line\n')])
279
branch1_tree.commit(message='second commit')
282
def test_diff_to_working_tree(self):
283
self.example_branch2()
284
self.build_tree_contents([('branch1/file1', 'new line')])
285
output = self.run_bzr('diff -r 1.. branch1', retcode=1)
286
self.assertContainsRe(output[0], '\n\\-original line\n\\+new line\n')
288
def test_diff_to_working_tree_in_subdir(self):
289
self.example_branch2()
290
self.build_tree_contents([('branch1/file1', 'new line')])
291
os.mkdir('branch1/dir1')
292
os.chdir('branch1/dir1')
293
output = self.run_bzr('diff -r 1..', retcode=1)
294
self.assertContainsRe(output[0], '\n\\-original line\n\\+new line\n')
296
def test_diff_across_rename(self):
297
"""The working tree path should always be considered for diffing"""
298
tree = self.make_example_branch()
299
self.run_bzr('diff -r 0..1 hello', retcode=1)
300
tree.rename_one('hello', 'hello1')
301
self.run_bzr('diff hello1', retcode=1)
302
self.run_bzr('diff -r 0..1 hello1', retcode=1)
304
def test_diff_to_branch_no_working_tree(self):
305
branch1_tree = self.example_branch2()
306
dir1 = branch1_tree.bzrdir
307
dir1.destroy_workingtree()
308
self.assertFalse(dir1.has_workingtree())
309
output = self.run_bzr('diff -r 1.. branch1', retcode=1)
310
self.assertContainsRe(output[0], '\n\\-original line\n\\+repo line\n')
312
def test_custom_format(self):
313
class BooDiffTree(DiffTree):
315
def show_diff(self, specific_files, extra_trees=None):
316
self.to_file.write("BOO!\n")
317
return super(BooDiffTree, self).show_diff(specific_files,
320
diff_format_registry.register("boo", BooDiffTree,
322
self.addCleanup(diff_format_registry.remove, "boo")
323
self.make_example_branch()
324
self.build_tree_contents([('hello', 'hello world!\n')])
325
output = self.run_bzr('diff --format=boo', retcode=1)
326
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, self).example_branches()
345
os.mkdir('checkouts')
346
branch1_tree = branch1_tree.branch.create_checkout('checkouts/branch1')
347
branch2_tree = branch2_tree.branch.create_checkout('checkouts/branch2')
348
os.chdir('checkouts')
349
return branch1_tree, branch2_tree
352
class TestDiffLabels(DiffBase):
354
def test_diff_label_removed(self):
355
tree = super(TestDiffLabels, self).make_example_branch()
356
tree.remove('hello', keep_files=False)
357
diff = self.run_bzr('diff', retcode=1)
358
self.assertTrue("=== removed file 'hello'" in diff[0])
360
def test_diff_label_added(self):
361
tree = super(TestDiffLabels, self).make_example_branch()
362
self.build_tree_contents([('barbar', 'barbar')])
364
diff = self.run_bzr('diff', retcode=1)
365
self.assertTrue("=== added file 'barbar'" in diff[0])
367
def test_diff_label_modified(self):
368
super(TestDiffLabels, self).make_example_branch()
369
self.build_tree_contents([('hello', 'barbar')])
370
diff = self.run_bzr('diff', retcode=1)
371
self.assertTrue("=== modified file 'hello'" in diff[0])
373
def test_diff_label_renamed(self):
374
tree = super(TestDiffLabels, self).make_example_branch()
375
tree.rename_one('hello', 'gruezi')
376
diff = self.run_bzr('diff', retcode=1)
377
self.assertTrue("=== renamed file 'hello' => 'gruezi'" in diff[0])
380
class TestExternalDiff(DiffBase):
382
def test_external_diff(self):
383
"""Test that we can spawn an external diff process"""
384
self.disable_missing_extensions_warning()
385
# We have to use run_bzr_subprocess, because we need to
386
# test writing directly to stdout, (there was a bug in
387
# subprocess.py that we had to workaround).
388
# However, if 'diff' may not be available
389
self.make_example_branch()
390
# this will be automatically restored by the base bzr test class
391
os.environ['BZR_PROGRESS_BAR'] = 'none'
392
out, err = self.run_bzr_subprocess('diff -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"
407
class TestDiffOutput(DiffBase):
409
def test_diff_output(self):
410
# check that output doesn't mangle line-endings
411
self.make_example_branch()
412
self.build_tree_contents([('hello', 'hello world!\n')])
413
output = self.run_bzr_subprocess('diff', retcode=1)[0]
414
self.assert_('\n+hello world!\n' in output)