# 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.

"""Swarming staging recipe: runs tests for HEAD of chromium using HEAD of
swarming_client toolset on Swarming staging server instances
(*-dev.appspot.com).

Intended to catch bugs in swarming_client and Swarming servers early on, before
full roll out.

Waterfall page: https://build.chromium.org/p/chromium.swarm/waterfall
"""

from recipe_engine.recipe_api import Property

DEPS = [
  'chromium',
  'chromium_checkout',
  'chromium_tests',
  'commit_position',
  'depot_tools/gclient',
  'isolate',
  'recipe_engine/json',
  'recipe_engine/path',
  'recipe_engine/platform',
  'recipe_engine/properties',
  'recipe_engine/step',
  'swarming',
  'swarming_client',
  'test_results',
  'test_utils',
]


PROPERTIES = {
    'buildername': Property(default=''),
    'mastername': Property(default=''),
}


def RunSteps(api, buildername, mastername):
  # Configure isolate & swarming modules to use staging instances.
  api.isolate.isolate_server = 'https://isolateserver-dev.appspot.com'
  api.swarming.swarming_server = 'https://chromium-swarm-dev.appspot.com'
  api.swarming.verbose = True

  # Run tests from chromium.swarm buildbot with a relatively high priority
  # so that they take precedence over manually triggered tasks.
  api.swarming.default_priority = 20

  # Do not care about the OS specific version on Canary.
  api.swarming.set_default_dimension(
      'os',
      api.swarming.prefered_os_dimension(api.platform.name).split('-', 1)[0])
  if api.platform.is_win:
    # Force os:Windows-10 instead of os:Windows which may trigger on Windows 7.
    api.swarming.set_default_dimension('os', 'Windows-10')

  api.swarming.set_default_dimension('pool', 'Chrome')
  api.swarming.add_default_tag('project:chromium')
  api.swarming.add_default_tag('purpose:staging')
  api.swarming.default_idempotent = True

  # We are checking out Chromium with swarming_client dep unpinned and pointing
  # to ToT of swarming_client repo, see recipe_modules/gclient/config.py.
  bot_config = api.chromium_tests.create_bot_config_object(
      [api.chromium_tests.create_bot_id(mastername, buildername)])
  api.chromium_tests.configure_build(bot_config)
  api.gclient.c.solutions[0].custom_vars['swarming_revision'] = ''
  api.gclient.c.revisions['src/tools/swarming_client'] = 'HEAD'
  update_step = api.chromium_checkout.ensure_checkout(bot_config)

  # Ensure swarming_client version is fresh enough.
  api.swarming.check_client_version()

  bot_db = api.chromium_tests.create_bot_db_object()
  bot_config.initialize_bot_db(api.chromium_tests, bot_db, update_step)
  test_config = api.chromium_tests.get_tests(bot_config, bot_db)
  compile_targets = api.chromium_tests.get_compile_targets(
      bot_config, bot_db, test_config.all_tests())

  # Build all supported tests.
  api.chromium.ensure_goma()
  api.chromium.runhooks()
  api.chromium_tests.compile_specific_targets(
      bot_config, update_step, bot_db, compile_targets, test_config.all_tests())

  platform_to_os = {
      'android': 'Android',
      'chromeos': 'ChromeOS',
  }
  if api.chromium.c.TARGET_PLATFORM in platform_to_os:
    api.swarming.set_default_dimension(
        'os', platform_to_os[api.chromium.c.TARGET_PLATFORM])
    api.swarming.set_default_dimension('gpu', None)
    api.swarming.set_default_dimension('cpu', None)

  test_runner = api.chromium_tests.create_test_runner(test_config.all_tests())
  with api.chromium_tests.wrap_chromium_tests(bot_config, test_config.all_tests()):
    test_runner()


def GenTests(api):
  yield (
    api.test('android') +
    api.properties(
        buildername='Android N5 Swarm',
        mastername='chromium.swarm',
        bot_id='TestSlave',
        buildnumber=123,
        path_config='kitchen')
  )

  yield (
    api.test('cros') +
    api.properties(
        buildername='ChromeOS Swarm',
        mastername='chromium.swarm',
        bot_id='TestSlave',
        buildnumber=123,
        path_config='kitchen') +
        api.override_step_data(
            'read test spec (chromium.swarm.json)',
             api.json.output({
               'ChromeOS Swarm': {
                 'gtest_tests': [
                     {
                       'test': 'browser_tests',
                       'swarming': {
                         'can_use_on_swarming_builders': True,
                         'dimension_sets': [
                           {
                             'device_type': 'kevin-signed-mpkeys',
                             'os': 'ChromeOS',
                             'pool': 'ChromeOS',
                           }
                         ],
                       }
                     },
                  ],
               },
            })
        ) +
        api.override_step_data(
            'find isolated tests',
            api.json.output({
                'browser_tests': 'deadbeef',
            })
        )
  )

  # One 'collect' fails due to a missing shard and failing test, should not
  # prevent the second 'collect' from running.
  yield (
    api.test('one_fails') +
    api.properties(
        buildername='Linux Swarm',
        mastername='chromium.swarm',
        bot_id='TestSlave',
        buildnumber=123,
        path_config='kitchen') +
    api.override_step_data(
        'read test spec (chromium.swarm.json)',
        api.json.output({
            'Linux Swarm': {
                'gtest_tests': [
                    {
                        'test': 'browser_tests',
                        'swarming': {
                            'can_use_on_swarming_builders': True,
                            'shards': 2,
                         }
                    },
                ],
            },
        }
      )
    ) +
    api.override_step_data(
        'find isolated tests',
        api.json.output({
            'browser_tests': 'deadbeef',
        })
    ) +
    api.override_step_data(
        'browser_tests on Ubuntu',
        api.swarming.canned_summary_output(failure=True) +
        api.test_utils.canned_gtest_output(
            passing=False,
            minimal=True,
            extra_json={'missing_shards': [1]})
    )
  )

  yield (
    api.test('windows') +
    api.properties(
        buildername='Windows Swarm',
        mastername='chromium.swarm',
        bot_id='TestSlave',
        buildnumber=123,
        path_config='kitchen') +
    api.platform('win', 64) +
    api.override_step_data(
        'read test spec (chromium.swarm.json)',
        api.json.output({
            'Windows Swarm': {
                'gtest_tests': [
                    {
                        'test': 'browser_tests',
                        'swarming': {
                            'can_use_on_swarming_builders': True,
                            'shards': 2,
                         }
                    },
                ],
            },
        }
      )
    ) +
    api.override_step_data(
        'find isolated tests',
        api.json.output({
            'browser_tests': 'deadbeef',
        })
    )
  )