batchfetch 1.1.1__tar.gz → 1.1.3__tar.gz

{batchfetch-1.1.1/batchfetch.egg-info → batchfetch-1.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.1.1
+Version: 1.1.3
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -95,7 +95,7 @@ options:
 
 ## License
 
-Copyright (c) [James Cherti](https://www.jamescherti.com)
+Copyright (C) 2024 [James Cherti](https://www.jamescherti.com)
 
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 

{batchfetch-1.1.1 → batchfetch-1.1.3}/README.md

@@ -71,7 +71,7 @@ options:
 
 ## License
 
-Copyright (c) [James Cherti](https://www.jamescherti.com)
+Copyright (C) 2024 [James Cherti](https://www.jamescherti.com)
 
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 

{batchfetch-1.1.1 → batchfetch-1.1.3}/batchfetch/__init__.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright (c) James Cherti
+# Copyright (C) 2024 James Cherti
 # URL: https://github.com/jamescherti/batchfetch
 #
 # This program is free software: you can redistribute it and/or modify it under

{batchfetch-1.1.1 → batchfetch-1.1.3}/batchfetch/batchfetch_base.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright (c) James Cherti
+# Copyright (C) 2024 James Cherti
 # URL: https://github.com/jamescherti/batchfetch
 #
 # This program is free software: you can redistribute it and/or modify it under
@@ -58,7 +58,7 @@ class TaskBase:
 
         # Options
         self.options = {}
-        self.options.update(deepcopy(self.global_options_values))  # Default
+        self.options.update(deepcopy(self.global_options_values))
         self.options.update(deepcopy(self._item_options))
         schema = Schema(self.global_options_schema)
         schema.validate(self.options)
@@ -94,7 +94,7 @@ class TaskBase:
         raise KeyError(f"The item '{key}' was not found in '{self.values}")
 
 
-class BatchFetchBase(TaskBase):
+class TaskBatchFetch(TaskBase):
     """Plugin downloader base class."""
 
     def __init__(self, data: Dict[str, Any], options: Dict[str, Any]):

{batchfetch-1.1.1 → batchfetch-1.1.3}/batchfetch/batchfetch_cli.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright (c) James Cherti
+# Copyright (C) 2024 James Cherti
 # URL: https://github.com/jamescherti/batchfetch
 #
 # This program is free software: you can redistribute it and/or modify it under
@@ -33,7 +33,7 @@ from colorama import Fore
 from schema import Optional, Or, Schema, SchemaError
 from setproctitle import setproctitle
 
-from .batchfetch_base import BatchFetchBase, BatchFetchError
+from .batchfetch_base import BatchFetchError, TaskBatchFetch
 from .batchfetch_git import BatchFetchGit
 
 
@@ -51,7 +51,7 @@ class BatchFetchCli:
 
         # Plugin
         self.batchfetch_schemas: Dict[Any, Any] = {}
-        self.batchfetch_classes: Dict[str, BatchFetchBase] = {}
+        self.batchfetch_classes: Dict[str, TaskBatchFetch] = {}
         self.cfg_schema: Dict[Any, Any] = {}
         self._plugin_add("git", BatchFetchGit)
 
@@ -216,8 +216,11 @@ def parse_args():
     usage = "%(prog)s [--option] [args]"
     parser = argparse.ArgumentParser(description=desc, usage=usage)
 
-    parser.add_argument("batchfetch_files", metavar="N", type=str, nargs="*",
-                        help=("Specify the batchfetch YAML file(s) "
+    parser.add_argument("-f",
+                        "--file",
+                        default=None,
+                        required=False,
+                        help=("Specify the batchfetch YAML file "
                               "(default: './batchfetch.yaml')."))
 
     parser.add_argument(
@@ -231,24 +234,24 @@ def parse_args():
     )
 
     args = parser.parse_args()
-    if not args.batchfetch_files:
-        args.batchfetch_files = ["./batchfetch.yaml"]
 
-    for batchfetch_file in args.batchfetch_files:
-        if not Path(batchfetch_file).is_file():
-            print(f"Error: File not found: {batchfetch_file}",
-                  file=sys.stderr)
-            sys.exit(1)
+    if not args.file:
+        args.file = "./batchfetch.yaml"
+
+    if not Path(args.file).is_file():
+        print(f"Error: File not found: {args.file}",
+              file=sys.stderr)
+        sys.exit(1)
 
     return args
 
 
-def run_batchfetch_procedure(batchfetch_file: Path, args) -> int:
+def run_batchfetch_procedure(file: Path, args) -> int:
     errno = 0
     batchfetch_cli = BatchFetchCli(verbose=args.verbose,
                                    max_workers=int(args.jobs))
-    batchfetch_cli.load(batchfetch_file)
-    os.chdir(batchfetch_file.parent)
+    batchfetch_cli.load(file)
+    os.chdir(file.parent)
 
     try:
         if not batchfetch_cli.run_tasks():
@@ -276,14 +279,15 @@ def command_line_interface():
 
         args = parse_args()
         done = []
-        for batchfetch_file in args.batchfetch_files:
-            batchfetch_file = Path(batchfetch_file)
-            batchfetch_file_resolved = batchfetch_file.resolve()
-            if batchfetch_file_resolved in done:
-                continue
-
-            done.append(batchfetch_file_resolved)
-            errno |= run_batchfetch_procedure(batchfetch_file, args)
+        file = Path(args.file)
+        file_resolved = file.resolve()
+        if not file_resolved:
+            print(f"Error: cannot resolve the path {file}",
+                  file=sys.stderr)
+            sys.exit(1)
+
+        done.append(file_resolved)
+        errno |= run_batchfetch_procedure(file, args)
 
         sys.exit(errno)
     except BrokenPipeError:

{batchfetch-1.1.1 → batchfetch-1.1.3}/batchfetch/batchfetch_git.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright (c) James Cherti
+# Copyright (C) 2024 James Cherti
 # URL: https://github.com/jamescherti/batchfetch
 #
 # This program is free software: you can redistribute it and/or modify it under
@@ -28,18 +28,24 @@ from typing import List, Union
 
 from schema import Optional
 
-from .batchfetch_base import BatchFetchBase, BatchFetchError
+from .batchfetch_base import BatchFetchError, TaskBatchFetch
 from .helpers import run_simple
 
 
 class GitReferenceDoesNotExist(Exception):
-    """Exception raised by Name()."""
+    """The Git reference does not exist."""
 
 
-class BatchFetchGit(BatchFetchBase):
+class GitRemoteError(Exception):
+    """The git remote does not exist."""
+
+
+class BatchFetchGit(TaskBatchFetch):
     """Clone or update a Git repository."""
 
     def __init__(self, *args, **kwargs):
+        self._git_fetch_origin_done = False
+
         super().__init__(*args, **kwargs)
         self.env["GIT_TERMINAL_PROMPT"] = "0"
         self.env["GIT_PAGER"] = ""
@@ -87,25 +93,11 @@ class BatchFetchGit(BatchFetchBase):
                 posixpath.basename(
                     self.values[self.main_key])  # type: ignore
 
-    def _git_ref(self, cwd: Union[None, Path] = None) -> str:
-        """Get the commit reference of HEAD.
-
-        The command will fail if the branch is detached.
-        """
-        cmd = ["git", "show-ref", "--head", "--verify", "HEAD"]
-        try:
-            stdout, _ = run_simple(cmd, cwd=cwd, env=self.env)
-            output = stdout[0].split(" ")[0]
-        except IndexError:
-            return ""
-        return output
-
     def update(self):
         """Clone or update a Git repository."""
         super().update()
 
         is_clone = False
-
         if not self.git_local_dir.exists():
             is_clone = True
 
@@ -117,16 +109,15 @@ class BatchFetchGit(BatchFetchBase):
         else:
             update_type = "UPDATE"
 
-        self.add_output(
-            f"[GIT {update_type}] {self[self.main_key]}" +
-            (f" (Ref: {self['reference']})"
-             if self["reference"] else "") + "\n"
-        )
+        self.add_output(f"[GIT {update_type}] {self[self.main_key]}" +
+                        (f" (Ref: {self['reference']})"
+                         if self["reference"] else "") + "\n")
 
         try:
             # Delete
             if self["delete"]:
                 self._repo_delete()
+
             # Clone
             elif is_clone:
                 self._repo_clone()
@@ -134,10 +125,10 @@ class BatchFetchGit(BatchFetchBase):
             # Update
             if self.git_local_dir.is_dir():
                 # Pre exec
+                self._update_current_branch()
+                self._repo_fix_remote_origin()
                 self._run_pre_exec(cwd=self.git_local_dir)
 
-                self._repo_check_remote_origin()
-                self._update_current_branch()
                 self._repo_reset()
 
                 git_merge_done = self._repo_pull()
@@ -163,14 +154,28 @@ class BatchFetchGit(BatchFetchBase):
 
         return self.values
 
+    def _git_ref(self, cwd: Union[None, Path] = None) -> str:
+        """Get the commit reference of HEAD.
+
+        The command will fail if the branch is detached.
+        """
+        cmd = ["git", "show-ref", "--head", "--verify", "HEAD"]
+        try:
+            stdout, _ = run_simple(cmd, cwd=cwd, env=self.env)
+            output = stdout[0].split(" ")[0]
+        except IndexError:
+            return ""
+        return output
+
     def _update_current_branch(self):
         try:
-            self.current_branch, _ = run_simple(
+            stdout, _ = run_simple(
                 ["git", "symbolic-ref", "--short", "HEAD"],
                 env=self.env,
                 cwd=self.git_local_dir,
             )
-        except subprocess.CalledProcessError:
+            self.current_branch = stdout[0]
+        except (IndexError, subprocess.CalledProcessError):
             # Not a symbolic ref
             self.current_branch = None
 
@@ -209,47 +214,91 @@ class BatchFetchGit(BatchFetchBase):
 
         # Merge
         do_git_pull = self["git_pull"]
-        if self["reference"]:
+        if not self["reference"]:
+            self.add_output(
+                self.indent_spaces +
+                "[INFO] Git fetch origin reason: " +
+                f"No 'reference:' specified." +
+                "\n")
+        else:
             do_git_pull = False
             commit_ref = None
 
             try:
-                # Returns the commit ref of the branch or commit
-                #
-                # If the tag is annotated, it points to a tag object, not
-                # directly to a commit. You need to resolve it to the commit it
-                # points to. Using `git rev-parse <tagname>^{commit}` allows
-                # getting the right reference.
-                commit_ref = self._git_tags(self["reference"] + "^{commit}")[0]
+                # Check if the reference such as
+                # 0560fe21d1173b2221fd8c600fab818f7eecbad4 exist
+                commit_ref = self._git_tags(self["reference"])[0]
+                commit_ref = commit_ref.strip().lower()
             except GitReferenceDoesNotExist:
-                # The wanted reference does not exist. We should git pull in
-                # case we can get the reference
-                do_git_pull = True
-            else:  # The reference exists
+                pass
+
+            if not commit_ref:
                 try:
                     # If the tag is annotated, it points to a tag object, not
                     # directly to a commit. You need to resolve it to the
                     # commit it points to. Using `git rev-parse
                     # <tagname>^{commit}` allows getting the right reference.
-                    commit_ref_head = self._git_tags("HEAD^{commit}")[0]
+                    commit_ref = self._git_tags("origin/" + self["reference"] +
+                                                "^{commit}")[0]
+                    commit_ref = commit_ref.strip().lower()
                 except GitReferenceDoesNotExist:
-                    # HEAD is detached
-                    commit_ref_head = None
-
-                # The wanted commit reference does not exist
-                # Or the commit ref of HEAD hasn't changed
-                if commit_ref and commit_ref_head == commit_ref:
-                    do_git_pull = False
-                else:
+                    # The branch does not exist. We should git pull in case we
+                    # can get the reference
                     do_git_pull = True
+                    self.add_output(
+                        self.indent_spaces +
+                        "[INFO] Git fetch origin reason:" +
+                        f"The reference does not exist: {self['reference']}" +
+                        "\n")
+
+
+                if not do_git_pull:
+                    # Check if it is a branch or a tag such as 1.1.3
+                    is_tag = False
+                    try:
+                        # Check if the branch is a tag or a branch
+                        cmd = ["git", "show-ref", "--verify", "--quiet",
+                               f"refs/heads/{self['reference']}"]
+                        run_simple(cmd, env=self.env, cwd=self.git_local_dir)
+                        self.add_output(
+                            self.indent_spaces +
+                            "[INFO] Git fetch origin reason:" +
+                            f"{self['reference']} is a branch, not a tag" +
+                            "\n")
+                        do_git_pull = True
+                    except subprocess.CalledProcessError:
+                        pass
+
+            # if not do_git_pull:
+            #     try:
+            #         # If the tag is annotated, it points to a tag object,
+            #         # not directly to a commit. You need to resolve it to
+            #         # the commit it points to. Using `git rev-parse
+            #         # <tagname>^{commit}` allows getting the right
+            #         # reference.
+            #         commit_ref_head = self._git_tags("HEAD^{commit}")[0]
+            #         commit_ref_head = commit_ref_head.strip().lower()
+            #     except GitReferenceDoesNotExist:
+            #         # HEAD is detached
+            #         commit_ref_head = None
+            #
+            #     # The wanted commit reference does not exist
+            #     # Or the commit ref of HEAD hasn't changed
+            #     if not commit_ref_head or commit_ref_head != commit_ref:
+            #         self.add_output(
+            #             self.indent_spaces +
+            #             "[INFO] Git fetch origin reason: "
+            #             f"Commit ref head '{commit_ref_head}' != "
+            #             f"commit ref '{commit_ref_head}'"
+            #             "\n")
+            #         do_git_pull = True
 
         if not do_git_pull:
             self.add_output(self.indent_spaces + "[INFO] git pull ignored\n")
             return git_merge
 
         # Fetch
-        cmd = ["git", "fetch", "origin"]
-        self._run(cmd, cwd=str(self.git_local_dir), env=self.env)
+        self._git_fetch_origin()
 
         # Merge
         real_branch = self._git_is_local_branch("HEAD")
@@ -271,6 +320,44 @@ class BatchFetchGit(BatchFetchBase):
 
         return git_merge
 
+    def _git_get_remote_url(self, remote_name: str = "origin") -> str:
+        origin_url = ""
+        try:
+            stdout, _ = run_simple(["git", "config",
+                                    f"remote.{remote_name}.url"],
+                                   env=self.env,
+                                   cwd=self.git_local_dir)
+            origin_url = stdout[0]
+        except (subprocess.CalledProcessError, IndexError) as err:
+            raise GitRemoteError(
+                f"Failed to get the Git remote url: {remote_name}") from err
+
+        return origin_url
+
+    def _git_set_remote_url(self, url: str,
+                            remote_name: str = "origin") -> str:
+        origin_url = ""
+        try:
+            run_simple(["git", "remote", "remove", remote_name],
+                       env=self.env, cwd=self.git_local_dir)
+        except subprocess.CalledProcessError:
+            # Ignore when it cannot be removed when it does not exist
+            pass
+
+        try:
+            stdout, _ = run_simple(
+                ["git", "remote", "add", remote_name, url],
+                env=self.env,
+                cwd=self.git_local_dir,
+            )
+            origin_url = stdout[0]
+        except (subprocess.CalledProcessError, IndexError) as err:
+            raise GitRemoteError(
+                f"Failed to modify the Git remote url: {remote_name}") \
+                from err
+
+        return origin_url
+
     def _git_is_local_branch(self, branch: str) -> bool:
         try:
             stdout, _ = run_simple(["git", "rev-parse", "--symbolic-full-name",
@@ -290,13 +377,19 @@ class BatchFetchGit(BatchFetchBase):
 
     def _git_tags(self, branch: str) -> List[str]:
         stdout: List[str] = []
+        error = False
         try:
             stdout, _ = run_simple(["git", "rev-parse", "--verify", branch],
                                    env=self.env,
                                    cwd=self.git_local_dir)
-        except subprocess.CalledProcessError as err:
+            if not stdout:
+                error = True
+        except subprocess.CalledProcessError:
+            error = True
+
+        if error:
             raise GitReferenceDoesNotExist(
-                f"The reference '{branch}' does not exist.") from err
+                f"The reference '{branch}' does not exist.")
 
         return stdout
 
@@ -337,6 +430,13 @@ class BatchFetchGit(BatchFetchBase):
 
         return branch_changed
 
+    def _git_fetch_origin(self):
+        # Fetch
+        if not self._git_fetch_origin_done:
+            cmd = ["git", "fetch", "origin"]
+            self._run(cmd, cwd=str(self.git_local_dir), env=self.env)
+            self._git_fetch_origin_done = True
+
     def _repo_update_submodules(self):
         # This parameter instructs Git to initiate the update
         # process for submodules:
@@ -354,21 +454,41 @@ class BatchFetchGit(BatchFetchBase):
             cmd = ["git", "submodule", "update", "--recursive"]
             self._run(cmd, cwd=str(self.git_local_dir), env=self.env)
 
-    def _repo_check_remote_origin(self):
-        cmd = ["git", "config", "remote.origin.url"]
+    def _repo_fix_remote_origin(self):
+        correct_origin_url = self[self.main_key]
+        update_remote_origin = False
+
         try:
-            stdout, _ = run_simple(cmd,
-                                   env=self.env,
-                                   cwd=self.git_local_dir)
-            origin_url = stdout[0]
-        except IndexError:
-            origin_url = ""
+            origin_url = self._git_get_remote_url()
+            if origin_url != correct_origin_url:
+                update_remote_origin = True
+        except GitRemoteError:
+            update_remote_origin = True
+
+        if update_remote_origin:
+            # Update remote
+            try:
+                self._git_set_remote_url(correct_origin_url)
+            except GitRemoteError:
+                # TODO handle errors
+                return
 
-        if origin_url != self[self.main_key]:
-            self.set_error(True)
-            self.add_output(
-                self.indent_spaces +
-                "[ERROR] The Git remote origin URL is incorrect: "
-                f"'{origin_url}' (It is supposed to "
-                f"be '{self[self.main_key]}')\n")
-            raise BatchFetchError
+            # Get the current branch
+            if self.current_branch:
+                try:
+                    self.add_output(
+                        self.indent_spaces +
+                        "[INFO] Git fetch origin reason: "
+                        f"we need to set the upstream "
+                        f"origin to {self.current_branch}"
+                        "\n"
+                    )
+                    self._git_fetch_origin()
+
+                    cmd = ["git", "branch",
+                        f"--set-upstream-to=origin/{self.current_branch}"]
+                    _, _ = run_simple(cmd, env=self.env,
+                                      cwd=self.git_local_dir)
+                    # TODO: handle errors
+                except subprocess.CalledProcessError as err:
+                    raise BatchFetchError(str(err)) from err

{batchfetch-1.1.1 → batchfetch-1.1.3}/batchfetch/helpers.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright (c) James Cherti
+# Copyright (C) 2024 James Cherti
 # URL: https://github.com/jamescherti/batchfetch
 #
 # This program is free software: you can redistribute it and/or modify it under

{batchfetch-1.1.1 → batchfetch-1.1.3/batchfetch.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.1.1
+Version: 1.1.3
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -95,7 +95,7 @@ options:
 
 ## License
 
-Copyright (c) [James Cherti](https://www.jamescherti.com)
+Copyright (C) 2024 [James Cherti](https://www.jamescherti.com)
 
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 

{batchfetch-1.1.1 → batchfetch-1.1.3}/run_tests.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 #
-# Copyright (c) James Cherti
+# Copyright (C) 2024 James Cherti
 # URL: https://github.com/jamescherti/batchfetch
 #
 # This program is free software: you can redistribute it and/or modify it under

{batchfetch-1.1.1 → batchfetch-1.1.3}/setup.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright (c) James Cherti
+# Copyright (C) 2024 James Cherti
 # URL: https://github.com/jamescherti/batchfetch
 #
 # This program is free software: you can redistribute it and/or modify it under
@@ -22,7 +22,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="batchfetch",
-    version="1.1.1",
+    version="1.1.3",
     packages=find_packages(),
     description="Efficiently clone and pull multiple Git repositories.",
     license="GPLv3",

{batchfetch-1.1.1 → batchfetch-1.1.3}/tests/test_helpers.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 #
-# Copyright (c) James Cherti
+# Copyright (C) 2024 James Cherti
 # URL: https://github.com/jamescherti/batchfetch
 #
 # This program is free software: you can redistribute it and/or modify it under