blob: 36013f86ee79e4541e46a188c3b4146f545a9566 [file] [log] [blame]
// Copyright 2019 The LUCI Authors.
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// See the License for the specific language governing permissions and
// limitations under the License.
package luciexe
import (
bbpb ""
const (
// BuildProtoLogName is the Build.Step.Log.Name for sub-lucictx programs.
BuildProtoLogName = "$build.proto"
// BuildProtoContentType is the ContentType of the build.proto LogDog datagram
// stream.
BuildProtoContentType = protoutil.BuildMediaType
// BuildProtoZlibContentType is the ContentType of the compressed
// build.proto LogDog datagram stream. It's the same as BuildProtoContentType
// except it's compressed with zlib.
BuildProtoZlibContentType = BuildProtoContentType + "; encoding=zlib"
// BuildProtoStreamSuffix is the logdog stream name suffix for sub-lucictx
// programs to output their build.proto stream to.
// TODO(iannucci): Maybe change protocol so that build.proto stream can be
// opened by the invoking process instead of the invoked process.
BuildProtoStreamSuffix = "build.proto"
// OutputCLIArg is the CLI argument to luciexe binaries to instruct them to
// dump their final Build message. The value of this flag must be an absolute
// path to a file which doesn't exist in a directory which does (and which the
// luciexe binary has access to write in). See Output*FileExt for valid
// extensions.
OutputCLIArg = "--output"
// These file extensions are used with the `--output` flag to determine the
// output serialization type for the luciexe's final Build message.
const (
OutputBinaryFileExt = ".pb"
OutputTextFileExt = ".textpb"
OutputJSONFileExt = ".json"
// IsMergeStep returns true iff the given step is identified as a 'merge step'.
// See "Recursive Invocation" in the doc for this package.
func IsMergeStep(s *bbpb.Step) bool {
if len(s.GetLogs()) >= 1 && s.Logs[0].Name == BuildProtoLogName {
return true
return false