( )⚙ D6566 abort: added logic for of hg abort

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D6566

abort: added logic for of hg abort
ClosedPublic

Authored by taapas1128 on Jun 23 2019, 1:42 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHGbb135a784b70: abort: added logic for of hg abort
Summary

This is part of GSoC19 project `Implement abort and
continue commands`. This patch is part of the abort plan.

This adds the basic logic for hg abort. This command
aborts an multistep operation like graft, histedit, rebase,
merge and unshelve if they are in an unfinished state.

The first part of the logic is determining the unfinished
operation from the state detection API under statemod.
This API is extended to support hg abort by adding a method
to register the abort logic as a function (here abortfunc).

Once the unfinished operation is determined the registered
logic is used to abort the command. The benefit of this kind
of framework is that any new extension developed can support
hg abort by registering the command and logic under
statedetection API.

hg abort currently supports --dry-run/-n flag only.
It is used to dry run hg abort

Further patches sequentially add support for graft, rebase,
unshelve, histedit and merge.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

taapas1128 created this revision.Jun 23 2019, 1:42 PM
martinvonz added a subscriber: martinvonz.Jun 23 2019, 5:29 PM

Need to set the parent of this patch

taapas1128 added a comment.Jun 24 2019, 5:47 AM

@martinvonz I wanted this as a seperate stack for now so that the previous stack can be committed first. Do you want me to update its parents and add it to the previous stack?

pulkit added a subscriber: pulkit.Jun 30 2019, 3:08 PM
pulkit added inline comments.
mercurial/commands.py
147

return state.abortfunc(ui, repo, **opts) instead of storing and calling that later.

152

we should pass opts to abortfunc too. I can think of --no-backup as a flag which tells not to store a backup when aborting.

A nice addition will be --dry-run flag which tells which operation will be aborted. Also, maybe add a message saying aborting <command>.

mercurial/state.py
102

the new argument needs documentation.

136

since we will be using this argument outside of this class, let's not prepend _ to the name.

taapas1128 updated this revision to Diff 15731.Jul 1 2019, 5:49 PM
taapas1128 marked 3 inline comments as done.Jul 1 2019, 5:58 PM
pulkit added inline comments.Jul 2 2019, 5:28 PM
mercurial/commands.py
164

Arguments for abort can increase in future. Rather pass the opts directly to abort functions for now and make related functions look for flag which they need.

I agree it's not nice, but seems like a good tradeoff to start and have better code.

171

should be ui.status() instead of error.Abort()

taapas1128 retitled this revision from abort: first prototype of hg abort to abort: added logic for of hg abort.Jul 3 2019, 7:01 PM
taapas1128 edited the summary of this revision. (Show Details)
taapas1128 updated this revision to Diff 15750.
taapas1128 marked 3 inline comments as done.Jul 3 2019, 7:04 PM
taapas1128 updated this revision to Diff 15775.Jul 5 2019, 2:21 PM
pulkit added inline comments.Jul 5 2019, 5:49 PM
mercurial/commands.py
134

Can you mark this command as experimental for now, we will be close to release soon. Marking this as experimental will help us take more time to smoothen things out.

135

This help should be 'do not save backup bundle' as similar to strip command.

141

s/an/a

153

need to prepend r'' in front of dry_run for py3 compat.

164

we should return here so that abortstate.abortfunc() is not called below in case of dry-run.

taapas1128 marked 4 inline comments as done.Jul 6 2019, 2:56 PM
pulkit added a comment.Jul 9 2019, 6:25 AM

hg abort currently supports --dry-run/-n flag only.
It is used to dry run hg abort

We should specify what does dry run does i.e. it prints the operation which will be aborted if hg abort is run.

mercurial/commands.py
138

You need a space between operation and (EXPERIMENTAL)

152

%s is in progress but does not support 'hg abort'.

157

Now that we don't have backup flag, and --dry-run is tackled before calling abortfunc, we can prevent passing **opts.

taapas1128 marked 3 inline comments as done.Jul 9 2019, 8:27 AM
taapas1128 updated this revision to Diff 15836.
pulkit accepted this revision.Jul 10 2019, 8:39 AM
This revision is now accepted and ready to land.Jul 10 2019, 8:39 AM
taapas1128 added a commit: rHGbb135a784b70: abort: added logic for of hg abort.Jul 10 2019, 9:13 AM
Closed by commit rHGbb135a784b70: abort: added logic for of hg abort (authored by taapas1128). · Explain Why
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 15646

