Ask for feedback one time out of 5, only when there is presubmit check notification.

presubmit_support.py

 #!/usr/bin/python
 # 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.
 
 """Enables directory-specific presubmit checks to run at upload and/or commit.
 """
 
 __version__ = '1.3.2'
 
 # TODO(joi) Add caching where appropriate/needed. The API is designed to allow
 # caching (between all different invocations of presubmit scripts for a given
 # change). We should add it as our presubmit scripts start feeling slow.
 
 import cPickle  # Exposed through the API.
 import cStringIO  # Exposed through the API.
 import exceptions
 import fnmatch
 import glob
 import logging
 import marshal  # Exposed through the API.
 import optparse
 import os  # Somewhat exposed through the API.
 import pickle  # Exposed through the API.
+import random
 import re  # Exposed through the API.
 import subprocess  # Exposed through the API.
 import sys  # Parts exposed through API.
 import tempfile  # Exposed through the API.
 import traceback  # Exposed through the API.
 import types
 import unittest  # Exposed through the API.
 import urllib2  # Exposed through the API.
 import warnings
 
 # Local imports.
 # TODO(joi) Would be cleaner to factor out utils in gcl to separate module, but
 # for now it would only be a couple of functions so hardly worth it.
 import gcl
 import gclient
 import presubmit_canned_checks
 
 
+# Ask for feedback only once in program lifetime.
+_ASKED_FOR_FEEDBACK = False
+
+
 class NotImplementedException(Exception):
   """We're leaving placeholders in a bunch of places to remind us of the
   design of the API, but we have not implemented all of it yet. Implement as
   the need arises.
   """
   pass
 
 
 def normpath(path):
   '''Version of os.path.normpath that also changes backward slashes to
@@ skipping 720 matching lines @@
 
   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.
 
+  Warning:
+    If may_prompt is true, output_streeam SHOULD be sys.stdout and input_stream

[Jói Sigurðsson, 2009/06/25 21:19:28]

output_streeam -> output_stream

+    SHOULD be sys.stdin.
+
   Return:
     True if execution can continue, False if not.
   """
   presubmit_files = ListRelevantPresubmitFiles(change.AbsoluteLocalPaths(True),
                                                change.RepositoryRoot())
   if not presubmit_files and verbose:
     output_stream.write("Warning, no presubmit.py found.\n")
   results = []
   executer = PresubmitExecuter(change, committing)
   if default_presubmit:
@@ skipping 30 matching lines @@
         if not item._Handle(output_stream, input_stream,
                             may_prompt=False):
           error_count += 1
         output_stream.write('\n')
   if not errors and warnings and may_prompt:
     output_stream.write(
       'There were presubmit warnings. Sure you want to continue? (y/N): ')
     response = input_stream.readline()
     if response.strip().lower() != 'y':
       error_count += 1
+
+  global _ASKED_FOR_FEEDBACK
+  # Ask for feedback one time out of 5.
+  if (len(results) and random.randint(0, 4) == 0 and not _ASKED_FOR_FEEDBACK):
+    output_stream.write("Was the presubmit check useful? Please send feedback "
+                        "& hate mail to maruel@chromium.org!\n")
+    _ASKED_FOR_FEEDBACK = True
   return (error_count == 0)
 
 
 def ScanSubDirs(mask, recursive):
   if not recursive:
     return [x for x in glob.glob(mask) if '.svn' not in x and '.git' not in x]
   else:
     results = []
     for root, dirs, files in os.walk('.'):
       if '.svn' in dirs:
@@ skipping 65 matching lines @@
                                options.commit,
                                options.verbose,
                                sys.stdout,
                                sys.stdin,
                                options.default_presubmit,
                                options.may_prompt)
 
 
 if __name__ == '__main__':
   sys.exit(Main(sys.argv))