recipe_modules/adhoc_validation/api.py

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

from recipe_engine import recipe_api
from RECIPE_MODULES.flutter.flutter_bcid.api import BcidStage


class AddhocValidationApi(recipe_api.RecipeApi):
  """Wrapper api to run bash scripts as validation in LUCI builder steps.

  This api expects all the bash or bat scripts to exist in its resources
  directory and also expects the validation name to be listed in
  available_validations method.
  """

  def available_validations(self):
    """Returns the list of accepted validations."""
    return [
        'analyze', 'customer_testing', 'docs', 'fuchsia_precache',
        'verify_binaries_codesigned', 'docs_deploy'
    ]

  def run(self, name, validation, env, env_prefixes, secrets=None):
    """Runs a validation as a recipe step.

    Args:
      name(str): The step group name.
      validation(str): The name of a validation to run. This has to correlate
        to a <validation>.sh for linux/mac or <validation>.bat for windows.
      env(dict): Current environment variables.
      env_prefixes(dict):  Current environment prefixes variables.
      secrets(dict): The key is the name of the secret and value is the path to kms.
    """
    if validation not in self.available_validations():
      msg = str(validation) + ' is not listed in available_validations.'
      raise AssertionError(msg)
    secrets = secrets or {}
    with self.m.step.nest(name):
      resource_name = ''
      self.m.kms.decrypt_secrets(env, secrets)
      if self.m.platform.is_linux or self.m.platform.is_mac:
        resource_name = self.resource('%s.sh' % validation)
        self.m.step(
            'Set execute permission',
            ['chmod', '755', resource_name],
            infra_step=True,
        )
      elif self.m.platform.is_win:
        resource_name = self.resource('%s.bat' % validation)
      checkout_path = self.m.repo_util.sdk_checkout_path()
      if self.m.properties.get('$flutter/osx_sdk'):
        with self.m.osx_sdk('ios'):
          self.m.flutter_deps.gems(
              env, env_prefixes, checkout_path.join('dev', 'ci', 'mac')
          )
          with self.m.context(env=env, env_prefixes=env_prefixes):
            self.m.flutter_bcid.report_stage(BcidStage.COMPILE.value)
            self.m.test_utils.run_test(
                validation,
                [resource_name],
                timeout_secs=4500  # 75 minutes
            )
      else:
        git_ref = self.m.properties.get(
            'release_ref'
        ) or self.m.buildbucket.gitiles_commit.ref
        # Post-processing of docs require LUCI_BRANCH to be set when running from dart-internal.
        env['LUCI_BRANCH'] = git_ref.replace('refs/heads/', '')
        # Override LUCI_BRANCH for docs and release candidate branches. Docs built from
        # release candidate branches need to be build as stable to ensure they are processed
        # correctly.
        checkout_path = self.m.repo_util.sdk_checkout_path()
        if (validation == 'docs'
           ) and self.m.repo_util.is_release_candidate_branch(checkout_path):
          env['LUCI_BRANCH'] = 'stable'
          env['LUCI_CI'] = True

        with self.m.context(env=env, env_prefixes=env_prefixes):
          self.m.flutter_bcid.report_stage(BcidStage.COMPILE.value)
          self.m.test_utils.run_test(
              validation,
              [resource_name],
              timeout_secs=4500  # 75 minutes
          )
          if ((validation == 'docs' or validation == 'docs_deploy') and
              self.m.properties.get('firebase_project')):
            docs_path = checkout_path.join('dev', 'docs')
            # Do not upload on docs_deploy.
            if not validation == 'docs_deploy':
              self.m.flutter_bcid.report_stage(BcidStage.UPLOAD.value)
              src = docs_path.join('api_docs.zip')
              commit = self.m.repo_util.get_commit(checkout_path)
              dst = 'gs://flutter_infra_release/flutter/%s/api_docs.zip' % commit
              self.m.archives.upload_artifact(src, dst)
              self.m.flutter_bcid.upload_provenance(src, dst)
              self.m.flutter_bcid.report_stage(BcidStage.UPLOAD_COMPLETE.value)
            project = self.m.properties.get('firebase_project')
            # Only deploy to firebase directly if this is master or main.
            if ((self.m.properties.get('git_branch') in ['master', 'main']) or
                (git_ref == 'refs/heads/stable')):
              self.m.firebase.deploy_docs(
                  env=env,
                  env_prefixes=env_prefixes,
                  docs_path=docs_path,
                  project=project
              )