src/chromiumos/tast/local/arc/commands.go

// Copyright 2018 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 arc

import (
	"context"
	"strings"

	"chromiumos/tast/common/android/adb"
	"chromiumos/tast/common/testexec"
)

// Command returns a command in Android via adb.
func (a *ARC) Command(ctx context.Context, name string, args ...string) *testexec.Cmd {
	return a.device.ShellCommand(ctx, name, args...)
}

// BootstrapCommand runs a command with android-sh.
//
// It is very rare you want to call this function from your test; call Command
// instead. A valid use case would to run commands in the Android mini
// container, to set up adb, etc.
//
// This function should be called only after WaitAndroidInit returns
// successfully. Please keep in mind that command execution environment of
// android-sh is not exactly the same as the actual Android container.
func BootstrapCommand(ctx context.Context, name string, arg ...string) *testexec.Cmd {
	// Refuse to find an executable with $PATH.
	// android-sh inserts /vendor/bin before /system/bin in $PATH, and /vendor/bin
	// contains very similar executables as /system/bin on some boards (e.g. nocturne).
	// In particular, /vendor/bin/sh is rarely what you want since it drops
	// /system/bin from $PATH. To avoid such mistakes, refuse to run executables
	// without explicitly specifying absolute paths. To run shell commands,
	// specify /system/bin/sh.
	// See: http://crbug.com/949853
	if !strings.HasPrefix(name, "/") {
		panic("Refusing to search $PATH; specify an absolute path instead")
	}
	return testexec.CommandContext(ctx, "android-sh", append([]string{"-c", "exec \"$@\"", "-", name}, arg...)...)
}

// SendIntentCommand returns a Cmd to send an intent with "am start" command.
func (a *ARC) SendIntentCommand(ctx context.Context, action, data string) *testexec.Cmd {
	return a.device.SendIntentCommand(ctx, action, data)
}

// GetProp returns the Android system property indicated by the specified key.
func (a *ARC) GetProp(ctx context.Context, key string) (string, error) {
	return a.device.GetProp(ctx, key)
}

// BroadcastIntent broadcasts an intent with "am broadcast" and returns the result.
func (a *ARC) BroadcastIntent(ctx context.Context, action string, params ...string) (*adb.BroadcastResult, error) {
	return a.device.BroadcastIntent(ctx, action, params...)
}

// BroadcastIntentGetData broadcasts an intent with "am broadcast" and returns the result data.
func (a *ARC) BroadcastIntentGetData(ctx context.Context, action string, params ...string) (string, error) {
	return a.device.BroadcastIntentGetData(ctx, action, params...)
}

// BugReport returns bugreport of the device.
func (a *ARC) BugReport(ctx context.Context, path string) error {
	return a.device.BugReport(ctx, path)
}

// ReverseTCP forwards the host port to an ADB device local port and returns that ADB device port.
func (a *ARC) ReverseTCP(ctx context.Context, hostPort int) (int, error) {
	return a.device.ReverseTCP(ctx, hostPort)
}

// RemoveReverseTCP removes the forwarding from a host port to the specified ADB device local port.
func (a *ARC) RemoveReverseTCP(ctx context.Context, androidPort int) error {
	return a.device.RemoveReverseTCP(ctx, androidPort)
}