Refactor nag functionality in to NagTimer class.

gclient_scm.py

 # Copyright (c) 2012 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.
 
 """Gclient-specific SCM-specific operations."""
 
 import logging
 import os
 import posixpath
 import re
@@ skipping 98 matching lines @@
   return scm_class(url, root_dir, relpath)
 
 
 # SCMWrapper base class
 
 class SCMWrapper(object):
   """Add necessary glue between all the supported SCM.
 
   This is the abstraction layer to bind to different SCM.
   """
+  nag_timer = 30
+  nag_max = 3
+
   def __init__(self, url=None, root_dir=None, relpath=None):
     self.url = url
     self._root_dir = root_dir
     if self._root_dir:
       self._root_dir = self._root_dir.replace('/', os.sep)
     self.relpath = relpath
     if self.relpath:
       self.relpath = self.relpath.replace('/', os.sep)
     if self.relpath and self._root_dir:
       self.checkout_path = os.path.join(self._root_dir, self.relpath)
@@ skipping 59 matching lines @@
     """Generates a patch file which can be applied to the root of the
     repository.
 
     The patch file is generated from a diff of the merge base of HEAD and
     its upstream branch.
     """
     merge_base = self._Capture(['merge-base', 'HEAD', 'origin'])
     gclient_utils.CheckCallAndFilter(
         ['git', 'diff', merge_base],
         cwd=self.checkout_path,
+        nag_timer=self.nag_timer,
+        nag_max=self.nag_max,
         filter_fn=GitDiffFilterer(self.relpath).Filter)
 
   def UpdateSubmoduleConfig(self):
     submod_cmd = ['git', 'config', '-f', '$toplevel/.git/config',
                   'submodule.$name.ignore', '||',
                   'git', 'config', '-f', '$toplevel/.git/config',
                   'submodule.$name.ignore', 'all']
     cmd = ['git', 'submodule', '--quiet', 'foreach', ' '.join(submod_cmd)]
     cmd2 = ['git', 'config', 'diff.ignoreSubmodules', 'all']
     cmd3 = ['git', 'config', 'branch.autosetupmerge']
     cmd4 = ['git', 'config', 'fetch.recurseSubmodules', 'false']
     kwargs = {'cwd': self.checkout_path,
               'print_stdout': False,
+              'nag_timer': self.nag_timer,
+              'nag_max': self.nag_max,
               'filter_fn': lambda x: None}
     try:
       gclient_utils.CheckCallAndFilter(cmd, **kwargs)
       gclient_utils.CheckCallAndFilter(cmd2, **kwargs)
     except subprocess2.CalledProcessError:
       # Not a fatal error, or even very interesting in a non-git-submodule
       # world.  So just keep it quiet.
       pass
     try:
       gclient_utils.CheckCallAndFilter(cmd3, **kwargs)
@@ skipping 624 matching lines @@
     # Returns name of current branch or None for detached HEAD
     branch = self._Capture(['rev-parse', '--abbrev-ref=strict', 'HEAD'])
     if branch == 'HEAD':
       return None
     return branch
 
   def _Capture(self, args):
     return subprocess2.check_output(
         ['git'] + args,
         stderr=subprocess2.PIPE,
+        nag_timer=self.nag_timer,
+        nag_max=self.nag_max,
         cwd=self.checkout_path).strip()
 
   def _UpdateBranchHeads(self, options, fetch=False):
     """Adds, and optionally fetches, "branch-heads" refspecs if requested."""
     if hasattr(options, 'with_branch_heads') and options.with_branch_heads:
       backoff_time = 5
       for _ in range(3):
         try:
           config_cmd = ['config', 'remote.origin.fetch',
                         '+refs/branch-heads/*:refs/remotes/branch-heads/*',
                         '^\\+refs/branch-heads/\\*:.*$']
           self._Run(config_cmd, options)
           if fetch:
             fetch_cmd = ['fetch', 'origin']
             if options.verbose:
               fetch_cmd.append('--verbose')
             self._Run(fetch_cmd, options)
           break
         except subprocess2.CalledProcessError, e:
           print(str(e))
           print('Retrying in %.1f seconds...' % backoff_time)
           time.sleep(backoff_time)
           backoff_time *= 1.3
 
   def _Run(self, args, options, **kwargs):
     kwargs.setdefault('cwd', self.checkout_path)
     kwargs.setdefault('print_stdout', True)
+    kwargs.setdefault('nag_timer', self.nag_timer)
+    kwargs.setdefault('nag_max', self.nag_max)
     stdout = kwargs.get('stdout', sys.stdout)
     stdout.write('\n________ running \'git %s\' in \'%s\'\n' % (
                  ' '.join(args), kwargs['cwd']))
     gclient_utils.CheckCallAndFilter(['git'] + args, **kwargs)
 
 
 class SVNWrapper(SCMWrapper):
   """ Wrapper for SVN """
 
   @staticmethod
@@ skipping 29 matching lines @@
   def pack(self, options, args, file_list):
     """Generates a patch file which can be applied to the root of the
     repository."""
     if not os.path.isdir(self.checkout_path):
       raise gclient_utils.Error('Directory %s is not present.' %
           self.checkout_path)
     gclient_utils.CheckCallAndFilter(
         ['svn', 'diff', '-x', '--ignore-eol-style'] + args,
         cwd=self.checkout_path,
         print_stdout=False,
+        nag_timer=self.nag_timer,
+        nag_max=self.nag_max,
         filter_fn=SvnDiffFilterer(self.relpath).Filter)
 
   def update(self, options, args, file_list):
     """Runs svn to update or transparently checkout the working copy.
 
     All updated files will be appended to file_list.
 
     Raises:
       Error: if can't get URL for relative path.
     """
@@ skipping 277 matching lines @@
           'correct.') % rev)
     return rev
 
   def FullUrlForRelativeUrl(self, url):
     # Find the forth '/' and strip from there. A bit hackish.
     return '/'.join(self.url.split('/')[:4]) + url
 
   def _Run(self, args, options, **kwargs):
     """Runs a commands that goes to stdout."""
     kwargs.setdefault('cwd', self.checkout_path)
+    kwargs.setdefault('nag_timer', self.nag_timer)
+    kwargs.setdefault('nag_max', self.nag_max)
     gclient_utils.CheckCallAndFilterAndHeader(['svn'] + args,
         always=options.verbose, **kwargs)
 
   def _RunAndGetFileList(self, args, options, file_list, cwd=None):
     """Runs a commands that goes to stdout and grabs the file listed."""
     cwd = cwd or self.checkout_path
     scm.SVN.RunAndGetFileList(
         options.verbose,
         args + ['--ignore-externals'],
         cwd=cwd,
@@ skipping 22 matching lines @@
       new_command.append('--force')
       if command[0] != 'checkout' and scm.SVN.AssertVersion('1.6')[0]:
         new_command.extend(('--accept', 'theirs-conflict'))
     elif options.manually_grab_svn_rev:
       new_command.append('--force')
       if command[0] != 'checkout' and scm.SVN.AssertVersion('1.6')[0]:
         new_command.extend(('--accept', 'postpone'))
     elif command[0] != 'checkout' and scm.SVN.AssertVersion('1.6')[0]:
       new_command.extend(('--accept', 'postpone'))
     return new_command