| # Copyright (c) 2006-2009 The Chromium Authors. All rights reserved. |
| # Use of this source code is governed by a BSD-style license that can be |
| # found in the LICENSE file. |
| |
| """SCM-specific utility classes.""" |
| |
| import os |
| import re |
| import shutil |
| import subprocess |
| import sys |
| import tempfile |
| import xml.dom.minidom |
| |
| import gclient_utils |
| |
| def ValidateEmail(email): |
| return (re.match(r"^[a-zA-Z0-9._%-+]+@[a-zA-Z0-9._%-]+.[a-zA-Z]{2,6}$", email) |
| is not None) |
| |
| |
| class GIT(object): |
| COMMAND = "git" |
| |
| @staticmethod |
| def Capture(args, in_directory=None, print_error=True, error_ok=False): |
| """Runs git, capturing output sent to stdout as a string. |
| |
| Args: |
| args: A sequence of command line parameters to be passed to git. |
| in_directory: The directory where git is to be run. |
| |
| Returns: |
| The output sent to stdout as a string. |
| """ |
| c = [GIT.COMMAND] |
| c.extend(args) |
| try: |
| return gclient_utils.CheckCall(c, in_directory, print_error) |
| except gclient_utils.CheckCallError: |
| if error_ok: |
| return '' |
| raise |
| |
| @staticmethod |
| def CaptureStatus(files, upstream_branch='origin'): |
| """Returns git status. |
| |
| @files can be a string (one file) or a list of files. |
| |
| Returns an array of (status, file) tuples.""" |
| command = ["diff", "--name-status", "-r", "%s.." % upstream_branch] |
| if not files: |
| pass |
| elif isinstance(files, basestring): |
| command.append(files) |
| else: |
| command.extend(files) |
| |
| status = GIT.Capture(command).rstrip() |
| results = [] |
| if status: |
| for statusline in status.split('\n'): |
| m = re.match('^(\w)\t(.+)$', statusline) |
| if not m: |
| raise Exception("status currently unsupported: %s" % statusline) |
| results.append(('%s ' % m.group(1), m.group(2))) |
| return results |
| |
| @staticmethod |
| def RunAndFilterOutput(args, |
| in_directory, |
| print_messages, |
| print_stdout, |
| filter): |
| """Runs a command, optionally outputting to stdout. |
| |
| stdout is passed line-by-line to the given filter function. If |
| print_stdout is true, it is also printed to sys.stdout as in Run. |
| |
| Args: |
| args: A sequence of command line parameters to be passed. |
| in_directory: The directory where svn is to be run. |
| print_messages: Whether to print status messages to stdout about |
| which commands are being run. |
| print_stdout: Whether to forward program's output to stdout. |
| filter: A function taking one argument (a string) which will be |
| passed each line (with the ending newline character removed) of |
| program's output for filtering. |
| |
| Raises: |
| gclient_utils.Error: An error occurred while running the command. |
| """ |
| command = [GIT.COMMAND] |
| command.extend(args) |
| gclient_utils.SubprocessCallAndFilter(command, |
| in_directory, |
| print_messages, |
| print_stdout, |
| filter=filter) |
| |
| @staticmethod |
| def GetEmail(repo_root): |
| """Retrieves the user email address if known.""" |
| # We could want to look at the svn cred when it has a svn remote but it |
| # should be fine for now, users should simply configure their git settings. |
| return GIT.Capture(['config', 'user.email'], |
| repo_root, error_ok=True).strip() |
| |
| @staticmethod |
| def ShortBranchName(branch): |
| """Converts a name like 'refs/heads/foo' to just 'foo'.""" |
| return branch.replace('refs/heads/', '') |
| |
| @staticmethod |
| def GetBranchRef(cwd): |
| """Returns the full branch reference, e.g. 'refs/heads/master'.""" |
| return GIT.Capture(['symbolic-ref', 'HEAD'], cwd).strip() |
| |
| @staticmethod |
| def GetBranch(cwd): |
| """Returns the short branch name, e.g. 'master'.""" |
| return GIT.ShortBranchName(GIT.GetBranchRef(cwd)) |
| |
| @staticmethod |
| def IsGitSvn(cwd): |
| """Returns true if this repo looks like it's using git-svn.""" |
| # If you have any "svn-remote.*" config keys, we think you're using svn. |
| try: |
| GIT.Capture(['config', '--get-regexp', r'^svn-remote\.'], cwd) |
| return True |
| except gclient_utils.CheckCallError: |
| return False |
| |
| @staticmethod |
| def GetSVNBranch(cwd): |
| """Returns the svn branch name if found.""" |
| # Try to figure out which remote branch we're based on. |
| # Strategy: |
| # 1) find all git-svn branches and note their svn URLs. |
| # 2) iterate through our branch history and match up the URLs. |
| |
| # regexp matching the git-svn line that contains the URL. |
| git_svn_re = re.compile(r'^\s*git-svn-id: (\S+)@', re.MULTILINE) |
| |
| # Get the refname and svn url for all refs/remotes/*. |
| remotes = GIT.Capture( |
| ['for-each-ref', '--format=%(refname)', 'refs/remotes'], |
| cwd).splitlines() |
| svn_refs = {} |
| for ref in remotes: |
| match = git_svn_re.search( |
| GIT.Capture(['cat-file', '-p', ref], cwd)) |
| if match: |
| svn_refs[match.group(1)] = ref |
| |
| svn_branch = '' |
| if len(svn_refs) == 1: |
| # Only one svn branch exists -- seems like a good candidate. |
| svn_branch = svn_refs.values()[0] |
| elif len(svn_refs) > 1: |
| # We have more than one remote branch available. We don't |
| # want to go through all of history, so read a line from the |
| # pipe at a time. |
| # The -100 is an arbitrary limit so we don't search forever. |
| cmd = ['git', 'log', '-100', '--pretty=medium'] |
| proc = subprocess.Popen(cmd, stdout=subprocess.PIPE, cwd=cwd) |
| for line in proc.stdout: |
| match = git_svn_re.match(line) |
| if match: |
| url = match.group(1) |
| if url in svn_refs: |
| svn_branch = svn_refs[url] |
| proc.stdout.close() # Cut pipe. |
| break |
| return svn_branch |
| |
| @staticmethod |
| def FetchUpstreamTuple(cwd): |
| """Returns a tuple containg remote and remote ref, |
| e.g. 'origin', 'refs/heads/master' |
| """ |
| remote = '.' |
| branch = GIT.GetBranch(cwd) |
| upstream_branch = None |
| upstream_branch = GIT.Capture( |
| ['config', 'branch.%s.merge' % branch], error_ok=True).strip() |
| if upstream_branch: |
| remote = GIT.Capture( |
| ['config', 'branch.%s.remote' % branch], |
| error_ok=True).strip() |
| else: |
| # Fall back on trying a git-svn upstream branch. |
| if GIT.IsGitSvn(cwd): |
| upstream_branch = GIT.GetSVNBranch(cwd) |
| # Fall back on origin/master if it exits. |
| if not upstream_branch: |
| GIT.Capture(['branch', '-r']).split().count('origin/master') |
| remote = 'origin' |
| upstream_branch = 'refs/heads/master' |
| return remote, upstream_branch |
| |
| @staticmethod |
| def GetUpstream(cwd): |
| """Gets the current branch's upstream branch.""" |
| remote, upstream_branch = GIT.FetchUpstreamTuple(cwd) |
| if remote is not '.': |
| upstream_branch = upstream_branch.replace('heads', 'remotes/' + remote) |
| return upstream_branch |
| |
| @staticmethod |
| def GenerateDiff(cwd, branch=None, full_move=False): |
| """Diffs against the upstream branch or optionally another branch. |
| |
| full_move means that move or copy operations should completely recreate the |
| files, usually in the prospect to apply the patch for a try job.""" |
| if not branch: |
| branch = GIT.GetUpstream(cwd) |
| command = ['diff-tree', '-p', '--no-prefix', branch, 'HEAD'] |
| if not full_move: |
| command.append('-C') |
| diff = GIT.Capture(command, cwd).splitlines(True) |
| for i in range(len(diff)): |
| # In the case of added files, replace /dev/null with the path to the |
| # file being added. |
| if diff[i].startswith('--- /dev/null'): |
| diff[i] = '--- %s' % diff[i+1][4:] |
| return ''.join(diff) |
| |
| @staticmethod |
| def GetPatchName(cwd): |
| """Constructs a name for this patch.""" |
| short_sha = GIT.Capture(['rev-parse', '--short=4', 'HEAD'], cwd).strip() |
| return "%s-%s" % (GIT.GetBranch(cwd), short_sha) |
| |
| @staticmethod |
| def GetCheckoutRoot(cwd): |
| """Returns the top level directory of the current repository. |
| |
| The directory is returned as an absolute path. |
| """ |
| return os.path.abspath(GIT.Capture(['rev-parse', '--show-cdup'], |
| cwd).strip()) |
| |
| |
| class SVN(object): |
| COMMAND = "svn" |
| |
| @staticmethod |
| def Run(args, in_directory): |
| """Runs svn, sending output to stdout. |
| |
| Args: |
| args: A sequence of command line parameters to be passed to svn. |
| in_directory: The directory where svn is to be run. |
| |
| Raises: |
| Error: An error occurred while running the svn command. |
| """ |
| c = [SVN.COMMAND] |
| c.extend(args) |
| # TODO(maruel): This is very gclient-specific. |
| gclient_utils.SubprocessCall(c, in_directory) |
| |
| @staticmethod |
| def Capture(args, in_directory=None, print_error=True): |
| """Runs svn, capturing output sent to stdout as a string. |
| |
| Args: |
| args: A sequence of command line parameters to be passed to svn. |
| in_directory: The directory where svn is to be run. |
| |
| Returns: |
| The output sent to stdout as a string. |
| """ |
| c = [SVN.COMMAND] |
| c.extend(args) |
| |
| # *Sigh*: Windows needs shell=True, or else it won't search %PATH% for |
| # the svn.exe executable, but shell=True makes subprocess on Linux fail |
| # when it's called with a list because it only tries to execute the |
| # first string ("svn"). |
| stderr = None |
| if not print_error: |
| stderr = subprocess.PIPE |
| return subprocess.Popen(c, |
| cwd=in_directory, |
| shell=(sys.platform == 'win32'), |
| stdout=subprocess.PIPE, |
| stderr=stderr).communicate()[0] |
| |
| @staticmethod |
| def RunAndGetFileList(options, args, in_directory, file_list): |
| """Runs svn checkout, update, or status, output to stdout. |
| |
| The first item in args must be either "checkout", "update", or "status". |
| |
| svn's stdout is parsed to collect a list of files checked out or updated. |
| These files are appended to file_list. svn's stdout is also printed to |
| sys.stdout as in Run. |
| |
| Args: |
| options: command line options to gclient |
| args: A sequence of command line parameters to be passed to svn. |
| in_directory: The directory where svn is to be run. |
| |
| Raises: |
| Error: An error occurred while running the svn command. |
| """ |
| command = [SVN.COMMAND] |
| command.extend(args) |
| |
| # svn update and svn checkout use the same pattern: the first three columns |
| # are for file status, property status, and lock status. This is followed |
| # by two spaces, and then the path to the file. |
| update_pattern = '^... (.*)$' |
| |
| # The first three columns of svn status are the same as for svn update and |
| # svn checkout. The next three columns indicate addition-with-history, |
| # switch, and remote lock status. This is followed by one space, and then |
| # the path to the file. |
| status_pattern = '^...... (.*)$' |
| |
| # args[0] must be a supported command. This will blow up if it's something |
| # else, which is good. Note that the patterns are only effective when |
| # these commands are used in their ordinary forms, the patterns are invalid |
| # for "svn status --show-updates", for example. |
| pattern = { |
| 'checkout': update_pattern, |
| 'status': status_pattern, |
| 'update': update_pattern, |
| }[args[0]] |
| compiled_pattern = re.compile(pattern) |
| # Place an upper limit. |
| for i in range(1, 10): |
| previous_list_len = len(file_list) |
| failure = [] |
| def CaptureMatchingLines(line): |
| match = compiled_pattern.search(line) |
| if match: |
| file_list.append(match.group(1)) |
| if line.startswith('svn: '): |
| # We can't raise an exception. We can't alias a variable. Use a cheap |
| # way. |
| failure.append(True) |
| try: |
| SVN.RunAndFilterOutput(args, |
| in_directory, |
| options.verbose, |
| True, |
| CaptureMatchingLines) |
| except gclient_utils.Error: |
| # We enforce that some progress has been made. |
| if len(failure) and len(file_list) > previous_list_len: |
| if args[0] == 'checkout': |
| args = args[:] |
| # An aborted checkout is now an update. |
| args[0] = 'update' |
| continue |
| break |
| |
| @staticmethod |
| def RunAndFilterOutput(args, |
| in_directory, |
| print_messages, |
| print_stdout, |
| filter): |
| """Runs a command, optionally outputting to stdout. |
| |
| stdout is passed line-by-line to the given filter function. If |
| print_stdout is true, it is also printed to sys.stdout as in Run. |
| |
| Args: |
| args: A sequence of command line parameters to be passed. |
| in_directory: The directory where svn is to be run. |
| print_messages: Whether to print status messages to stdout about |
| which commands are being run. |
| print_stdout: Whether to forward program's output to stdout. |
| filter: A function taking one argument (a string) which will be |
| passed each line (with the ending newline character removed) of |
| program's output for filtering. |
| |
| Raises: |
| gclient_utils.Error: An error occurred while running the command. |
| """ |
| command = [SVN.COMMAND] |
| command.extend(args) |
| gclient_utils.SubprocessCallAndFilter(command, |
| in_directory, |
| print_messages, |
| print_stdout, |
| filter=filter) |
| |
| @staticmethod |
| def CaptureInfo(relpath, in_directory=None, print_error=True): |
| """Returns a dictionary from the svn info output for the given file. |
| |
| Args: |
| relpath: The directory where the working copy resides relative to |
| the directory given by in_directory. |
| in_directory: The directory where svn is to be run. |
| """ |
| output = SVN.Capture(["info", "--xml", relpath], in_directory, print_error) |
| dom = gclient_utils.ParseXML(output) |
| result = {} |
| if dom: |
| GetNamedNodeText = gclient_utils.GetNamedNodeText |
| GetNodeNamedAttributeText = gclient_utils.GetNodeNamedAttributeText |
| def C(item, f): |
| if item is not None: return f(item) |
| # /info/entry/ |
| # url |
| # reposityory/(root|uuid) |
| # wc-info/(schedule|depth) |
| # commit/(author|date) |
| # str() the results because they may be returned as Unicode, which |
| # interferes with the higher layers matching up things in the deps |
| # dictionary. |
| # TODO(maruel): Fix at higher level instead (!) |
| result['Repository Root'] = C(GetNamedNodeText(dom, 'root'), str) |
| result['URL'] = C(GetNamedNodeText(dom, 'url'), str) |
| result['UUID'] = C(GetNamedNodeText(dom, 'uuid'), str) |
| result['Revision'] = C(GetNodeNamedAttributeText(dom, 'entry', |
| 'revision'), |
| int) |
| result['Node Kind'] = C(GetNodeNamedAttributeText(dom, 'entry', 'kind'), |
| str) |
| # Differs across versions. |
| if result['Node Kind'] == 'dir': |
| result['Node Kind'] = 'directory' |
| result['Schedule'] = C(GetNamedNodeText(dom, 'schedule'), str) |
| result['Path'] = C(GetNodeNamedAttributeText(dom, 'entry', 'path'), str) |
| result['Copied From URL'] = C(GetNamedNodeText(dom, 'copy-from-url'), str) |
| result['Copied From Rev'] = C(GetNamedNodeText(dom, 'copy-from-rev'), str) |
| return result |
| |
| @staticmethod |
| def CaptureHeadRevision(url): |
| """Get the head revision of a SVN repository. |
| |
| Returns: |
| Int head revision |
| """ |
| info = SVN.Capture(["info", "--xml", url], os.getcwd()) |
| dom = xml.dom.minidom.parseString(info) |
| return dom.getElementsByTagName('entry')[0].getAttribute('revision') |
| |
| @staticmethod |
| def CaptureStatus(files): |
| """Returns the svn 1.5 svn status emulated output. |
| |
| @files can be a string (one file) or a list of files. |
| |
| Returns an array of (status, file) tuples.""" |
| command = ["status", "--xml"] |
| if not files: |
| pass |
| elif isinstance(files, basestring): |
| command.append(files) |
| else: |
| command.extend(files) |
| |
| status_letter = { |
| None: ' ', |
| '': ' ', |
| 'added': 'A', |
| 'conflicted': 'C', |
| 'deleted': 'D', |
| 'external': 'X', |
| 'ignored': 'I', |
| 'incomplete': '!', |
| 'merged': 'G', |
| 'missing': '!', |
| 'modified': 'M', |
| 'none': ' ', |
| 'normal': ' ', |
| 'obstructed': '~', |
| 'replaced': 'R', |
| 'unversioned': '?', |
| } |
| dom = gclient_utils.ParseXML(SVN.Capture(command)) |
| results = [] |
| if dom: |
| # /status/target/entry/(wc-status|commit|author|date) |
| for target in dom.getElementsByTagName('target'): |
| #base_path = target.getAttribute('path') |
| for entry in target.getElementsByTagName('entry'): |
| file_path = entry.getAttribute('path') |
| wc_status = entry.getElementsByTagName('wc-status') |
| assert len(wc_status) == 1 |
| # Emulate svn 1.5 status ouput... |
| statuses = [' '] * 7 |
| # Col 0 |
| xml_item_status = wc_status[0].getAttribute('item') |
| if xml_item_status in status_letter: |
| statuses[0] = status_letter[xml_item_status] |
| else: |
| raise Exception('Unknown item status "%s"; please implement me!' % |
| xml_item_status) |
| # Col 1 |
| xml_props_status = wc_status[0].getAttribute('props') |
| if xml_props_status == 'modified': |
| statuses[1] = 'M' |
| elif xml_props_status == 'conflicted': |
| statuses[1] = 'C' |
| elif (not xml_props_status or xml_props_status == 'none' or |
| xml_props_status == 'normal'): |
| pass |
| else: |
| raise Exception('Unknown props status "%s"; please implement me!' % |
| xml_props_status) |
| # Col 2 |
| if wc_status[0].getAttribute('wc-locked') == 'true': |
| statuses[2] = 'L' |
| # Col 3 |
| if wc_status[0].getAttribute('copied') == 'true': |
| statuses[3] = '+' |
| # Col 4 |
| if wc_status[0].getAttribute('switched') == 'true': |
| statuses[4] = 'S' |
| # TODO(maruel): Col 5 and 6 |
| item = (''.join(statuses), file_path) |
| results.append(item) |
| return results |
| |
| @staticmethod |
| def IsMoved(filename): |
| """Determine if a file has been added through svn mv""" |
| info = SVN.CaptureInfo(filename) |
| return (info.get('Copied From URL') and |
| info.get('Copied From Rev') and |
| info.get('Schedule') == 'add') |
| |
| @staticmethod |
| def GetFileProperty(file, property_name): |
| """Returns the value of an SVN property for the given file. |
| |
| Args: |
| file: The file to check |
| property_name: The name of the SVN property, e.g. "svn:mime-type" |
| |
| Returns: |
| The value of the property, which will be the empty string if the property |
| is not set on the file. If the file is not under version control, the |
| empty string is also returned. |
| """ |
| output = SVN.Capture(["propget", property_name, file]) |
| if (output.startswith("svn: ") and |
| output.endswith("is not under version control")): |
| return "" |
| else: |
| return output |
| |
| @staticmethod |
| def DiffItem(filename, full_move=False): |
| """Diffs a single file. |
| |
| Be sure to be in the appropriate directory before calling to have the |
| expected relative path. |
| full_move means that move or copy operations should completely recreate the |
| files, usually in the prospect to apply the patch for a try job.""" |
| # Use svn info output instead of os.path.isdir because the latter fails |
| # when the file is deleted. |
| if SVN.CaptureInfo(filename).get("Node Kind") == "directory": |
| return None |
| # If the user specified a custom diff command in their svn config file, |
| # then it'll be used when we do svn diff, which we don't want to happen |
| # since we want the unified diff. Using --diff-cmd=diff doesn't always |
| # work, since they can have another diff executable in their path that |
| # gives different line endings. So we use a bogus temp directory as the |
| # config directory, which gets around these problems. |
| bogus_dir = tempfile.mkdtemp() |
| try: |
| # Grabs the diff data. |
| data = SVN.Capture(["diff", "--config-dir", bogus_dir, filename], None) |
| if data: |
| pass |
| elif SVN.IsMoved(filename): |
| if full_move: |
| file_content = gclient_utils.FileRead(filename, 'rb') |
| # Prepend '+' to every lines. |
| file_content = ['+' + i for i in file_content.splitlines(True)] |
| nb_lines = len(file_content) |
| # We need to use / since patch on unix will fail otherwise. |
| filename = filename.replace('\\', '/') |
| data = "Index: %s\n" % filename |
| data += '=' * 67 + '\n' |
| # Note: Should we use /dev/null instead? |
| data += "--- %s\n" % filename |
| data += "+++ %s\n" % filename |
| data += "@@ -0,0 +1,%d @@\n" % nb_lines |
| data += ''.join(file_content) |
| else: |
| # svn diff on a mv/cp'd file outputs nothing. |
| # We put in an empty Index entry so upload.py knows about them. |
| data = "Index: %s\n" % filename |
| else: |
| # The file is not modified anymore. It should be removed from the set. |
| pass |
| finally: |
| shutil.rmtree(bogus_dir) |
| return data |
| |
| @staticmethod |
| def GenerateDiff(filenames, root=None, full_move=False): |
| """Returns a string containing the diff for the given file list. |
| |
| The files in the list should either be absolute paths or relative to the |
| given root. If no root directory is provided, the repository root will be |
| used. |
| The diff will always use relative paths. |
| """ |
| previous_cwd = os.getcwd() |
| root = os.path.join(root or SVN.GetCheckoutRoot(previous_cwd), '') |
| def RelativePath(path, root): |
| """We must use relative paths.""" |
| if path.startswith(root): |
| return path[len(root):] |
| return path |
| try: |
| os.chdir(root) |
| diff = "".join(filter(None, |
| [SVN.DiffItem(RelativePath(f, root), |
| full_move=full_move) |
| for f in filenames])) |
| finally: |
| os.chdir(previous_cwd) |
| return diff |
| |
| |
| @staticmethod |
| def GetEmail(repo_root): |
| """Retrieves the svn account which we assume is an email address.""" |
| infos = SVN.CaptureInfo(repo_root) |
| uuid = infos.get('UUID') |
| root = infos.get('Repository Root') |
| if not root: |
| return None |
| |
| # Should check for uuid but it is incorrectly saved for https creds. |
| realm = root.rsplit('/', 1)[0] |
| if root.startswith('https') or not uuid: |
| regexp = re.compile(r'<%s:\d+>.*' % realm) |
| else: |
| regexp = re.compile(r'<%s:\d+> %s' % (realm, uuid)) |
| if regexp is None: |
| return None |
| if sys.platform.startswith('win'): |
| if not 'APPDATA' in os.environ: |
| return None |
| auth_dir = os.path.join(os.environ['APPDATA'], 'Subversion', 'auth', |
| 'svn.simple') |
| else: |
| if not 'HOME' in os.environ: |
| return None |
| auth_dir = os.path.join(os.environ['HOME'], '.subversion', 'auth', |
| 'svn.simple') |
| for credfile in os.listdir(auth_dir): |
| cred_info = SVN.ReadSimpleAuth(os.path.join(auth_dir, credfile)) |
| if regexp.match(cred_info.get('svn:realmstring')): |
| return cred_info.get('username') |
| |
| @staticmethod |
| def ReadSimpleAuth(filename): |
| f = open(filename, 'r') |
| values = {} |
| def ReadOneItem(type): |
| m = re.match(r'%s (\d+)' % type, f.readline()) |
| if not m: |
| return None |
| data = f.read(int(m.group(1))) |
| if f.read(1) != '\n': |
| return None |
| return data |
| |
| while True: |
| key = ReadOneItem('K') |
| if not key: |
| break |
| value = ReadOneItem('V') |
| if not value: |
| break |
| values[key] = value |
| return values |
| |
| @staticmethod |
| def GetCheckoutRoot(directory): |
| """Returns the top level directory of the current repository. |
| |
| The directory is returned as an absolute path. |
| """ |
| directory = os.path.abspath(directory) |
| infos = SVN.CaptureInfo(directory, print_error=False) |
| cur_dir_repo_root = infos.get("Repository Root") |
| if not cur_dir_repo_root: |
| return None |
| |
| while True: |
| parent = os.path.dirname(directory) |
| if (SVN.CaptureInfo(parent, print_error=False).get( |
| "Repository Root") != cur_dir_repo_root): |
| break |
| directory = parent |
| return directory |
