Merge lp:~jelmer/brz/amend into lp:brz

[Jelmer Vernooij]

Add a --amend option to commit.

Add a --amend option to commit.

[Martin Packman (gz)]

All looks pretty sane. Adding new positional args can lead to annoying compat bugs, but `make_commit_message_template_encoded()` is presumably not widely used. Could probably do with some more focused tests for this later, but for now just see one inline nit.

review: Approve

[The Breezy Bot (the-breezy-bot)]

Running landing tests failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/373/

[The Breezy Bot (the-breezy-bot)]

Merging failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/748/

[The Breezy Bot (the-breezy-bot)]

Merging failed
https://ci.breezy-vcs.org/job/brz/job/brz-land/994/

Unmerged revisions

6780. By Jelmer Vernooij on 2019-06-16

Fix docstring.

6779. By Jelmer Vernooij on 2019-06-16

Fix up tests for amend.

6778. By Jelmer Vernooij on 2019-06-16

Use WorkingTree.update during amend.

6777. By Jelmer Vernooij on 2019-06-16

merge trunk.

6776. By Jelmer Vernooij on 2017-09-07

Merge trunk.

6775. By Jelmer Vernooij on 2017-09-07

Add tests for amend.

6774. By Jelmer Vernooij on 2017-08-29

Merge lock context branch.

6773. By Jelmer Vernooij on 2017-08-29

Add --amend option to commit.

=== modified file 'breezy/builtins.py'
--- breezy/builtins.py	2019-06-15 12:04:34 +0000
+++ breezy/builtins.py	2019-06-16 02:56:15 +0000
@@ -3537,7 +3537,11 @@
         Option('lossy',
                help='When committing to a foreign version control '
                'system do not push data that can not be natively '
-               'represented.'), ]
+               'represented.'),
+        Option('amend',
+               help='Rather than create a new commit, amend the last '
+               'one.'),
+        ]
     aliases = ['ci', 'checkin']
 
     def _iter_bug_urls(self, bugs, branch, status):
@@ -3578,7 +3582,7 @@
     def run(self, message=None, file=None, verbose=False, selected_list=None,
             unchanged=False, strict=False, local=False, fixes=None, bugs=None,
             author=None, show_diff=False, exclude=None, commit_time=None,
-            lossy=False):
+            lossy=False, amend=False):
         import itertools
         from .commit import (
             PointlessCommit,
@@ -3592,7 +3596,7 @@
             generate_commit_message_template,
             make_commit_message_template_encoded,
             set_commit_message,
-        )
+            )
 
         commit_stamp = offset = None
         if commit_time is not None:
@@ -3611,6 +3615,18 @@
             # selected-file merge commit is not done yet
             selected_list = []
 
+        template_message = None
+
+        if amend:
+            rev = tree.branch.repository.get_revision(tree.last_revision())
+            properties.update(rev.properties)
+            template_message = rev.message
+            if author is None:
+                author = rev.get_apparent_authors()
+            parents = rev.parent_ids
+        else:
+            parents = None
+
         if fixes is None:
             fixes = []
         if bugs is None:
@@ -3656,9 +3672,10 @@
             else:
                 # No message supplied: make one up.
                 # text is the status of the tree
-                text = make_commit_message_template_encoded(tree,
-                                                            selected_list, diff=show_diff,
-                                                            output_encoding=osutils.get_user_encoding())
+                text = make_commit_message_template_encoded(
+                    tree, commit_obj.basis_revid, selected_list,
+                    diff=show_diff,
+                    output_encoding=osutils.get_user_encoding())
                 # start_message is the template generated from hooks
                 # XXX: Warning - looks like hooks return unicode,
                 # make_commit_message_template_encoded returns user encoding.
@@ -3666,13 +3683,15 @@
                 # avoid this.
                 my_message = set_commit_message(commit_obj)
                 if my_message is None:
-                    start_message = generate_commit_message_template(
-                        commit_obj)
+                    if template_message is not None:
+                        start_message = template_message
+                    else:
+                        start_message = generate_commit_message_template(commit_obj)
                     if start_message is not None:
                         start_message = start_message.encode(
                             osutils.get_user_encoding())
-                    my_message = edit_commit_message_encoded(text,
-                                                             start_message=start_message)
+                    my_message = edit_commit_message_encoded(
+                        text, start_message=start_message)
                 if my_message is None:
                     raise errors.BzrCommandError(gettext("please specify a commit"
                                                          " message with either --message or --file"))
@@ -3695,7 +3714,7 @@
                         authors=author, timestamp=commit_stamp,
                         timezone=offset,
                         exclude=tree.safe_relpath_files(exclude),
