Refactor main arguments + other improvements

[sebalix]

Context

This is a rework of #33 , and bring breaking changes, both for CLI tool and API if used as a Python package.

Description

Introduce 3 concepts:

• source: source of the comparison
• target: target of the comparison
• destination: where to push the work done

All of them accept git [remote/]branch references, so additional info like repository and organization is retrieved from the remote URL.

This is also a preliminary step to support porting from one repo to another (very handy in case of modules moved to different repos).

CLI syntax changed to this:

$ oca-port origin/14.0 origin/16.0 my_module [--destination camptocamp/dev]

A local dev branch where commits have already been ported can be resumed this way:

$ oca-port origin/14.0 dev my_module --target-version=16.0 [--destination camptocamp/dev]

Here we are forced to use an additional parameter --target-version as the tool is unable to guess it from dev name.

A new --dry-run option has been added too:

$ oca-port origin/14.0 origin/16.0 my_module --dry-run

If no remote is defined (detected from destination or target), porting can still be done but the development branch won't be pushed, nor the PR open against the expected repository. However, a brief PR description will be proposed to the user at the end of the session so he'll be able to open the PR by its own if needed:

Remote is not mandatory for source, target and destination, so we can work fully with local branches:

$ oca-port 14.0 16.0 my_module --destination 16.0-port-things

Another improvement is that PortAddonPullRequest class doesn't create one branch for each ported PR, resulting in tons of branches created during a porting session. Instead, the destination branch is used (if provided) or one will be created automatically (name based on list of PRs to port, so re-running the command twice generates the same branch name in
most use cases). Of course, setting your own destination branch is recommended to preserve the full control of your porting session.

Also, the blacklisting of PRs/modules have been refactored to not create files to commit in the middle of a porting session. Instead, if a PR is set as blacklisted, this information will be stored in the user's session and commited at the end of the porting session. If for any reason the porting session is interrupted, such data are not lost when re-running the command again, and the user will be prompted if he still wants to blacklist such PR:

How to install and test this PR

$ pip install -U git+https://github.com/OCA/oca-port.git@refs/pull/51/head

Examples

Run a comparison for stock_restrict_lot in verbose mode first in --dry-run with --fetch to ensure we get the last changes locally:

$ oca-port origin/14.0 origin/16.0 stock_restrict_lot --verbose --dry-run --fetch

This had the effect to put some data in the user's cache, so further similar commands will be faster to run.

Re-run the same command without --dry-run nor --fetch, but with --destination (here a local branch) to not let the tool generates the destination branch automatically:

$ oca-port origin/14.0 origin/16.0 stock_restrict_lot --verbose --destination=16-port-from-14-stock_restrict_lot

Up to the user to resolve the conflicts manually (then git add [...] && git am --continue or git am --skip) before continuing the porting session. Answering no will perform a git am --abort before trying to port the next commit of the PR (if any), or propose to port the next PR.

In case the porting session is interrupted, we can resume it by changing restarting the comparison using our destination branch also as the target (with the help of --target-version so the tool knows which version we are talking about), so already ported commits won't be listed anymore:

$ oca-port origin/14.0 16-port-from-14-stock_restrict_lot --target-version=16.0 stock_restrict_lot --verbose --destination=16-port-from-14-stock_restrict_lot

Running the same command once everything is ported will produce this result:

TODO:

• update the README

[simahawk]

LG

[simahawk]

Suggested change

	"""Migrate ADDON from SOURCE to TARGET or list Pull Requests to port
	if ADDON already exists on TARGET.
	E.g.:
	$ oca-port OCA/server-tools#14.0 OCA/server-tools#16.0 auditlog
	"""Migrate ``addon``` from ``source`` to ``target`` or list PRs.
	If ``addon`` already exists....
	E.g.:
	$ oca-port OCA/server-tools#14.0 OCA/server-tools#16.0 auditlog

[sebalix]

Not sure, I used these capitalized terms to align with the command as displayed by --help thanks to click:

$ oca-port --help
Usage: oca-port [OPTIONS] SOURCE TARGET ADDON

  Migrate ADDON from SOURCE to TARGET or list Pull Requests to port     if
  ADDON already exists on TARGET.

But we still need to fix the example in this docstring.

[sebalix]

With last changes, when re-running the same command twice while having ported some commits in the first run, a WIP status will be displayed:

$ oca-port origin/14.0 origin/17.0 server_environment --verbose

And running the proposed command to recover the ongoing work could show there is nothing left to port, and therefore propose the user to open the PR (manually here as no destination was set):

$ oca-port origin/14.0 oca-port-server_environment-14.0-to-17.0-761c9d server_environment --target-version=17.0 --verbose