misc/fake_kitchen.sh

#!/bin/bash
# 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.

# This script emulates the LUCI User Code Contract (go/luci-user-code-contract,
# internal, sorry, but it's basically a lot of words that boil down to the
# responsibilities of the script below :)).
#
# Use this script like `fake_kitchen.py < build.proto.jpb` where
# `build.proto.jpb` is a JSON encoded buildbucket.v2.Build message[1]. This
# script will transmute the JSON encoded message to a binary-encoded one (which
# is required by the code contract).
#
# This puts all the outputs from the executed recipe in the current git repo's
# //workdir directory:
#   * //workdir/tmp   - api.path['tmp_base']
#   * //workdir/cache - api.path['cache']
#   * //workdir/wd    - api.path['start_dir']
#   * //workdir/logs  - Dumps of all the logdog streams emitted by the recipe
#     engine (and any child processes).
#
# This script requires the `logdog_butler` tool[2] in your $PATH. If you have an
# 'infra' checkout, you can get this by doing:
#   * eval `//infra/go/env.py`
#   * go install go.chromium.org/luci/logdog/client/cmd/logdog_butler
#
#
# Example:
#
#    ./misc/fake_kitchen.sh <<EOF & tail -F workdir/logs/stderr
#    {
#      "input": {
#        "properties": {
#          "recipe": "engine_tests/comprehensive_ui"
#        }
#      }
#    }
#    EOF
# [1]: https://chromium.googlesource.com/infra/luci/luci-go/+/master/buildbucket/proto/build.proto
# [2]: https://chromium.googlesource.com/infra/luci/luci-go/+/refs/heads/master/logdog/client/cmd/logdog_butler

ROOT="$(realpath "$(git rev-parse --show-toplevel)")"
WD="$ROOT/workdir"

echo "Clean workdir."
rm -rf "$WD"
mkdir -p "$WD/tmp" "$WD/cache" "$WD/wd" "$WD/luci_context"

# Set up environmental predicates
unset LS_COLORS
export TMP="$WD/tmp"
export LOGDOG_NAMESPACE=u
export LOGDOG_COORDINATOR_HOST=logs.example.com
export LUCI_CONTEXT="$WD/luci_context/context.json"
cat > "$LUCI_CONTEXT" <<EOF
{
  "run_build": {
    "cache_dir": "$WD/cache"
  }
}
EOF

case "$(uname -s)" in
    Linux*|Darwin*)
      STREAMSERVER="unix:$WD/butler.sock";;
    *)
      STREAMSERVER="net.pipe:\\\\.\\fake_kitchen\\butler"
esac

# Convert JSON -> binary PB
# Start a local logdog server.
# Project is "required" but its value doesn't matter.
# Output to the 'logs' subdir of workdir
# Attach "stdout" and "stderr" at their usual names.
# Set startdir to an empty dir.
# Set up a local fifo for butler to serve on.
# Actaully run the recipes.
"$ROOT/misc/build_proto.py" | \
    logdog_butler -project local                              \
    -output directory,path="$WD/logs"                         \
    run -stdout=name=stdout -stderr=name=stderr               \
    -forward-stdin                                            \
    -chdir="$WD/wd"                                           \
    -streamserver-uri="$STREAMSERVER"                         \
    python "$ROOT/recipes.py" -vvv                            \
    run_build --build-proto-jsonpb "$@"