mercurial/commands.py

diffopts2 = cmdutil.diffopts2 diffopts2 = cmdutil.diffopts2
mergetoolopts = cmdutil.mergetoolopts mergetoolopts = cmdutil.mergetoolopts
similarityopts = cmdutil.similarityopts similarityopts = cmdutil.similarityopts
subrepoopts = cmdutil.subrepoopts subrepoopts = cmdutil.subrepoopts
debugrevlogopts = cmdutil.debugrevlogopts debugrevlogopts = cmdutil.debugrevlogopts
# Commands start here, listed alphabetically # Commands start here, listed alphabetically
@command('abort', [], helpcategory=command.CATEGORY_CHANGE_MANAGEMENT,
pulkitUnsubmitted
Done

Can you mark this command as experimental for now, we will be close to release soon. Marking this as experimental will help us take more time to smoothen things out.

pulkit: Can you mark this command as experimental for now, we will be close to release soon. Marking…
helpbasic=True)
pulkitUnsubmitted
Done

This help should be 'do not save backup bundle' as similar to strip command.

pulkit: This help should be `'do not save backup bundle'` as similar to strip command.
def abort(ui, repo, **opts):
"""abort an unfinished operation
pulkitUnsubmitted
Done

You need a space between operation and (EXPERIMENTAL)

pulkit: You need a space between operation and (EXPERIMENTAL)
This function is the first prototype for hg abort command.
It first checks the state and checks which command is active
then calls then returns the respective logic for aborting the
pulkitUnsubmitted
Done

s/an/a

pulkit: s/an/a
command.
"""
abortstate = None
for state in statemod._unfinishedstates:
if state.isunfinished(repo):
abortstate = state
pulkitUnsubmitted
Done

return state.abortfunc(ui, repo, **opts) instead of storing and calling that later.

pulkit: `return state.abortfunc(ui, repo, **opts)` instead of storing and calling that later.
break
if not abortstate:
raise error.Abort(_('no operation in progress'))
if abortstate._abortfunc:
return abortstate._abortfunc(ui, repo)
pulkitUnsubmitted
Done

we should pass opts to abortfunc too. I can think of --no-backup as a flag which tells not to store a backup when aborting.

A nice addition will be --dry-run flag which tells which operation will be aborted. Also, maybe add a message saying aborting <command>.

pulkit: we should pass opts to abortfunc too. I can think of `--no-backup` as a flag which tells not to…
pulkitUnsubmitted
Done

%s is in progress but does not support 'hg abort'.

pulkit: `%s is in progress but does not support 'hg abort'`.
raise error.Abort((_("%s does not support 'hg abort'") %
pulkitUnsubmitted
Done

need to prepend r'' in front of dry_run for py3 compat.

pulkit: need to prepend `r''` in front of dry_run for py3 compat.
(abortstate._opname)), hint=abortstate.hint())
@command('add', @command('add',
walkopts + subrepoopts + dryrunopts, walkopts + subrepoopts + dryrunopts,
pulkitUnsubmitted
Done

Now that we don't have backup flag, and --dry-run is tackled before calling abortfunc, we can prevent passing **opts.

pulkit: Now that we don't have backup flag, and --dry-run is tackled before calling abortfunc, we can…
_('[OPTION]... [FILE]...'), _('[OPTION]... [FILE]...'),
helpcategory=command.CATEGORY_WORKING_DIRECTORY, helpcategory=command.CATEGORY_WORKING_DIRECTORY,
helpbasic=True, inferrepo=True) helpbasic=True, inferrepo=True)
def add(ui, repo, *pats, **opts): def add(ui, repo, *pats, **opts):
"""add the specified files on the next commit """add the specified files on the next commit
Schedule files to be version controlled and added to the Schedule files to be version controlled and added to the
pulkitUnsubmitted
Done

Arguments for abort can increase in future. Rather pass the opts directly to abort functions for now and make related functions look for flag which they need.

I agree it's not nice, but seems like a good tradeoff to start and have better code.

pulkit: Arguments for abort can increase in future. Rather pass the opts directly to abort functions…
pulkitUnsubmitted
Not Done

we should return here so that abortstate.abortfunc() is not called below in case of dry-run.

