mirror of
https://gerrit.googlesource.com/git-repo
synced 2024-12-21 07:16:21 +00:00
8c1e9cbef1
We conflate the manifest & parsing logic with the management of the repo client checkout in a single class. This makes testing just one part (the manifest parsing) hard as it requires a full checkout too. Start splitting the two apart into separate classes to make it easy to reason about & test. Change-Id: Iaf897c93db9c724baba6044bfe7a589c024523b2 Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/288682 Reviewed-by: Michael Mortensen <mmortensen@google.com> Tested-by: Mike Frysinger <vapier@google.com>
540 lines
20 KiB
Python
540 lines
20 KiB
Python
# -*- coding:utf-8 -*-
|
|
#
|
|
# Copyright (C) 2008 The Android Open Source Project
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
from __future__ import print_function
|
|
|
|
import optparse
|
|
import os
|
|
import platform
|
|
import re
|
|
import sys
|
|
|
|
from pyversion import is_python3
|
|
if is_python3():
|
|
import urllib.parse
|
|
else:
|
|
import imp
|
|
import urlparse
|
|
urllib = imp.new_module('urllib')
|
|
urllib.parse = urlparse
|
|
|
|
from color import Coloring
|
|
from command import InteractiveCommand, MirrorSafeCommand
|
|
from error import ManifestParseError
|
|
from project import SyncBuffer
|
|
from git_config import GitConfig
|
|
from git_command import git_require, MIN_GIT_VERSION_SOFT, MIN_GIT_VERSION_HARD
|
|
import platform_utils
|
|
from wrapper import Wrapper
|
|
|
|
|
|
class Init(InteractiveCommand, MirrorSafeCommand):
|
|
common = True
|
|
helpSummary = "Initialize repo in the current directory"
|
|
helpUsage = """
|
|
%prog [options]
|
|
"""
|
|
helpDescription = """
|
|
The '%prog' command is run once to install and initialize repo.
|
|
The latest repo source code and manifest collection is downloaded
|
|
from the server and is installed in the .repo/ directory in the
|
|
current working directory.
|
|
|
|
The optional -b argument can be used to select the manifest branch
|
|
to checkout and use. If no branch is specified, the remote's default
|
|
branch is used.
|
|
|
|
The optional -m argument can be used to specify an alternate manifest
|
|
to be used. If no manifest is specified, the manifest default.xml
|
|
will be used.
|
|
|
|
The --reference option can be used to point to a directory that
|
|
has the content of a --mirror sync. This will make the working
|
|
directory use as much data as possible from the local reference
|
|
directory when fetching from the server. This will make the sync
|
|
go a lot faster by reducing data traffic on the network.
|
|
|
|
The --dissociate option can be used to borrow the objects from
|
|
the directory specified with the --reference option only to reduce
|
|
network transfer, and stop borrowing from them after a first clone
|
|
is made by making necessary local copies of borrowed objects.
|
|
|
|
The --no-clone-bundle option disables any attempt to use
|
|
$URL/clone.bundle to bootstrap a new Git repository from a
|
|
resumeable bundle file on a content delivery network. This
|
|
may be necessary if there are problems with the local Python
|
|
HTTP client or proxy configuration, but the Git binary works.
|
|
|
|
# Switching Manifest Branches
|
|
|
|
To switch to another manifest branch, `repo init -b otherbranch`
|
|
may be used in an existing client. However, as this only updates the
|
|
manifest, a subsequent `repo sync` (or `repo sync -d`) is necessary
|
|
to update the working directory files.
|
|
"""
|
|
|
|
def _Options(self, p, gitc_init=False):
|
|
# Logging
|
|
g = p.add_option_group('Logging options')
|
|
g.add_option('-v', '--verbose',
|
|
dest='output_mode', action='store_true',
|
|
help='show all output')
|
|
g.add_option('-q', '--quiet',
|
|
dest='output_mode', action='store_false',
|
|
help='only show errors')
|
|
|
|
# Manifest
|
|
g = p.add_option_group('Manifest options')
|
|
g.add_option('-u', '--manifest-url',
|
|
dest='manifest_url',
|
|
help='manifest repository location', metavar='URL')
|
|
g.add_option('-b', '--manifest-branch',
|
|
dest='manifest_branch',
|
|
help='manifest branch or revision', metavar='REVISION')
|
|
cbr_opts = ['--current-branch']
|
|
# The gitc-init subcommand allocates -c itself, but a lot of init users
|
|
# want -c, so try to satisfy both as best we can.
|
|
if not gitc_init:
|
|
cbr_opts += ['-c']
|
|
g.add_option(*cbr_opts,
|
|
dest='current_branch_only', action='store_true',
|
|
help='fetch only current manifest branch from server')
|
|
g.add_option('-m', '--manifest-name',
|
|
dest='manifest_name', default='default.xml',
|
|
help='initial manifest file', metavar='NAME.xml')
|
|
g.add_option('--mirror',
|
|
dest='mirror', action='store_true',
|
|
help='create a replica of the remote repositories '
|
|
'rather than a client working directory')
|
|
g.add_option('--reference',
|
|
dest='reference',
|
|
help='location of mirror directory', metavar='DIR')
|
|
g.add_option('--dissociate',
|
|
dest='dissociate', action='store_true',
|
|
help='dissociate from reference mirrors after clone')
|
|
g.add_option('--depth', type='int', default=None,
|
|
dest='depth',
|
|
help='create a shallow clone with given depth; see git clone')
|
|
g.add_option('--partial-clone', action='store_true',
|
|
dest='partial_clone',
|
|
help='perform partial clone (https://git-scm.com/'
|
|
'docs/gitrepository-layout#_code_partialclone_code)')
|
|
g.add_option('--clone-filter', action='store', default='blob:none',
|
|
dest='clone_filter',
|
|
help='filter for use with --partial-clone [default: %default]')
|
|
# TODO(vapier): Expose option with real help text once this has been in the
|
|
# wild for a while w/out significant bug reports. Goal is by ~Sep 2020.
|
|
g.add_option('--worktree', action='store_true',
|
|
help=optparse.SUPPRESS_HELP)
|
|
g.add_option('--archive',
|
|
dest='archive', action='store_true',
|
|
help='checkout an archive instead of a git repository for '
|
|
'each project. See git archive.')
|
|
g.add_option('--submodules',
|
|
dest='submodules', action='store_true',
|
|
help='sync any submodules associated with the manifest repo')
|
|
g.add_option('-g', '--groups',
|
|
dest='groups', default='default',
|
|
help='restrict manifest projects to ones with specified '
|
|
'group(s) [default|all|G1,G2,G3|G4,-G5,-G6]',
|
|
metavar='GROUP')
|
|
g.add_option('-p', '--platform',
|
|
dest='platform', default='auto',
|
|
help='restrict manifest projects to ones with a specified '
|
|
'platform group [auto|all|none|linux|darwin|...]',
|
|
metavar='PLATFORM')
|
|
g.add_option('--clone-bundle', action='store_true',
|
|
help='force use of /clone.bundle on HTTP/HTTPS (default if not --partial-clone)')
|
|
g.add_option('--no-clone-bundle',
|
|
dest='clone_bundle', action='store_false',
|
|
help='disable use of /clone.bundle on HTTP/HTTPS (default if --partial-clone)')
|
|
g.add_option('--no-tags',
|
|
dest='tags', default=True, action='store_false',
|
|
help="don't fetch tags in the manifest")
|
|
|
|
# Tool
|
|
g = p.add_option_group('repo Version options')
|
|
g.add_option('--repo-url',
|
|
dest='repo_url',
|
|
help='repo repository location', metavar='URL')
|
|
g.add_option('--repo-rev', metavar='REV',
|
|
help='repo branch or revision')
|
|
g.add_option('--repo-branch', dest='repo_rev',
|
|
help=optparse.SUPPRESS_HELP)
|
|
g.add_option('--no-repo-verify',
|
|
dest='repo_verify', default=True, action='store_false',
|
|
help='do not verify repo source code')
|
|
|
|
# Other
|
|
g = p.add_option_group('Other options')
|
|
g.add_option('--config-name',
|
|
dest='config_name', action="store_true", default=False,
|
|
help='Always prompt for name/e-mail')
|
|
|
|
def _RegisteredEnvironmentOptions(self):
|
|
return {'REPO_MANIFEST_URL': 'manifest_url',
|
|
'REPO_MIRROR_LOCATION': 'reference'}
|
|
|
|
def _SyncManifest(self, opt):
|
|
m = self.manifest.manifestProject
|
|
is_new = not m.Exists
|
|
|
|
if is_new:
|
|
if not opt.manifest_url:
|
|
print('fatal: manifest url (-u) is required.', file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
if not opt.quiet:
|
|
print('Downloading manifest from %s' %
|
|
(GitConfig.ForUser().UrlInsteadOf(opt.manifest_url),),
|
|
file=sys.stderr)
|
|
|
|
# The manifest project object doesn't keep track of the path on the
|
|
# server where this git is located, so let's save that here.
|
|
mirrored_manifest_git = None
|
|
if opt.reference:
|
|
manifest_git_path = urllib.parse.urlparse(opt.manifest_url).path[1:]
|
|
mirrored_manifest_git = os.path.join(opt.reference, manifest_git_path)
|
|
if not mirrored_manifest_git.endswith(".git"):
|
|
mirrored_manifest_git += ".git"
|
|
if not os.path.exists(mirrored_manifest_git):
|
|
mirrored_manifest_git = os.path.join(opt.reference,
|
|
'.repo/manifests.git')
|
|
|
|
m._InitGitDir(mirror_git=mirrored_manifest_git)
|
|
|
|
self._ConfigureDepth(opt)
|
|
|
|
# Set the remote URL before the remote branch as we might need it below.
|
|
if opt.manifest_url:
|
|
r = m.GetRemote(m.remote.name)
|
|
r.url = opt.manifest_url
|
|
r.ResetFetch()
|
|
r.Save()
|
|
|
|
if opt.manifest_branch:
|
|
m.revisionExpr = opt.manifest_branch
|
|
else:
|
|
if is_new:
|
|
default_branch = m.ResolveRemoteHead()
|
|
if default_branch is None:
|
|
# If the remote doesn't have HEAD configured, default to master.
|
|
default_branch = 'refs/heads/master'
|
|
m.revisionExpr = default_branch
|
|
else:
|
|
m.PreSync()
|
|
|
|
groups = re.split(r'[,\s]+', opt.groups)
|
|
all_platforms = ['linux', 'darwin', 'windows']
|
|
platformize = lambda x: 'platform-' + x
|
|
if opt.platform == 'auto':
|
|
if (not opt.mirror and
|
|
not m.config.GetString('repo.mirror') == 'true'):
|
|
groups.append(platformize(platform.system().lower()))
|
|
elif opt.platform == 'all':
|
|
groups.extend(map(platformize, all_platforms))
|
|
elif opt.platform in all_platforms:
|
|
groups.append(platformize(opt.platform))
|
|
elif opt.platform != 'none':
|
|
print('fatal: invalid platform flag', file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
groups = [x for x in groups if x]
|
|
groupstr = ','.join(groups)
|
|
if opt.platform == 'auto' and groupstr == 'default,platform-' + platform.system().lower():
|
|
groupstr = None
|
|
m.config.SetString('manifest.groups', groupstr)
|
|
|
|
if opt.reference:
|
|
m.config.SetString('repo.reference', opt.reference)
|
|
|
|
if opt.dissociate:
|
|
m.config.SetString('repo.dissociate', 'true')
|
|
|
|
if opt.worktree:
|
|
if opt.mirror:
|
|
print('fatal: --mirror and --worktree are incompatible',
|
|
file=sys.stderr)
|
|
sys.exit(1)
|
|
if opt.submodules:
|
|
print('fatal: --submodules and --worktree are incompatible',
|
|
file=sys.stderr)
|
|
sys.exit(1)
|
|
m.config.SetString('repo.worktree', 'true')
|
|
if is_new:
|
|
m.use_git_worktrees = True
|
|
print('warning: --worktree is experimental!', file=sys.stderr)
|
|
|
|
if opt.archive:
|
|
if is_new:
|
|
m.config.SetString('repo.archive', 'true')
|
|
else:
|
|
print('fatal: --archive is only supported when initializing a new '
|
|
'workspace.', file=sys.stderr)
|
|
print('Either delete the .repo folder in this workspace, or initialize '
|
|
'in another location.', file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
if opt.mirror:
|
|
if is_new:
|
|
m.config.SetString('repo.mirror', 'true')
|
|
else:
|
|
print('fatal: --mirror is only supported when initializing a new '
|
|
'workspace.', file=sys.stderr)
|
|
print('Either delete the .repo folder in this workspace, or initialize '
|
|
'in another location.', file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
if opt.partial_clone:
|
|
if opt.mirror:
|
|
print('fatal: --mirror and --partial-clone are mutually exclusive',
|
|
file=sys.stderr)
|
|
sys.exit(1)
|
|
m.config.SetString('repo.partialclone', 'true')
|
|
if opt.clone_filter:
|
|
m.config.SetString('repo.clonefilter', opt.clone_filter)
|
|
else:
|
|
opt.clone_filter = None
|
|
|
|
if opt.clone_bundle is None:
|
|
opt.clone_bundle = False if opt.partial_clone else True
|
|
else:
|
|
m.config.SetString('repo.clonebundle', 'true' if opt.clone_bundle else 'false')
|
|
|
|
if opt.submodules:
|
|
m.config.SetString('repo.submodules', 'true')
|
|
|
|
if not m.Sync_NetworkHalf(is_new=is_new, quiet=opt.quiet, verbose=opt.verbose,
|
|
clone_bundle=opt.clone_bundle,
|
|
current_branch_only=opt.current_branch_only,
|
|
tags=opt.tags, submodules=opt.submodules,
|
|
clone_filter=opt.clone_filter):
|
|
r = m.GetRemote(m.remote.name)
|
|
print('fatal: cannot obtain manifest %s' % r.url, file=sys.stderr)
|
|
|
|
# Better delete the manifest git dir if we created it; otherwise next
|
|
# time (when user fixes problems) we won't go through the "is_new" logic.
|
|
if is_new:
|
|
platform_utils.rmtree(m.gitdir)
|
|
sys.exit(1)
|
|
|
|
if opt.manifest_branch:
|
|
m.MetaBranchSwitch(submodules=opt.submodules)
|
|
|
|
syncbuf = SyncBuffer(m.config)
|
|
m.Sync_LocalHalf(syncbuf, submodules=opt.submodules)
|
|
syncbuf.Finish()
|
|
|
|
if is_new or m.CurrentBranch is None:
|
|
if not m.StartBranch('default'):
|
|
print('fatal: cannot create default in manifest', file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
def _LinkManifest(self, name):
|
|
if not name:
|
|
print('fatal: manifest name (-m) is required.', file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
try:
|
|
self.manifest.Link(name)
|
|
except ManifestParseError as e:
|
|
print("fatal: manifest '%s' not available" % name, file=sys.stderr)
|
|
print('fatal: %s' % str(e), file=sys.stderr)
|
|
sys.exit(1)
|
|
|
|
def _Prompt(self, prompt, value):
|
|
print('%-10s [%s]: ' % (prompt, value), end='')
|
|
# TODO: When we require Python 3, use flush=True w/print above.
|
|
sys.stdout.flush()
|
|
a = sys.stdin.readline().strip()
|
|
if a == '':
|
|
return value
|
|
return a
|
|
|
|
def _ShouldConfigureUser(self, opt):
|
|
gc = self.client.globalConfig
|
|
mp = self.manifest.manifestProject
|
|
|
|
# If we don't have local settings, get from global.
|
|
if not mp.config.Has('user.name') or not mp.config.Has('user.email'):
|
|
if not gc.Has('user.name') or not gc.Has('user.email'):
|
|
return True
|
|
|
|
mp.config.SetString('user.name', gc.GetString('user.name'))
|
|
mp.config.SetString('user.email', gc.GetString('user.email'))
|
|
|
|
if not opt.quiet:
|
|
print()
|
|
print('Your identity is: %s <%s>' % (mp.config.GetString('user.name'),
|
|
mp.config.GetString('user.email')))
|
|
print("If you want to change this, please re-run 'repo init' with --config-name")
|
|
return False
|
|
|
|
def _ConfigureUser(self, opt):
|
|
mp = self.manifest.manifestProject
|
|
|
|
while True:
|
|
if not opt.quiet:
|
|
print()
|
|
name = self._Prompt('Your Name', mp.UserName)
|
|
email = self._Prompt('Your Email', mp.UserEmail)
|
|
|
|
if not opt.quiet:
|
|
print()
|
|
print('Your identity is: %s <%s>' % (name, email))
|
|
print('is this correct [y/N]? ', end='')
|
|
# TODO: When we require Python 3, use flush=True w/print above.
|
|
sys.stdout.flush()
|
|
a = sys.stdin.readline().strip().lower()
|
|
if a in ('yes', 'y', 't', 'true'):
|
|
break
|
|
|
|
if name != mp.UserName:
|
|
mp.config.SetString('user.name', name)
|
|
if email != mp.UserEmail:
|
|
mp.config.SetString('user.email', email)
|
|
|
|
def _HasColorSet(self, gc):
|
|
for n in ['ui', 'diff', 'status']:
|
|
if gc.Has('color.%s' % n):
|
|
return True
|
|
return False
|
|
|
|
def _ConfigureColor(self):
|
|
gc = self.client.globalConfig
|
|
if self._HasColorSet(gc):
|
|
return
|
|
|
|
class _Test(Coloring):
|
|
def __init__(self):
|
|
Coloring.__init__(self, gc, 'test color display')
|
|
self._on = True
|
|
out = _Test()
|
|
|
|
print()
|
|
print("Testing colorized output (for 'repo diff', 'repo status'):")
|
|
|
|
for c in ['black', 'red', 'green', 'yellow', 'blue', 'magenta', 'cyan']:
|
|
out.write(' ')
|
|
out.printer(fg=c)(' %-6s ', c)
|
|
out.write(' ')
|
|
out.printer(fg='white', bg='black')(' %s ' % 'white')
|
|
out.nl()
|
|
|
|
for c in ['bold', 'dim', 'ul', 'reverse']:
|
|
out.write(' ')
|
|
out.printer(fg='black', attr=c)(' %-6s ', c)
|
|
out.nl()
|
|
|
|
print('Enable color display in this user account (y/N)? ', end='')
|
|
# TODO: When we require Python 3, use flush=True w/print above.
|
|
sys.stdout.flush()
|
|
a = sys.stdin.readline().strip().lower()
|
|
if a in ('y', 'yes', 't', 'true', 'on'):
|
|
gc.SetString('color.ui', 'auto')
|
|
|
|
def _ConfigureDepth(self, opt):
|
|
"""Configure the depth we'll sync down.
|
|
|
|
Args:
|
|
opt: Options from optparse. We care about opt.depth.
|
|
"""
|
|
# Opt.depth will be non-None if user actually passed --depth to repo init.
|
|
if opt.depth is not None:
|
|
if opt.depth > 0:
|
|
# Positive values will set the depth.
|
|
depth = str(opt.depth)
|
|
else:
|
|
# Negative numbers will clear the depth; passing None to SetString
|
|
# will do that.
|
|
depth = None
|
|
|
|
# We store the depth in the main manifest project.
|
|
self.manifest.manifestProject.config.SetString('repo.depth', depth)
|
|
|
|
def _DisplayResult(self, opt):
|
|
if self.manifest.IsMirror:
|
|
init_type = 'mirror '
|
|
else:
|
|
init_type = ''
|
|
|
|
if not opt.quiet:
|
|
print()
|
|
print('repo %shas been initialized in %s' %
|
|
(init_type, self.manifest.topdir))
|
|
|
|
current_dir = os.getcwd()
|
|
if current_dir != self.manifest.topdir:
|
|
print('If this is not the directory in which you want to initialize '
|
|
'repo, please run:')
|
|
print(' rm -r %s/.repo' % self.manifest.topdir)
|
|
print('and try again.')
|
|
|
|
def ValidateOptions(self, opt, args):
|
|
if opt.reference:
|
|
opt.reference = os.path.expanduser(opt.reference)
|
|
|
|
# Check this here, else manifest will be tagged "not new" and init won't be
|
|
# possible anymore without removing the .repo/manifests directory.
|
|
if opt.archive and opt.mirror:
|
|
self.OptionParser.error('--mirror and --archive cannot be used together.')
|
|
|
|
if args:
|
|
self.OptionParser.error('init takes no arguments')
|
|
|
|
def Execute(self, opt, args):
|
|
git_require(MIN_GIT_VERSION_HARD, fail=True)
|
|
if not git_require(MIN_GIT_VERSION_SOFT):
|
|
print('repo: warning: git-%s+ will soon be required; please upgrade your '
|
|
'version of git to maintain support.'
|
|
% ('.'.join(str(x) for x in MIN_GIT_VERSION_SOFT),),
|
|
file=sys.stderr)
|
|
|
|
opt.quiet = opt.output_mode is False
|
|
opt.verbose = opt.output_mode is True
|
|
|
|
rp = self.manifest.repoProject
|
|
|
|
# Handle new --repo-url requests.
|
|
if opt.repo_url:
|
|
remote = rp.GetRemote('origin')
|
|
remote.url = opt.repo_url
|
|
remote.Save()
|
|
|
|
# Handle new --repo-rev requests.
|
|
if opt.repo_rev:
|
|
wrapper = Wrapper()
|
|
remote_ref, rev = wrapper.check_repo_rev(
|
|
rp.gitdir, opt.repo_rev, repo_verify=opt.repo_verify, quiet=opt.quiet)
|
|
branch = rp.GetBranch('default')
|
|
branch.merge = remote_ref
|
|
rp.work_git.update_ref('refs/heads/default', rev)
|
|
branch.Save()
|
|
|
|
if opt.worktree:
|
|
# Older versions of git supported worktree, but had dangerous gc bugs.
|
|
git_require((2, 15, 0), fail=True, msg='git gc worktree corruption')
|
|
|
|
self._SyncManifest(opt)
|
|
self._LinkManifest(opt.manifest_name)
|
|
|
|
if os.isatty(0) and os.isatty(1) and not self.manifest.IsMirror:
|
|
if opt.config_name or self._ShouldConfigureUser(opt):
|
|
self._ConfigureUser(opt)
|
|
self._ConfigureColor()
|
|
|
|
self._DisplayResult(opt)
|