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