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
|
# Copyright 2022 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.
"""Unit tests for callback_handler_v2.CallbackHandlerV2."""
import unittest
from unittest import mock
from mobly.controllers.android_device_lib import callback_handler_v2
from mobly.snippet import callback_event
from mobly.snippet import errors
MOCK_CALLBACK_ID = '2-1'
MOCK_RAW_EVENT = {
'callbackId': '2-1',
'name': 'AsyncTaskResult',
'time': 20460228696,
'data': {
'exampleData': "Here's a simple event.",
'successful': True,
'secretNumber': 12,
},
}
class CallbackHandlerV2Test(unittest.TestCase):
"""Unit tests for callback_handler_v2.CallbackHandlerV2."""
def _make_callback_handler(
self,
callback_id=None,
event_client=None,
ret_value=None,
method_name=None,
device=None,
rpc_max_timeout_sec=600,
default_timeout_sec=120,
):
return callback_handler_v2.CallbackHandlerV2(
callback_id=callback_id,
event_client=event_client,
ret_value=ret_value,
method_name=method_name,
device=device,
rpc_max_timeout_sec=rpc_max_timeout_sec,
default_timeout_sec=default_timeout_sec,
)
def assert_event_correct(self, actual_event, expected_raw_event_dict):
expected_event = callback_event.from_dict(expected_raw_event_dict)
self.assertEqual(str(actual_event), str(expected_event))
def test_wait_and_get(self):
mock_event_client = mock.Mock()
mock_event_client.eventWaitAndGet = mock.Mock(return_value=MOCK_RAW_EVENT)
handler = self._make_callback_handler(
callback_id=MOCK_CALLBACK_ID, event_client=mock_event_client
)
event = handler.waitAndGet('ha')
self.assert_event_correct(event, MOCK_RAW_EVENT)
mock_event_client.eventWaitAndGet.assert_called_once_with(
MOCK_CALLBACK_ID, 'ha', mock.ANY
)
def test_wait_and_get_timeout_arg_transform(self):
mock_event_client = mock.Mock()
mock_event_client.eventWaitAndGet = mock.Mock(return_value=MOCK_RAW_EVENT)
handler = self._make_callback_handler(event_client=mock_event_client)
wait_and_get_timeout_sec = 10
expected_rpc_timeout_ms = 10000
_ = handler.waitAndGet('ha', timeout=wait_and_get_timeout_sec)
mock_event_client.eventWaitAndGet.assert_called_once_with(
mock.ANY, mock.ANY, expected_rpc_timeout_ms
)
def test_wait_for_event(self):
mock_event_client = mock.Mock()
handler = self._make_callback_handler(
callback_id=MOCK_CALLBACK_ID, event_client=mock_event_client
)
event_should_ignore = {
'callbackId': '2-1',
'name': 'AsyncTaskResult',
'time': 20460228696,
'data': {
'successful': False,
},
}
mock_event_client.eventWaitAndGet.side_effect = [
event_should_ignore,
MOCK_RAW_EVENT,
]
def some_condition(event):
return event.data['successful']
event = handler.waitForEvent('AsyncTaskResult', some_condition, 0.01)
self.assert_event_correct(event, MOCK_RAW_EVENT)
mock_event_client.eventWaitAndGet.assert_has_calls([
mock.call(MOCK_CALLBACK_ID, 'AsyncTaskResult', mock.ANY),
mock.call(MOCK_CALLBACK_ID, 'AsyncTaskResult', mock.ANY),
])
def test_get_all(self):
mock_event_client = mock.Mock()
handler = self._make_callback_handler(
callback_id=MOCK_CALLBACK_ID, event_client=mock_event_client
)
mock_event_client.eventGetAll = mock.Mock(
return_value=[MOCK_RAW_EVENT, MOCK_RAW_EVENT]
)
all_events = handler.getAll('ha')
self.assertEqual(len(all_events), 2)
for event in all_events:
self.assert_event_correct(event, MOCK_RAW_EVENT)
mock_event_client.eventGetAll.assert_called_once_with(
MOCK_CALLBACK_ID, 'ha'
)
def test_wait_and_get_timeout_message_pattern_matches(self):
mock_event_client = mock.Mock()
android_snippet_timeout_msg = (
'com.google.android.mobly.snippet.event.EventSnippet$'
'EventSnippetException: timeout.'
)
mock_event_client.eventWaitAndGet = mock.Mock(
side_effect=errors.ApiError(mock.Mock(), android_snippet_timeout_msg)
)
handler = self._make_callback_handler(
event_client=mock_event_client, method_name='test_method'
)
expected_msg = (
'Timed out after waiting .*s for event "ha" triggered by test_method .*'
)
with self.assertRaisesRegex(
errors.CallbackHandlerTimeoutError, expected_msg
):
handler.waitAndGet('ha')
def test_wait_and_get_reraise_if_pattern_not_match(self):
mock_event_client = mock.Mock()
snippet_timeout_msg = 'Snippet executed with error.'
mock_event_client.eventWaitAndGet = mock.Mock(
side_effect=errors.ApiError(mock.Mock(), snippet_timeout_msg)
)
handler = self._make_callback_handler(event_client=mock_event_client)
with self.assertRaisesRegex(errors.ApiError, snippet_timeout_msg):
handler.waitAndGet('ha')
if __name__ == '__main__':
unittest.main()
|
