Add --dry_run to presubmit_support.

presubmit_support.py

 #!/usr/bin/env python
 # 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.
 
 """Enables directory-specific presubmit checks to run at upload and/or commit.
 """
 
 __version__ = '1.8.0'
 
@@ skipping 247 matching lines @@
       r".*\b[A-Z0-9_]{2,}$",
       # SCM (can happen in dual SCM configuration). (Slightly over aggressive)
       r"(|.*[\\\/])\.git[\\\/].*",
       r"(|.*[\\\/])\.svn[\\\/].*",
       # There is no point in processing a patch file.
       r".+\.diff$",
       r".+\.patch$",
   )
 
   def __init__(self, change, presubmit_path, is_committing,
-      rietveld_obj, verbose):
+      rietveld_obj, verbose, dry_run=None):
     """Builds an InputApi object.
 
     Args:
       change: A presubmit.Change object.
       presubmit_path: The path to the presubmit script being processed.
       is_committing: True if the change is about to be committed.
       rietveld_obj: rietveld.Rietveld client object
     """
     # Version number of the presubmit_support script.
     self.version = [int(x) for x in __version__.split('.')]
     self.change = change
     self.is_committing = is_committing
     self.rietveld = rietveld_obj
+    self.dry_run = dry_run
     # TBD
     self.host_url = 'http://codereview.chromium.org'
     if self.rietveld:
       self.host_url = self.rietveld.url
 
     # We expose various modules and functions as attributes of the input_api
     # so that presubmit scripts don't have to import them.
     self.basename = os.path.basename
     self.cPickle = cPickle
     self.cpplint = cpplint
@@ skipping 1048 matching lines @@
   if results:
     output_stream.write('** Post Upload Hook Messages **\n')
   for result in results:
     result.handle(output_stream)
     output_stream.write('\n')
 
   return results
 
 
 class PresubmitExecuter(object):
-  def __init__(self, change, committing, rietveld_obj, verbose):
+  def __init__(self, change, committing, rietveld_obj, verbose,
+               dry_run=None):
     """
     Args:
       change: The Change object.
       committing: True if 'gcl commit' is running, False if 'gcl upload' is.
       rietveld_obj: rietveld.Rietveld client object.
     """
     self.change = change
     self.committing = committing
     self.rietveld = rietveld_obj
     self.verbose = verbose
+    self.dry_run = dry_run
 
   def ExecPresubmitScript(self, script_text, presubmit_path):
     """Executes a single presubmit script.
 
     Args:
       script_text: The text of the presubmit script.
       presubmit_path: The path to the presubmit file (this will be reported via
         input_api.PresubmitLocalPath()).
 
     Return:
       A list of result objects, empty if no problems.
     """
 
     # Change to the presubmit file's directory to support local imports.
     main_path = os.getcwd()
     os.chdir(os.path.dirname(presubmit_path))
 
     # Load the presubmit script into context.
     input_api = InputApi(self.change, presubmit_path, self.committing,
-                         self.rietveld, self.verbose)
+                         self.rietveld, self.verbose,
+                         dry_run=self.dry_run)
     context = {}
     try:
       exec script_text in context
     except Exception, e:
       raise PresubmitFailure('"%s" had an exception.\n%s' % (presubmit_path, e))
 
     # These function names must change if we make substantial changes to
     # the presubmit API that are not backwards compatible.
     if self.committing:
       function_name = 'CheckChangeOnCommit'
@@ skipping 21 matching lines @@
     return result
 
 
 def DoPresubmitChecks(change,
                       committing,
                       verbose,
                       output_stream,
                       input_stream,
                       default_presubmit,
                       may_prompt,
-                      rietveld_obj):
+                      rietveld_obj,
+                      dry_run=None):
   """Runs all presubmit checks that apply to the files in the change.
 
   This finds all PRESUBMIT.py files in directories enclosing the files in the
   change (up to the repository root) and calls the relevant entrypoint function
   depending on whether the change is being committed or uploaded.
 
   Prints errors, warnings and notifications.  Prompts the user for warnings
   when needed.
 
   Args:
     change: The Change object.
     committing: True if 'gcl commit' is running, False if 'gcl upload' is.
     verbose: Prints debug info.
     output_stream: A stream to write output from presubmit tests to.
     input_stream: A stream to read input from the user.
     default_presubmit: A default presubmit script to execute in any case.
     may_prompt: Enable (y/n) questions on warning or error.
     rietveld_obj: rietveld.Rietveld object.
+    dry_run: if true, some Checks will be skipped.
 
   Warning:
     If may_prompt is true, output_stream SHOULD be sys.stdout and input_stream
     SHOULD be sys.stdin.
 
   Return:
     A PresubmitOutput object. Use output.should_continue() to figure out
     if there were errors or warnings and the caller should abort.
   """
   old_environ = os.environ
   try:
     # Make sure python subprocesses won't generate .pyc files.
     os.environ = os.environ.copy()
     os.environ['PYTHONDONTWRITEBYTECODE'] = '1'
 
     output = PresubmitOutput(input_stream, output_stream)
     if committing:
       output.write("Running presubmit commit checks ...\n")
     else:
       output.write("Running presubmit upload checks ...\n")
     start_time = time.time()
     presubmit_files = ListRelevantPresubmitFiles(
         change.AbsoluteLocalPaths(True), change.RepositoryRoot())
     if not presubmit_files and verbose:
       output.write("Warning, no PRESUBMIT.py found.\n")
     results = []
