[Predator] Add maximum number argument to delta test.

appengine/findit/util_scripts/crash_queries/delta_test/run-delta-test.py

 # Copyright 2016 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.
 
 """Runs delta test on two Predator revisions."""
 
 import argparse
 from datetime import date
 from datetime import timedelta
 import logging
@@ skipping 10 matching lines @@
 
 from crash_queries.delta_test import delta_test
 from crash_queries.delta_test import delta_util
 
 _TODAY = date.today().strftime('%Y-%m-%d')
 _A_YEAR_AGO = (date.today() - timedelta(days=365)).strftime('%Y-%m-%d')
 
 # App Engine APIs will fail if batch size is more than 1000.
 _MAX_BATCH_SIZE = 1000
 _DEFAULT_BATCH_SIZE = _MAX_BATCH_SIZE
+_DEFAULT_MAX_N = 100
 
 DELTA_RESULTS_DIRECTORY = os.path.join(os.path.dirname(__file__),
                                        'delta_results')
 CHROMIUM_REPO = 'https://chromium.googlesource.com/chromium/src'
 
 
+def GenerateDeltaResultPath(directory, git_hash1, git_hash2,
+                            since_date, until_date, max_n):
+  """Returns the file path of delta result."""
+  delta_result_prefix = '%s_%s_%s..%s_max_%d.delta' % (
+      git_hash1[:7], git_hash2[:7], since_date, until_date, max_n)
+
+  return os.path.join(directory, delta_result_prefix)
+
+
 def RunDeltaTest():
   """Runs delta testing between two different Predator revisions."""
   argparser = argparse.ArgumentParser(
       description=('Delta test is a script to report the differences between '
                    'analysis results of two local repo revisions. Local git '
                    'checkouts are used instead of Gitile to avoid quota '
                    'issue.\nNOTE, since the delta test needs to switch on '
                    'different revisions of local repo, please commit all local '
                    'changes before running the script, and do not make any '
                    'new changes while running it.'))
 
   argparser.add_argument(
       '--revisions',
       '-r',
       nargs='+',
       default=['HEAD^', 'HEAD'],
       help=('The Predator revisions to be compared. It can take '
-            'one or two revisions seperated by empty spaces.\n'
+            'one or two revisions seperated by empty spaces. N.B. The revision '
+            'can be any format that git can recognize, for example, it can be '
+            'either "97312dbc1" or "HEAD~5"\n'
             '(1) -r rev1 rev2: compare rev1 and rev2\n'
             '(2) -r rev: compare rev and current HEAD\n'
             '(3) no revisions provided, default to compare HEAD^ and HEAD'))
 
   argparser.add_argument(
       '--client',
       '-c',
       default='fracas',
       help=('Type of client data the delta test is running on, '
             'possible values are: fracas, cracas, clusterfuzz. '
@@ skipping 29 matching lines @@
   argparser.add_argument(
       '--batch',
       '-b',
       type=int,
       default=_DEFAULT_BATCH_SIZE,
       help=('The size of batch that can be processed at one time.\n'
             'NOTE, the batch size cannot be greater than 1000, or app engine '
             'APIs would fail, defaults to 1000.'))
 
   argparser.add_argument(
+      '--max',
+      '-m',
+      type=int,
+      default=_DEFAULT_MAX_N,
+      help='The maximum number of crashes we want to check, defaults to 100.')
+
+  argparser.add_argument(
       '--verbose',
       '-v',
       action='store_true',
       default=False,
       help='Print Predator results. Defaults to False.')
 
   args = argparser.parse_args()
 
   # If in verbose mode, prints debug information.
   if args.verbose:
     logging.basicConfig(level=logging.DEBUG)
   else:
     logging.basicConfig(level=logging.INFO)
 
   if len(args.revisions) > 2:
     logging.error('Only support delta test between 2 revisions.')
     sys.exit(1)
 
   if args.batch > _MAX_BATCH_SIZE:
     logging.error('Batch size cannot be greater than %s, or app engine APIs '
                   'would fail.', _MAX_BATCH_SIZE)
     sys.exit(1)
 
+  args.batch = args.max if args.max < args.batch else args.batch

[lijeffrey, 2017/01/24 02:22:49]

how about
args.batch = min(args.max, args.batch)?

[Sharu Jiang, 2017/01/25 19:17:29]

Done.

+
   # If only one revision provided, default the rev2 to HEAD.
   if len(args.revisions) == 1:
     args.revisions.append('HEAD')
 
   git_hash1 = delta_util.ParseGitHash(args.revisions[0])
   git_hash2 = delta_util.ParseGitHash(args.revisions[1])
-
-  delta_result_prefix = '%s_%s_%s..%s.delta' % (git_hash1[:7], git_hash2[:7],
-                                                args.since, args.until)
-  delta_csv_path = os.path.join(DELTA_RESULTS_DIRECTORY,
-                                '%s.csv' % delta_result_prefix)
-  delta_path = os.path.join(DELTA_RESULTS_DIRECTORY,
-                            delta_result_prefix)
-
+  delta_path = GenerateDeltaResultPath(DELTA_RESULTS_DIRECTORY,
+                                       git_hash1, git_hash1,
+                                       args.since, args.until, args.max)
+  delta_csv_path = delta_path + '.csv'
   # Check if delta results already existed.
   # TODO: this code has race conditions for interacting with the file system.
   if os.path.exists(delta_csv_path):
     print 'Delta results existed in\n%s' % delta_csv_path
     if not os.path.exists(delta_path):
       print 'Cannot print out delta results, please open %s to see the results.'
       return
 
     with open(delta_path) as f:
       deltas, crash_num = pickle.load(f)
   else:
     print 'Running delta test...'
     print ('WARNING: Please commit any local change before running delta test, '
            'and do not make any new changes while running the delta test.')
     # Get delta of results between git_hash1 and git_hash2.
     deltas, crash_num = delta_test.DeltaEvaluator(
         git_hash1, git_hash2, args.client, args.app,
-        start_date=args.since, end_date=args.until,
+        start_date=args.since, end_date=args.until, max_n=args.max,
         batch_size=args.batch, verbose=args.verbose)
     delta_util.FlushResult([deltas, crash_num], delta_path)
     delta_util.WriteDeltaToCSV(deltas, crash_num, args.app,
                                git_hash1, git_hash2, delta_csv_path)
 
   # Print delta results to users.
   print '\n========================= Summary ========================='
   delta_util.PrintDelta(deltas, crash_num, args.app)
 
 
 if __name__ == '__main__':
   RunDeltaTest()