amend: add a flag `-n/--note` to store note with amend

This patch utilises the functionality added in previous patches and adds a flag
to amend command in hgext/amend to add a note to the amend. Since the note is
stored in the obsmarker metadata, this will only be useful when obsmarker
creation is enabled, otherwise this is no-op.

Not adding releasenotes part as we yet don't have a functionality in core to
show the note.

Differential Revision: https://phab.mercurial-scm.org/D1095

hgext/amend.py

@@ -1,51 +1,52 b''
 # amend.py - provide the amend command
 #
 # Copyright 2017 Facebook, Inc.
 #
 # This software may be used and distributed according to the terms of the
 # GNU General Public License version 2 or any later version.
 """provide the amend command (EXPERIMENTAL)
 
 This extension provides an ``amend`` command that is similar to
 ``commit --amend`` but does not prompt an editor.
 """
 
 from __future__ import absolute_import
 
 from mercurial.i18n import _
 from mercurial import (
     cmdutil,
     commands,
     registrar,
 )
 
 # Note for extension authors: ONLY specify testedwith = 'ships-with-hg-core' for
 # extensions which SHIP WITH MERCURIAL. Non-mainline extensions should
 # be specifying the version(s) of Mercurial they are tested with, or
 # leave the attribute unspecified.
 testedwith = 'ships-with-hg-core'
 
 cmdtable = {}
 command = registrar.command(cmdtable)
 
 @command('amend',
     [('A', 'addremove', None,
       _('mark new/missing files as added/removed before committing')),
      ('e', 'edit', None, _('invoke editor on commit messages')),
      ('i', 'interactive', None, _('use interactive mode')),
+     ('n', 'note', '', _('store a note on the amend')),
     ] + cmdutil.walkopts + cmdutil.commitopts + cmdutil.commitopts2,
     _('[OPTION]... [FILE]...'),
     inferrepo=True)
 def amend(ui, repo, *pats, **opts):
     """amend the working copy parent with all or specified outstanding changes
 
     Similar to :hg:`commit --amend`, but reuse the commit message without
     invoking editor, unless ``--edit`` was set.
 
     See :hg:`help commit` for more details.
     """
     with repo.wlock(), repo.lock():
         if not opts.get('logfile'):
             opts['message'] = opts.get('message') or repo['.'].description()
         opts['amend'] = True
         return commands._docommit(ui, repo, *pats, **opts)

tests/test-amend.t

