GceManager

public class GceManager
extends Object

java.lang.Object
com.android.tradefed.device.cloud.GceManager


管理 GCE 调用以启动/停止并从 GCE 收集日志的助手。

概括

字段

public static final String GCE_HOSTNAME_KEY

public static final String GCE_INSTANCE_CLEANED_KEY

public static final String GCE_INSTANCE_NAME_KEY

public static final String GCE_IP_PRECONFIGURED_KEY

公共构造函数

GceManager ( DeviceDescriptor deviceDesc, TestDeviceOptions deviceOptions, IBuildInfo buildInfo)

Ctor

GceManager ( DeviceDescriptor deviceDesc, TestDeviceOptions deviceOptions, IBuildInfo buildInfo, testResourceBuildInfos) GceManager ( DeviceDescriptor deviceDesc, TestDeviceOptions deviceOptions, IBuildInfo buildInfo, testResourceBuildInfos)

此构造函数已弃用。使用其他构造函数,我们暂时保留它是为了向后兼容。

GceManager ( DeviceDescriptor deviceDesc, TestDeviceOptions deviceOptions, IBuildInfo buildInfo, String gceInstanceName, String gceHost)

Ctor,可用于提供要直接使用的 GCE 实例名称的变体。

公共方法

static boolean AcloudShutdown ( TestDeviceOptions options, IRunUtil runUtil, String instanceName, String hostname, boolean isIpPreconfigured)

实际 Acloud 运行以关闭虚拟设备。

void cleanUp ()
static File getBugreportzWithSsh ( GceAvdInfo gceAvd, TestDeviceOptions options, IRunUtil runUtil)

使用 ssh 从设备获取 bugreportz 以避免任何 adb 连接潜在问题。

static String getInstanceSerialLog ( GceAvdInfo infos, File avdConfigFile, File jsonKeyFile, IRunUtil runUtil)

读取 Gce Avd 实例串行日志的当前内容。

static File getNestedDeviceSshBugreportz ( GceAvdInfo gceAvd, TestDeviceOptions options, IRunUtil runUtil)

通过 ssh 获取嵌套实例的错误报告。

static boolean logNestedRemoteFile ( ITestLogger logger, GceAvdInfo gceAvd, TestDeviceOptions options, IRunUtil runUtil, String remoteFilePath, LogDataType type)

从嵌套实例中获取远程文件并记录它。

static boolean logNestedRemoteFile ( ITestLogger logger, GceAvdInfo gceAvd, TestDeviceOptions options, IRunUtil runUtil, String remoteFilePath, LogDataType type, String baseName)

从嵌套实例中获取远程文件并记录它。

void logSerialOutput ( GceAvdInfo infos, ITestLogger logger)

记录GceAvdInfo描述的设备的串行输出。

static CommandResult remoteSshCommandExecution ( GceAvdInfo gceAvd, TestDeviceOptions options, IRunUtil runUtil, long timeoutMs, String... command)

在实例上通过 ssh 执行远程命令。

boolean shutdownGce ()

关闭与startGce()关联的 Gce 实例。

GceAvdInfo startGce (String ipDevice, String user, Integer offset, MultiMap <String, String> attributes, ITestLogger logger)

尝试使用 Acloud 或 Oxygen 启动 gce 实例。

GceAvdInfo startGce (String ipDevice, String user, Integer offset, MultiMap <String, String> attributes)

尝试使用 Acloud 或 Oxygen 启动 gce 实例。

GceAvdInfo startGce ()
GceAvdInfo startGce (String ipDevice, MultiMap <String, String> attributes)

尝试启动 gce 实例。

startMultiDevicesGce ( buildInfos) startMultiDevicesGce ( buildInfos)

尝试使用 Oxygen 启动多设备 gce 实例。

受保护的方法

buildGceCmd (File reportFile, IBuildInfo b, String ipDevice, String user, Integer offset, MultiMap <String, String> attributes)

构建并返回启动 GCE 的命令。

static buildShutdownCommand (File config, TestDeviceOptions options, String instanceName, String hostname, boolean isIpPreconfigured)
String extractInstanceName (String bootupLogs)

从 gce 引导日志中检索实例名称。

字段

GCE_HOSTNAME_KEY

public static final String GCE_HOSTNAME_KEY

GCE_INSTANCE_CLEANED_KEY

public static final String GCE_INSTANCE_CLEANED_KEY

GCE_INSTANCE_NAME_KEY

public static final String GCE_INSTANCE_NAME_KEY

GCE_IP_PRECONFIGURED_KEY

public static final String GCE_IP_PRECONFIGURED_KEY

公共构造函数

GceManager

public GceManager (DeviceDescriptor deviceDesc, 
                TestDeviceOptions deviceOptions, 
                IBuildInfo buildInfo)

Ctor

参数
deviceDesc DeviceDescriptor :将与 GCE 设备关联的DeviceDescriptor

deviceOptions TestDeviceOptions :与设备关联的TestDeviceOptions