pulkit: we should return here so that `abortstate.abortfunc()` is not called below in case of dry-run.
repository. repository.
The files will be added to the repository at the next commit. To The files will be added to the repository at the next commit. To
undo an add before that, see :hg:`forget`. undo an add before that, see :hg:`forget`.
If no names are given, add all files to the repository (except If no names are given, add all files to the repository (except
files matching ``.hgignore``). files matching ``.hgignore``).
pulkitUnsubmitted
Done

should be ui.status() instead of error.Abort()

pulkit: should be `ui.status()` instead of `error.Abort()`
.. container:: verbose .. container:: verbose
Examples: Examples:
- New (unknown) files are added - New (unknown) files are added
automatically by :hg:`add`:: automatically by :hg:`add`::

mercurial/state.py

are in an unfinished conditition or not and return appropriate message are in an unfinished conditition or not and return appropriate message
and hint. and hint.
It also has the ability to register and determine the states of any new It also has the ability to register and determine the states of any new
multistep operation or multistep command extension. multistep operation or multistep command extension.
""" """
def __init__(self, opname, fname, clearable=False, allowcommit=False, def __init__(self, opname, fname, clearable=False, allowcommit=False,
reportonly=False, continueflag=False, stopflag=False , reportonly=False, continueflag=False, stopflag=False ,
cmdmsg="", cmdhint="", statushint=""): cmdmsg="", cmdhint="", statushint="", abortfunc=None):
pulkitUnsubmitted
Done

the new argument needs documentation.

pulkit: the new argument needs documentation.
"""opname is the name the command or operation """opname is the name the command or operation
fname is the file name in which data should be stored in .hg directory. fname is the file name in which data should be stored in .hg directory.
It is None for merge command. It is None for merge command.
clearable boolean determines whether or not interrupted states can be clearable boolean determines whether or not interrupted states can be
cleared by running `hg update -C .` which in turn deletes the cleared by running `hg update -C .` which in turn deletes the
state file. state file.
allowcommit boolean decides whether commit is allowed during interrupted allowcommit boolean decides whether commit is allowed during interrupted
state or not. state or not.
self._clearable = clearable self._clearable = clearable
self._allowcommit = allowcommit self._allowcommit = allowcommit
self._cmdhint = cmdhint self._cmdhint = cmdhint
self._statushint = statushint self._statushint = statushint
self._cmdmsg = cmdmsg self._cmdmsg = cmdmsg
self._stopflag = stopflag self._stopflag = stopflag
self._reportonly = reportonly self._reportonly = reportonly
self._continueflag = continueflag self._continueflag = continueflag
self._abortfunc = abortfunc
pulkitUnsubmitted
Done

since we will be using this argument outside of this class, let's not prepend _ to the name.

