Add git utility class & test

Author: ArBridgeman

exasol/toolbox/util/git.py

@@ -0,0 +1,46 @@
+import subprocess
+from functools import wraps
+from pathlib import Path
+
+
+def run_command(func):
+    @wraps(func)
+    def wrapper(*args, **kwargs) -> str:
+        command_list = func(*args, **kwargs).split()
+        output = subprocess.run(
+            command_list, capture_output=True, text=True, check=True
+        )
+        return output.stdout.strip()
+
+    return wrapper
+
+
+class Git:
+    @staticmethod
+    @run_command
+    def get_latest_tag() -> str:
+        """
+        Get the latest tag from the git repository.
+        """
+        return "git describe --tags --abbrev=0"
+
+    @staticmethod
+    @run_command
+    def read_file_from_tag(tag: str, remote_file: str) -> str:
+        """
+        Read the contents of the specified file `remote_file` at the point in time
+        specified by git tag `tag`.
+        """
+        return f"git cat-file blob {tag}:{remote_file}"
+
+    @staticmethod
+    def copy_remote_file_locally(
+        tag: str, remote_file: str, destination_directory: Path
+    ) -> None:
+        """
+        Copy the contents of the specified file `remote_file` at the point in time
+        specified by git tag `tag` and copy it into the local `destination_directory/remote_file`.
+        """
+        contents = Git.read_file_from_tag(tag=tag, remote_file=remote_file)
+        destination_filepath = destination_directory / remote_file
+        destination_filepath.write_text(contents)

test/unit/util/git_test.py

@@ -0,0 +1,38 @@
+import pytest
+from packaging.version import Version
+from toolbox.util.git import Git
+
+POETRY_LOCK = "poetry.lock"
+
+
+@pytest.fixture(scope="module")
+def latest_tag() -> str:
+    return Git.get_latest_tag()
+
+
+@pytest.fixture(scope="module")
+def read_file_from_tag(latest_tag) -> str:
+    return Git.read_file_from_tag(tag=latest_tag, remote_file=POETRY_LOCK)
+
+
+class TestGit:
+    @staticmethod
+    def test_latest_tag(latest_tag):
+        assert isinstance(latest_tag, str)
+        assert Version(latest_tag)
+
+    @staticmethod
+    def test_read_file_from_tag(read_file_from_tag):
+        assert isinstance(read_file_from_tag, str)
+        assert read_file_from_tag != ""
+
+    @staticmethod
+    def test_copy_remote_file_locally(tmp_path, read_file_from_tag):
+        latest_tag = Git.get_latest_tag()
+
+        Git.copy_remote_file_locally(
+            tag=latest_tag, remote_file=POETRY_LOCK, destination_directory=tmp_path
+        )
+
+        result = (tmp_path / POETRY_LOCK).read_text()
+        assert result == read_file_from_tag