feat(mr,diff): #13 - add diff and get_latest_mr_state

Author: leorolland

.dockerignore

@@ -0,0 +1,40 @@
+# Specific files/folder
+.cache
+.coverage
+.coveragerc
+.dockerignore
+.git
+.gitignore
+.gitlab-ci.yml
+.noserc
+.venv/
+.idea
+.vscode
+htmlcov
+sonar-project.properties
+**/tests/**
+*.egg-info
+.flake8
+docs/
+devops/
+tmp/
+.gitlab/
+.releaserc.json$
+README.rst
+sonar-project.properties
+pylama.ini
+openapi.yml
+cov.xml
+commitlint.config.js
+codespellrc
+CHANGELOG.md
+celerybeat-schedule.db
+.pre-commit-config.yaml
+.gitlab-ci.yml
+.coverage
+public
+*/__pycache__/
+# Ignore all markdown file
+*.md
+# Ignore all *.pyc files in all folders, including build root
+**/*.pyc

gitflow_toolbox/check_branch_exists.py

@@ -16,6 +16,9 @@ def check_branch_exists(ctx: click.Context, remote: bool, branch: str):
     Args:
         remote (bool): whether to check on the current gitlab or remote gitlab (True=remote)
         branch (str): branch name
+
+    Returns:
+        bool: True if branch exists (exit code 0), False otherwise (exit code 1)
     """
     click.echo(f"Checking if {branch} branch exists...")
     project = RemoteGitlab().project if remote else CurrentGitlab().project

gitflow_toolbox/check_mr_exists.py

@@ -19,6 +19,9 @@ def check_mr_exists(ctx: click.Context, remote: bool, source_branch: str, target
         remote (bool): whether to check on the current gitlab or remote gitlab (True=remote)
         source_branch (str): branch to create
         remote_target_branch (str): branch reference to create branch from
+
+    Returns:
+        bool: True if a MR exists (exit code 0), False otherwise (exit code 1)
     """
     click.echo(f"Checking if an opened merge request from {source_branch} to {target_branch} exists...")
     project = RemoteGitlab().project if remote else CurrentGitlab().project

gitflow_toolbox/diff.py

@@ -0,0 +1,58 @@
+import os
+import shutil
+import uuid
+
+import click
+import git
+
+from gitflow_toolbox.common.gitlab import CurrentGitlab, RemoteGitlab
+from gitflow_toolbox.common.is_main_call import is_main_call
+
+
+@click.command()
+@click.option("--from-gitlab", type=click.Choice(["current", "remote"], case_sensitive=False))
+@click.argument("source_branch", type=str)
+@click.option("--to-gitlab", type=click.Choice(["current", "remote"], case_sensitive=False))
+@click.argument("target_branch", type=str)
+@click.pass_context
+def diff(
+    ctx: click.Context,
+    from_gitlab: tuple[str],
+    source_branch: str,
+    to_gitlab: tuple[str],
+    target_branch: str,
+):
+    """Returns the 'git diff' between two branches
+
+    Args:
+        from_gitlab (str): source gitlab [current/remote]
+        source_branch (str): source branch
+        to_gitlab (str): destination gitlab [current/remote]
+        target_branch (str): destination branch
+
+    Returns:
+        str: the 'git diff' between two branches, or an empty string (line return) if no diff
+    """
+
+    gitlab_from = CurrentGitlab() if from_gitlab == "current" else RemoteGitlab()
+    gitlab_to = CurrentGitlab() if to_gitlab == "current" else RemoteGitlab()
+
+    project_from_clone_dir = os.path.join("/tmp", f"gf_{uuid.uuid4()}")
+
+    try:
+        # Clone
+        repo_from = git.Repo.clone_from(
+            gitlab_from.project_authenticated_url, project_from_clone_dir, branch=source_branch
+        )
+        # Add remote
+        repo_from.create_remote("target", gitlab_to.project_authenticated_url)
+        # Diff
+        repo_from.remotes.target.fetch(target_branch)
+        diff_output = str(repo_from.git.diff(f"target/{target_branch}"))
+        if diff_output and is_main_call(ctx):
+            click.echo(diff_output)
+        return diff_output
+    finally:
+        # Clean
+        if os.path.isdir(project_from_clone_dir):
+            shutil.rmtree(project_from_clone_dir)

gitflow_toolbox/get_latest_mr_state.py

@@ -0,0 +1,35 @@
+import click
+
+from gitflow_toolbox.common.gitlab import CurrentGitlab, RemoteGitlab
+from gitflow_toolbox.common.is_main_call import is_main_call
+
+
+@click.command()
+@click.option("--remote/--current", default=False)
+@click.argument("source_branch", type=str)
+@click.argument("target_branch", type=str)
+@click.argument("labels", type=str, nargs=-1)
+@click.pass_context
+def get_latest_mr_state(ctx: click.Context, remote: bool, source_branch: str, target_branch: str, labels: tuple[str]):
+    """Returns the state of the latest MR from/to branch
+
+    Args:
+        remote (bool): whether to check on the current gitlab or remote gitlab (True=remote)
+        source_branch (str): branch to create
+        remote_target_branch (str): branch reference to create branch from
+        labels (tuple[str]): filter by labels
+
+    Returns:
+        str: state of the latest MR (opened/closed/merged/locked) or 'no-mr' if nothing was found
+    """
+    project = RemoteGitlab().project if remote else CurrentGitlab().project
+    mrs = project.mergerequests.list(
+        source_branch=source_branch, target_branch=target_branch, order_by="created_at", labels=list(labels)
+    )
+    if len(mrs) == 0:
+        if is_main_call(ctx):
+            click.echo("no-mr")
+        return "no-mr"
+    if is_main_call(ctx):
+        click.echo(mrs[0].state)
+    return mrs[0].state

gitflow_toolbox/push.py

@@ -1,5 +1,6 @@
 import os
 import shutil
+import sys
 import uuid
 
 import click
@@ -24,28 +25,41 @@ def push(
     target_branch: str,
     force: bool,
 ):
+    """Push commits from a branch to another branch
+
+    Args:
+        from_gitlab (str): source gitlab [current/remote]
+        source_branch (str): source branch
+        to_gitlab (str): destination gitlab [current/remote]
+        target_branch (str): destination branch
+        force (bool): whether to force push (default: False)
+    """
 
     gitlab_from = CurrentGitlab() if from_gitlab == "current" else RemoteGitlab()
     gitlab_to = CurrentGitlab() if to_gitlab == "current" else RemoteGitlab()
 
     project_from_http_url = ctx.invoke(get_project_http_url, remote=(from_gitlab == "remote"))
     project_from_clone_dir = os.path.join("/tmp", f"gf_{uuid.uuid4()}")
 
-    # Clone
     click.echo(f"Cloning {project_from_http_url} into {project_from_clone_dir}")
-
     try:
+        # Clone
         repo_from = git.Repo.clone_from(
             gitlab_from.project_authenticated_url, project_from_clone_dir, branch=source_branch
         )
-        # Check if directory exists
         # Add remote
         project_to_http_url = ctx.invoke(get_project_http_url, remote=(to_gitlab == "remote"))
         click.echo(f"Adding remote to {project_to_http_url}")
         repo_from.create_remote("target", gitlab_to.project_authenticated_url)
         # Push
+        repo_from.remotes.target.fetch(target_branch)
         click.echo(f"Pushing {from_gitlab} {source_branch} into {to_gitlab} {target_branch} (force={force})")
-        repo_from.remotes.target.push(refspec=f"{source_branch}:{target_branch}", force=force)
+        changes = repo_from.remotes.target.push(refspec=f"{source_branch}:{target_branch}", force=force)
+        for change in changes:
+            click.echo(change.summary)
+            if "rejected" in change.summary:
+                click.echo(f"❌ Couldn't push changes to {to_gitlab} {target_branch}")
+                sys.exit(1)
         click.echo(f"✨ Successfully pushed {from_gitlab} {source_branch} into {to_gitlab} {target_branch}")
 
     finally:

main.py

@@ -3,6 +3,7 @@
 
 from gitflow_toolbox.check_branch_exists import check_branch_exists
 from gitflow_toolbox.check_mr_exists import check_mr_exists
+from gitflow_toolbox.diff import diff
 from gitflow_toolbox.ensure_branch import ensure_branch
 from gitflow_toolbox.ensure_mr import ensure_mr
 from gitflow_toolbox.get_project_http_url import get_project_http_url
@@ -24,6 +25,7 @@ def cli():
 cli.add_command(get_project_ssh_url)
 cli.add_command(get_project_http_url)
 cli.add_command(push)
+cli.add_command(diff)
 
 if __name__ == "__main__":
     cli()