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_unversioned(self):
159
# Get an error when diffing a non-versioned file.
161
self.make_example_branch()
162
self.build_tree(['unversioned-file'])
163
out, err = self.run_bzr('diff unversioned-file', retcode=3)
164
self.assertContainsRe(err, 'not versioned.*unversioned-file')
166
# TODO: What should diff say for a file deleted in working tree?
168
def example_branches(self):
169
branch1_tree = self.make_branch_and_tree('branch1')
170
self.build_tree(['branch1/file'], line_endings='binary')
171
self.build_tree(['branch1/file2'], line_endings='binary')
172
branch1_tree.add('file')
173
branch1_tree.add('file2')
174
branch1_tree.commit(message='add file and file2')
175
branch2_tree = branch1_tree.bzrdir.sprout('branch2').open_workingtree()
176
self.build_tree_contents([('branch2/file', 'new content\n')])
177
branch2_tree.commit(message='update file')
178
return branch1_tree, branch2_tree
180
def check_b2_vs_b1(self, cmd):
181
# Compare branch2 vs branch1 using cmd and check the result
182
out, err = self.run_bzr(cmd, retcode=1)
183
self.assertEquals('', err)
184
self.assertEquals("=== modified file 'file'\n"
185
"--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
186
"+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
189
"+contents of branch1/file\n"
190
"\n", subst_dates(out))
192
def check_b1_vs_b2(self, cmd):
193
# Compare branch1 vs branch2 using cmd and check the result
194
out, err = self.run_bzr(cmd, retcode=1)
195
self.assertEquals('', err)
196
self.assertEqualDiff("=== modified file 'file'\n"
197
"--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
198
"+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
200
"-contents of branch1/file\n"
202
"\n", subst_dates(out))
204
def check_no_diffs(self, cmd):
205
# Check that running cmd returns an empty diff
206
out, err = self.run_bzr(cmd, retcode=0)
207
self.assertEquals('', err)
208
self.assertEquals('', out)
210
def test_diff_branches(self):
211
self.example_branches()
212
# should open branch1 and diff against branch2,
213
self.check_b2_vs_b1('diff -r branch:branch2 branch1')
214
# Compare two working trees using various syntax forms
215
self.check_b2_vs_b1('diff --old branch2 --new branch1')
216
self.check_b2_vs_b1('diff --old branch2 branch1')
217
self.check_b2_vs_b1('diff branch2 --new branch1')
218
# Test with a selected file that was changed
219
self.check_b2_vs_b1('diff --old branch2 --new branch1 file')
220
self.check_b2_vs_b1('diff --old branch2 branch1/file')
221
self.check_b2_vs_b1('diff branch2/file --new branch1')
222
# Test with a selected file that was not changed
223
self.check_no_diffs('diff --old branch2 --new branch1 file2')
224
self.check_no_diffs('diff --old branch2 branch1/file2')
225
self.check_no_diffs('diff branch2/file2 --new branch1')
227
def test_diff_branches_no_working_trees(self):
228
branch1_tree, branch2_tree = self.example_branches()
229
# Compare a working tree to a branch without a WT
230
dir1 = branch1_tree.bzrdir
231
dir1.destroy_workingtree()
232
self.assertFalse(dir1.has_workingtree())
233
self.check_b2_vs_b1('diff --old branch2 --new branch1')
234
self.check_b2_vs_b1('diff --old branch2 branch1')
235
self.check_b2_vs_b1('diff branch2 --new branch1')
236
# Compare a branch without a WT to one with a WT
237
self.check_b1_vs_b2('diff --old branch1 --new branch2')
238
self.check_b1_vs_b2('diff --old branch1 branch2')
239
self.check_b1_vs_b2('diff branch1 --new branch2')
240
# Compare a branch with a WT against another without a WT
241
dir2 = branch2_tree.bzrdir
242
dir2.destroy_workingtree()
243
self.assertFalse(dir2.has_workingtree())
244
self.check_b1_vs_b2('diff --old branch1 --new branch2')
245
self.check_b1_vs_b2('diff --old branch1 branch2')
246
self.check_b1_vs_b2('diff branch1 --new branch2')
248
def test_diff_revno_branches(self):
249
self.example_branches()
250
branch2_tree = workingtree.WorkingTree.open_containing('branch2')[0]
251
self.build_tree_contents([('branch2/file', 'even newer content')])
252
branch2_tree.commit(message='update file once more')
254
out, err = self.run_bzr('diff -r revno:1:branch2..revno:1:branch1',
256
self.assertEquals('', err)
257
self.assertEquals('', out)
258
out, err = self.run_bzr('diff -r revno:2:branch2..revno:1:branch1',
260
self.assertEquals('', err)
261
self.assertEqualDiff("=== modified file 'file'\n"
262
"--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
263
"+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
266
"+contents of branch1/file\n"
267
"\n", subst_dates(out))
269
def example_branch2(self):
270
branch1_tree = self.make_branch_and_tree('branch1')
271
self.build_tree_contents([('branch1/file1', 'original line\n')])
272
branch1_tree.add('file1')
273
branch1_tree.commit(message='first commit')
274
self.build_tree_contents([('branch1/file1', 'repo line\n')])
275
branch1_tree.commit(message='second commit')
278
def test_diff_to_working_tree(self):
279
self.example_branch2()
280
self.build_tree_contents([('branch1/file1', 'new line')])
281
output = self.run_bzr('diff -r 1.. branch1', retcode=1)
282
self.assertContainsRe(output[0], '\n\\-original line\n\\+new line\n')
284
def test_diff_to_working_tree_in_subdir(self):
285
self.example_branch2()
286
self.build_tree_contents([('branch1/file1', 'new line')])
287
os.mkdir('branch1/dir1')
288
os.chdir('branch1/dir1')
289
output = self.run_bzr('diff -r 1..', retcode=1)
290
self.assertContainsRe(output[0], '\n\\-original line\n\\+new line\n')
292
def test_diff_across_rename(self):
293
"""The working tree path should always be considered for diffing"""
294
tree = self.make_example_branch()
295
self.run_bzr('diff -r 0..1 hello', retcode=1)
296
tree.rename_one('hello', 'hello1')
297
self.run_bzr('diff hello1', retcode=1)
298
self.run_bzr('diff -r 0..1 hello1', retcode=1)
300
def test_diff_to_branch_no_working_tree(self):
301
branch1_tree = self.example_branch2()
302
dir1 = branch1_tree.bzrdir
303
dir1.destroy_workingtree()
304
self.assertFalse(dir1.has_workingtree())
305
output = self.run_bzr('diff -r 1.. branch1', retcode=1)
306
self.assertContainsRe(output[0], '\n\\-original line\n\\+repo line\n')
308
def test_custom_format(self):
309
class BooDiffTree(DiffTree):
311
def show_diff(self, specific_files, extra_trees=None):
312
self.to_file.write("BOO!\n")
313
return super(BooDiffTree, self).show_diff(specific_files,
316
diff_format_registry.register("boo", BooDiffTree,
318
self.addCleanup(diff_format_registry.remove, "boo")
319
self.make_example_branch()
320
self.build_tree_contents([('hello', 'hello world!\n')])
321
output = self.run_bzr('diff --format=boo', retcode=1)
322
self.assertTrue("BOO!" in output[0])
325
class TestCheckoutDiff(TestDiff):
327
def make_example_branch(self):
328
tree = super(TestCheckoutDiff, self).make_example_branch()
329
tree = tree.branch.create_checkout('checkout')
333
def example_branch2(self):
334
tree = super(TestCheckoutDiff, self).example_branch2()
335
os.mkdir('checkouts')
336
tree = tree.branch.create_checkout('checkouts/branch1')
337
os.chdir('checkouts')
340
def example_branches(self):
341
branch1_tree, branch2_tree = super(TestCheckoutDiff, self).example_branches()
342
os.mkdir('checkouts')
343
branch1_tree = branch1_tree.branch.create_checkout('checkouts/branch1')
344
branch2_tree = branch2_tree.branch.create_checkout('checkouts/branch2')
345
os.chdir('checkouts')
346
return branch1_tree, branch2_tree
349
class TestDiffLabels(DiffBase):
351
def test_diff_label_removed(self):
352
tree = super(TestDiffLabels, self).make_example_branch()
353
tree.remove('hello', keep_files=False)
354
diff = self.run_bzr('diff', retcode=1)
355
self.assertTrue("=== removed file 'hello'" in diff[0])
357
def test_diff_label_added(self):
358
tree = super(TestDiffLabels, self).make_example_branch()
359
self.build_tree_contents([('barbar', 'barbar')])
361
diff = self.run_bzr('diff', retcode=1)
362
self.assertTrue("=== added file 'barbar'" in diff[0])
364
def test_diff_label_modified(self):
365
super(TestDiffLabels, self).make_example_branch()
366
self.build_tree_contents([('hello', 'barbar')])
367
diff = self.run_bzr('diff', retcode=1)
368
self.assertTrue("=== modified file 'hello'" in diff[0])
370
def test_diff_label_renamed(self):
371
tree = super(TestDiffLabels, self).make_example_branch()
372
tree.rename_one('hello', 'gruezi')
373
diff = self.run_bzr('diff', retcode=1)
374
self.assertTrue("=== renamed file 'hello' => 'gruezi'" in diff[0])
377
class TestExternalDiff(DiffBase):
379
def test_external_diff(self):
380
"""Test that we can spawn an external diff process"""
381
self.disable_missing_extensions_warning()
382
# We have to use run_bzr_subprocess, because we need to
383
# test writing directly to stdout, (there was a bug in
384
# subprocess.py that we had to workaround).
385
# However, if 'diff' may not be available
386
self.make_example_branch()
387
# this will be automatically restored by the base bzr test class
388
os.environ['BZR_PROGRESS_BAR'] = 'none'
389
out, err = self.run_bzr_subprocess('diff -r 1 --diff-options -ub',
390
universal_newlines=True,
392
if 'Diff is not installed on this machine' in err:
393
raise tests.TestSkipped("No external 'diff' is available")
394
self.assertEqual('', err)
395
# We have to skip the stuff in the middle, because it depends
397
self.assertStartsWith(out, "=== added file 'goodbye'\n"
398
"--- goodbye\t1970-01-01 00:00:00 +0000\n"
400
self.assertEndsWith(out, "\n@@ -0,0 +1 @@\n"
404
class TestDiffOutput(DiffBase):
406
def test_diff_output(self):
407
# check that output doesn't mangle line-endings
408
self.make_example_branch()
409
self.build_tree_contents([('hello', 'hello world!\n')])
410
output = self.run_bzr_subprocess('diff', retcode=1)[0]
411
self.assert_('\n+hello world!\n' in output)