@@ -1,225 +1,233 b''
 #testcases obsstore-off obsstore-on
 
   $ cat << EOF >> $HGRCPATH
   > [extensions]
   > amend=
   > debugdrawdag=$TESTDIR/drawdag.py
   > [diff]
   > git=1
   > EOF
 
 #if obsstore-on
   $ cat << EOF >> $HGRCPATH
   > [experimental]
   > stabilization=createmarkers
   > EOF
 #endif
 
 Basic amend
 
   $ hg init repo1
   $ cd repo1
   $ hg debugdrawdag <<'EOS'
   > B
   > |
   > A
   > EOS
 
   $ hg update B -q
   $ echo 2 >> B
 
   $ hg amend
   saved backup bundle to $TESTTMP/repo1/.hg/strip-backup/112478962961-7e959a55-amend.hg (glob) (obsstore-off !)
 #if obsstore-off
   $ hg log -p -G --hidden -T '{rev} {node|short} {desc}\n'
   @  1 be169c7e8dbe B
   |  diff --git a/B b/B
   |  new file mode 100644
   |  --- /dev/null
   |  +++ b/B
   |  @@ -0,0 +1,1 @@
   |  +B2
   |
   o  0 426bada5c675 A
      diff --git a/A b/A
      new file mode 100644
      --- /dev/null
      +++ b/A
      @@ -0,0 +1,1 @@
      +A
      \ No newline at end of file
   
 #else
   $ hg log -p -G --hidden -T '{rev} {node|short} {desc}\n'
   @  2 be169c7e8dbe B
   |  diff --git a/B b/B
   |  new file mode 100644
   |  --- /dev/null
   |  +++ b/B
   |  @@ -0,0 +1,1 @@
   |  +B2
   |
   | x  1 112478962961 B
   |/   diff --git a/B b/B
   |    new file mode 100644
   |    --- /dev/null
   |    +++ b/B
   |    @@ -0,0 +1,1 @@
   |    +B
   |    \ No newline at end of file
   |
   o  0 426bada5c675 A
      diff --git a/A b/A
      new file mode 100644
      --- /dev/null
      +++ b/A
      @@ -0,0 +1,1 @@
      +A
      \ No newline at end of file
   
 #endif
 
 Nothing changed
 
   $ hg amend
   nothing changed
   [1]
 
   $ hg amend -d "0 0"
   nothing changed
   [1]
 
   $ hg amend -d "Thu Jan 01 00:00:00 1970 UTC"
   nothing changed
   [1]
 
 Matcher and metadata options
 
   $ echo 3 > C
   $ echo 4 > D
   $ hg add C D
   $ hg amend -m NEWMESSAGE -I C
   saved backup bundle to $TESTTMP/repo1/.hg/strip-backup/be169c7e8dbe-7684ddc5-amend.hg (glob) (obsstore-off !)
   $ hg log -r . -T '{node|short} {desc} {files}\n'
   c7ba14d9075b NEWMESSAGE B C
   $ echo 5 > E
   $ rm C
   $ hg amend -d '2000 1000' -u 'Foo <[e-mail]>' -A C D
   saved backup bundle to $TESTTMP/repo1/.hg/strip-backup/c7ba14d9075b-b3e76daa-amend.hg (glob) (obsstore-off !)
   $ hg log -r . -T '{node|short} {desc} {files} {author} {date}\n'
   14f6c4bcc865 NEWMESSAGE B D Foo <[e-mail]> 2000.01000
 
 Amend with editor
 
   $ cat > $TESTTMP/prefix.sh <<'EOF'
   > printf 'EDITED: ' > $TESTTMP/msg
   > cat "$1" >> $TESTTMP/msg
   > mv $TESTTMP/msg "$1"
   > EOF
   $ chmod +x $TESTTMP/prefix.sh
 
   $ HGEDITOR="sh $TESTTMP/prefix.sh" hg amend --edit
   saved backup bundle to $TESTTMP/repo1/.hg/strip-backup/14f6c4bcc865-6591f15d-amend.hg (glob) (obsstore-off !)
   $ hg log -r . -T '{node|short} {desc}\n'
   298f085230c3 EDITED: NEWMESSAGE
   $ HGEDITOR="sh $TESTTMP/prefix.sh" hg amend -e -m MSG
   saved backup bundle to $TESTTMP/repo1/.hg/strip-backup/298f085230c3-d81a6ad3-amend.hg (glob) (obsstore-off !)
   $ hg log -r . -T '{node|short} {desc}\n'
   974f07f28537 EDITED: MSG
 
   $ echo FOO > $TESTTMP/msg
   $ hg amend -l $TESTTMP/msg -m BAR
   abort: options --message and --logfile are mutually exclusive
   [255]
   $ hg amend -l $TESTTMP/msg
   saved backup bundle to $TESTTMP/repo1/.hg/strip-backup/974f07f28537-edb6470a-amend.hg (glob) (obsstore-off !)
   $ hg log -r . -T '{node|short} {desc}\n'
   507be9bdac71 FOO
 
 Interactive mode
 
   $ touch F G
   $ hg add F G
   $ cat <<EOS | hg amend -i --config ui.interactive=1
   > y
   > n
   > EOS
   diff --git a/F b/F
   new file mode 100644
   examine changes to 'F'? [Ynesfdaq?] y
   
   diff --git a/G b/G
   new file mode 100644
   examine changes to 'G'? [Ynesfdaq?] n
   
   saved backup bundle to $TESTTMP/repo1/.hg/strip-backup/507be9bdac71-c8077452-amend.hg (glob) (obsstore-off !)
   $ hg log -r . -T '{files}\n'
   B D F
 
 Amend in the middle of a stack
 
   $ hg init $TESTTMP/repo2
   $ cd $TESTTMP/repo2
   $ hg debugdrawdag <<'EOS'
   > C
   > |
   > B
   > |
   > A
   > EOS
 
   $ hg update -q B
   $ echo 2 >> B
   $ hg amend
   abort: cannot amend changeset with children
   [255]
 
 #if obsstore-on
 
 With allowunstable, amend could work in the middle of a stack
 
   $ cat >> $HGRCPATH <<EOF
   > [experimental]
   > stabilization=createmarkers, allowunstable
   > EOF
 
   $ hg amend
   $ hg log -T '{rev} {node|short} {desc}\n' -G
   @  3 be169c7e8dbe B
   |
   | o  2 26805aba1e60 C
   | |
   | x  1 112478962961 B
   |/
   o  0 426bada5c675 A
   
+Checking the note stored in the obsmarker
+
+  $ echo foo > bar
+  $ hg add bar
+  $ hg amend --note "adding bar"
+  $ hg debugobsolete -r .
+  112478962961147124edd43549aedd1a335e44bf be169c7e8dbe21cd10b3d79691cbe7f241e3c21c 0 (Thu Jan 01 00:00:00 1970 +0000) {'operation': 'amend', 'user': 'test'}
+  be169c7e8dbe21cd10b3d79691cbe7f241e3c21c 16084da537dd8f84cfdb3055c633772269d62e1b 0 (Thu Jan 01 00:00:00 1970 +0000) {'note': 'adding bar', 'operation': 'amend', 'user': 'test'}
 #endif
 
 Cannot amend public changeset
 
   $ hg phase -r A --public
   $ hg update -C -q A
   $ hg amend -m AMEND
   abort: cannot amend public changesets
   [255]
 
 Amend a merge changeset
 
   $ hg init $TESTTMP/repo3
   $ cd $TESTTMP/repo3
   $ hg debugdrawdag <<'EOS'
   >   C
   >  /|
   > A B
   > EOS
   $ hg update -q C
   $ hg amend -m FOO
   saved backup bundle to $TESTTMP/repo3/.hg/strip-backup/a35c07e8a2a4-15ff4612-amend.hg (glob) (obsstore-off !)
   $ rm .hg/localtags
   $ hg log -G -T '{desc}\n'
   @    FOO
   |\
   | o  B
   |
   o  A