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
|
# Copyright 2018 Google Inc.
#
# 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.
"""Module for the BaseService."""
import abc
class BaseService(abc.ABC):
"""Base class of a Mobly AndroidDevice service.
This class defines the interface for Mobly's AndroidDevice service.
"""
_alias = None
def __init__(self, device, configs=None):
"""Constructor of the class.
The constructor is the only place to pass in a config. If you need to
change the config later, you should unregister the service instance
from `ServiceManager` and register again with the new config.
Args:
device: the device object this service is associated with.
config: optional configuration defined by the author of the service
class.
"""
self._device = device
self._configs = configs
@property
def alias(self):
"""String, alias used to register this service with service manager.
This can be None if the service is never registered.
"""
return self._alias
@alias.setter
def alias(self, alias):
self._alias = alias
@property
def is_alive(self):
"""True if the service is active; False otherwise."""
def start(self):
"""Starts the service."""
def stop(self):
"""Stops the service and cleans up all resources.
This method should handle any error and not throw.
"""
def pause(self):
"""Pauses a service temporarily.
For when the Python service object needs to temporarily lose connection
to the device without shutting down the service running on the actual
device.
This is relevant when a service needs to maintain a constant connection
to the device and the connection is lost if USB connection to the
device is disrupted.
E.g. a services that utilizes a socket connection over adb port
forwarding would need to implement this for the situation where the USB
connection to the device will be temporarily cut, but the device is not
rebooted.
For more context, see:
`mobly.controllers.android_device.AndroidDevice.handle_usb_disconnect`
If not implemented, we assume the service is not sensitive to device
disconnect, and `stop` will be called by default.
"""
self.stop()
def resume(self):
"""Resumes a paused service.
Same context as the `pause` method. This should resume the service
after the connection to the device has been re-established.
If not implemented, we assume the service is not sensitive to device
disconnect, and `start` will be called by default.
"""
self.start()
def create_output_excerpts(self, test_info):
"""Creates excerpts of the service's output files.
[Optional] This method only applies to services with output files.
For services that generates output files, calling this method would
create excerpts of the output files. An excerpt should contain info
between two calls of `create_output_excerpts` or from the start of the
service to the call to `create_output_excerpts`.
Use `AndroidDevice#generate_filename` to get the proper filenames for
excerpts.
This is usually called at the end of: `setup_class`, `teardown_test`,
or `teardown_class`.
Args:
test_info: RuntimeTestInfo, the test info associated with the scope
of the excerpts.
Returns:
List of strings, the absolute paths to the excerpt files created.
Empty list if no excerpt files are created.
"""
return []
|
