~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/blackbox/test_diff.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-10-31 04:39:04 UTC
  • mfrom: (3565.6.16 switch_nick)
  • Revision ID: pqm@pqm.ubuntu.com-20081031043904-52fnbfrloojemvcc
(mbp) branch nickname documentation

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
 
18
"""Black-box tests for bzr diff.
 
19
"""
 
20
 
 
21
import os
 
22
import re
 
23
 
 
24
import bzrlib
 
25
from bzrlib import workingtree
 
26
from bzrlib.branch import Branch
 
27
from bzrlib.tests import TestSkipped
 
28
from bzrlib.tests.blackbox import ExternalBase
 
29
 
 
30
 
 
31
def subst_dates(string):
 
32
    """Replace date strings with constant values."""
 
33
    return re.sub(r'\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} [-\+]\d{4}',
 
34
                  'YYYY-MM-DD HH:MM:SS +ZZZZ', string)
 
35
 
 
36
 
 
37
class DiffBase(ExternalBase):
 
38
    """Base class with common setup method"""
 
39
 
 
40
    def make_example_branch(self):
 
41
        tree = self.make_branch_and_tree('.')
 
42
        self.build_tree_contents([
 
43
            ('hello', 'foo\n'),
 
44
            ('goodbye', 'baz\n')])
 
45
        tree.add(['hello'])
 
46
        tree.commit('setup')
 
47
        tree.add(['goodbye'])
 
48
        tree.commit('setup')
 
49
        return tree
 
50
 
 
51
 
 
52
class TestDiff(DiffBase):
 
53
 
 
54
    def test_diff(self):
 
55
        tree = self.make_example_branch()
 
56
        self.build_tree_contents([('hello', 'hello world!')])
 
57
        tree.commit(message='fixing hello')
 
58
        output = self.run_bzr('diff -r 2..3', retcode=1)[0]
 
59
        self.assert_('\n+hello world!' in output)
 
60
        output = self.run_bzr('diff -c 3', retcode=1)[0]
 
61
        self.assert_('\n+hello world!' in output)
 
62
        output = self.run_bzr('diff -r last:3..last:1', retcode=1)[0]
 
63
        self.assert_('\n+baz' in output)
 
64
        output = self.run_bzr('diff -c last:2', retcode=1)[0]
 
65
        self.assert_('\n+baz' in output)
 
66
        self.build_tree(['moo'])
 
67
        tree.add('moo')
 
68
        os.unlink('moo')
 
69
        self.run_bzr('diff')
 
70
 
 
71
    def test_diff_prefix(self):
 
72
        """diff --prefix appends to filenames in output"""
 
73
        self.make_example_branch()
 
74
        self.build_tree_contents([('hello', 'hello world!\n')])
 
75
        out, err = self.run_bzr('diff --prefix old/:new/', retcode=1)
 
76
        self.assertEquals(err, '')
 
77
        self.assertEqualDiff(subst_dates(out), '''\
 
78
=== modified file 'hello'
 
79
--- old/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
 
80
+++ new/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
 
81
@@ -1,1 +1,1 @@
 
82
-foo
 
83
+hello world!
 
84
 
 
85
''')
 
86
 
 
87
    def test_diff_illegal_prefix_value(self):
 
88
        # There was an error in error reporting for this option
 
89
        out, err = self.run_bzr('diff --prefix old/', retcode=3)
 
90
        self.assertContainsRe(err,
 
91
            '--prefix expects two values separated by a colon')
 
92
 
 
93
    def test_diff_p1(self):
 
94
        """diff -p1 produces lkml-style diffs"""
 
95
        self.make_example_branch()
 
96
        self.build_tree_contents([('hello', 'hello world!\n')])
 
97
        out, err = self.run_bzr('diff -p1', retcode=1)
 
98
        self.assertEquals(err, '')
 
99
        self.assertEqualDiff(subst_dates(out), '''\
 
100
=== modified file 'hello'
 
101
--- old/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
 
102
+++ new/hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
 
103
@@ -1,1 +1,1 @@
 
104
-foo
 
105
+hello world!
 
106
 
 
107
''')
 
108
 
 
109
    def test_diff_p0(self):
 
110
        """diff -p0 produces diffs with no prefix"""
 
111
        self.make_example_branch()
 
112
        self.build_tree_contents([('hello', 'hello world!\n')])
 
113
        out, err = self.run_bzr('diff -p0', retcode=1)
 
114
        self.assertEquals(err, '')
 
115
        self.assertEqualDiff(subst_dates(out), '''\
 
116
=== modified file 'hello'
 
117
--- hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
 
118
+++ hello\tYYYY-MM-DD HH:MM:SS +ZZZZ
 
119
@@ -1,1 +1,1 @@
 
120
-foo
 
121
+hello world!
 
122
 
 
123
''')
 