-    executer = PresubmitExecuter(change, committing, rietveld_obj, verbose)
+    executer = PresubmitExecuter(change, committing, rietveld_obj, verbose,
+                                 dry_run=dry_run)
     if default_presubmit:
       if verbose:
         output.write("Running default presubmit script.\n")
       fake_path = os.path.join(change.RepositoryRoot(), 'PRESUBMIT.py')
       results += executer.ExecPresubmitScript(default_presubmit, fake_path)
     for filename in presubmit_files:
       filename = os.path.abspath(filename)
       if verbose:
         output.write("Running %s\n" % filename)
       # Accept CRLF presubmit script.
@@ skipping 159 matching lines @@
                     "system directories will also be searched.")
   parser.add_option("--upstream",
                     help="Git only: the base ref or upstream branch against "
                     "which the diff should be computed.")
   parser.add_option("--default_presubmit")
   parser.add_option("--may_prompt", action='store_true', default=False)
   parser.add_option("--skip_canned", action='append', default=[],
                     help="A list of checks to skip which appear in "
                     "presubmit_canned_checks. Can be provided multiple times "
                     "to skip multiple canned checks.")
+  parser.add_option("--dry_run", action='store_true',
+                    help=optparse.SUPPRESS_HELP)
   parser.add_option("--gerrit_url", help=optparse.SUPPRESS_HELP)
-  parser.add_option("--gerrit_fetch", help=optparse.SUPPRESS_HELP)
+  parser.add_option("--gerrit_fetch", action='store_true',
+                    help=optparse.SUPPRESS_HELP)
   parser.add_option("--rietveld_url", help=optparse.SUPPRESS_HELP)
   parser.add_option("--rietveld_email", help=optparse.SUPPRESS_HELP)
   parser.add_option("--rietveld_fetch", action='store_true', default=False,
                     help=optparse.SUPPRESS_HELP)
   # These are for OAuth2 authentication for bots. See also apply_issue.py
   parser.add_option("--rietveld_email_file", help=optparse.SUPPRESS_HELP)
   parser.add_option("--rietveld_private_key_file", help=optparse.SUPPRESS_HELP)
 
   # TODO(phajdan.jr): Update callers and remove obsolete --trybot-json .
   parser.add_option("--trybot-json",
@@ skipping 64 matching lines @@
       print >> sys.stderr, ('Patchset %d was not found in Gerrit issue %d' %
                             options.patchset, options.issue)
       return 2
     logging.info('Got author: "%s"', options.author)
     logging.info('Got description: """\n%s\n"""', options.description)
 
   try:
     with canned_check_filter(options.skip_canned):
       results = DoPresubmitChecks(
           change_class(options.name,
-                      options.description,
-                      options.root,
-                      files,
-                      options.issue,
-                      options.patchset,
-                      options.author,
-                      upstream=options.upstream),
+                       options.description,
+                       options.root,
+                       files,
+                       options.issue,
+                       options.patchset,
+                       options.author,
+                       upstream=options.upstream),
           options.commit,
           options.verbose,
           sys.stdout,
           sys.stdin,
           options.default_presubmit,
           options.may_prompt,
-          rietveld_obj)
+          rietveld_obj,
+          options.dry_run)
     return not results.should_continue()
   except NonexistantCannedCheckFilter, e:
     print >> sys.stderr, (
       'Attempted to skip nonexistent canned presubmit check: %s' % e.message)
     return 2
   except PresubmitFailure, e:
     print >> sys.stderr, e
     print >> sys.stderr, 'Maybe your depot_tools is out of date?'
     print >> sys.stderr, 'If all fails, contact maruel@'
     return 2
 
 
 if __name__ == '__main__':
   fix_encoding.fix_encoding()
   try:
     sys.exit(main())
   except KeyboardInterrupt:
     sys.stderr.write('interrupted\n')
     sys.exit(1)