buildInfo IBuildInfo :描述要启动的IBuildInfo构建的 IBuildInfo。

GceManager

public GceManager (DeviceDescriptor deviceDesc, 
                TestDeviceOptions deviceOptions, 
                IBuildInfo buildInfo, 
                 testResourceBuildInfos)

此构造函数已弃用。
使用其他构造函数,我们暂时保留它是为了向后兼容。

参数
deviceDesc DeviceDescriptor

deviceOptions TestDeviceOptions

buildInfo IBuildInfo

testResourceBuildInfos

GceManager

public GceManager (DeviceDescriptor deviceDesc, 
                TestDeviceOptions deviceOptions, 
                IBuildInfo buildInfo, 
                String gceInstanceName, 
                String gceHost)

Ctor,可用于提供要直接使用的 GCE 实例名称的变体。

参数
deviceDesc DeviceDescriptor :将与 GCE 设备关联的DeviceDescriptor

deviceOptions TestDeviceOptions :与设备关联的TestDeviceOptions

buildInfo IBuildInfo :描述要启动的IBuildInfo构建的 IBuildInfo。

gceInstanceName String :要使用的实例名称。

gceHost String :要使用的实例的主机名或 ip。

公共方法

Acloud关机

public static boolean AcloudShutdown (TestDeviceOptions options, 
                IRunUtil runUtil, 
                String instanceName, 
                String hostname, 
                boolean isIpPreconfigured)

实际 Acloud 运行以关闭虚拟设备。

参数
options TestDeviceOptionsTestDeviceOptions选项的 TestDeviceOptions

runUtil IRunUtil :运行IRunUtil的 IRunUtil

instanceName String :要关闭的实例。

hostname String : 实例的主机名,仅用于 Oxygen cuttlefish。

isIpPreconfigured boolean :AVD 是否是在具有预配置 IP 的远程设备上创建的

退货
boolean如果成功则为真

清理

public void cleanUp ()

getBugreportzWithSsh

public static File getBugreportzWithSsh (GceAvdInfo gceAvd, 
                TestDeviceOptions options, 
                IRunUtil runUtil)

使用 ssh 从设备获取 bugreportz 以避免任何 adb 连接潜在问题。

参数
gceAvd GceAvdInfo :描述设备的GceAvdInfo

options TestDeviceOptions :一个TestDeviceOptions描述用于 GCE 设备的设备选项。

runUtil IRunUtil :用于执行命令的IRunUtil

退货
File指向 zip 错误报告的文件,如果出现问题则为 null。

getInstanceSerialLog

public static String getInstanceSerialLog (GceAvdInfo infos, 
                File avdConfigFile, 
                File jsonKeyFile, 
                IRunUtil runUtil)

读取 Gce Avd 实例串行日志的当前内容。

参数
infos GceAvdInfo :描述实例的GceAvdInfo

avdConfigFile File :avd 配置文件

jsonKeyFile File :服务帐户 json 密钥文件。

runUtil IRunUtil :用于执行命令的IRunUtil

退货
String串行日志输出,如果出现问题则为 null。

getNestedDeviceSshBugreportz

public static File getNestedDeviceSshBugreportz (GceAvdInfo gceAvd, 
                TestDeviceOptions options, 
                IRunUtil runUtil)

通过 ssh 获取嵌套实例的错误报告。这需要在嵌套的虚拟实例中请求 adb。

参数
gceAvd GceAvdInfo :描述设备的GceAvdInfo

options TestDeviceOptions :一个TestDeviceOptions描述用于 GCE 设备的设备选项。

runUtil IRunUtil :用于执行命令的IRunUtil

退货
File指向 zip 错误报告的文件,如果出现问题则为 null。

日志嵌套远程文件

public static boolean logNestedRemoteFile (ITestLogger logger, 
                GceAvdInfo gceAvd, 
                TestDeviceOptions options, 
                IRunUtil runUtil, 
                String remoteFilePath, 
                LogDataType type)

从嵌套实例中获取远程文件并记录它。

参数
logger ITestLogger :记录文件的ITestLogger

gceAvd GceAvdInfo :描述设备的GceAvdInfo

options TestDeviceOptions :一个TestDeviceOptions描述用于 GCE 设备的设备选项。

runUtil IRunUtil :用于执行命令的IRunUtil

remoteFilePath String :查找文件的远程路径。

type LogDataType :记录文件的LogDataType

退货
boolean文件是否记录成功。

日志嵌套远程文件

public static boolean logNestedRemoteFile (ITestLogger logger, 
                GceAvdInfo gceAvd, 
                TestDeviceOptions options, 
                IRunUtil runUtil, 
                String remoteFilePath, 
                LogDataType type, 
                String baseName)

从嵌套实例中获取远程文件并记录它。

参数
logger ITestLogger :记录文件的ITestLogger

gceAvd GceAvdInfo :描述设备的GceAvdInfo

options TestDeviceOptions :一个TestDeviceOptions描述用于 GCE 设备的设备选项。