124
 
 
125
    def test_diff_nonexistent(self):
 
126
        # Get an error from a file that does not exist at all
 
127
        # (Malone #3619)
 
128
        self.make_example_branch()
 
129
        out, err = self.run_bzr('diff does-not-exist', retcode=3)
 
130
        self.assertContainsRe(err, 'not versioned.*does-not-exist')
 
131
 
 
132
    def test_diff_illegal_revision_specifiers(self):
 
133
        out, err = self.run_bzr('diff -r 1..23..123', retcode=3)
 
134
        self.assertContainsRe(err, 'one or two revision specifiers')
 
135
 
 
136
    def test_diff_unversioned(self):
 
137
        # Get an error when diffing a non-versioned file.
 
138
        # (Malone #3619)
 
139
        self.make_example_branch()
 
140
        self.build_tree(['unversioned-file'])
 
141
        out, err = self.run_bzr('diff unversioned-file', retcode=3)
 
142
        self.assertContainsRe(err, 'not versioned.*unversioned-file')
 
143
 
 
144
    # TODO: What should diff say for a file deleted in working tree?
 
145
 
 
146
    def example_branches(self):
 
147
        branch1_tree = self.make_branch_and_tree('branch1')
 
148
        self.build_tree(['branch1/file'], line_endings='binary')
 
149
        self.build_tree(['branch1/file2'], line_endings='binary')
 
150
        branch1_tree.add('file')
 
151
        branch1_tree.add('file2')
 
152
        branch1_tree.commit(message='add file and file2')
 
153
        branch2_tree = branch1_tree.bzrdir.sprout('branch2').open_workingtree()
 
154
        self.build_tree_contents([('branch2/file', 'new content\n')])
 
155
        branch2_tree.commit(message='update file')
 
156
        return branch1_tree, branch2_tree
 
157
 
 
158
    def check_b2_vs_b1(self, cmd):
 
159
        # Compare branch2 vs branch1 using cmd and check the result
 
160
        out, err = self.run_bzr(cmd, retcode=1)
 
161
        self.assertEquals('', err)
 
162
        self.assertEquals("=== modified file 'file'\n"
 
163
                          "--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
 
164
                          "+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
 
165
                          "@@ -1,1 +1,1 @@\n"
 
166
                          "-new content\n"
 
167
                          "+contents of branch1/file\n"
 
168
                          "\n", subst_dates(out))
 
169
 
 
170
    def check_b1_vs_b2(self, cmd):
 
171
        # Compare branch1 vs branch2 using cmd and check the result
 
172
        out, err = self.run_bzr(cmd, retcode=1)
 
173
        self.assertEquals('', err)
 
174
        self.assertEqualDiff("=== modified file 'file'\n"
 
175
                              "--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
 
176
                              "+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
 
177
                              "@@ -1,1 +1,1 @@\n"
 
178
                              "-contents of branch1/file\n"
 
179
                              "+new content\n"
 
180
                              "\n", subst_dates(out))
 
181
 
 
182
    def check_no_diffs(self, cmd):
 
183
        # Check that running cmd returns an empty diff
 
184
        out, err = self.run_bzr(cmd, retcode=0)
 
185
        self.assertEquals('', err)
 
186
        self.assertEquals('', out)
 
187
 
 
188
    def test_diff_branches(self):
 
189
        self.example_branches()
 
190
        # should open branch1 and diff against branch2, 
 
191
        self.check_b2_vs_b1('diff -r branch:branch2 branch1')
 
192
        # Compare two working trees using various syntax forms
 
193
        self.check_b2_vs_b1('diff --old branch2 --new branch1')
 
194
        self.check_b2_vs_b1('diff --old branch2 branch1')
 
195
        self.check_b2_vs_b1('diff branch2 --new branch1')
 
196
        # Test with a selected file that was changed
 
197
        self.check_b2_vs_b1('diff --old branch2 --new branch1 file')
 
198
        self.check_b2_vs_b1('diff --old branch2 branch1/file')
 
199
        self.check_b2_vs_b1('diff branch2/file --new branch1')
 
200
        # Test with a selected file that was not changed
 
201
        self.check_no_diffs('diff --old branch2 --new branch1 file2')
 
202
        self.check_no_diffs('diff --old branch2 branch1/file2')
 
203
        self.check_no_diffs('diff branch2/file2 --new branch1')
 
204
 
 
205
    def test_diff_branches_no_working_trees(self):
 
206
        branch1_tree, branch2_tree = self.example_branches()
 
207
        # Compare a working tree to a branch without a WT
 
