b82471ad6d
This adds a new status package that merges the running of "actions" (ninja calls them edges) of multiple tools into one view of the current state, and gives that to a number of different outputs. For inputs: Kati's output parser has been rewritten (and moved) to map onto the StartAction/FinishAction API. A byproduct of this is that the build servers should be able to extract errors from Kati better, since they look like the errors that Ninja used to write. Ninja is no longer directly connected to the terminal, but its output is read via the protobuf frontend API, so it's just another tool whose output becomes merged together. multiproduct_kati loses its custom status routines, and uses the common one instead. For outputs: The primary output is the ui/terminal.Status type, which along with ui/terminal.Writer now controls everything about the terminal output. Today, this doesn't really change any behaviors, but having all terminal output going through here allows a more complicated (multi-line / full window) status display in the future. The tracer acts as an output of the status package, tracing all the action start / finish events. This replaces reading the .ninja_log file, so it now properly handles multiple output files from a single action. A new rotated log file (out/error.log, or out/dist/logs/error.log) just contains a description of all of the errors that happened during the current build. Another new compressed and rotated log file (out/verbose.log.gz, or out/dist/logs/verbose.log.gz) contains the full verbose (showcommands) log of every execution run by the build. Since this is now written on every build, the showcommands argument is now ignored -- if you want to get the commands run, look at the log file after the build. Test: m Test: <built-in tests> Test: NINJA_ARGS="-t list" m Test: check the build.trace.gz Test: check the new log files Change-Id: If1d8994890d43ef68f65aa10ddd8e6e06dc7013a
141 lines
3.3 KiB
Go
141 lines
3.3 KiB
Go
// Copyright 2017 Google Inc. All rights reserved.
|
|
//
|
|
// 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
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package build
|
|
|
|
import (
|
|
"os/exec"
|
|
)
|
|
|
|
// Cmd is a wrapper of os/exec.Cmd that integrates with the build context for
|
|
// logging, the config's Environment for simpler environment modification, and
|
|
// implements hooks for sandboxing
|
|
type Cmd struct {
|
|
*exec.Cmd
|
|
|
|
Environment *Environment
|
|
Sandbox Sandbox
|
|
|
|
ctx Context
|
|
config Config
|
|
name string
|
|
}
|
|
|
|
func Command(ctx Context, config Config, name string, executable string, args ...string) *Cmd {
|
|
ret := &Cmd{
|
|
Cmd: exec.CommandContext(ctx.Context, executable, args...),
|
|
Environment: config.Environment().Copy(),
|
|
Sandbox: noSandbox,
|
|
|
|
ctx: ctx,
|
|
config: config,
|
|
name: name,
|
|
}
|
|
|
|
return ret
|
|
}
|
|
|
|
func (c *Cmd) prepare() {
|
|
if c.Env == nil {
|
|
c.Env = c.Environment.Environ()
|
|
}
|
|
if c.sandboxSupported() {
|
|
c.wrapSandbox()
|
|
}
|
|
|
|
c.ctx.Verboseln(c.Path, c.Args)
|
|
}
|
|
|
|
func (c *Cmd) Start() error {
|
|
c.prepare()
|
|
return c.Cmd.Start()
|
|
}
|
|
|
|
func (c *Cmd) Run() error {
|
|
c.prepare()
|
|
err := c.Cmd.Run()
|
|
return err
|
|
}
|
|
|
|
func (c *Cmd) Output() ([]byte, error) {
|
|
c.prepare()
|
|
bytes, err := c.Cmd.Output()
|
|
return bytes, err
|
|
}
|
|
|
|
func (c *Cmd) CombinedOutput() ([]byte, error) {
|
|
c.prepare()
|
|
bytes, err := c.Cmd.CombinedOutput()
|
|
return bytes, err
|
|
}
|
|
|
|
// StartOrFatal is equivalent to Start, but handles the error with a call to ctx.Fatal
|
|
func (c *Cmd) StartOrFatal() {
|
|
if err := c.Start(); err != nil {
|
|
c.ctx.Fatalf("Failed to run %s: %v", c.name, err)
|
|
}
|
|
}
|
|
|
|
func (c *Cmd) reportError(err error) {
|
|
if err == nil {
|
|
return
|
|
}
|
|
if e, ok := err.(*exec.ExitError); ok {
|
|
c.ctx.Fatalf("%s failed with: %v", c.name, e.ProcessState.String())
|
|
} else {
|
|
c.ctx.Fatalf("Failed to run %s: %v", c.name, err)
|
|
}
|
|
}
|
|
|
|
// RunOrFatal is equivalent to Run, but handles the error with a call to ctx.Fatal
|
|
func (c *Cmd) RunOrFatal() {
|
|
c.reportError(c.Run())
|
|
}
|
|
|
|
// WaitOrFatal is equivalent to Wait, but handles the error with a call to ctx.Fatal
|
|
func (c *Cmd) WaitOrFatal() {
|
|
c.reportError(c.Wait())
|
|
}
|
|
|
|
// OutputOrFatal is equivalent to Output, but handles the error with a call to ctx.Fatal
|
|
func (c *Cmd) OutputOrFatal() []byte {
|
|
ret, err := c.Output()
|
|
c.reportError(err)
|
|
return ret
|
|
}
|
|
|
|
// CombinedOutputOrFatal is equivalent to CombinedOutput, but handles the error with
|
|
// a call to ctx.Fatal
|
|
func (c *Cmd) CombinedOutputOrFatal() []byte {
|
|
ret, err := c.CombinedOutput()
|
|
c.reportError(err)
|
|
return ret
|
|
}
|
|
|
|
// RunAndPrintOrFatal will run the command, then after finishing
|
|
// print any output, then handling any errors with a call to
|
|
// ctx.Fatal
|
|
func (c *Cmd) RunAndPrintOrFatal() {
|
|
ret, err := c.CombinedOutput()
|
|
st := c.ctx.Status.StartTool()
|
|
if len(ret) > 0 {
|
|
if err != nil {
|
|
st.Error(string(ret))
|
|
} else {
|
|
st.Print(string(ret))
|
|
}
|
|
}
|
|
st.Finish()
|
|
c.reportError(err)
|
|
}
|