Merge pull request #390 from C0DE-X/feature/patches

Add patches functionality

Author: jacebrowning

gitman/cli.py

@@ -125,6 +125,13 @@ def main(args=None, function=None):
         action="store_true",
         dest="no_scripts",
     )
+    sub.add_argument(
+        "-P",
+        "--no-patches",
+        help="skip patches after installation",
+        action="store_true",
+        dest="no_patches",
+    )
 
     # Update parser
     info = "update dependencies to the latest versions"
@@ -158,6 +165,13 @@ def main(args=None, function=None):
         action="store_true",
         dest="no_scripts",
     )
+    sub.add_argument(
+        "-P",
+        "--no-patches",
+        help="skip patches after installation",
+        action="store_true",
+        dest="no_patches",
+    )
 
     # List parser
     info = "display the current version of each dependency"
@@ -277,6 +291,7 @@ def _get_command(function, namespace):
             clean=namespace.clean,
             skip_changes=namespace.skip_changes,
             skip_scripts=namespace.no_scripts,
+            skip_patches=namespace.no_patches,
         )
         if namespace.command == "install":
             kwargs.update(
@@ -350,6 +365,8 @@ def _run_command(function, args, kwargs):
     except exceptions.ScriptFailure as exception:
         _show_error(exception)
         exit_message = "Run again with '--force' to ignore script errors"
+    except exceptions.PatchFailure as exception:
+        _show_error(exception)
     except exceptions.InvalidConfig as exception:
         _show_error(exception)
         exit_message = "Adapt config and run again"

gitman/commands.py

@@ -62,6 +62,7 @@ def install(
     skip_changes=False,
     skip_default_group=False,
     skip_scripts=False,
+    skip_patches=False,
 ):
     """Install dependencies for a project.
 
@@ -70,17 +71,18 @@ def install(
     - `*names`: optional list of dependency directory names to filter on
     - `root`: specifies the path to the root working tree
     - `depth`: number of levels of dependencies to traverse
-    - `force`: indicates uncommitted changes can be overwritten and
-               script errors can be ignored
+    - `force`: indicates uncommitted changes can be overwritten,
+               script errors can be ignored and failed patches can be ignored
     - `force_interactive`: indicates uncommitted changes can be interactively
-    overwritten and script errors can be ignored
+    overwritten, script errors can be ignored and failed patches can be ignored
     - `fetch`: indicates the latest branches should always be fetched
     - `clean`: indicates untracked files should be deleted from dependencies
     - `skip_changes`: indicates dependencies with uncommitted changes
      should be skipped
     - `skip_default_group`: indicates default_group should be skipped if
      `*names` is empty
     - `skip_scripts`: indicates scripts should be skipped
+    - `skip_patches`: indicates patches should be skipped
     """
     log.info(
         "%sInstalling dependencies: %s",
@@ -115,6 +117,10 @@ def install(
         )
         count += _count  # type: ignore
 
+        if _count and not skip_patches:
+            common.show("Applying patches...", color="message", log=False)
+            common.newline()
+            config.apply_patches(*names, depth=depth, force=force)
         if _count and not skip_scripts:
             label = "nested scripts" if index else "scripts"
             common.show(f"Running {label}...", color="message", log=False)
@@ -137,6 +143,7 @@ def update(
     skip_changes=False,
     skip_default_group=False,
     skip_scripts=False,
+    skip_patches=False,
 ):
     """Update dependencies for a project.
 
@@ -157,6 +164,7 @@ def update(
     - `skip_default_group`: indicates default_group should be skipped if
      `*names` is empty
     - `skip_scripts`: indicates scripts should be skipped
+    - `skip_patches`: indicates patches should be skipped
     """
     log.info(
         "%s dependencies%s: %s",
@@ -201,6 +209,10 @@ def update(
                 skip_changes=skip_changes or force_interactive,
             )
 
+        if _count and not skip_patches:
+            common.show("Applying patches...", color="message", log=False)
+            common.newline()
+            config.apply_patches(*names, depth=depth, force=force)
         if _count and not skip_scripts:
             label = "nested scripts" if index else "scripts"
             common.show(f"Running {label}...", color="message", log=False)

gitman/exceptions.py

@@ -24,3 +24,7 @@ class UncommittedChanges(RuntimeError):
 
 class ScriptFailure(ShellError):
     """Raised when post-install script has a non-zero exit code."""
+
+
+class PatchFailure(ShellError):
+    """Raised when applying a patch has a non-zero exit code."""

gitman/git.py

@@ -37,7 +37,7 @@ def clone(
         user_params = []
 
     if type == "git-svn":
-        # just the preperation for the svn deep clone / checkout here
+        # just the preparation for the svn deep clone / checkout here
         # clone will be made in update function to simplify source.py).
         os.makedirs(path)
         return
@@ -78,6 +78,38 @@ def clone(
         git("clone", "--reference-if-able", reference, repo, normpath, *user_params)
 
 
+def create_branch_local(type, name: str, base_ref: str = "HEAD", recreate: bool = True):
+    """Create a local branch.
+
+    :param recreate: delete and create if already exists
+    """
+    if type == "git-svn":
+        return  # ignore creating branch in case of git-svn
+
+    assert type == "git"
+
+    # Check if branch exists and delete
+    if recreate and _local_branch_exists(name):
+        git("branch", "-D", name, _show=False)
+
+    # Create branch
+    git("branch", name, base_ref, _show=False)
+
+
+def checkout(type, branch_name: str):
+    """Checkout a specific branch.
+
+    :param branch_name: branch name for the checkout
+    """
+    if type == "git-svn":
+        return  # ignore checkout in the case of git-svn
+
+    assert type == "git"
+
+    # Checkout branch
+    git("checkout", branch_name)
+
+
 def is_sha(rev):
     """Heuristically determine whether a revision corresponds to a commit SHA.
 
@@ -152,7 +184,7 @@ def rebuild(type, repo):  # pylint: disable=unused-argument
 
     assert type == "git"
 
-    common.show("Rebuilding mising git repo...", color="message")
+    common.show("Rebuilding missing git repo...", color="message")
     git("init", _show=True)
     git("remote", "add", "origin", repo, _show=True)
     common.show("Rebuilt git repo...", color="message")
@@ -163,8 +195,7 @@ def changes(type, include_untracked=False, display_status=True, _show=False):
     status = False
 
     if type == "git-svn":
-        # ignore changes in case of git-svn
-        return status
+        return status  # ignore changes in case of git-svn
 
     assert type == "git"
 
@@ -194,6 +225,26 @@ def changes(type, include_untracked=False, display_status=True, _show=False):
     return status
 
 
+def am(patch, _skip=False):
+    """Apply a patch.
+
+    :param patch: the patch to be applied
+    :param _skip: skip patch if applying fails
+    """
+    try:
+        git("am", "--3way", patch, _show=True)
+    except ShellError as e:
+        if _skip:
+            # Check if current git am is stuck
+            rebase_dir = git("rev-parse", "--git-path", "rebase-apply", _show=False)
+            if rebase_dir and os.path.isdir(rebase_dir[0]):
+                try:
+                    git("am", "--skip", _show=True, _ignore=True)
+                except ShellError:
+                    pass
+        raise ShellError from e
+
+
 def update(
     type, repo, path, *, clean=True, fetch=False, rev=None
 ):  # pylint: disable=redefined-outer-name,unused-argument
@@ -241,14 +292,17 @@ def get_url(type):
     return git("config", "--get", "remote.origin.url", _show=False)[0]
 
 
-def get_hash(type, _show=False):
+def get_hash(type, short=False, _show=False):
     """Get the current working tree's hash."""
     if type == "git-svn":
         return "".join(filter(str.isdigit, gitsvn("info", _show=_show)[4]))
 
     assert type == "git"
-
-    return git("rev-parse", "HEAD", _show=_show, _stream=False)[0]
+    args = ["rev-parse"]
+    if short:
+        args.append("--short")
+    args.append("HEAD")
+    return git(*args, _show=_show, _stream=False)[0]
 
 
 def get_tag():
@@ -283,6 +337,15 @@ def get_object_rev(object_name):
     return commit_sha
 
 
+def _local_branch_exists(name) -> bool:
+    """Check if a local branch exists."""
+    try:
+        git("rev-parse", "--verify", name, _show=False)
+        return True
+    except ShellError:
+        return False
+
+
 def _get_sha_from_rev(rev):
     """Get a rev-parse string's hash."""
     if "@{" in rev:

gitman/models/config.py

@@ -187,6 +187,52 @@ def run_scripts(
 
         return count
 
+    @preserve_cwd
+    def apply_patches(
+        self,
+        *names: str,
+        depth: Optional[int] = None,
+        force: bool = False,
+    ) -> int:
+        """Apply patches for the specified dependencies."""
+        if depth == 0:
+            log.info("Skipped directory: %s", self.location_path)
+            return 0
+
+        sources = self._get_sources()
+        sources_filter = self._get_sources_filter(
+            *names, sources=sources, skip_default_group=False
+        )
+
+        shell.cd(self.location_path)
+        common.newline()
+        common.indent()
+
+        count = 0
+        for source in sources:
+            if source.name in sources_filter:
+                shell.cd(source.name)
+
+                config = load_config(search=False)
+                if config:
+                    common.indent()
+                    remaining_depth = None if depth is None else max(0, depth - 1)
+                    if remaining_depth:
+                        common.newline()
+                    count += config.apply_patches(depth=remaining_depth, force=force)
+                    common.dedent()
+
+                source.apply_patches(
+                    topdir=os.path.normpath(self.location_path), skip=force
+                )
+                count += 1
+
+                shell.cd(self.location_path, _show=False)
+
+        common.dedent()
+
+        return count
+
     @classmethod
     def _split_name_and_rev(cls, name_rev):
         true_name = name_rev

gitman/models/source.py

@@ -30,6 +30,7 @@ class Source:
     | `sparse_paths` | Controls partial checkout | No | `[]` |
     | `links` | Creates symlinks within a project | No | `[]` |
     | `scripts` | Shell commands to run after checkout | No | `[]` |
+    | `patches` | patches to be applied after checkout | No | `[]` |
 
     ### Params
 
@@ -62,6 +63,17 @@ class Source:
       - cabal install
     ```
 
+    ### Patches
+
+    Patches that are applied after checkout. For example:
+
+    ```
+    repo: "https://github.com/koalaman/shellcheck"
+    patches:
+      - patchdir/0001-add-something.patch
+      - patchdir/0002-add-more.patch
+    ```
+
     """
 
     repo: str = ""
@@ -74,6 +86,7 @@ class Source:
     links: List[Link] = field(default_factory=list)
 
     scripts: List[str] = field(default_factory=list)
+    patches: List[str] = field(default_factory=list)
 
     DIRTY = "<dirty>"
     UNKNOWN = "<unknown>"
@@ -235,6 +248,46 @@ def run_scripts(self, force: bool = False, show_shell_stdout: bool = False):
                     raise exceptions.ScriptFailure(msg)
         common.newline()
 
+    def apply_patches(self, topdir: str, skip: bool = False):
+        log.info("Applying patches...")
+
+        # Enter the working tree
+        if not git.valid():
+            raise self._invalid_repository
+
+        # Check for patches
+        if not self.patches or not self.patches[0]:
+            common.show("(no patches to apply)", color="shell_info")
+            common.newline()
+            return
+
+        # Create a branch from the current hash to apply patches
+        try:
+            hash = git.get_hash(self.type, short=True, _show=False)
+            patched_branch = hash + "-patched"
+            git.create_branch_local(self.type, patched_branch)
+            git.checkout(self.type, patched_branch)
+            log.info("Working on local branch{} for patching.".format(patched_branch))
+        except exceptions.ShellError as exc:
+            msg = "Patch preparation failed! Could not create branch {}".format(
+                patched_branch
+            )
+            raise exceptions.PatchFailure(msg) from exc
+
+        # Apply all patches
+        for patch in self.patches:
+            try:
+                # Convert patch to absolute path
+                patch_path = os.path.abspath(os.path.join(topdir, patch))
+                git.am(patch_path, skip)
+            except exceptions.ShellError as exc:
+                if skip:
+                    log.debug("Ignored error from patch '%s'", patch)
+                else:
+                    msg = "Failed to apply patch '{}' in {}".format(patch, os.getcwd())
+                    raise exceptions.PatchFailure(msg) from exc
+        common.newline()
+
     def identify(
         self,
         allow_dirty: bool = True,
@@ -318,6 +371,7 @@ def lock(
             rev=rev,
             links=self.links,
             scripts=self.scripts,
+            patches=self.patches,
             sparse_paths=self.sparse_paths,
         )
         return source