1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
18
"""Tests for the commit CLI of bzr."""
 
 
27
from bzrlib.branch import Branch
 
 
28
from bzrlib.bzrdir import BzrDir
 
 
29
from bzrlib.errors import BzrCommandError
 
 
30
from bzrlib.tests.blackbox import ExternalBase
 
 
31
from bzrlib.workingtree import WorkingTree
 
 
34
class TestCommit(ExternalBase):
 
 
36
    def test_05_empty_commit(self):
 
 
37
        """Commit of tree with no versioned files should fail"""
 
 
38
        # If forced, it should succeed, but this is not tested here.
 
 
40
        self.build_tree(['hello.txt'])
 
 
41
        out,err = self.run_bzr('commit -m empty', retcode=3)
 
 
42
        self.assertEqual('', out)
 
 
43
        self.assertStartsWith(err, 'bzr: ERROR: no changes to commit.'
 
 
44
                                  ' use --unchanged to commit anyhow\n')
 
 
46
    def test_commit_success(self):
 
 
47
        """Successful commit should not leave behind a bzr-commit-* file"""
 
 
49
        self.run_bzr('commit --unchanged -m message')
 
 
50
        self.assertEqual('', self.run_bzr('unknowns')[0])
 
 
52
        # same for unicode messages
 
 
53
        self.run_bzr(["commit", "--unchanged", "-m", u'foo\xb5'])
 
 
54
        self.assertEqual('', self.run_bzr('unknowns')[0])
 
 
56
    def test_commit_with_path(self):
 
 
57
        """Commit tree with path of root specified"""
 
 
58
        self.run_bzr('init a')
 
 
59
        self.build_tree(['a/a_file'])
 
 
60
        self.run_bzr('add a/a_file')
 
 
61
        self.run_bzr(['commit', '-m', 'first commit', 'a'])
 
 
63
        self.run_bzr('branch a b')
 
 
64
        self.build_tree_contents([('b/a_file', 'changes in b')])
 
 
65
        self.run_bzr(['commit', '-m', 'first commit in b', 'b'])
 
 
67
        self.build_tree_contents([('a/a_file', 'new contents')])
 
 
68
        self.run_bzr(['commit', '-m', 'change in a', 'a'])
 
 
71
        self.run_bzr('merge ../a', retcode=1) # will conflict
 
 
73
        self.run_bzr('resolved b/a_file')
 
 
74
        self.run_bzr(['commit', '-m', 'merge into b', 'b'])
 
 
77
    def test_10_verbose_commit(self):
 
 
78
        """Add one file and examine verbose commit output"""
 
 
80
        self.build_tree(['hello.txt'])
 
 
81
        self.run_bzr("add hello.txt")
 
 
82
        out,err = self.run_bzr('commit -m added')
 
 
83
        self.assertEqual('', out)
 
 
