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("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('..') or 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 if url.endswith("{}{}".format(ud.host, ud.path)): 119 raise bb.fetch2.FetchError("Submodule refers to the parent repository. This will cause deadlock situation in current version of Bitbake." \ 120 "Consider using git fetcher instead.") 121 122 url += ';protocol=%s' % proto 123 url += ";name=%s" % module 124 url += ";subpath=%s" % module 125 url += ";nobranch=1" 126 127 ld = d.createCopy() 128 # Not necessary to set SRC_URI, since we're passing the URI to 129 # Fetch. 130 #ld.setVar('SRC_URI', url) 131 ld.setVar('SRCREV_%s' % module, subrevision[module]) 132 133 # Workaround for issues with SRCPV/SRCREV_FORMAT errors 134 # error refer to 'multiple' repositories. Only the repository 135 # in the original SRC_URI actually matters... 136 ld.setVar('SRCPV', d.getVar('SRCPV')) 137 ld.setVar('SRCREV_FORMAT', module) 138 139 function(ud, url, module, paths[module], workdir, ld) 140 141 return submodules != [] 142 143 def need_update(self, ud, d): 144 if Git.need_update(self, ud, d): 145 return True 146 147 need_update_list = [] 148 def need_update_submodule(ud, url, module, modpath, workdir, d): 149 url += ";bareclone=1;nobranch=1" 150 151 try: 152 newfetch = Fetch([url], d, cache=False) 153 new_ud = newfetch.ud[url] 154 if new_ud.method.need_update(new_ud, d): 155 need_update_list.append(modpath) 156 except Exception as e: 157 logger.error('gitsm: submodule update check failed: %s %s' % (type(e).__name__, str(e))) 158 need_update_result = True 159 160 # If we're using a shallow mirror tarball it needs to be unpacked 161 # temporarily so that we can examine the .gitmodules file 162 if ud.shallow and os.path.exists(ud.fullshallow) and not os.path.exists(ud.clonedir): 163 tmpdir = tempfile.mkdtemp(dir=d.getVar("DL_DIR")) 164 runfetchcmd("tar -xzf %s" % ud.fullshallow, d, workdir=tmpdir) 165 self.process_submodules(ud, tmpdir, need_update_submodule, d) 166 shutil.rmtree(tmpdir) 167 else: 168 self.process_submodules(ud, ud.clonedir, need_update_submodule, d) 169 170 if need_update_list: 171 logger.debug('gitsm: Submodules requiring update: %s' % (' '.join(need_update_list))) 172 return True 173 174 return False 175 176 def download(self, ud, d): 177 def download_submodule(ud, url, module, modpath, workdir, d): 178 url += ";bareclone=1;nobranch=1" 179 180 # Is the following still needed? 181 #url += ";nocheckout=1" 182 183 try: 184 newfetch = Fetch([url], d, cache=False) 185 newfetch.download() 186 except Exception as e: 187 logger.error('gitsm: submodule download failed: %s %s' % (type(e).__name__, str(e))) 188 raise 189 190 Git.download(self, ud, d) 191 192 # If we're using a shallow mirror tarball it needs to be unpacked 193 # temporarily so that we can examine the .gitmodules file 194 if ud.shallow and os.path.exists(ud.fullshallow) and self.need_update(ud, d): 195 tmpdir = tempfile.mkdtemp(dir=d.getVar("DL_DIR")) 196 runfetchcmd("tar -xzf %s" % ud.fullshallow, d, workdir=tmpdir) 197 self.process_submodules(ud, tmpdir, download_submodule, d) 198 shutil.rmtree(tmpdir) 199 else: 200 self.process_submodules(ud, ud.clonedir, download_submodule, d) 201 202 def unpack(self, ud, destdir, d): 203 def unpack_submodules(ud, url, module, modpath, workdir, d): 204 url += ";bareclone=1;nobranch=1" 205 206 # Figure out where we clone over the bare submodules... 207 if ud.bareclone: 208 repo_conf = ud.destdir 209 else: 210 repo_conf = os.path.join(ud.destdir, '.git') 211 212 try: 213 newfetch = Fetch([url], d, cache=False) 214 newfetch.unpack(root=os.path.dirname(os.path.join(repo_conf, 'modules', module))) 215 except Exception as e: 216 logger.error('gitsm: submodule unpack failed: %s %s' % (type(e).__name__, str(e))) 217 raise 218 219 local_path = newfetch.localpath(url) 220 221 # Correct the submodule references to the local download version... 222 runfetchcmd("%(basecmd)s config submodule.%(module)s.url %(url)s" % {'basecmd': ud.basecmd, 'module': module, 'url' : local_path}, d, workdir=ud.destdir) 223 224 if ud.shallow: 225 runfetchcmd("%(basecmd)s config submodule.%(module)s.shallow true" % {'basecmd': ud.basecmd, 'module': module}, d, workdir=ud.destdir) 226 227 # Ensure the submodule repository is NOT set to bare, since we're checking it out... 228 try: 229 runfetchcmd("%s config core.bare false" % (ud.basecmd), d, quiet=True, workdir=os.path.join(repo_conf, 'modules', module)) 230 except: 231 logger.error("Unable to set git config core.bare to false for %s" % os.path.join(repo_conf, 'modules', module)) 232 raise 233 234 Git.unpack(self, ud, destdir, d) 235 236 ret = self.process_submodules(ud, ud.destdir, unpack_submodules, d) 237 238 if not ud.bareclone and ret: 239 # All submodules should already be downloaded and configured in the tree. This simply sets 240 # up the configuration and checks out the files. The main project config should remain 241 # unmodified, and no download from the internet should occur. 242 runfetchcmd("%s submodule update --recursive --no-fetch" % (ud.basecmd), d, quiet=True, workdir=ud.destdir) 243 244 def implicit_urldata(self, ud, d): 245 import shutil, subprocess, tempfile 246 247 urldata = [] 248 def add_submodule(ud, url, module, modpath, workdir, d): 249 url += ";bareclone=1;nobranch=1" 250 newfetch = Fetch([url], d, cache=False) 251 urldata.extend(newfetch.expanded_urldata()) 252 253 # If we're using a shallow mirror tarball it needs to be unpacked 254 # temporarily so that we can examine the .gitmodules file 255 if ud.shallow and os.path.exists(ud.fullshallow) and ud.method.need_update(ud, d): 256 tmpdir = tempfile.mkdtemp(dir=d.getVar("DL_DIR")) 257 subprocess.check_call("tar -xzf %s" % ud.fullshallow, cwd=tmpdir, shell=True) 258 self.process_submodules(ud, tmpdir, add_submodule, d) 259 shutil.rmtree(tmpdir) 260 else: 261 self.process_submodules(ud, ud.clonedir, add_submodule, d) 262 263 return urldata 264