runUtil IRunUtil :用于执行命令的IRunUtil

remoteFilePath String :查找文件的远程路径。

type LogDataType :记录文件的LogDataType

baseName String :用于记录文件的基本名称。如果为空,将使用实际文件名。

退货
boolean文件是否记录成功。

日志串行输出

public void logSerialOutput (GceAvdInfo infos, 
                ITestLogger logger)

记录GceAvdInfo描述的设备的串行输出。

参数
infos GceAvdInfo :描述实例的GceAvdInfo

logger ITestLogger :记录串行日志的ITestLogger

远程 Ssh 命令执行

public static CommandResult remoteSshCommandExecution (GceAvdInfo gceAvd, 
                TestDeviceOptions options, 
                IRunUtil runUtil, 
                long timeoutMs, 
                String... command)

在实例上通过 ssh 执行远程命令。

参数
gceAvd GceAvdInfo :描述设备的GceAvdInfo

options TestDeviceOptions :一个TestDeviceOptions描述用于 GCE 设备的设备选项。

runUtil IRunUtil :用于执行命令的IRunUtil

timeoutMs long :命令的超时时间(以毫秒为单位)。 0 表示没有超时。

command String :要执行的远程命令。

退货
CommandResult包含执行结果的CommandResult

关闭Gce

public boolean shutdownGce ()

关闭与startGce()关联的 Gce 实例。

退货
boolean如果 gce shutdown 被请求为非阻塞,则返回 true。

开始

public GceAvdInfo startGce (String ipDevice, 
                String user, 
                Integer offset, 
                MultiMap<String, String> attributes, 
                ITestLogger logger)

尝试使用 Acloud 或 Oxygen 启动 gce 实例。

参数
ipDevice String : 运行 AVD 的 GCE 实例的初始 IP,如果不适用则为null

user String : AVD的主机运行用户,不适用则为null

offset Integer : 主机中 AVD 的设备编号偏移量,如果不适用则为null

attributes MultiMap :与当前调用关联的属性,用于将适用信息向下传递到 GCE 实例以作为 VM 元数据添加

logger ITestLogger :用于记录设备启动日志的ITestLogger

退货
GceAvdInfo描述 GCE 实例的GceAvdInfo 。可能是 BOOT_FAIL 实例。

投掷
TargetSetupError

开始

public GceAvdInfo startGce (String ipDevice, 
                String user, 
                Integer offset, 
                MultiMap<String, String> attributes)

尝试使用 Acloud 或 Oxygen 启动 gce 实例。

参数
ipDevice String : 运行 AVD 的 GCE 实例的初始 IP,如果不适用则为null

user String : AVD的主机运行用户,不适用则为null

offset Integer : 主机中 AVD 的设备编号偏移量,如果不适用则为null

attributes MultiMap :与当前调用关联的属性,用于将适用信息向下传递到 GCE 实例以作为 VM 元数据添加

退货
GceAvdInfo描述 GCE 实例的GceAvdInfo 。可能是 BOOT_FAIL 实例。

投掷
TargetSetupError

开始

public GceAvdInfo startGce ()

退货
GceAvdInfo

投掷
TargetSetupError

开始

public GceAvdInfo startGce (String ipDevice, 
                MultiMap<String, String> attributes)

尝试启动 gce 实例。

参数
ipDevice String : 运行 AVD 的 GCE 实例的初始 IP,如果不适用则为null

attributes MultiMap :与当前调用关联的属性,用于将适用信息向下传递到 GCE 实例以作为 VM 元数据添加

退货
GceAvdInfo描述 GCE 实例的GceAvdInfo 。可能是 BOOT_FAIL 实例。

投掷
TargetSetupError

启动MultiDevicesGce

public  startMultiDevicesGce ( buildInfos)

尝试使用 Oxygen 启动多设备 gce 实例。

参数
buildInfos : ERROR(/List ) ERROR(/List )

退货
一个ERROR(/List ) ERROR(/List )描述 GCE Avd 信息。

投掷
TargetSetupError

受保护的方法

构建GceCmd

protected  buildGceCmd (File reportFile, 
                IBuildInfo b, 
                String ipDevice, 
                String user, 
                Integer offset, 
                MultiMap<String, String> attributes)

构建并返回启动 GCE 的命令。暴露测试。

参数
reportFile File

b IBuildInfo

ipDevice String

user String

offset Integer

attributes MultiMap

退货

建立关机命令

protected static  buildShutdownCommand (File config, 
                TestDeviceOptions options, 
                String instanceName, 
                String hostname, 
                boolean isIpPreconfigured)

参数
config File

options TestDeviceOptions

instanceName String

hostname String

isIpPreconfigured boolean

退货

提取实例名称

protected String extractInstanceName (String bootupLogs)

从 gce 引导日志中检索实例名称。搜索“名称”:“gce- ' 模式来提取它的名称。我们从日志而不是结果文件中提取,因为在 gce 启动失败时,尝试的实例名称不会显示在 json 中。

参数
bootupLogs String

退货
String