208
        dir1 = branch1_tree.bzrdir
 
209
        dir1.destroy_workingtree()
 
210
        self.assertFalse(dir1.has_workingtree())
 
211
        self.check_b2_vs_b1('diff --old branch2 --new branch1')
 
212
        self.check_b2_vs_b1('diff --old branch2 branch1')
 
213
        self.check_b2_vs_b1('diff branch2 --new branch1')
 
214
        # Compare a branch without a WT to one with a WT
 
215
        self.check_b1_vs_b2('diff --old branch1 --new branch2')
 
216
        self.check_b1_vs_b2('diff --old branch1 branch2')
 
217
        self.check_b1_vs_b2('diff branch1 --new branch2')
 
218
        # Compare a branch with a WT against another without a WT
 
219
        dir2 = branch2_tree.bzrdir
 
220
        dir2.destroy_workingtree()
 
221
        self.assertFalse(dir2.has_workingtree())
 
222
        self.check_b1_vs_b2('diff --old branch1 --new branch2')
 
223
        self.check_b1_vs_b2('diff --old branch1 branch2')
 
224
        self.check_b1_vs_b2('diff branch1 --new branch2')
 
225
 
 
226
    def test_diff_revno_branches(self):
 
227
        self.example_branches()
 
228
        branch2_tree = workingtree.WorkingTree.open_containing('branch2')[0]
 
229
        self.build_tree_contents([('branch2/file', 'even newer content')])
 
230
        branch2_tree.commit(message='update file once more')
 
231
 
 
232
        out, err = self.run_bzr('diff -r revno:1:branch2..revno:1:branch1',
 
233
                                )
 
234
        self.assertEquals('', err)
 
235
        self.assertEquals('', out)
 
236
        out, err = self.run_bzr('diff -r revno:2:branch2..revno:1:branch1',
 
237
                                retcode=1)
 
238
        self.assertEquals('', err)
 
239
        self.assertEqualDiff("=== modified file 'file'\n"
 
240
                              "--- file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
 
241
                              "+++ file\tYYYY-MM-DD HH:MM:SS +ZZZZ\n"
 
242
                              "@@ -1,1 +1,1 @@\n"
 
243
                              "-new content\n"
 
244
                              "+contents of branch1/file\n"
 
245
                              "\n", subst_dates(out))
 
246
 
 
247
    def example_branch2(self):
 
248
        branch1_tree = self.make_branch_and_tree('branch1')
 
249
        self.build_tree_contents([('branch1/file1', 'original line\n')])
 
250
        branch1_tree.add('file1')
 
251
        branch1_tree.commit(message='first commit')
 
252
        self.build_tree_contents([('branch1/file1', 'repo line\n')])
 
253
        branch1_tree.commit(message='second commit')
 
254
        return branch1_tree
 
255
 
 
256
    def test_diff_to_working_tree(self):
 
257
        self.example_branch2()
 
258
        self.build_tree_contents([('branch1/file1', 'new line')])
 
259
        output = self.run_bzr('diff -r 1.. branch1', retcode=1)
 
260
        self.assertContainsRe(output[0], '\n\\-original line\n\\+new line\n')
 
261
 
 
262
    def test_diff_to_working_tree_in_subdir(self):
 
263
        self.example_branch2()
 
264
        self.build_tree_contents([('branch1/file1', 'new line')])
 
265
        os.mkdir('branch1/dir1')
 
266
        os.chdir('branch1/dir1')
 
267
        output = self.run_bzr('diff -r 1..', retcode=1)
 
268
        self.assertContainsRe(output[0], '\n\\-original line\n\\+new line\n')
 
269
 
 
270
    def test_diff_across_rename(self):
 
271
        """The working tree path should always be considered for diffing"""
 
272
        tree = self.make_example_branch()
 
273
        self.run_bzr('diff -r 0..1 hello', retcode=1)
 
274
        tree.rename_one('hello', 'hello1')
 
275
        self.run_bzr('diff hello1', retcode=1)
 
276
        self.run_bzr('diff -r 0..1 hello1', retcode=1)
 
277
 
 
278
    def test_diff_to_branch_no_working_tree(self):
 
279
        branch1_tree = self.example_branch2()
 
280
        dir1 = branch1_tree.bzrdir
 
281
        dir1.destroy_workingtree()
 
282
        self.assertFalse(dir1.has_workingtree())
 
283
        output = self.run_bzr('diff -r 1.. branch1', retcode=1)
 
284
        self.assertContainsRe(output[0], '\n\\-original line\n\\+repo line\n')
 
285
 
 
286
 
 
287
class TestCheckoutDiff(TestDiff):
 
