1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
#!/usr/bin/env python
#
# Copyright 2018 - The Android Open Source Project
#
# 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.
"""A client that manages Goldfish Virtual Device on compute engine.
** GoldfishComputeClient **
GoldfishComputeClient derives from AndroidComputeClient. It manges a google
compute engine project that is setup for running Goldfish Virtual Devices.
It knows how to create a host instance from a Goldfish Stable Host Image, fetch
Android build, an emulator build, and start Android within the host instance.
** Class hierarchy **
base_cloud_client.BaseCloudApiClient
^
|
gcompute_client.ComputeClient
^
|
android_compute_client.AndroidComputeClient
^
|
goldfish_compute_client.GoldfishComputeClient
TODO: This class should likely be merged with CvdComputeClient
"""
import getpass
import logging
from acloud import errors
from acloud.internal.lib import android_compute_client
from acloud.internal.lib import gcompute_client
logger = logging.getLogger(__name__)
class GoldfishComputeClient(android_compute_client.AndroidComputeClient):
"""Client that manages Goldfish based Android Virtual Device.
Attributes:
acloud_config: An AcloudConfig object.
oauth2_credentials: An oauth2client.OAuth2Credentials instance.
"""
# To determine if the boot failed
BOOT_FAILED_MSG = "VIRTUAL_DEVICE_FAILED"
# To determine the failure reason
# If the emulator build is not available
EMULATOR_FETCH_FAILED_MSG = "EMULATOR_FETCH_FAILED"
# If the system image build is not available
ANDROID_FETCH_FAILED_MSG = "ANDROID_FETCH_FAILED"
# If the emulator could not boot in time
BOOT_TIMEOUT_MSG = "VIRTUAL_DEVICE_BOOT_FAILED"
#pylint: disable=signature-differs
def _GetDiskArgs(self, disk_name, image_name, image_project, disk_size_gb):
"""Helper to generate disk args that is used to create an instance.
Args:
disk_name: String, the name of disk.
image_name: String, the name of the system image.
image_project: String, the name of the project where the image.
disk_size_gb: Integer, size of the blank data disk in GB.
Returns:
A dictionary representing disk args.
"""
return [{
"type": "PERSISTENT",
"boot": True,
"mode": "READ_WRITE",
"autoDelete": True,
"initializeParams": {
"diskName":
disk_name,
"sourceImage":
self.GetImage(image_name, image_project)["selfLink"],
"diskSizeGb":
disk_size_gb
},
}]
#pylint: disable=signature-differs
def CheckBootFailure(self, serial_out, instance):
"""Overriding method from the parent class.
Args:
serial_out: String
instance: String
Raises:
Raises an errors.DeviceBootError exception if a failure is detected.
"""
if self.BOOT_FAILED_MSG in serial_out:
if self.EMULATOR_FETCH_FAILED_MSG in serial_out:
raise errors.DeviceBootError(
"Failed to download emulator build. Re-run with a newer build."
)
if self.ANDROID_FETCH_FAILED_MSG in serial_out:
raise errors.DeviceBootError(
"Failed to download system image build. Re-run with a newer build."
)
if self.BOOT_TIMEOUT_MSG in serial_out:
raise errors.DeviceBootError(
"Emulator timed out while booting.")
# pylint: disable=too-many-locals,arguments-differ
# TODO: Refactor CreateInstance to pass in an object instead of all these args.
def CreateInstance(self,
instance,
image_name,
image_project,
build_target,
branch,
build_id,
emulator_branch=None,
emulator_build_id=None,
blank_data_disk_size_gb=None,
gpu=None):
"""Create a goldfish instance given a stable host image and a build id.
Args:
instance: String, instance name.
image_name: String, the name of the system image.
image_project: String, name of the project where the image belongs.
Assume the default project if None.
build_target: String, target name, e.g. "sdk_phone_x86_64-sdk"
branch: String, branch name, e.g. "git_pi-dev"
build_id: String, build id, a string, e.g. "2263051", "P2804227"
emulator_branch: String, emulator branch name, e.g."aosp-emu-master-dev"
emulator_build_id: String, emulator build id, a string, e.g. "2263051", "P2804227"
blank_data_disk_size_gb: Integer, size of the blank data disk in GB.
gpu: String, GPU that should be attached to the instance, or None of no
acceleration is needed. e.g. "nvidia-tesla-k80"
"""
self._CheckMachineSize()
# Add space for possible data partition.
boot_disk_size_gb = (
int(self.GetImage(image_name, image_project)["diskSizeGb"]) +
blank_data_disk_size_gb)
disk_args = self._GetDiskArgs(instance, image_name, image_project,
boot_disk_size_gb)
# Goldfish instances are metadata compatible with cuttlefish devices.
# See details goto/goldfish-deployment
metadata = self._metadata.copy()
resolution = self._resolution.split("x")
# Note that we use the same metadata naming conventions as cuttlefish
metadata["cvd_01_dpi"] = resolution[3]
metadata["cvd_01_fetch_android_build_target"] = build_target
metadata["cvd_01_fetch_android_bid"] = "{branch}/{build_id}".format(
branch=branch, build_id=build_id)
if emulator_branch and emulator_build_id:
metadata[
"cvd_01_fetch_emulator_bid"] = "{branch}/{build_id}".format(
branch=emulator_branch, build_id=emulator_build_id)
metadata["cvd_01_launch"] = "1"
metadata["cvd_01_x_res"] = resolution[0]
metadata["cvd_01_y_res"] = resolution[1]
# Add per-instance ssh key
if self._ssh_public_key_path:
rsa = self._LoadSshPublicKey(self._ssh_public_key_path)
logger.info(
"ssh_public_key_path is specified in config: %s, "
"will add the key to the instance.", self._ssh_public_key_path)
metadata["sshKeys"] = "%s:%s" % (getpass.getuser(), rsa)
else:
logger.warning("ssh_public_key_path is not specified in config, "
"only project-wide key will be effective.")
gcompute_client.ComputeClient.CreateInstance(
self,
instance=instance,
image_name=image_name,
image_project=image_project,
disk_args=disk_args,
metadata=metadata,
machine_type=self._machine_type,
network=self._network,
zone=self._zone,
gpu=gpu)
|
