|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | + |
| 3 | +from os import PathLike |
| 4 | +from pathlib import Path |
| 5 | +import sys |
| 6 | + |
| 7 | +from pygit2 import init_repository, Oid |
| 8 | +from pygit2 import Repository as _Repository |
| 9 | + |
| 10 | +from ..constants import GL_REPOSITORY_URL |
| 11 | +from ..logger import LoggerSetup |
| 12 | + |
| 13 | + |
| 14 | +class Repository(_Repository): |
| 15 | + """ |
| 16 | + Repository operations handler based on the given Git directory. |
| 17 | +
|
| 18 | + :author: Garden Linux Maintainers |
| 19 | + :copyright: Copyright 2024 SAP SE |
| 20 | + :package: gardenlinux |
| 21 | + :subpackage: git |
| 22 | + :since: 0.10.0 |
| 23 | + :license: https://www.apache.org/licenses/LICENSE-2.0 |
| 24 | + Apache License, Version 2.0 |
| 25 | + """ |
| 26 | + |
| 27 | + def __init__(self, git_directory=".", logger=None, **kwargs): |
| 28 | + """ |
| 29 | + Constructor __init__(Repository) |
| 30 | +
|
| 31 | + :param git_directory: Git directory |
| 32 | + :param logger: Logger instance |
| 33 | +
|
| 34 | + :since: 0.10.0 |
| 35 | + """ |
| 36 | + |
| 37 | + if logger is None or not logger.hasHandlers(): |
| 38 | + logger = LoggerSetup.get_logger("gardenlinux.git") |
| 39 | + |
| 40 | + if not isinstance(git_directory, PathLike): |
| 41 | + git_directory = Path(git_directory) |
| 42 | + |
| 43 | + if not git_directory.exists(): |
| 44 | + raise RuntimeError(f"Git directory given is invalid: {git_directory}") |
| 45 | + |
| 46 | + _Repository.__init__(self, git_directory, **kwargs) |
| 47 | + |
| 48 | + self._git_directory = git_directory |
| 49 | + self._logger = logger |
| 50 | + |
| 51 | + @property |
| 52 | + def commit_id(self): |
| 53 | + """ |
| 54 | + Returns the commit ID for Git `HEAD`. |
| 55 | +
|
| 56 | + :return: (str) Git commit ID |
| 57 | + :since: 0.10.0 |
| 58 | + """ |
| 59 | + |
| 60 | + return str(self.root_repo.head.target) |
| 61 | + |
| 62 | + @property |
| 63 | + def root(self): |
| 64 | + """ |
| 65 | + Returns the root directory of the current Git repository. |
| 66 | +
|
| 67 | + :return: (object) Git root directory |
| 68 | + :since: 0.10.0 |
| 69 | + """ |
| 70 | + |
| 71 | + root_dir = self.workdir |
| 72 | + |
| 73 | + if self.is_bare: |
| 74 | + root_dir = self.path |
| 75 | + |
| 76 | + usual_git_dir = Path(root_dir, ".git") |
| 77 | + |
| 78 | + # Possible submodule Git repository. Validate repository containing `.git` directory. |
| 79 | + if self.path != str(usual_git_dir): |
| 80 | + try: |
| 81 | + repo = Repository(usual_git_dir, self._logger) |
| 82 | + |
| 83 | + if self.path != repo.path: |
| 84 | + root_dir = repo.root |
| 85 | + except Exception as exc: |
| 86 | + self._logger.warning(f"Failed to inspect Git directory: {exc}") |
| 87 | + |
| 88 | + self._logger.debug(f"Git root directory: {root_dir}") |
| 89 | + return Path(root_dir) |
| 90 | + |
| 91 | + @property |
| 92 | + def root_repo(self): |
| 93 | + """ |
| 94 | + Returns the root Git `Repository` instance. |
| 95 | +
|
| 96 | + :return: (object) Git root `Repository` instance |
| 97 | + :since: 0.10.0 |
| 98 | + """ |
| 99 | + |
| 100 | + repo = self |
| 101 | + |
| 102 | + if self._git_directory != self.root: |
| 103 | + repo = Repository(self.root, self._logger) |
| 104 | + |
| 105 | + return repo |
| 106 | + |
| 107 | + @staticmethod |
| 108 | + def checkout_repo(git_directory, repo_url=GL_REPOSITORY_URL, branch="main", commit=None, pathspecs=None, logger=None, **kwargs): |
| 109 | + """ |
| 110 | + Returns the root Git `Repo` instance. |
| 111 | +
|
| 112 | + :return: (object) Git `Repo` instance |
| 113 | + :since: 0.10.0 |
| 114 | + """ |
| 115 | + |
| 116 | + if not isinstance(git_directory, PathLike): |
| 117 | + git_directory = Path(git_directory) |
| 118 | + |
| 119 | + if not git_directory.is_dir() or git_directory.match("/*"): |
| 120 | + raise RuntimeError("Git directory should not exist or be empty before checkout") |
| 121 | + |
| 122 | + repo = init_repository(git_directory, origin_url=repo_url) |
| 123 | + repo.remotes["origin"].fetch() |
| 124 | + |
| 125 | + if commit is None: |
| 126 | + refish = f"origin/{branch}" |
| 127 | + resolved = repo.resolve_refish(refish) |
| 128 | + commit = str(resolved[0].id) |
| 129 | + |
| 130 | + checkout_tree_kwargs = kwargs |
| 131 | + if pathspecs is not None: checkout_tree_kwargs['paths'] = pathspecs |
| 132 | + repo.checkout_tree(repo[Oid(hex=commit)], **checkout_tree_kwargs) |
| 133 | + |
| 134 | + return Repository(git_directory, logger) |
| 135 | + |
| 136 | + @staticmethod |
| 137 | + def checkout_repo_sparse(git_directory, pathspecs=[], repo_url=GL_REPOSITORY_URL, branch="main", commit=None, logger=None, **kwargs): |
| 138 | + """ |
| 139 | + Sparse checkout given Git repository and return the `Repository` instance. |
| 140 | +
|
| 141 | + :return: (object) Git `Repository` instance |
| 142 | + :since: 0.10.0 |
| 143 | + """ |
| 144 | + |
| 145 | + # @TODO: pygit2 does not support sparse checkouts. We use the `paths` parameter at the moment. |
| 146 | + return Repository.checkout_repo(git_directory, repo_url=repo_url, branch=branch, commit=commit, pathspecs=pathspecs, logger=logger) |
0 commit comments