recipe_engine/internal/commands/luciexe/__init__.py

# Copyright 2019 The LUCI Authors. All rights reserved.
# Use of this source code is governed under the Apache License, Version 2.0
# that can be found in the LICENSE file.

'''Implement the "luciexe" protocol.

This expects to read a build.proto[1] Build message on stdin (binary-encoded
protobuf), and will execute the task accordingly, selecting the recipe to run
from the 'recipe' property of the `Build.input.properties` field.

This synthesizes properties from the Build message:
  * $recipe_engine/runtime['is_experimental'] = Build.input.experimental
  * $recipe_engine/path['temp_dir'] = os.environ['TMP']
  * $recipe_engine/path['cache_dir'] = $LUCI_CONTEXT['luciexe']['cachedir']
'''

import argparse
import logging
import os
import sys


LOG = logging.getLogger(__name__)


class RunBuildContractViolation(Exception):
  pass


def _valid_output(output):
  _, ext = os.path.splitext(output)
  allowed_exts = ('.pb', '.json', '.textpb')
  if ext not in allowed_exts:
    raise argparse.ArgumentTypeError('Extension of output path must be one of '
      'one of %s; Got %s' % (allowed_exts, ext))
  return output

def add_arguments(parser):
  parser.add_argument(
      '--output', action='store', type=_valid_output, help=(
        'Path to write the final build.proto state to. The path extension MUST '
        'be one of (.pb, .json, .textpb). This will decide the encoding of the '
        'final build proto state.'
      ))
  parser.add_argument(
      '--build-proto-stream-jsonpb', action='store_true',
      help=(
        'If specified, output build.proto datagrams stream as JSONPB instead '
        'of PB. Only for debugging.'
      ))

  def _launch(args):
    from .cmd import main
    try:
      return main(args)
    except RunBuildContractViolation as ex:
      LOG.fatal('"luciexe" protocol contract violation: %s', ex)
      return 1

  def _post(_error, _args):
    logging.getLogger().setLevel(logging.INFO)

  parser.set_defaults(func=_launch, postprocess_func=_post, skip_deps=True)