pulkit: since we will be using this argument outside of this class, let's not prepend `_` to the name.
def statusmsg(self): def statusmsg(self):
"""returns the hint message corresponding to the command for """returns the hint message corresponding to the command for
hg status --verbose hg status --verbose
""" """
if not self._statushint: if not self._statushint:
hint = (_('To continue: hg %s --continue\n' hint = (_('To continue: hg %s --continue\n'
'To abort: hg %s --abort') % (self._opname, 'To abort: hg %s --abort') % (self._opname,

tests/test-completion.t

Show all commands except debug commands Show all commands except debug commands
$ hg debugcomplete $ hg debugcomplete
abort
add add
addremove addremove
annotate annotate
archive archive
backout backout
bisect bisect
bookmarks bookmarks
branch branch
tip tip
unbundle unbundle
update update
verify verify
version version
Show all commands that start with "a" Show all commands that start with "a"
$ hg debugcomplete a $ hg debugcomplete a
abort
add add
addremove addremove
annotate annotate
archive archive
Do not show debug commands if there are other candidates Do not show debug commands if there are other candidates
$ hg debugcomplete d $ hg debugcomplete d
diff diff
Show an error if we use --options with an ambiguous abbreviation Show an error if we use --options with an ambiguous abbreviation
$ hg debugcomplete --options s $ hg debugcomplete --options s
hg: command 's' is ambiguous: hg: command 's' is ambiguous:
serve showconfig status summary serve showconfig status summary
[255] [255]
Show all commands + options Show all commands + options
$ hg debugcommands $ hg debugcommands
abort:
add: include, exclude, subrepos, dry-run add: include, exclude, subrepos, dry-run
addremove: similarity, subrepos, include, exclude, dry-run addremove: similarity, subrepos, include, exclude, dry-run
annotate: rev, follow, no-follow, text, user, file, date, number, changeset, line-number, skip, ignore-all-space, ignore-space-change, ignore-blank-lines, ignore-space-at-eol, include, exclude, template annotate: rev, follow, no-follow, text, user, file, date, number, changeset, line-number, skip, ignore-all-space, ignore-space-change, ignore-blank-lines, ignore-space-at-eol, include, exclude, template
archive: no-decode, prefix, rev, type, subrepos, include, exclude archive: no-decode, prefix, rev, type, subrepos, include, exclude
backout: merge, commit, no-commit, parent, rev, edit, tool, include, exclude, message, logfile, date, user backout: merge, commit, no-commit, parent, rev, edit, tool, include, exclude, message, logfile, date, user
bisect: reset, good, bad, skip, extend, command, noupdate bisect: reset, good, bad, skip, extend, command, noupdate
bookmarks: force, rev, delete, rename, inactive, list, template bookmarks: force, rev, delete, rename, inactive, list, template
branch: force, clean, rev branch: force, clean, rev

tests/test-globalopts.t

serve start stand-alone webserver serve start stand-alone webserver
Change creation: Change creation:
commit commit the specified files or all outstanding changes commit commit the specified files or all outstanding changes
Change manipulation: Change manipulation:
abort abort an unfinished operation
backout reverse effect of earlier changeset backout reverse effect of earlier changeset
graft copy changes from other branches onto the current branch graft copy changes from other branches onto the current branch
merge merge another revision into working directory merge merge another revision into working directory
Change organization: Change organization:
bookmarks create a new bookmark or list existing bookmarks bookmarks create a new bookmark or list existing bookmarks
branch set or show the current branch name branch set or show the current branch name
serve start stand-alone webserver serve start stand-alone webserver
Change creation: Change creation:
commit commit the specified files or all outstanding changes commit commit the specified files or all outstanding changes
Change manipulation: Change manipulation:
abort abort an unfinished operation
backout reverse effect of earlier changeset backout reverse effect of earlier changeset
graft copy changes from other branches onto the current branch graft copy changes from other branches onto the current branch
merge merge another revision into working directory merge merge another revision into working directory
Change organization: Change organization:
bookmarks create a new bookmark or list existing bookmarks bookmarks create a new bookmark or list existing bookmarks
branch set or show the current branch name branch set or show the current branch name

tests/test-help-hide.t

serve start stand-alone webserver serve start stand-alone webserver
Change creation: Change creation:
commit commit the specified files or all outstanding changes commit commit the specified files or all outstanding changes
Change manipulation: Change manipulation:
abort abort an unfinished operation
backout reverse effect of earlier changeset backout reverse effect of earlier changeset
graft copy changes from other branches onto the current branch graft copy changes from other branches onto the current branch
merge merge another revision into working directory merge merge another revision into working directory
Change organization: Change organization:
bookmarks create a new bookmark or list existing bookmarks bookmarks create a new bookmark or list existing bookmarks
branch set or show the current branch name branch set or show the current branch name
serve start stand-alone webserver serve start stand-alone webserver
Change creation: Change creation:
commit commit the specified files or all outstanding changes commit commit the specified files or all outstanding changes
Change manipulation: Change manipulation:
abort abort an unfinished operation
backout reverse effect of earlier changeset backout reverse effect of earlier changeset
graft copy changes from other branches onto the current branch graft copy changes from other branches onto the current branch
merge merge another revision into working directory merge merge another revision into working directory
Change organization: Change organization:
bookmarks create a new bookmark or list existing bookmarks bookmarks create a new bookmark or list existing bookmarks
branch set or show the current branch name branch set or show the current branch name

tests/test-help.t

Short help: Short help:
$ hg $ hg
Mercurial Distributed SCM Mercurial Distributed SCM
basic commands: basic commands:
abort abort an unfinished operation
add add the specified files on the next commit add add the specified files on the next commit
annotate show changeset information by line for each file annotate show changeset information by line for each file
clone make a copy of an existing repository clone make a copy of an existing repository
commit commit the specified files or all outstanding changes commit commit the specified files or all outstanding changes
diff diff repository (or selected files) diff diff repository (or selected files)
export dump the header and diffs for one or more changesets export dump the header and diffs for one or more changesets
forget forget the specified files on the next commit forget forget the specified files on the next commit
init create a new repository in the given directory init create a new repository in the given directory
log show revision history of entire repository or files log show revision history of entire repository or files
merge merge another revision into working directory merge merge another revision into working directory
pull pull changes from the specified source pull pull changes from the specified source
push push changes to the specified destination push push changes to the specified destination
remove remove the specified files on the next commit remove remove the specified files on the next commit
serve start stand-alone webserver serve start stand-alone webserver
status show changed files in the working directory status show changed files in the working directory
summary summarize working directory state summary summarize working directory state
update update working directory (or switch revisions) update update working directory (or switch revisions)
(use 'hg help' for the full list of commands or 'hg -v' for details) (use 'hg help' for the full list of commands or 'hg -v' for details)
$ hg -q $ hg -q
abort abort an unfinished operation
add add the specified files on the next commit add add the specified files on the next commit
annotate show changeset information by line for each file annotate show changeset information by line for each file
clone make a copy of an existing repository clone make a copy of an existing repository
commit commit the specified files or all outstanding changes commit commit the specified files or all outstanding changes
diff diff repository (or selected files) diff diff repository (or selected files)
export dump the header and diffs for one or more changesets export dump the header and diffs for one or more changesets
forget forget the specified files on the next commit forget forget the specified files on the next commit
init create a new repository in the given directory init create a new repository in the given directory
serve start stand-alone webserver serve start stand-alone webserver
Change creation: Change creation:
commit commit the specified files or all outstanding changes commit commit the specified files or all outstanding changes
Change manipulation: Change manipulation:
abort abort an unfinished operation
backout reverse effect of earlier changeset backout reverse effect of earlier changeset
graft copy changes from other branches onto the current branch graft copy changes from other branches onto the current branch
merge merge another revision into working directory merge merge another revision into working directory
Change organization: Change organization:
bookmarks create a new bookmark or list existing bookmarks bookmarks create a new bookmark or list existing bookmarks
branch set or show the current branch name branch set or show the current branch name
serve start stand-alone webserver serve start stand-alone webserver
Change creation: Change creation:
commit commit the specified files or all outstanding changes commit commit the specified files or all outstanding changes
Change manipulation: Change manipulation:
abort abort an unfinished operation
backout reverse effect of earlier changeset backout reverse effect of earlier changeset
graft copy changes from other branches onto the current branch graft copy changes from other branches onto the current branch
merge merge another revision into working directory merge merge another revision into working directory
Change organization: Change organization:
bookmarks create a new bookmark or list existing bookmarks bookmarks create a new bookmark or list existing bookmarks
branch set or show the current branch name branch set or show the current branch name
Test short command list with verbose option Test short command list with verbose option
$ hg -v help shortlist $ hg -v help shortlist
Mercurial Distributed SCM Mercurial Distributed SCM
basic commands: basic commands:
abort abort an unfinished operation
add add the specified files on the next commit add add the specified files on the next commit
annotate, blame annotate, blame
show changeset information by line for each file show changeset information by line for each file
clone make a copy of an existing repository clone make a copy of an existing repository
commit, ci commit the specified files or all outstanding changes commit, ci commit the specified files or all outstanding changes
diff diff repository (or selected files) diff diff repository (or selected files)
export dump the header and diffs for one or more changesets export dump the header and diffs for one or more changesets
forget forget the specified files on the next commit forget forget the specified files on the next commit
</td><td> </td><td>
This is the topic to test omit indicating. This is the topic to test omit indicating.
</td></tr> </td></tr>
<tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr> <tr><td colspan="2"><h2><a name="main" href="#main">Main Commands</a></h2></td></tr>
<tr><td> <tr><td>
<a href="/help/abort">
abort
</a>
</td><td>
abort an unfinished operation
</td></tr>
<tr><td>
<a href="/help/add"> <a href="/help/add">
add add
</a> </a>
</td><td> </td><td>
add the specified files on the next commit add the specified files on the next commit
</td></tr> </td></tr>
<tr><td> <tr><td>
<a href="/help/annotate"> <a href="/help/annotate">