This is an archive of the discontinued Mercurial Phabricator instance.

Differential D3764

rebase: improve output of --dry-run
ClosedPublic

Authored by khanchi97 on Jun 17 2018, 7:48 AM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
Commits
rHG731debab233f: rebase: improve output of --dry-run
Summary

Improved output when in dryrun, for user to make sure that
no change will be written to repository.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

khanchi97 created this revision.Jun 17 2018, 7:48 AM
pulkit added a subscriber: pulkit.Jun 18 2018, 4:20 PM

Thinking out loud here: I see that --dry-run for rebase will be very useful for automation. How about returning 1 when there are conflicts and returning 0 when there are no conflicts? Also maybe we should add formatter support to the dry-run output for each command so that automation can read the JSON output and tell user what can happen.

indygreg added a subscriber: indygreg.Jun 18 2018, 7:03 PM
In D3764#59425, @pulkit wrote:

Thinking out loud here: I see that --dry-run for rebase will be very useful for automation. How about returning 1 when there are conflicts and returning 0 when there are no conflicts? Also maybe we should add formatter support to the dry-run output for each command so that automation can read the JSON output and tell user what can happen.

I approve of both of these feature suggestions! However, they should be implemented in standalone changesets and not incorporated into this one.

khanchi97 added a comment.Jun 19 2018, 3:05 AM

okay @pulkit , let me confirm if IIUC your points.

  1. First thing is we would have a function which will accept a return_code(0 or 1) and output_data (what can happen without --dry-run) from any command (which has dry-run functionality). And will give output to the user according to the return_code. Following is the rough code for this, correct me if I am wrong at any point.
def dryrunformatter(retcode, **outputdata):
    ui.status(_("starting dry-run; repository will not be changed"))

    # here show the outputdata accordingly

    if retcode == 0:
        ui.status(_("dry-run completed successfully; run without --dry-run/-n to perform this action"))
    else:
        ui.status(_("hit conflicts!"))
  1. If above explanation is right, talking about "additional functionality in dryrun" like --verbose mode in rebase which @indygreg suggested. May be we can add this type of functionality too in dryrunformatter? What do you say?
khanchi97 edited the summary of this revision. (Show Details)Jun 22 2018, 10:13 AM
khanchi97 retitled this revision from rebase: improve output of --dry-run to rebase: no need to store backup during dry-run while aborting.
khanchi97 updated this revision to Diff 9258.
pulkit added a comment.Jun 22 2018, 10:19 AM

@khanchi97 you should have created a new differential so that we don't loose your earlier patch titled: 'rebase: improve output of --dry-run' which is yet under review.

pulkit added a comment.Jun 22 2018, 10:19 AM
In D3764#59443, @indygreg wrote:
In D3764#59425, @pulkit wrote:

Thinking out loud here: I see that --dry-run for rebase will be very useful for automation. How about returning 1 when there are conflicts and returning 0 when there are no conflicts? Also maybe we should add formatter support to the dry-run output for each command so that automation can read the JSON output and tell user what can happen.

I approve of both of these feature suggestions! However, they should be implemented in standalone changesets and not incorporated into this one.

I agree.

khanchi97 added a comment.Jun 22 2018, 12:00 PM
In D3764#59797, @pulkit wrote:

@khanchi97 you should have created a new differential so that we don't loose your earlier patch titled: 'rebase: improve output of --dry-run' which is yet under review.

Oh sorry, it was by mistake.

khanchi97 retitled this revision from rebase: no need to store backup during dry-run while aborting to rebase: improve output of --dry-run.Jun 22 2018, 12:02 PM
khanchi97 updated this revision to Diff 9259.
khanchi97 updated this revision to Diff 9263.Jun 23 2018, 8:48 AM
khanchi97 updated this revision to Diff 9264.Jun 23 2018, 8:53 AM
khanchi97 updated this revision to Diff 9268.Jun 24 2018, 6:18 AM
khanchi97 edited the summary of this revision. (Show Details)Jun 28 2018, 4:11 PM
khanchi97 updated this revision to Diff 9348.
khanchi97 updated this revision to Diff 9360.Jun 29 2018, 2:09 PM
pulkit accepted this revision.Jul 4 2018, 3:16 PM
Closed by commit rHG731debab233f: rebase: improve output of --dry-run (authored by khanchi97). · Explain WhyJul 4 2018, 3:43 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mhgext/rebase.py (4 lines)
Mtests/test-rebase-inmemory.t (8 lines)

Diff 9436

hgext/rebase.py

