Support variable substitution and tryserver- and waterfall-only cmd line args.

scripts/slave/recipe_modules/chromium_tests/steps.py

 # Copyright 2014 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.
 
 import re
 import string
 
 
 class Test(object):
   """
@@ skipping 329 matching lines @@
     gtest_results = self._test_runs[suffix].test_utils.gtest_results
     if not gtest_results.valid:  # pragma: no cover
       return False
     global_tags = gtest_results.raw.get('global_tags', [])
     return 'UNRELIABLE_RESULTS' not in global_tags
 
   def failures(self, api, suffix):
     return self._test_runs[suffix].test_utils.gtest_results.failures
 
 
-def generate_gtest(api, mastername, buildername, test_spec,
-                   enable_swarming=False, scripts_compile_targets=None):
+def get_args_for_test(api, chromium_tests_api, test_spec, bot_update_step):
+  """Gets the argument list for a dynamically generated test, as
+  provided by the JSON files in src/testing/buildbot/ in the Chromium
+  workspace. This function provides the following build properties in
+  the form of variable substitutions in the tests' argument lists:
+
+      buildername
+      got_revision
+
+  so, for example, a test can declare the argument:
+
+      --test-machine-name=\"${buildername}\"
+
+  and ${buildername} will be replaced with the associated build
+  property. In this example, it will also be double-quoted, to handle
+  the case where the machine name contains contains spaces.
+
+  This function also supports trybot-only and waterfall-only
+  arguments, so that a test can pass a different argument lists on the
+  continuous builders compared to tryjobs. This is useful when the
+  waterfall bots generate some reference data that is tested against
+  during tryjobs.
+  """
+
+  args = test_spec.get('args', [])
+  if chromium_tests_api.is_precommit_mode():
+    args = args + test_spec.get('precommit_args', [])
+  else:
+    args = args + test_spec.get('non_precommit_args', [])
+  # Perform substitution of known variables.
+  substitutions = {
+    'buildername': api.properties.get('buildername'),
+    'got_revision': bot_update_step.presentation.properties['got_revision']
+  }
+  return [string.Template(arg).safe_substitute(substitutions) for arg in args]
+
+
+def generate_gtest(api, chromium_tests_api, mastername, buildername, test_spec,
+                   bot_update_step, enable_swarming=False,
+                   scripts_compile_targets=None):
   def canonicalize_test(test):
     if isinstance(test, basestring):
       canonical_test = {'test': test}
     else:
       canonical_test = test.copy()
 
     canonical_test.setdefault('shard_index', 0)
     canonical_test.setdefault('total_shards', 1)
     return canonical_test
 
   def get_tests(api):
     return [canonicalize_test(t) for t in
             test_spec.get(buildername, {}).get('gtest_tests', [])]
 
   for test in get_tests(api):
-    args = test.get('args', [])
+    args = get_args_for_test(api, chromium_tests_api, test, bot_update_step)
     if test['shard_index'] != 0 or test['total_shards'] != 1:
       args.extend(['--test-launcher-shard-index=%d' % test['shard_index'],
                    '--test-launcher-total-shards=%d' % test['total_shards']])
     use_swarming = False
     swarming_shards = 1
     swarming_dimension_sets = None
     if enable_swarming:
       swarming_spec = test.get('swarming', {})
       if swarming_spec.get('can_use_on_swarming_builders'):
         use_swarming = True
@@ skipping 13 matching lines @@
                         swarming_dimensions=dimensions,
                         override_compile_targets=override_compile_targets)
     else:
       yield GTestTest(name, args=args, target_name=target_name,
                       flakiness_dash=True,
                       enable_swarming=use_swarming,
                       swarming_shards=swarming_shards,
                       override_compile_targets=override_compile_targets)
 
 
-def generate_script(api, mastername, buildername, test_spec,
-                    enable_swarming=False, scripts_compile_targets=None):
+def generate_script(api, chromium_tests_api, mastername, buildername, test_spec,
+                    bot_update_step, enable_swarming=False,
+                    scripts_compile_targets=None):
   for script_spec in test_spec.get(buildername, {}).get('scripts', []):
     yield ScriptTest(
         str(script_spec['name']),
         script_spec['script'],
         scripts_compile_targets,  # pragma: no cover
-        script_spec.get('args', []))
+        get_args_for_test(
+            api, chromium_tests_api, script_spec, bot_update_step))
 
 
 class DynamicPerfTests(Test):
   def __init__(self, perf_id, platform, target_bits, max_battery_temp=None,
                num_device_shards=1, num_host_shards=1, shard_index=0):
     self._perf_id = perf_id
     self._platform = platform
     self._target_bits = target_bits
 
     self._max_battery_temp = max_battery_temp
@@ skipping 694 matching lines @@
       step_result.presentation.logs['invalid_results_exc'] = [str(e)]
       valid = False
       failures = None
     if valid:
       step_result.presentation.step_text += api.test_utils.format_step_text([
         ['failures:', failures]
       ])
     return valid, failures
 
 
-def generate_isolated_script(api, mastername, buildername, test_spec,
-                             enable_swarming=False,
+def generate_isolated_script(api, chromium_tests_api, mastername, buildername,
+                             test_spec, bot_update_step, enable_swarming=False,
                              scripts_compile_targets=None):
   for spec in test_spec.get(buildername, {}).get('isolated_scripts', []):
     use_swarming = False
     swarming_shards = 1
     swarming_dimension_sets = None
     if enable_swarming:
       swarming_spec = spec.get('swarming', {})
       if swarming_spec.get('can_use_on_swarming_builders', False):
         use_swarming = True
         swarming_shards = swarming_spec.get('shards', 1)
         swarming_dimension_sets = swarming_spec.get('dimension_sets')
     name = str(spec['name'])
-    args = args=spec.get('args', [])
+    args = get_args_for_test(api, chromium_tests_api, spec, bot_update_step)

[Paweł Hajdan Jr., 2016/01/20 15:10:38]

If the support is intended for isolated script test, can we please limit the
variable substitution just to that?

It'd indeed address my concern about two mechanisms for the same thing. We
indeed do not currently have a way to pass these properties to isolated script
test.

[Ken Russell (switch to Gerrit), 2016/01/21 01:29:27]

Done and tests updated.

     target_name = spec['isolate_name']
     # This features is only needed for the cases in which the *_run compile
     # target is needed to generate isolate files that contains dynamically libs.
     # TODO(nednguyen, kbr): Remove this once all the GYP builds are converted
     # to GN.
     override_compile_targets = spec.get('override_compile_targets', None)
     if use_swarming:
       if swarming_dimension_sets:
         for dimensions in swarming_dimension_sets:
           # Yield potentially multiple invocations of the same test,
@@ skipping 567 matching lines @@
   def run(self, api, suffix, test_filter=None):
     api.chromium_android.coverage_report(upload=False)
     api.chromium_android.get_changed_lines_for_revision()
     api.chromium_android.incremental_coverage_report()
 
 
 GOMA_TESTS = [
   GTestTest('base_unittests'),
   GTestTest('content_unittests'),
 ]