288
 
 
289
    def make_example_branch(self):
 
290
        tree = super(TestCheckoutDiff, self).make_example_branch()
 
291
        tree = tree.branch.create_checkout('checkout')
 
292
        os.chdir('checkout')
 
293
        return tree
 
294
 
 
295
    def example_branch2(self):
 
296
        tree = super(TestCheckoutDiff, self).example_branch2()
 
297
        os.mkdir('checkouts')
 
298
        tree = tree.branch.create_checkout('checkouts/branch1')
 
299
        os.chdir('checkouts')
 
300
        return tree
 
301
 
 
302
    def example_branches(self):
 
303
        branch1_tree, branch2_tree = super(TestCheckoutDiff, self).example_branches()
 
304
        os.mkdir('checkouts')
 
305
        branch1_tree = branch1_tree.branch.create_checkout('checkouts/branch1')
 
306
        branch2_tree = branch2_tree.branch.create_checkout('checkouts/branch2')
 
307
        os.chdir('checkouts')
 
308
        return branch1_tree, branch2_tree
 
309
 
 
310
 
 
311
class TestDiffLabels(DiffBase):
 
312
 
 
313
    def test_diff_label_removed(self):
 
314
        tree = super(TestDiffLabels, self).make_example_branch()
 
315
        tree.remove('hello', keep_files=False)
 
316
        diff = self.run_bzr('diff', retcode=1)
 
317
        self.assertTrue("=== removed file 'hello'" in diff[0])
 
318
 
 
319
    def test_diff_label_added(self):
 
320
        tree = super(TestDiffLabels, self).make_example_branch()
 
321
        self.build_tree_contents([('barbar', 'barbar')])
 
322
        tree.add('barbar')
 
323
        diff = self.run_bzr('diff', retcode=1)
 
324
        self.assertTrue("=== added file 'barbar'" in diff[0])
 
325
 
 
326
    def test_diff_label_modified(self):
 
327
        super(TestDiffLabels, self).make_example_branch()
 
328
        self.build_tree_contents([('hello', 'barbar')])
 
329
        diff = self.run_bzr('diff', retcode=1)
 
330
        self.assertTrue("=== modified file 'hello'" in diff[0])
 
331
 
 
332
    def test_diff_label_renamed(self):
 
333
        tree = super(TestDiffLabels, self).make_example_branch()
 
334
        tree.rename_one('hello', 'gruezi')
 
335
        diff = self.run_bzr('diff', retcode=1)
 
336
        self.assertTrue("=== renamed file 'hello' => 'gruezi'" in diff[0])
 
337
 
 
338
 
 
339
class TestExternalDiff(DiffBase):
 
340
 
 
341
    def test_external_diff(self):
 
342
        """Test that we can spawn an external diff process"""
 
343
        # We have to use run_bzr_subprocess, because we need to
 
344
        # test writing directly to stdout, (there was a bug in
 
345
        # subprocess.py that we had to workaround).
 
346
        # However, if 'diff' may not be available
 
347
        self.make_example_branch()
 
348
        orig_progress = os.environ.get('BZR_PROGRESS_BAR')
 
349
        try:
 
350
            os.environ['BZR_PROGRESS_BAR'] = 'none'
 
351
            out, err = self.run_bzr_subprocess('diff -r 1 --diff-options -ub',
 
352
                                               universal_newlines=True,
 
353
                                               retcode=None)
 
354
        finally:
 
355
            if orig_progress is None:
 
356
                del os.environ['BZR_PROGRESS_BAR']
 
357
            else:
 
358
                os.environ['BZR_PROGRESS_BAR'] = orig_progress
 
359
            
 
360
        if 'Diff is not installed on this machine' in err:
 
361
            raise TestSkipped("No external 'diff' is available")
 
362
        self.assertEqual('', err)
 
363
        # We have to skip the stuff in the middle, because it depends
 
364
        # on time.time()
 
365
        self.assertStartsWith(out, "=== added file 'goodbye'\n"
 
366
                                   "--- goodbye\t1970-01-01 00:00:00 +0000\n"
 
367
                                   "+++ goodbye\t")
 
368
        self.assertEndsWith(out, "\n@@ -0,0 +1 @@\n"
 
369
                                 "+baz\n\n")
 
370
 
 
371
 
 
372
class TestDiffOutput(DiffBase):
 
373
 
 
374
    def test_diff_output(self):
 
375
        # check that output doesn't mangle line-endings
 
376
        self.make_example_branch()
 
377
        self.build_tree_contents([('hello', 'hello world!\n')])
 
378
        output = self.run_bzr_subprocess('diff', retcode=1)[0]
 
379
        self.assert_('\n+hello world!\n' in output)