-                        lossy=lossy)
+                        lossy=lossy, parents=parents)
         except PointlessCommit:
             raise errors.BzrCommandError(gettext("No changes to commit."
                                                  " Please 'brz add' the files you want to commit, or use"

=== modified file 'breezy/commit.py'
--- breezy/commit.py	2019-06-15 15:59:17 +0000
+++ breezy/commit.py	2019-06-16 02:56:15 +0000
@@ -245,7 +245,8 @@
                recursive='down',
                exclude=None,
                possible_master_transports=None,
-               lossy=False):
+               lossy=False,
+               parents=None):
         """Commit working copy as a new revision.
 
         :param message: the commit message (it or message_callback is required)
@@ -303,12 +304,13 @@
             recursive=recursive,
             exclude=exclude,
             possible_master_transports=possible_master_transports,
-            lossy=lossy)
+            lossy=lossy,
+            parents=parents)
 
     def _commit(self, operation, message, timestamp, timezone, committer,
                 specific_files, rev_id, allow_pointless, strict, verbose,
                 working_tree, local, reporter, message_callback, recursive,
-                exclude, possible_master_transports, lossy):
+                exclude, possible_master_transports, lossy, parents):
         mutter('preparing to commit')
 
         if working_tree is None:
@@ -359,11 +361,21 @@
 
         self.work_tree.lock_write()
         operation.add_cleanup(self.work_tree.unlock)
-        self.parents = self.work_tree.get_parent_ids()
+        if parents is None:
+            parents = self.work_tree.get_parent_ids()
+        self.parents = parents
         self.pb = ui.ui_factory.nested_progress_bar()
         operation.add_cleanup(self.pb.finished)
-        self.basis_revid = self.work_tree.last_revision()
-        self.basis_tree = self.work_tree.basis_tree()
+        if len(parents) > 0:
+            self.basis_revid = parents[0]
+        else:
+            self.basis_revid = breezy.revision.NULL_REVISION
+        self.wt_basis_tree = self.work_tree.basis_tree()
+        try:
+            self.basis_tree = self.work_tree.revision_tree(self.basis_revid)
+        except errors.NoSuchRevisionInTree:
+            self.basis_tree = self.branch.repository.revision_tree(
+                    self.basis_revid)
         self.basis_tree.lock_read()
         operation.add_cleanup(self.basis_tree.unlock)
         # Cannot commit with conflicts present.
@@ -462,8 +474,12 @@
         # as updating its basis and unversioning paths that were missing.
         self.work_tree.unversion(self.deleted_paths)
         self._set_progress_stage("Updating the working tree")
-        self.work_tree.update_basis_by_delta(self.rev_id,
-                                             self.builder.get_basis_delta())
+        if self.work_tree.last_revision() == self.basis_revid:
+            invdelta = self.builder.get_basis_delta()
+            self.work_tree.update_basis_by_delta(self.rev_id, invdelta)
+        else:
+            with self.wt_basis_tree.lock_read():
+                self.work_tree.set_last_revision(self.rev_id)
         self.reporter.completed(new_revno, self.rev_id)
         self._process_post_hooks(old_revno, new_revno)
         return self.rev_id
@@ -587,15 +603,13 @@
             # - in a checkout scenario the tree may have no
             # parents but the branch may do.
             first_tree_parent = breezy.revision.NULL_REVISION
-        try:
-            old_revno, master_last = self.master_branch.last_revision_info()
-        except errors.UnsupportedOperation:
-            master_last = self.master_branch.last_revision()
-            old_revno = self.branch.revision_id_to_revno(master_last)
+        master_last = self.master_branch.last_revision()
         if master_last != first_tree_parent:
             if master_last != breezy.revision.NULL_REVISION:
                 raise errors.OutOfDateTree(self.work_tree)
-        if self.branch.repository.has_revision(first_tree_parent):
+
+        if self.branch.repository.has_revision(self.basis_revid):
+            old_revno = self.branch.revision_id_to_revno(self.basis_revid)
             new_revno = old_revno + 1
         else:
             # ghost parents never appear in revision history.

=== modified file 'breezy/msgeditor.py'
--- breezy/msgeditor.py	2019-06-16 01:03:51 +0000
+++ breezy/msgeditor.py	2019-06-16 02:56:15 +0000
@@ -32,7 +32,10 @@
     transport,
     ui,
     )
-from .errors import BzrError
+from .errors import (
+    BzrError,
+    NoSuchRevisionInTree,
+    )
 from .hooks import Hooks
 from .sixish import (
     BytesIO,
@@ -267,12 +270,17 @@
     return status_tmp.getvalue()
 
 
-def make_commit_message_template_encoded(working_tree, specific_files,
+def make_commit_message_template_encoded(working_tree, basis_revid, specific_files,
                                          diff=None, output_encoding='utf-8'):
     """Prepare a template file for a commit into a branch.
 
     Returns an encoded string.
     """
+    try:
+        basis_tree = working_tree.revision_tree(basis_revid)
+    except NoSuchRevisionInTree:
+        basis_tree = working_tree.branch.repository.revision_tree(basis_revid)
+
     # TODO: make provision for this to be overridden or modified by a hook
     #
     # TODO: Rather than running the status command, should prepare a draft of
@@ -285,7 +293,7 @@
 
     if diff:
         stream = BytesIO()
-        show_diff_trees(working_tree.basis_tree(),
+        show_diff_trees(basis_tree,
                         working_tree, stream, specific_files,
                         path_encoding=output_encoding)
         template = template + b'\n' + stream.getvalue()

=== modified file 'breezy/mutabletree.py'
--- breezy/mutabletree.py	2019-06-15 12:04:34 +0000
+++ breezy/mutabletree.py	2019-06-16 02:56:15 +0000
@@ -156,7 +156,7 @@
 
     def commit(self, message=None, revprops=None, *args, **kwargs):
         # avoid circular imports
-        from breezy import commit
+        from . import commit
         possible_master_transports = []
         with self.lock_write():
             revprops = commit.Commit.update_revprops(
@@ -165,14 +165,16 @@
                 kwargs.pop('authors', None),
                 kwargs.get('local', False),
                 possible_master_transports)
-            # args for wt.commit start at message from the Commit.commit method,
+            # args for wt.commit start at message from the Commit.commit
+            # method,
             args = (message, ) + args
             for hook in MutableTree.hooks['start_commit']:
                 hook(self)
-            committed_id = commit.Commit().commit(working_tree=self,
-                                                  revprops=revprops,
-                                                  possible_master_transports=possible_master_transports,
-                                                  *args, **kwargs)
+            committed_id = commit.Commit().commit(
+                working_tree=self,
+                revprops=revprops,
+                possible_master_transports=possible_master_transports,
+                *args, **kwargs)
             post_hook_params = PostCommitHookParams(self)
             for hook in MutableTree.hooks['post_commit']:
                 hook(post_hook_params)

=== modified file 'breezy/tests/blackbox/test_commit.py'
--- breezy/tests/blackbox/test_commit.py	2018-11-16 11:37:47 +0000
+++ breezy/tests/blackbox/test_commit.py	2019-06-16 02:56:15 +0000
@@ -877,6 +877,31 @@
             ['Unable to determine your name'],
             ['commit', '-m', 'initial'], working_dir='foo')
 
+    def test_commit_amend(self):
+        """Ensure --amend works."""
+        tree = self.make_branch_and_tree('foo')
+        self.build_tree_contents([('foo/foo.txt', 'hello')])
+        self.run_bzr(['add'], working_dir='foo')
+        out, err = self.run_bzr("commit -m original\\ message foo/foo.txt")
+        revid1 = tree.last_revision()
+        self.assertEqualDiff(out, '')
+        self.assertContainsRe(err, '^Committing to: .*\n'
+                              'added foo\.txt\n'
+                              'Committed revision 1\.\n$')
+        self.build_tree_contents([('foo/foo.txt', 'hello again')])
+        out, err = self.run_bzr("commit --amend -m new\\ message foo/foo.txt")
+        self.assertEqualDiff(out, '')
+        self.assertContainsRe(err, '^Committing to: .*\n'
+                              'added foo\.txt\n'
+                              'Committed revision 1\.\n$')
+        self.assertEqualDiff(out, '')
+        revid2 = tree.last_revision()
+        self.assertNotEqual(revid1, revid2)
+        self.assertEqual('hello again', tree.get_file_text('foo.txt'))
+        basis_tree = tree.basis_tree()
+        with basis_tree.lock_read():
+            self.assertEqual('hello again', basis_tree.get_file_text('foo.txt'))
+
     def test_commit_recursive_checkout(self):
         """Ensure that a commit to a recursive checkout fails cleanly.
         """
@@ -925,7 +950,7 @@
         # being too low. If rpc_count increases, more network roundtrips have
         # become necessary for this use case. Please do not adjust this number
         # upwards without agreement from bzr's network support maintainers.
-        self.assertLength(211, self.hpss_calls)
+        self.assertLength(212, self.hpss_calls)
         self.assertLength(2, self.hpss_connections)
         self.expectFailure("commit still uses VFS calls",
                            self.assertThat, self.hpss_calls, ContainsNoVfsCalls)

=== modified file 'doc/en/release-notes/brz-3.1.txt'
--- doc/en/release-notes/brz-3.1.txt	2019-06-15 19:09:08 +0000
+++ doc/en/release-notes/brz-3.1.txt	2019-06-16 02:56:15 +0000
@@ -43,6 +43,9 @@
 * Automatically upgrade to branch format 8 when setting branch references.
   (Jelmer Vernooij)
 
+* A new ``--amend`` option has been added to ``brz commit``.
+  (Jelmer Vernooij, #507529)
+
 Bug Fixes
 *********