1# Copyright 2018 - The Android Open Source Project
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7#     http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14r"""Custom Exceptions for acloud."""
15
16HTTP_NOT_FOUND_CODE = 404
17
18
19class DriverError(Exception):
20    """Base Android Gce driver exception."""
21
22
23class ConfigError(DriverError):
24    """Error related to config."""
25
26
27class CommandArgError(DriverError):
28    """Error related to command line args."""
29
30
31class GceOperationTimeoutError(DriverError):
32    """Error raised when a GCE operation timedout."""
33
34
35class GetGceZoneError(DriverError):
36    """Can't get GCE zones info."""
37
38
39class HttpError(DriverError):
40    """Error related to http requests."""
41
42    def __init__(self, code, message):
43        self.code = code
44        super(HttpError, self).__init__(message)
45
46    @staticmethod
47    def CreateFromHttpError(http_error):
48        """Create from an apiclient.errors.HttpError.
49
50        Parse the error code from apiclient.errors.HttpError
51        and create an instance of HttpError from this module
52        that has the error code.
53
54        Args:
55            http_error: An apiclient.errors.HttpError instance.
56
57        Returns:
58            An HttpError instance from this module.
59        """
60        return HttpError(http_error.resp.status, str(http_error))
61
62
63class ResourceNotFoundError(HttpError):
64    """Error raised when a resource is not found."""
65
66
67class InvalidVirtualDeviceIpError(DriverError):
68    """Invalid virtual device's IP is set.
69
70    Raise this when the virtual device's IP of an AVD instance is invalid.
71    """
72
73
74class HasRetriableRequestsError(DriverError):
75    """Raised when some retriable requests fail in a batch execution."""
76
77
78class AuthenticationError(DriverError):
79    """Raised when authentication fails."""
80
81
82class DeviceBootError(DriverError):
83    """To catch device boot errors."""
84
85
86class NoSubnetwork(DriverError):
87    """When there is no subnetwork for the GCE."""
88
89
90class DeviceConnectionError(DriverError):
91    """To catch device connection errors."""
92
93
94class PortOccupied(DriverError):
95    """Raised when open port fail."""
96
97
98class DeviceBootTimeoutError(DeviceBootError):
99    """Raised when an AVD defice failed to boot within timeout."""
100
101
102class SetupError(Exception):
103    """Base Setup cmd exception."""
104
105
106class OSTypeError(SetupError):
107    """Error related to OS type."""
108
109
110class NoGoogleSDKDetected(SetupError):
111    """Can't find the SDK path."""
112
113
114class NoBillingError(SetupError):
115    """Billing account isn't enabled."""
116
117
118class PackageInstallError(SetupError):
119    """Error related to package installation."""
120
121
122class RequiredPackageNotInstalledError(SetupError):
123    """Error related to required package not installed."""
124
125
126class UnableToLocatePkgOnRepositoryError(SetupError):
127    """Error related to unable to locate package."""
128
129
130class NotSupportedPlatformError(SetupError):
131    """Error related to user using a not supported os."""
132
133
134class CreateError(Exception):
135    """Base Create cmd exception."""
136
137
138class GetAndroidBuildEnvVarError(CreateError):
139    """Can't get Android Build set environment variables."""
140
141
142class CheckPathError(CreateError):
143    """Path does not exist."""
144
145
146class UnsupportedInstanceImageType(CreateError):
147    """Unsupported create action for given instance/image type."""
148
149
150class UnsupportedFlavor(CreateError):
151    """Unsupported create action for given flavor name."""
152
153
154class UnsupportedMultiAdbPort(CreateError):
155    """Unsupported create action for multi AVDs and specify adb port."""
156
157
158class UnsupportedCreateArgs(CreateError):
159    """Unsupported create arg for a specified AVD type."""
160
161
162class GetBuildIDError(CreateError):
163    """Can't get build id from Android Build."""
164
165
166class NotSupportedHWPropertyError(CreateError):
167    """An error to wrap a non-supported property issue."""
168
169
170class MalformedDictStringError(CreateError):
171    """Error related to unable to convert string to dict."""
172
173
174class InvalidHWPropertyError(CreateError):
175    """An error to wrap a malformed hw property issue."""
176
177
178class GetLocalImageError(CreateError):
179    """Can't find the local image."""
180
181
182class GetCvdLocalHostPackageError(CreateError):
183    """Can't find the lost host package."""
184
185
186class GetSdkRepoPackageError(CreateError):
187    """Can't find the local SDK repository package for goldfish."""
188
189
190class NoCuttlefishCommonInstalled(SetupError):
191    """Can't find cuttlefish_common lib."""
192
193
194class ImgDoesNotExist(CreateError):
195    """Image does not exist."""
196
197
198class UnsupportedCompressionFileType(SetupError):
199    """Don't support the compression file type."""
200
201
202class LaunchCVDFail(CreateError):
203    """Cuttlefish AVD launch failed."""
204
205
206class SubprocessFail(CreateError):
207    """Subprocess failed."""
208
209
210class NoExecuteCmd(CreateError):
211    """Can't find execute bin command."""
212
213
214class ReconnectError(Exception):
215    """Base reconnect cmd exception."""
216
217
218class NoInstancesFound(ReconnectError):
219    """No instances found."""
220
221
222class FunctionTimeoutError(Exception):
223    """Timeout error of decorator function."""
224
225
226class ZipImageError(Exception):
227    """Zip image error."""
228
229
230class UnknownAvdType(Exception):
231    """Unknown AVD type."""
232
233
234class UnknownType(Exception):
235    """Unknown type."""
236
237
238class AdbDisconnectFailed(Exception):
239    """Adb still be alive after disconnect instance."""
240
241
242class UnsupportedLocalInstanceId(Exception):
243    """Unsupported local instance id."""
244
245
246class InvalidInstanceDir(Exception):
247    """Invalid instance dir."""
248