1""" 2BitBake 'Fetch' git submodules implementation 3 4Inherits from and extends the Git fetcher to retrieve submodules of a git repository 5after cloning. 6 7SRC_URI = "gitsm://<see Git fetcher for syntax>" 8 9See the Git fetcher, git://, for usage documentation. 10 11NOTE: Switching a SRC_URI from "git://" to "gitsm://" requires a clean of your recipe. 12 13""" 14 15# Copyright (C) 2013 Richard Purdie 16# 17# SPDX-License-Identifier: GPL-2.0-only 18# 19 20import os 21import bb 22import copy 23import shutil 24import tempfile 25from bb.fetch2.git import Git 26from bb.fetch2 import runfetchcmd 27from bb.fetch2 import logger 28from bb.fetch2 import Fetch 29 30class GitSM(Git): 31 def supports(self, ud, d): 32 """ 33 Check to see if a given url can be fetched with git. 34 """ 35 return ud.type in ['gitsm'] 36 37 def process_submodules(self, ud, workdir, function, d): 38 """ 39 Iterate over all of the submodules in this repository and execute 40 the 'function' for each of them. 41 """ 42 43 submodules = [] 44 paths = {} 45 revision = {} 46 uris = {} 47 subrevision = {} 48 49 def parse_gitmodules(gitmodules): 50 modules = {} 51 module = "" 52 for line in gitmodules.splitlines(): 53 if line.startswith('[submodule'): 54 module = line.split('"')[1] 55 modules[module] = {} 56 elif module and line.strip().startswith('path'): 57 path = line.split('=')[1].strip() 58 modules[module]['path'] = path 59 elif module and line.strip().startswith('url'): 60 url = line.split('=')[1].strip() 61 modules[module]['url'] = url 62 return modules 63 64 # Collect the defined submodules, and their attributes 65 for name in ud.names: 66 try: 67 gitmodules = runfetchcmd("%s show %s:.gitmodules" % (ud.basecmd, ud.revisions[name]), d, quiet=True, workdir=workdir) 68 except: 69 # No submodules to update 70 continue 71 72 for m, md in parse_gitmodules(gitmodules).items(): 73 try: 74 module_hash = runfetchcmd("%s ls-tree -z -d %s %s" % (ud.basecmd, ud.revisions[name], md['path']), d, quiet=True, workdir=workdir) 75 except: 76 # If the command fails, we don't have a valid file to check. If it doesn't 77 # fail -- it still might be a failure, see next check... 78 module_hash = "" 79 80 if not module_hash: 81 logger.debug(1, "submodule %s is defined, but is not initialized in the repository. Skipping", m) 82 continue 83 84 submodules.append(m) 85 paths[m] = md['path'] 86 revision[m] = ud.revisions[name] 87 uris[m] = md['url'] 88 subrevision[m] = module_hash.split()[2] 89 90 # Convert relative to absolute uri based on parent uri 91 if uris[m].startswith('..'): 92 newud = copy.copy(ud) 93 newud.path = os.path.realpath(os.path.join(newud.path, uris[m])) 94 uris[m] = Git._get_repo_url(self, newud) 95 96 for module in submodules: 97 # Translate the module url into a SRC_URI 98 99 if "://" in uris[module]: 100 # Properly formated URL already 101 proto = uris[module].split(':', 1)[0] 102 url = uris[module].replace('%s:' % proto, 'gitsm:', 1) 103 else: 104 if ":" in uris[module]: 105 # Most likely an SSH style reference 106 proto = "ssh" 107 if ":/" in uris[module]: 108 # Absolute reference, easy to convert.. 109 url = "gitsm://" + uris[module].replace(':/', '/', 1) 110 else: 111 # Relative reference, no way to know if this is right! 112 logger.warning("Submodule included by %s refers to relative ssh reference %s. References may fail if not absolute." % (ud.url, uris[module])) 113 url = "gitsm://" + uris[module].replace(':', '/', 1) 114 else: 115 # This has to be a file reference 116 proto = "file" 117 url = "gitsm://" + uris[module] 118 119 url += ';protocol=%s' % proto 120 url += ";name=%s" % module 121 url += ";subpath=%s" % module 122 123 ld = d.createCopy() 124 # Not necessary to set SRC_URI, since we're passing the URI to 125 # Fetch. 126 #ld.setVar('SRC_URI', url) 127 ld.setVar('SRCREV_%s' % module, subrevision[module]) 128 129 # Workaround for issues with SRCPV/SRCREV_FORMAT errors 130 # error refer to 'multiple' repositories. Only the repository 131 # in the original SRC_URI actually matters... 132 ld.setVar('SRCPV', d.getVar('SRCPV')) 133 ld.setVar('SRCREV_FORMAT', module) 134 135 function(ud, url, module, paths[module], workdir, ld) 136 137 return submodules != [] 138 139 def need_update(self, ud, d): 140 if Git.need_update(self, ud, d): 141 return True 142 143 try: 144 # Check for the nugget dropped by the download operation 145 known_srcrevs = runfetchcmd("%s config --get-all bitbake.srcrev" % \ 146 (ud.basecmd), d, workdir=ud.clonedir) 147 148 if ud.revisions[ud.names[0]] in known_srcrevs.split(): 149 return False 150 except bb.fetch2.FetchError: 151 pass 152 153 need_update_list = [] 154 def need_update_submodule(ud, url, module, modpath, workdir, d): 155 url += ";bareclone=1;nobranch=1" 156 157 try: 158 newfetch = Fetch([url], d, cache=False) 159 new_ud = newfetch.ud[url] 160 if new_ud.method.need_update(new_ud, d): 161 need_update_list.append(modpath) 162 except Exception as e: 163 logger.error('gitsm: submodule update check failed: %s %s' % (type(e).__name__, str(e))) 164 need_update_result = True 165 166 # If we're using a shallow mirror tarball it needs to be unpacked 167 # temporarily so that we can examine the .gitmodules file 168 if ud.shallow and os.path.exists(ud.fullshallow) and not os.path.exists(ud.clonedir): 169 tmpdir = tempfile.mkdtemp(dir=d.getVar("DL_DIR")) 170 runfetchcmd("tar -xzf %s" % ud.fullshallow, d, workdir=tmpdir) 171 self.process_submodules(ud, tmpdir, need_update_submodule, d) 172 shutil.rmtree(tmpdir) 173 else: 174 self.process_submodules(ud, ud.clonedir, need_update_submodule, d) 175 if len(need_update_list) == 0: 176 # We already have the required commits of all submodules. Drop 177 # a nugget so we don't need to check again. 178 runfetchcmd("%s config --add bitbake.srcrev %s" % \ 179 (ud.basecmd, ud.revisions[ud.names[0]]), d, workdir=ud.clonedir) 180 181 if len(need_update_list) > 0: 182 logger.debug(1, 'gitsm: Submodules requiring update: %s' % (' '.join(need_update_list))) 183 return True 184 185 return False 186 187 def download(self, ud, d): 188 def download_submodule(ud, url, module, modpath, workdir, d): 189 url += ";bareclone=1;nobranch=1" 190 191 # Is the following still needed? 192 #url += ";nocheckout=1" 193 194 try: 195 newfetch = Fetch([url], d, cache=False) 196 newfetch.download() 197 except Exception as e: 198 logger.error('gitsm: submodule download failed: %s %s' % (type(e).__name__, str(e))) 199 raise 200 201 Git.download(self, ud, d) 202 203 # If we're using a shallow mirror tarball it needs to be unpacked 204 # temporarily so that we can examine the .gitmodules file 205 if ud.shallow and os.path.exists(ud.fullshallow) and self.need_update(ud, d): 206 tmpdir = tempfile.mkdtemp(dir=d.getVar("DL_DIR")) 207 runfetchcmd("tar -xzf %s" % ud.fullshallow, d, workdir=tmpdir) 208 self.process_submodules(ud, tmpdir, download_submodule, d) 209 shutil.rmtree(tmpdir) 210 else: 211 self.process_submodules(ud, ud.clonedir, download_submodule, d) 212 # Drop a nugget for the srcrev we've fetched (used by need_update) 213 runfetchcmd("%s config --add bitbake.srcrev %s" % \ 214 (ud.basecmd, ud.revisions[ud.names[0]]), d, workdir=ud.clonedir) 215 216 def unpack(self, ud, destdir, d): 217 def unpack_submodules(ud, url, module, modpath, workdir, d): 218 url += ";bareclone=1;nobranch=1" 219 220 # Figure out where we clone over the bare submodules... 221 if ud.bareclone: 222 repo_conf = ud.destdir 223 else: 224 repo_conf = os.path.join(ud.destdir, '.git') 225 226 try: 227 newfetch = Fetch([url], d, cache=False) 228 newfetch.unpack(root=os.path.dirname(os.path.join(repo_conf, 'modules', module))) 229 except Exception as e: 230 logger.error('gitsm: submodule unpack failed: %s %s' % (type(e).__name__, str(e))) 231 raise 232 233 local_path = newfetch.localpath(url) 234 235 # Correct the submodule references to the local download version... 236 runfetchcmd("%(basecmd)s config submodule.%(module)s.url %(url)s" % {'basecmd': ud.basecmd, 'module': module, 'url' : local_path}, d, workdir=ud.destdir) 237 238 if ud.shallow: 239 runfetchcmd("%(basecmd)s config submodule.%(module)s.shallow true" % {'basecmd': ud.basecmd, 'module': module}, d, workdir=ud.destdir) 240 241 # Ensure the submodule repository is NOT set to bare, since we're checking it out... 242 try: 243 runfetchcmd("%s config core.bare false" % (ud.basecmd), d, quiet=True, workdir=os.path.join(repo_conf, 'modules', module)) 244 except: 245 logger.error("Unable to set git config core.bare to false for %s" % os.path.join(repo_conf, 'modules', module)) 246 raise 247 248 Git.unpack(self, ud, destdir, d) 249 250 ret = self.process_submodules(ud, ud.destdir, unpack_submodules, d) 251 252 if not ud.bareclone and ret: 253 # All submodules should already be downloaded and configured in the tree. This simply sets 254 # up the configuration and checks out the files. The main project config should remain 255 # unmodified, and no download from the internet should occur. 256 runfetchcmd("%s submodule update --recursive --no-fetch" % (ud.basecmd), d, quiet=True, workdir=ud.destdir) 257 258 def implicit_urldata(self, ud, d): 259 import shutil, subprocess, tempfile 260 261 urldata = [] 262 def add_submodule(ud, url, module, modpath, workdir, d): 263 url += ";bareclone=1;nobranch=1" 264 newfetch = Fetch([url], d, cache=False) 265 urldata.extend(newfetch.expanded_urldata()) 266 267 # If we're using a shallow mirror tarball it needs to be unpacked 268 # temporarily so that we can examine the .gitmodules file 269 if ud.shallow and os.path.exists(ud.fullshallow) and ud.method.need_update(ud, d): 270 tmpdir = tempfile.mkdtemp(dir=d.getVar("DL_DIR")) 271 subprocess.check_call("tar -xzf %s" % ud.fullshallow, cwd=tmpdir, shell=True) 272 self.process_submodules(ud, tmpdir, add_submodule, d) 273 shutil.rmtree(tmpdir) 274 else: 275 self.process_submodules(ud, ud.clonedir, add_submodule, d) 276 277 return urldata 278