batchfetch 1.1.9__tar.gz → 1.2.1__tar.gz

batchfetch-1.2.1/.gitignore

@@ -0,0 +1,138 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/

{batchfetch-1.1.9 → batchfetch-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.1.9
+Version: 1.2.1
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -57,12 +57,12 @@ tasks:
   # Clone the tag 1.5 of the consult repository to the './consult'
   # directory
   - git: https://github.com/minad/consult
-    reference: "1.5"
+    revision: "1.5"
 
   # Clone the s.el repository to the './another-name.el' directory
   - git: https://github.com/magnars/s.el
     path: another-name.el
-    reference: dda84d38fffdaf0c9b12837b504b402af910d01d
+    revision: dda84d38fffdaf0c9b12837b504b402af910d01d
 
   # Delete './impatient-mode'
   - git: https://github.com/skeeto/impatient-mode

{batchfetch-1.1.9 → batchfetch-1.2.1}/README.md

@@ -37,12 +37,12 @@ tasks:
   # Clone the tag 1.5 of the consult repository to the './consult'
   # directory
   - git: https://github.com/minad/consult
-    reference: "1.5"
+    revision: "1.5"
 
   # Clone the s.el repository to the './another-name.el' directory
   - git: https://github.com/magnars/s.el
     path: another-name.el
-    reference: dda84d38fffdaf0c9b12837b504b402af910d01d
+    revision: dda84d38fffdaf0c9b12837b504b402af910d01d
 
   # Delete './impatient-mode'
   - git: https://github.com/skeeto/impatient-mode

{batchfetch-1.1.9 → batchfetch-1.2.1}/batchfetch/batchfetch_git.py

@@ -32,8 +32,8 @@ from .batchfetch_base import BatchFetchError, TaskBatchFetch
 from .helpers import run_simple
 
 
-class GitReferenceDoesNotExist(Exception):
-    """The Git reference does not exist."""
+class GitRevisionDoesNotExist(Exception):
+    """The Git revision does not exist."""
 
 
 class GitRemoteError(Exception):
@@ -58,6 +58,7 @@ class BatchFetchGit(TaskBatchFetch):
         self.task_schema.update({
             # Local options
             self.main_key: str,
+            Optional("revision"): str,
             Optional("reference"): str,
 
             # Same as global options
@@ -77,7 +78,7 @@ class BatchFetchGit(TaskBatchFetch):
 
         self.task_default_values.update({
             self.main_key: "",
-            "reference": "",
+            "revision": "",
             "delete": False,
         })
 
@@ -100,6 +101,11 @@ class BatchFetchGit(TaskBatchFetch):
         """Clone or update a Git repository."""
         super().update()
 
+        # Backward compatibility
+        if "reference" in self._item_values \
+                and "revision" not in self._item_values:
+            self._item_values["revision"] = "reference"
+
         is_clone = False
         if not self.git_local_dir.exists():
             is_clone = True
@@ -113,8 +119,8 @@ class BatchFetchGit(TaskBatchFetch):
             update_type = "UPDATE"
 
         self.add_output(f"[GIT {update_type}] {self[self.main_key]}" +
-                        (f" (Ref: {self['reference']})"
-                         if self["reference"] else "") + "\n")
+                        (f" (Ref: {self['revision']})"
+                         if self["revision"] else "") + "\n")
 
         try:
             # Delete
@@ -160,7 +166,7 @@ class BatchFetchGit(TaskBatchFetch):
         return self.values
 
     def _git_ref(self, cwd: Union[None, Path] = None) -> str:
-        """Get the commit reference of HEAD.
+        """Get the commit revision of HEAD.
 
         The command will fail if the branch is detached.
         """
@@ -191,11 +197,11 @@ class BatchFetchGit(TaskBatchFetch):
                 # 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"] +
+                # <tagname>^{commit}` allows getting the right revision.
+                commit_ref = self._git_tags(self["revision"] +
                                             "^{commit}")[0]
                 self.branch_commit_ref = commit_ref.strip()
-            except GitReferenceDoesNotExist:
+            except GitRevisionDoesNotExist:
                 pass
 
     def _repo_delete(self):
@@ -235,21 +241,21 @@ class BatchFetchGit(TaskBatchFetch):
         do_git_pull = self["git_pull"]
         if self.is_branch:
             do_git_pull = True
-        elif not self["reference"]:
+        elif not self["revision"]:
             do_git_pull = True
             self.add_output(self.indent_spaces +
                             "[INFO] Git fetch origin reason: " +
-                            "No 'reference:' specified\n")
+                            "No 'revision:' specified\n")
         else:
             do_git_pull = False
             commit_ref = None
 
             try:
-                # Check if the reference such as
+                # Check if the revision such as
                 # 0560fe21d1173b2221fd8c600fab818f7eecbad4 exist
-                commit_ref = self._git_tags(self["reference"])[0]
+                commit_ref = self._git_tags(self["revision"])[0]
                 commit_ref = commit_ref.strip()
-            except GitReferenceDoesNotExist:
+            except GitRevisionDoesNotExist:
                 pass
 
             if not commit_ref and not self.is_branch:
@@ -257,19 +263,19 @@ class BatchFetchGit(TaskBatchFetch):
                 self.add_output(
                     self.indent_spaces +
                     "[INFO] Git fetch origin reason: " +
-                    f"The reference does not exist: {self['reference']}" +
+                    f"The revision does not exist: {self['revision']}" +
                     "\n")
 
             if not do_git_pull:
                 try:
                     # Check if the branch is a tag or a branch
                     cmd = ["git", "show-ref", "--verify", "--quiet",
-                           f"refs/heads/{self['reference']}"]
+                           f"refs/heads/{self['revision']}"]
                     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" +
+                        f"{self['revision']} is a branch, not a tag" +
                         "\n")
                     do_git_pull = True
                 except subprocess.CalledProcessError:
@@ -282,14 +288,14 @@ class BatchFetchGit(TaskBatchFetch):
                     # 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.
+                    # revision.
                     commit_ref_head = self._git_tags("HEAD^{commit}")[0]
                     commit_ref_head = commit_ref_head.strip()
-                except GitReferenceDoesNotExist:
+                except GitRevisionDoesNotExist:
                     # HEAD is detached
                     commit_ref_head = None
 
-                # The wanted commit reference does not exist
+                # The wanted commit revision 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(
@@ -395,46 +401,46 @@ class BatchFetchGit(TaskBatchFetch):
             error = True
 
         if error:
-            raise GitReferenceDoesNotExist(
-                f"The reference '{branch}' does not exist.")
+            raise GitRevisionDoesNotExist(
+                f"The revision '{branch}' does not exist.")
 
         return stdout
 
     def _repo_fix_branch(self) -> bool:
         git_ref_after_merge = self._git_ref(cwd=self.git_local_dir)
         branch_changed = False
-        if self["reference"]:
+        if self["revision"]:
             # We also need tags because sometimes, a branch
-            # returns a different commit reference
+            # returns a different commit revision
             git_tags, _ = run_simple(
                 ["git", "tag", "--points-at", "HEAD"],
                 env=self.env,
                 cwd=self.git_local_dir,
             )
 
-            # Also check the commit reference in case
-            # branch is a commit reference instead of a tag
+            # Also check the commit revision in case
+            # branch is a commit revision instead of a tag
             try:
                 # Check if the branch exists
                 git_ref_branch = self._git_tags("origin/" +
-                                                self["reference"] +
+                                                self["revision"] +
                                                 "^{commit}")[0]
-            except GitReferenceDoesNotExist as err:
+            except GitRevisionDoesNotExist:
                 # Check if the commit ref exists
                 try:
-                    git_ref_branch = self._git_tags(self["reference"])[0]
-                except GitReferenceDoesNotExist as err:
-                    raise BatchFetchError(f"The branch '{self['reference']}' "
+                    git_ref_branch = self._git_tags(self["revision"])[0]
+                except GitRevisionDoesNotExist as err:
+                    raise BatchFetchError(f"The branch '{self['revision']}' "
                                           "does not exist.") from err
 
             if git_ref_after_merge != git_ref_branch and \
-                    self["reference"] not in git_tags:
+                    self["revision"] not in git_tags:
                 # Update the branch
-                self._run(["git", "checkout"] + [self["reference"]],
+                self._run(["git", "checkout"] + [self["revision"]],
                           cwd=str(self.git_local_dir), env=self.env)
                 self.add_output(self.indent_spaces +
                                 "[INFO] Branch changed to " +
-                                self["reference"] + "\n")
+                                self["revision"] + "\n")
                 self.set_changed(True)
                 branch_changed = True
 
@@ -460,7 +466,7 @@ class BatchFetchGit(TaskBatchFetch):
         # 3. It does not directly consult the upstream repositories
         # of the submodules.
         # 4. Submodules are updated to reflect the exact commits
-        # referenced in the parent repository's configuration,
+        # revision in the parent repository's configuration,
         # potentially lagging behind the latest changes made in the
         # upstream repositories.
         if self.git_local_dir.joinpath(".gitmodules").is_file():

{batchfetch-1.1.9 → batchfetch-1.2.1}/batchfetch.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.1.9
+Version: 1.2.1
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -57,12 +57,12 @@ tasks:
   # Clone the tag 1.5 of the consult repository to the './consult'
   # directory
   - git: https://github.com/minad/consult
-    reference: "1.5"
+    revision: "1.5"
 
   # Clone the s.el repository to the './another-name.el' directory
   - git: https://github.com/magnars/s.el
     path: another-name.el
-    reference: dda84d38fffdaf0c9b12837b504b402af910d01d
+    revision: dda84d38fffdaf0c9b12837b504b402af910d01d
 
   # Delete './impatient-mode'
   - git: https://github.com/skeeto/impatient-mode

{batchfetch-1.1.9 → batchfetch-1.2.1}/batchfetch.egg-info/SOURCES.txt

@@ -1,5 +1,7 @@
+.gitignore
 LICENSE
 README.md
+run_tests.sh
 setup.py
 batchfetch/__init__.py
 batchfetch/batchfetch_base.py
@@ -11,4 +13,7 @@ batchfetch.egg-info/SOURCES.txt
 batchfetch.egg-info/dependency_links.txt
 batchfetch.egg-info/entry_points.txt
 batchfetch.egg-info/requires.txt
-batchfetch.egg-info/top_level.txt
+batchfetch.egg-info/top_level.txt
+tests/test_helpers.py
+tests/data/test-md5sum.txt
+tests/data/test-run_simple.sh

batchfetch-1.2.1/run_tests.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+#
+# 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
+# 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.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <https://www.gnu.org/licenses/>.
+#
+cd "$(dirname "${BASH_SOURCE[0]}")"
+export PYTHONPATH="$(pwd)"
+exec pytest -v -v --cov=batchfetch --cov=tests \
+  --cov-report=term \
+  --cov-report=html:htmlcov \
+  tests/test_*py

{batchfetch-1.1.9 → batchfetch-1.2.1}/setup.py

@@ -22,7 +22,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="batchfetch",
-    version="1.1.9",
+    version="1.2.1",
     packages=find_packages(),
     description="Efficiently clone and pull multiple Git repositories.",
     license="GPLv3",

batchfetch-1.2.1/tests/data/test-md5sum.txt

@@ -0,0 +1,3 @@
+Test 1.
+Test 2.
+Test 3.

batchfetch-1.2.1/tests/data/test-run_simple.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+cd "$(dirname "${BASH_SOURCE[0]}")"
+cat ./test-md5sum.txt
+cat ./test-md5sum.txt | tail -n 1 >&2

batchfetch-1.2.1/tests/test_helpers.py

@@ -0,0 +1,56 @@
+#!/usr/bin/env python
+#
+# 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
+# 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.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <https://www.gnu.org/licenses/>.
+#
+"""Unit tests."""
+
+from pathlib import Path
+
+from batchfetch import helpers
+
+DATA_PATH = Path(".").joinpath("tests", "data").absolute()
+SCRIPT_RUN_SIMPLE = DATA_PATH / "test-run_simple.sh"
+TEST_MD5SUM_FILE = DATA_PATH / "test-md5sum.txt"
+
+
+def test_md5sum():
+    md5sum = helpers.md5sum(TEST_MD5SUM_FILE)
+    assert md5sum == "f31e127edc87a6aa2eb01b7d94d2ec58"
+
+
+def test_run_simple():
+    # Stdout
+    stdout_lines, stderr_lines = helpers.run_simple(str(SCRIPT_RUN_SIMPLE))
+    assert stdout_lines == ['Test 1.',
+                            'Test 2.',
+                            'Test 3.']
+    assert stderr_lines == ['Test 3.']
+
+
+def test_indent_raw_output():
+    list_str = \
+        helpers.indent_raw_output(["Test 1.", "Test 2."])
+
+    assert list_str == ["    Test 1.", "    Test 2."]
+
+
+def test_run_indent():
+    stdout_lines, stderr_lines = helpers.run_indent(str(SCRIPT_RUN_SIMPLE))
+    assert stdout_lines == [f'    [RUN] {str(SCRIPT_RUN_SIMPLE)}',
+                            '    Test 1.',
+                            '    Test 2.',
+                            '    Test 3.']
+    assert stderr_lines == ['    Test 3.']