84
        self.assertEqual('added hello.txt\n'
 
 
85
                         'Committed revision 1.\n',
 
 
88
    def prepare_simple_history(self):
 
 
89
        """Prepare and return a working tree with one commit of one file"""
 
 
90
        # Commit with modified file should say so
 
 
91
        wt = BzrDir.create_standalone_workingtree('.')
 
 
92
        self.build_tree(['hello.txt', 'extra.txt'])
 
 
94
        wt.commit(message='added')
 
 
97
    def test_verbose_commit_modified(self):
 
 
98
        # Verbose commit of modified file should say so
 
 
99
        wt = self.prepare_simple_history()
 
 
100
        self.build_tree_contents([('hello.txt', 'new contents')])
 
 
101
        out, err = self.run_bzr('commit -m modified')
 
 
102
        self.assertEqual('', out)
 
 
103
        self.assertEqual('modified hello.txt\n'
 
 
104
                         'Committed revision 2.\n',
 
 
107
    def test_verbose_commit_renamed(self):
 
 
108
        # Verbose commit of renamed file should say so
 
 
109
        wt = self.prepare_simple_history()
 
 
110
        wt.rename_one('hello.txt', 'gutentag.txt')
 
 
111
        out, err = self.run_bzr('commit -m renamed')
 
 
112
        self.assertEqual('', out)
 
 
113
        self.assertEqual('renamed hello.txt => gutentag.txt\n'
 
 
114
                         'Committed revision 2.\n',
 
 
117
    def test_verbose_commit_moved(self):
 
 
118
        # Verbose commit of file moved to new directory should say so
 
 
119
        wt = self.prepare_simple_history()
 
 
122
        wt.rename_one('hello.txt', 'subdir/hello.txt')
 
 
123
        out, err = self.run_bzr('commit -m renamed')
 
 
124
        self.assertEqual('', out)
 
 
125
        self.assertEqualDiff('added subdir\n'
 
 
126
                             'renamed hello.txt => subdir/hello.txt\n'
 
 
127
                             'Committed revision 2.\n',
 
 
130
    def test_verbose_commit_with_unknown(self):
 
 
131
        """Unknown files should not be listed by default in verbose output"""
 
 
132
        # Is that really the best policy?
 
 
133
        wt = BzrDir.create_standalone_workingtree('.')
 
 
134
        self.build_tree(['hello.txt', 'extra.txt'])
 
 
135
        wt.add(['hello.txt'])
 
 
136
        out,err = self.run_bzr('commit -m added')
 
 
137
        self.assertEqual('', out)
 
 
138
        self.assertEqual('added hello.txt\n'
 
 
139
                         'Committed revision 1.\n',
 
 
142
    def test_verbose_commit_with_unchanged(self):
 
 
143
        """Unchanged files should not be listed by default in verbose output"""
 
 
145
        self.build_tree(['hello.txt', 'unchanged.txt'])
 
 
146
        self.run_bzr('add unchanged.txt')
 
 
147
        self.run_bzr('commit -m unchanged unchanged.txt')
 
 
148
        self.run_bzr("add hello.txt")
 
 
149
        out,err = self.run_bzr('commit -m added')
 
 
150
        self.assertEqual('', out)
 
 
151
        self.assertEqual('added hello.txt\n'
 
 
152
                         'Committed revision 2.\n',
 
 
155
    def test_commit_merge_reports_all_modified_files(self):
 
 
156
        # the commit command should show all the files that are shown by
 
 
157
        # bzr diff or bzr status when committing, even when they were not
 
 
158
        # changed by the user but rather through doing a merge.
 
 
159
        this_tree = self.make_branch_and_tree('this')
 
 
160
        # we need a bunch of files and dirs, to perform one action on each.
 
 
163
            'this/dirtoreparent/',
 
 
166
            'this/filetoreparent',
 
 
183
        this_tree.commit('create_files')
 
 
184
        other_dir = this_tree.bzrdir.sprout('other')
 
 
185
        other_tree = other_dir.open_workingtree()
 
 
186
        other_tree.lock_write()
 
 
187
        # perform the needed actions on the files and dirs.
 
 
189
            other_tree.rename_one('dirtorename', 'renameddir')
 
 
190
            other_tree.rename_one('dirtoreparent', 'renameddir/reparenteddir')
 
 
191
            other_tree.rename_one('filetorename', 'renamedfile')
 
 
192
            other_tree.rename_one('filetoreparent', 'renameddir/reparentedfile')
 
 
193
            other_tree.remove(['dirtoremove', 'filetoremove'])
 
 
194
            self.build_tree_contents([
 
 
196
                ('other/filetomodify', 'new content'),
 
 
197
                ('other/newfile', 'new file content')])
 
 
198
            other_tree.add('newfile')
 
 
199
            other_tree.add('newdir/')
 
 
200
            other_tree.commit('modify all sample files and dirs.')
 
 
203
        this_tree.merge_from_branch(other_tree.branch)
 
 
205
        out,err = self.run_bzr('commit -m added')
 
 
207
        self.assertEqual('', out)
 
 
208
        self.assertEqualDiff(
 
 
209
            'modified filetomodify\n'
 
 
212
            'renamed dirtorename => renameddir\n'
 
 
213
            'renamed dirtoreparent => renameddir/reparenteddir\n'
 
 
214
            'renamed filetoreparent => renameddir/reparentedfile\n'
 
 
215
            'renamed filetorename => renamedfile\n'
 
 
216
            'deleted dirtoremove\n'
 
 
217
            'deleted filetoremove\n'
 
 
218
            'Committed revision 2.\n',
 
 
221
    def test_empty_commit_message(self):
 
 
223
        file('foo.c', 'wt').write('int main() {}')
 
 
224
        self.run_bzr('add foo.c')
 
 
225
        self.run_bzr('commit -m ""', retcode=3)
 
 
227
    def test_other_branch_commit(self):
 
 
228
        # this branch is to ensure consistent behaviour, whether we're run
 
 
229
        # inside a branch, or not.
 
 
230
        os.mkdir('empty_branch')
 
 
231
        os.chdir('empty_branch')
 
 
236
        file('foo.c', 'wt').write('int main() {}')
 
 
237
        file('bar.c', 'wt').write('int main() {}')
 
 
239
        self.run_bzr('add branch/foo.c')
 
 
240
        self.run_bzr('add branch')
 
 
241
        # can't commit files in different trees; sane error
 
 
242
        self.run_bzr('commit -m newstuff branch/foo.c .', retcode=3)
 
 
243
        self.run_bzr('commit -m newstuff branch/foo.c')
 
 
244
        self.run_bzr('commit -m newstuff branch')
 
 
245
        self.run_bzr('commit -m newstuff branch', retcode=3)
 
 
247
    def test_out_of_date_tree_commit(self):
 
 
248
        # check we get an error code and a clear message committing with an out
 
 
250
        self.make_branch_and_tree('branch')
 
 
252
        self.run_bzr('checkout --lightweight branch checkout')
 
 
253
        # commit to the original branch to make the checkout out of date
 
 
254
        self.run_bzr('commit --unchanged -m message branch')
 
 
255
        # now commit to the checkout should emit
 
 
256
        # ERROR: Out of date with the branch, 'bzr update' is suggested
 
 
257
        output = self.run_bzr('commit --unchanged -m checkout_message '
 
 
258
                             'checkout', retcode=3)
 
 
259
        self.assertEqual(output,
 
 
261
                          "bzr: ERROR: Working tree is out of date, please run "
 
 
264
    def test_local_commit_unbound(self):
 
 
265
        # a --local commit on an unbound branch is an error
 
 
266
        self.make_branch_and_tree('.')
 
 
267
        out, err = self.run_bzr('commit --local', retcode=3)
 
 
268
        self.assertEqualDiff('', out)
 
 
269
        self.assertEqualDiff('bzr: ERROR: Cannot perform local-only commits '
 
 
270
                             'on unbound branches.\n', err)
 
 
272
    def test_commit_a_text_merge_in_a_checkout(self):
 
 
273
        # checkouts perform multiple actions in a transaction across bond
 
 
274
        # branches and their master, and have been observed to fail in the
 
 
275
        # past. This is a user story reported to fail in bug #43959 where 
 
 
276
        # a merge done in a checkout (using the update command) failed to
 
 
278
        self.run_bzr('init trunk')
 
 
280
        self.run_bzr('checkout trunk u1')
 
 
281
        self.build_tree_contents([('u1/hosts', 'initial contents')])
 
 
282
        self.run_bzr('add u1/hosts')
 
 
283
        self.run_bzr('commit -m add-hosts u1')
 
 
285
        self.run_bzr('checkout trunk u2')
 
 
286
        self.build_tree_contents([('u2/hosts', 'altered in u2')])
 
 
287
        self.run_bzr('commit -m checkin-from-u2 u2')
 
 
289
        # make an offline commits
 
 
290
        self.build_tree_contents([('u1/hosts', 'first offline change in u1')])
 
 
291
        self.run_bzr('commit -m checkin-offline --local u1')
 
 
293
        # now try to pull in online work from u2, and then commit our offline
 
 
295
        # retcode 1 as we expect a text conflict
 
 
296
        self.run_bzr('update u1', retcode=1)
 
 
297
        self.run_bzr('resolved u1/hosts')
 
 
298
        # add a text change here to represent resolving the merge conflicts in
 
 
299
        # favour of a new version of the file not identical to either the u1
 
 
300
        # version or the u2 version.
 
 
301
        self.build_tree_contents([('u1/hosts', 'merge resolution\n')])
 
 
302
        self.run_bzr('commit -m checkin-merge-of-the-offline-work-from-u1 u1')
 
 
304
    def test_commit_respects_spec_for_removals(self):
 
 
305
        """Commit with a file spec should only commit removals that match"""
 
 
306
        t = self.make_branch_and_tree('.')
 
 
307
        self.build_tree(['file-a', 'dir-a/', 'dir-a/file-b'])
 
 
308
        t.add(['file-a', 'dir-a', 'dir-a/file-b'])
 
 
310
        t.remove(['file-a', 'dir-a/file-b'])
 
 
312
        result = self.run_bzr('commit . -m removed-file-b')[1]
 
 
313
        self.assertNotContainsRe(result, 'file-a')
 
 
314
        result = self.run_bzr('status')[0]
 
 
315
        self.assertContainsRe(result, 'removed:\n  file-a')
 
 
317
    def test_strict_commit(self):
 
 
318
        """Commit with --strict works if everything is known"""
 
 
319
        ignores._set_user_ignores([])
 
 
320
        tree = self.make_branch_and_tree('tree')
 
 
321
        self.build_tree(['tree/a'])
 
 
323
        # A simple change should just work
 
 
324
        self.run_bzr('commit --strict -m adding-a',
 
 
327
    def test_strict_commit_no_changes(self):
 
 
328
        """commit --strict gives "no changes" if there is nothing to commit"""
 
 
329
        tree = self.make_branch_and_tree('tree')
 
 
330
        self.build_tree(['tree/a'])
 
 
332
        tree.commit('adding a')
 
 
334
        # With no changes, it should just be 'no changes'
 
 
335
        # Make sure that commit is failing because there is nothing to do
 
 
336
        self.run_bzr_error(['no changes to commit'],
 
 
337
                           'commit --strict -m no-changes',
 
 
340
        # But --strict doesn't care if you supply --unchanged
 
 
341
        self.run_bzr('commit --strict --unchanged -m no-changes',
 
 
344
    def test_strict_commit_unknown(self):
 
 
345
        """commit --strict fails if a file is unknown"""
 
 
346
        tree = self.make_branch_and_tree('tree')
 
 
347
        self.build_tree(['tree/a'])
 
 
349
        tree.commit('adding a')
 
 
351
        # Add one file so there is a change, but forget the other
 
 
352
        self.build_tree(['tree/b', 'tree/c'])
 
 
354
        self.run_bzr_error(['Commit refused because there are unknown files'],
 
 
355
                           'commit --strict -m add-b',
 
 
358
        # --no-strict overrides --strict
 
 
359
        self.run_bzr('commit --strict -m add-b --no-strict',
 
 
362
    def test_fixes_bug_output(self):
 
 
363
        """commit --fixes=lp:23452 succeeds without output."""
 
 
364
        tree = self.make_branch_and_tree('tree')
 
 
365
        self.build_tree(['tree/hello.txt'])
 
 
366
        tree.add('hello.txt')
 
 
367
        output, err = self.run_bzr(
 
 
368
            'commit -m hello --fixes=lp:23452 tree/hello.txt')
 
 
369
        self.assertEqual('', output)
 
 
370
        self.assertEqual('added hello.txt\nCommitted revision 1.\n', err)
 
 
372
    def test_no_bugs_no_properties(self):
 
 
373
        """If no bugs are fixed, the bugs property is not set.
 
 
375
        see https://beta.launchpad.net/bzr/+bug/109613
 
 
377
        tree = self.make_branch_and_tree('tree')
 
 
378
        self.build_tree(['tree/hello.txt'])
 
 
379
        tree.add('hello.txt')
 
 
380
        self.run_bzr( 'commit -m hello tree/hello.txt')
 
 
381
        # Get the revision properties, ignoring the branch-nick property, which
 
 
382
        # we don't care about for this test.
 
 
383
        last_rev = tree.branch.repository.get_revision(tree.last_revision())
 
 
384
        properties = dict(last_rev.properties)
 
 
385
        del properties['branch-nick']
 
 
386
        self.assertFalse('bugs' in properties)
 
 
388
    def test_fixes_bug_sets_property(self):
 
 
389
        """commit --fixes=lp:234 sets the lp:234 revprop to 'fixed'."""
 
 
390
        tree = self.make_branch_and_tree('tree')
 
 
391
        self.build_tree(['tree/hello.txt'])
 
 
392
        tree.add('hello.txt')
 
 
393
        self.run_bzr('commit -m hello --fixes=lp:234 tree/hello.txt')
 
 
395
        # Get the revision properties, ignoring the branch-nick property, which
 
 
396
        # we don't care about for this test.
 
 
397
        last_rev = tree.branch.repository.get_revision(tree.last_revision())
 
 
398
        properties = dict(last_rev.properties)
 
 
399
        del properties['branch-nick']
 
 
401
        self.assertEqual({'bugs': 'https://launchpad.net/bugs/234 fixed'},
 
 
404
    def test_fixes_multiple_bugs_sets_properties(self):
 
 
405
        """--fixes can be used more than once to show that bugs are fixed."""
 
 
406
        tree = self.make_branch_and_tree('tree')
 
 
407
        self.build_tree(['tree/hello.txt'])
 
 
408
        tree.add('hello.txt')
 
 
409
        self.run_bzr('commit -m hello --fixes=lp:123 --fixes=lp:235'
 
 
412
        # Get the revision properties, ignoring the branch-nick property, which
 
 
413
        # we don't care about for this test.
 
 
414
        last_rev = tree.branch.repository.get_revision(tree.last_revision())
 
 
415
        properties = dict(last_rev.properties)
 
 
416
        del properties['branch-nick']
 
 
419
            {'bugs': 'https://launchpad.net/bugs/123 fixed\n'
 
 
420
                     'https://launchpad.net/bugs/235 fixed'},
 
 
423
    def test_fixes_bug_with_alternate_trackers(self):
 
 
424
        """--fixes can be used on a properly configured branch to mark bug
 
 
425
        fixes on multiple trackers.
 
 
427
        tree = self.make_branch_and_tree('tree')
 
 
428
        tree.branch.get_config().set_user_option(
 
 
429
            'trac_twisted_url', 'http://twistedmatrix.com/trac')
 
 
430
        self.build_tree(['tree/hello.txt'])
 
 
431
        tree.add('hello.txt')
 
 
432
        self.run_bzr('commit -m hello --fixes=lp:123 --fixes=twisted:235 tree/')
 
 
434
        # Get the revision properties, ignoring the branch-nick property, which
 
 
435
        # we don't care about for this test.
 
 
436
        last_rev = tree.branch.repository.get_revision(tree.last_revision())
 
 
437
        properties = dict(last_rev.properties)
 
 
438
        del properties['branch-nick']
 
 
441
            {'bugs': 'https://launchpad.net/bugs/123 fixed\n'
 
 
442
                     'http://twistedmatrix.com/trac/ticket/235 fixed'},
 
 
445
    def test_fixes_unknown_bug_prefix(self):
 
 
446
        tree = self.make_branch_and_tree('tree')
 
 
447
        self.build_tree(['tree/hello.txt'])
 
 
448
        tree.add('hello.txt')
 
 
450
            ["Unrecognized bug %s. Commit refused." % 'xxx:123'],
 
 
451
            'commit -m add-b --fixes=xxx:123',
 
 
454
    def test_fixes_invalid_bug_number(self):
 
 
455
        tree = self.make_branch_and_tree('tree')
 
 
456
        self.build_tree(['tree/hello.txt'])
 
 
457
        tree.add('hello.txt')
 
 
459
            ["Invalid bug identifier for %s. Commit refused." % 'lp:orange'],
 
 
460
            'commit -m add-b --fixes=lp:orange',
 
 
463
    def test_fixes_invalid_argument(self):
 
 
464
        """Raise an appropriate error when the fixes argument isn't tag:id."""
 
 
465
        tree = self.make_branch_and_tree('tree')
 
 
466
        self.build_tree(['tree/hello.txt'])
 
 
467
        tree.add('hello.txt')
 
 
469
            [r"Invalid bug orange. Must be in the form of 'tag:id'\. "
 
 
470
             r"Commit refused\."],
 
 
471
            'commit -m add-b --fixes=orange',