Skip to content

Commit

Permalink
Support specifying a pin for merges
Browse files Browse the repository at this point in the history
  • Loading branch information
@janverb @thomaspaulb
janverb authored and thomaspaulb committed Jul 18, 2023
1 parent f4aaa32 commit 426fdfa
Show file tree
Hide file tree
Showing 4 changed files with 91 additions and 45 deletions.
8 changes: 6 additions & 2 deletions git_aggregator/config.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,19 +57,23 @@ def get_repos(config, force=False):
try:
# Assume parts is a str
parts = merge.split(' ')
if len(parts) != 2:
if len(parts) not in {2, 3}:
raise ConfigException(
'%s: Merge must be formatted as '
'"remote_name ref".' % directory)
'"remote_name ref [pin]".' % directory)
merge = {
"remote": parts[0],
"ref": parts[1],
}
if len(parts) == 3:
merge["pin"] = parts[2]
except AttributeError:
# Parts is a dict
try:
merge["remote"] = str(merge["remote"])
merge["ref"] = str(merge["ref"])
if merge.get("pin"):
merge["pin"] = str(merge["pin"])
except KeyError:
raise ConfigException(
'%s: Merge lacks mandatory '
Expand Down
73 changes: 34 additions & 39 deletions git_aggregator/repo.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -275,31 +275,45 @@ def fetch(self):
It returns a dict structure associating each (remote, ref) to their
SHA in local repository.
"""
merges_requested = [(m["remote"], m["ref"])
for m in self.merges]
basecmd = ("git", "fetch")
logger.info("Fetching required remotes")
fetch_heads = {}
ls_remote_refs = collections.defaultdict(list) # to ls-query
while merges_requested:
remote, ref = merges_requested[0]
merges_requested = merges_requested[1:]
for merge in self.merges:
remote = merge["remote"]
ref = merge["ref"]
pin = merge.get("pin")
cmd = (
basecmd +
self._fetch_options({"remote": remote, "ref": ref}) +
(remote,))
if remote not in self.fetch_all:
cmd += (ref, )
else:
if pin:
# Probably solvable, but a little too tricky for me to
# figure out right now
raise GitAggregatorException(

Check warning on line 296 in git_aggregator/repo.py

View check run for this annotation

Codecov / codecov/patch

git_aggregator/repo.py#L296 

Added line #L296 was not covered by tests
"Cannot use fetch_all with pin"
)
ls_remote_refs[remote].append(ref)
self.log_call(cmd, cwd=self.cwd)
with open(os.path.join(self.cwd, ".git", "FETCH_HEAD"), "r") as f:
for line in f:
fetch_head, for_merge, _ = line.split("\t")
if for_merge == "not-for-merge":
continue
break
fetch_heads[(remote, ref)] = fetch_head
if pin:
try:
fetch_heads[(remote, ref)] = self.rev_parse(pin)
except Exception:
logger.error(

Check warning on line 305 in git_aggregator/repo.py

View check run for this annotation

Codecov / codecov/patch

git_aggregator/repo.py#L304-L305 

Added lines #L304 - L305 were not covered by tests
"Could not find pin %r after fetching %r", pin, ref
)
raise

Check warning on line 308 in git_aggregator/repo.py

View check run for this annotation

Codecov / codecov/patch

git_aggregator/repo.py#L308 

Added line #L308 was not covered by tests
else:
with open(os.path.join(self.cwd, ".git", "FETCH_HEAD")) as f:
for line in f:
fetch_head, for_merge, _ = line.split("\t")
if for_merge == "not-for-merge":
continue
break
fetch_heads[(remote, ref)] = fetch_head
if self.fetch_all:
if self.fetch_all is True:
remotes = self.remotes

Check warning on line 319 in git_aggregator/repo.py

View check run for this annotation

Codecov / codecov/patch

git_aggregator/repo.py#L319 

Added line #L319 was not covered by tests
Expand All @@ -311,31 +325,16 @@ def fetch(self):
remote["url"],
ls_remote_refs[remote["name"]])
for _, ref, sha in refs:
if (remote["name"], ref) in merges_requested:
merges_requested.remove((remote["name"], ref))
fetch_heads[(remote["name"], ref)] = sha
if len(merges_requested):
# Last case: our ref is a sha and remote git repository does
# not support querying commit directly by SHA. In this case
# we need just to check if ref is actually SHA, and if we have
# this SHA locally.
for remote, ref in merges_requested:
if not re.search("[0-9a-f]{4,}", ref):
raise ValueError("Could not resolv ref %r on remote %r"
% (ref, remote))
valid_local_shas = self.log_call(
['git', 'rev-parse', '-v'] + [sha
for _r, sha in merges_requested],
cwd=self.cwd, callwith=subprocess.check_output
).strip().splitlines()
for remote, sha in merges_requested:
if sha not in valid_local_shas:
raise ValueError(
"Could not find SHA ref %r after fetch on remote %r"
% (ref, remote))
fetch_heads[(remote["name"], sha)] = sha
return fetch_heads

def rev_parse(self, ref):
return self.log_call(
["git", "rev-parse", "--verify", ref],
callwith=subprocess.check_output,
cwd=self.cwd,
).strip()

def push(self):
remote = self.target['remote']
branch = self.target['branch']
Expand Down Expand Up @@ -384,11 +383,7 @@ def _switch_to_branch(self, branch_name, ref=None):
logger.info("Switch to branch %s", branch_name)
cmd = ['git', 'checkout', '-B', branch_name]
if ref is not None:
sha1 = self.log_call(
['git', 'rev-parse', ref],
callwith=subprocess.check_output,
cwd=self.cwd).strip()
cmd.append(sha1)
cmd.append(self.rev_parse(ref))
self.log_call(cmd, cwd=self.cwd)

def _execute_shell_command_after(self):
Expand Down
11 changes: 7 additions & 4 deletions tests/test_config.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ def test_load(self):
merges:
- oca 8.0
- oca refs/pull/105/head
- oca refs/pull/106/head
- oca refs/pull/106/head 1234abcd
target: acsone aggregated_branch_name
"""
repos = config.get_repos(self._parse_config(config_yaml))
Expand All @@ -45,7 +45,8 @@ def test_load(self):
'defaults': {},
'merges': [{'ref': '8.0', 'remote': 'oca'},
{'ref': 'refs/pull/105/head', 'remote': 'oca'},
{'ref': 'refs/pull/106/head', 'remote': 'oca'}],
{'ref': 'refs/pull/106/head', 'remote': 'oca',
'pin': '1234abcd'}],
'remotes': [],
'shell_command_after': [],
'target': {'branch': 'aggregated_branch_name',
Expand Down Expand Up @@ -76,6 +77,7 @@ def test_load_defaults(self):
-
remote: oca
ref: refs/pull/106/head
pin: 1234abcd
target: acsone aggregated_branch_name
""")
repos = config.get_repos(self._parse_config(config_yaml))
Expand All @@ -92,7 +94,8 @@ def test_load_defaults(self):
'defaults': {'depth': 1},
'merges': [{'ref': '8.0', 'remote': 'oca', 'depth': 1000},
{'ref': 'refs/pull/105/head', 'remote': 'oca'},
{'ref': 'refs/pull/106/head', 'remote': 'oca'}],
{'ref': 'refs/pull/106/head', 'remote': 'oca',
'pin': '1234abcd'}],
'remotes': [],
'shell_command_after': [],
'target': {'branch': 'aggregated_branch_name',
Expand Down Expand Up @@ -202,7 +205,7 @@ def test_load_merges_exception(self):
self.assertEqual(
ex.exception.args[0],
'/product_attribute: Merge must be formatted as '
'"remote_name ref".')
'"remote_name ref [pin]".')
config_yaml = """
/product_attribute:
remotes:
Expand Down
44 changes: 44 additions & 0 deletions tests/test_repo.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -451,3 +451,47 @@ def test_multithreading(self):

self.assertTrue(os.path.isfile(os.path.join(repo3_dir, 'tracked')))
self.assertTrue(os.path.isfile(os.path.join(repo3_dir, 'tracked2')))

def test_pinned_base(self):
remotes = [{
'name': 'r1',
'url': self.url_remote1
}]
merges = [{
'remote': 'r1',
'ref': 'master',
'pin': self.commit_1_sha[:8]
}]
target = {
'remote': 'r1',
'branch': 'agg1'
}
repo = Repo(self.cwd, remotes, merges, target)
repo.aggregate()
last_rev = git_get_last_rev(self.cwd)
self.assertEqual(last_rev, self.commit_1_sha)

def test_pinned_merge(self):
remotes = [{
'name': 'r1',
'url': self.url_remote1
}, {
'name': 'r2',
'url': self.url_remote2
}]
merges = [{
'remote': 'r1',
'ref': 'tag2'
}, {
'remote': 'r2',
'ref': self.commit_3_sha,
'pin': self.commit_1_sha[:8]
}]
target = {
'remote': 'r1',
'branch': 'agg'
}
repo = Repo(self.cwd, remotes, merges, target)
repo.aggregate()
last_rev = git_get_last_rev(self.cwd)
self.assertEqual(last_rev, self.commit_2_sha)

0 comments on commit 426fdfa

Please sign in to comment.