Merge ~medicalwei/germinate:handle-git-subdir into germinate:master

[Yao Wei]

Handle including git subdir like "ubuntu.noble/languages"

This will assume we don't have / in our git branch names.

67e4aed... by Yao Wei on 2023-12-08

Handle including git subdir like "ubuntu.noble/languages"

Previously, to check out seeds in Bazaar repos, we use
notations like "ubuntu.noble/languages" to indicate checking
out "languages" subdirectory inside "noble" branch.

This workaround is to ensure the backward compatibility with
bzr repos. However, this implies we cannot include "/" in
git branch name, otherwise it will be recognized as a
subdirectory name in germinate.

Git itself does not provide a convenient function to check
out a subdirectory of a repo, therefore we remove the path
and attempt to check out the entire repo, which it might be
previously checked out.

[Julian Andres Klode (juliank)]

Can you explain the use case in the commit message and add the caveat there as well?

I don't like blindly merging features without knowing what they're for and there may be better solutions too.

review: Needs Information

[Yao Wei (medicalwei)]

I updated the commit messages, hope that would get a good enough explanations. However, since I am still not understanding how it was designed, my proposal might get totally wrong.

[Michael Hudson-Doyle (mwhudson)]

The usage that is causing the problem is here, right? https://git.launchpad.net/~oem-solutions-engineers/ubuntu-seeds/+git/ubuntu-oem/tree/STRUCTURE?h=noble#n2

[Yao Wei (medicalwei)]

Yes, should we change that line for this instance?

[Yao Wei (medicalwei)]

> The usage that is causing the problem is here, right?
> https://git.launchpad.net/~oem-solutions-engineers/ubuntu-seeds/+git/ubuntu-
> oem/tree/STRUCTURE?h=noble#n2

Now I realized why it didn't happen in stock Ubuntu: because "ubuntu.noble" was checked out already so "ubuntu.noble/language" directory exists.

However, as for ubuntu-oem, it checks out "ubuntu-oem.noble" but not "ubuntu.noble", therefore "ubuntu.noble/language" does not exist, triggering this issue.

[Yao Wei (medicalwei)]

I realized the issue is triggered by my misuse of seeds format, but I'll still keep the MP here since it is a possible issue for germinate.

Unmerged commits

67e4aed... by Yao Wei on 2023-12-08

Handle including git subdir like "ubuntu.noble/languages"

Previously, to check out seeds in Bazaar repos, we use
notations like "ubuntu.noble/languages" to indicate checking
out "languages" subdirectory inside "noble" branch.

This workaround is to ensure the backward compatibility with
bzr repos. However, this implies we cannot include "/" in
git branch name, otherwise it will be recognized as a
subdirectory name in germinate.

Git itself does not provide a convenient function to check
out a subdirectory of a repo, therefore we remove the path
and attempt to check out the entire repo, which it might be
previously checked out.

test:0 (build)

1 → 1 of 1 result

First • Previous • Next • Last

diff --git a/germinate/seeds.py b/germinate/seeds.py
index fe15734..361385e 100644
--- a/germinate/seeds.py
+++ b/germinate/seeds.py
@@ -133,6 +133,14 @@ class Seed:
         if _vcs_cache_dir is None:
             _vcs_cache_dir = tempfile.mkdtemp(prefix="germinate-")
             atexit.register(shutil.rmtree, _vcs_cache_dir, ignore_errors=True)
+
+        # Handling checking out directory of a git repo,
+        # e.g. "ubuntu.noble/languages"
+        # This assumes we don't have "/" in the branch name.
+        subdir = ""
+        if "/" in branch:
+            branch, subdir = branch.split("/", 1)
+
         checkout = os.path.join(_vcs_cache_dir, branch)
         if not os.path.isdir(checkout):
             # This is a very strange way to specify a git branch, but it's
@@ -161,7 +169,7 @@ class Seed:
                     "Command failed with exit status %d:\n"
                     "  '%s'" % (status, " ".join(command))
                 )
-        return open(os.path.join(checkout, name))
+        return open(os.path.join(checkout, subdir, name))
 
     def _open_seed_url(self, base, branch, name):
         path = os.path.join(base, branch)