src/chromiumos/tast/local/hwsec/cmd_runner.go

// Copyright 2021 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

package hwsec

/*
This file implements command runner for local tests.
*/

import (
	"context"
	"os/exec"

	"chromiumos/tast/common/hwsec"
	"chromiumos/tast/common/testexec"
	"chromiumos/tast/errors"
	"chromiumos/tast/shutil"
	"chromiumos/tast/testing"
)

// CmdRunnerLocal implements CmdRunner for local test.
type CmdRunnerLocal struct {
	printLog bool
}

// NewCmdRunner creates a new command runner for local test.
func NewCmdRunner() *CmdRunnerLocal {
	return &CmdRunnerLocal{printLog: true}
}

// NewLoglessCmdRunner creates a new command runner for local test, which wouldn't print logs.
func NewLoglessCmdRunner() *CmdRunnerLocal {
	return &CmdRunnerLocal{printLog: false}
}

// Run implements hwsec.CmdRunner.Run.
func (r *CmdRunnerLocal) Run(ctx context.Context, cmd string, args ...string) ([]byte, error) {
	if r.printLog {
		testing.ContextLogf(ctx, "Running: %s", shutil.EscapeSlice(append([]string{cmd}, args...)))
	}
	result, err := testexec.CommandContext(ctx, cmd, args...).Output()
	err = checkExitError(cmd, err)
	return result, err
}

// RunWithCombinedOutput implements hwsec.CmdRunner.RunWithCombinedOutput.
func (r *CmdRunnerLocal) RunWithCombinedOutput(ctx context.Context, cmd string, args ...string) ([]byte, error) {
	if r.printLog {
		testing.ContextLogf(ctx, "Running: %s", shutil.EscapeSlice(append([]string{cmd}, args...)))
	}
	result, err := testexec.CommandContext(ctx, cmd, args...).CombinedOutput()
	err = checkExitError(cmd, err)
	return result, err
}

func checkExitError(cmd string, err error) error {
	if e, ok := err.(*exec.ExitError); ok && e.Exited() {
		err = &hwsec.CmdExitError{
			E:        errors.Wrapf(err, "failed %q command with error code %d", cmd, e.ExitCode()),
			ExitCode: e.ExitCode(),
		}
	}
	return err
}