' merge\n')) ' merge\n'))
_dorebase(ui, repo, {'abort': True}) _dorebase(ui, repo, {'abort': True})
return _dorebase(ui, repo, opts, inmemory=False) return _dorebase(ui, repo, opts, inmemory=False)
else: else:
return _dorebase(ui, repo, opts) return _dorebase(ui, repo, opts)
def _dryrunrebase(ui, repo, opts): def _dryrunrebase(ui, repo, opts):
rbsrt = rebaseruntime(repo, ui, inmemory=True, opts=opts) rbsrt = rebaseruntime(repo, ui, inmemory=True, opts=opts)
ui.status(_('starting dry-run rebase; repository will not be changed\n'))
with repo.wlock(), repo.lock(): with repo.wlock(), repo.lock():
try: try:
overrides = {('rebase', 'singletransaction'): True} overrides = {('rebase', 'singletransaction'): True}
with ui.configoverride(overrides, 'rebase'): with ui.configoverride(overrides, 'rebase'):
_origrebase(ui, repo, opts, rbsrt, inmemory=True, _origrebase(ui, repo, opts, rbsrt, inmemory=True,
leaveunfinished=True) leaveunfinished=True)
except error.InMemoryMergeConflictsError: except error.InMemoryMergeConflictsError:
ui.status(_('hit a merge conflict\n')) ui.status(_('hit a merge conflict\n'))
return 1 return 1
else: else:
ui.status(_('there will be no conflict, you can rebase\n')) ui.status(_('dry-run rebase completed successfully; run without '
'-n/--dry-run to perform this rebase\n'))
return 0 return 0
finally: finally:
# no need to store backup in case of dryrun # no need to store backup in case of dryrun
rbsrt._prepareabortorcontinue(isabort=True, backup=False, rbsrt._prepareabortorcontinue(isabort=True, backup=False,
suppwarns=True) suppwarns=True)
def _dorebase(ui, repo, opts, inmemory=False): def _dorebase(ui, repo, opts, inmemory=False):
rbsrt = rebaseruntime(repo, ui, inmemory, opts) rbsrt = rebaseruntime(repo, ui, inmemory, opts)

tests/test-rebase-inmemory.t

abort: cannot specify both --dry-run and --continue abort: cannot specify both --dry-run and --continue
[255] [255]
$ hg rebase -s 2 -d 6 -n --abort $ hg rebase -s 2 -d 6 -n --abort
abort: cannot specify both --dry-run and --abort abort: cannot specify both --dry-run and --abort
[255] [255]
Check dryrun gives correct results when there is no conflict in rebasing Check dryrun gives correct results when there is no conflict in rebasing
$ hg rebase -s 2 -d 6 -n $ hg rebase -s 2 -d 6 -n
starting dry-run rebase; repository will not be changed
rebasing 2:177f92b77385 "c" rebasing 2:177f92b77385 "c"
rebasing 3:055a42cdd887 "d" rebasing 3:055a42cdd887 "d"
rebasing 4:e860deea161a "e" rebasing 4:e860deea161a "e"
there will be no conflict, you can rebase dry-run rebase completed successfully; run without -n/--dry-run to perform this rebase
$ hg diff $ hg diff
$ hg status $ hg status
$ hg log -G --template "{rev}:{short(node)} {person(author)}\n{firstline(desc)} {topic}\n\n" $ hg log -G --template "{rev}:{short(node)} {person(author)}\n{firstline(desc)} {topic}\n\n"
@ 6:baf10c5166d4 test @ 6:baf10c5166d4 test
| g | g
| |
o 1:d2ae7f538514 test o 1:d2ae7f538514 test
| b | b
| |
o 0:cb9a9f314b8b test o 0:cb9a9f314b8b test
a a
Check dryrun working with --collapse when there is no conflict Check dryrun working with --collapse when there is no conflict
$ hg rebase -s 2 -d 6 -n --collapse $ hg rebase -s 2 -d 6 -n --collapse
starting dry-run rebase; repository will not be changed
rebasing 2:177f92b77385 "c" rebasing 2:177f92b77385 "c"
rebasing 3:055a42cdd887 "d" rebasing 3:055a42cdd887 "d"
rebasing 4:e860deea161a "e" rebasing 4:e860deea161a "e"
there will be no conflict, you can rebase dry-run rebase completed successfully; run without -n/--dry-run to perform this rebase
Check dryrun gives correct results when there is conflict in rebasing Check dryrun gives correct results when there is conflict in rebasing
Make a conflict: Make a conflict:
$ hg up 6 -q $ hg up 6 -q
$ echo conflict>e $ echo conflict>e
$ hg ci -Aqm "conflict with e" $ hg ci -Aqm "conflict with e"
$ hg log -G --template "{rev}:{short(node)} {person(author)}\n{firstline(desc)} {topic}\n\n" $ hg log -G --template "{rev}:{short(node)} {person(author)}\n{firstline(desc)} {topic}\n\n"
@ 7:d2c195b28050 test @ 7:d2c195b28050 test
| |
o 1:d2ae7f538514 test o 1:d2ae7f538514 test
| b | b
| |
o 0:cb9a9f314b8b test o 0:cb9a9f314b8b test
a a
$ hg rebase -s 2 -d 7 -n $ hg rebase -s 2 -d 7 -n
starting dry-run rebase; repository will not be changed
rebasing 2:177f92b77385 "c" rebasing 2:177f92b77385 "c"
rebasing 3:055a42cdd887 "d" rebasing 3:055a42cdd887 "d"
rebasing 4:e860deea161a "e" rebasing 4:e860deea161a "e"
merging e merging e
transaction abort! transaction abort!
rollback completed rollback completed
hit a merge conflict hit a merge conflict
[1] [1]
o 1:d2ae7f538514 test o 1:d2ae7f538514 test
| b | b
| |
o 0:cb9a9f314b8b test o 0:cb9a9f314b8b test
a a
Check dryrun working with --collapse when there is conflicts Check dryrun working with --collapse when there is conflicts
$ hg rebase -s 2 -d 7 -n --collapse $ hg rebase -s 2 -d 7 -n --collapse
starting dry-run rebase; repository will not be changed
rebasing 2:177f92b77385 "c" rebasing 2:177f92b77385 "c"
rebasing 3:055a42cdd887 "d" rebasing 3:055a42cdd887 "d"
rebasing 4:e860deea161a "e" rebasing 4:e860deea161a "e"
merging e merging e
hit a merge conflict hit a merge conflict
[1] [1]