aboutsummaryrefslogtreecommitdiff
path: root/tests/mobly/controllers/android_device_lib/callback_handler_test.py
blob: a30408f93f0c1abccb3cb04685079f3e009d805f (plain)
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
# Copyright 2017 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.

import unittest
from unittest import mock

from mobly.controllers.android_device_lib import callback_handler
from mobly.controllers.android_device_lib import jsonrpc_client_base

MOCK_CALLBACK_ID = "1-0"
MOCK_RAW_EVENT = {
    'callbackId': '2-1',
    'name': 'AsyncTaskResult',
    'time': 20460228696,
    'data': {
        'exampleData': "Here's a simple event.",
        'successful': True,
        'secretNumber': 12
    }
}


class CallbackHandlerTest(unittest.TestCase):
  """Unit tests for mobly.controllers.android_device_lib.callback_handler.
  """

  def test_timeout_value(self):
    self.assertGreaterEqual(jsonrpc_client_base._SOCKET_READ_TIMEOUT,
                            callback_handler.MAX_TIMEOUT)

  def test_callback_id_property(self):
    mock_event_client = mock.Mock()
    handler = callback_handler.CallbackHandler(callback_id=MOCK_CALLBACK_ID,
                                               event_client=mock_event_client,
                                               ret_value=None,
                                               method_name=None,
                                               ad=mock.Mock())
    self.assertEqual(handler.callback_id, MOCK_CALLBACK_ID)
    with self.assertRaises(AttributeError):
      handler.callback_id = 'ha'

  def test_event_dict_to_snippet_event(self):
    mock_event_client = mock.Mock()
    mock_event_client.eventWaitAndGet = mock.Mock(return_value=MOCK_RAW_EVENT)
    handler = callback_handler.CallbackHandler(callback_id=MOCK_CALLBACK_ID,
                                               event_client=mock_event_client,
                                               ret_value=None,
                                               method_name=None,
                                               ad=mock.Mock())
    event = handler.waitAndGet('ha')
    self.assertEqual(event.name, MOCK_RAW_EVENT['name'])
    self.assertEqual(event.creation_time, MOCK_RAW_EVENT['time'])
    self.assertEqual(event.data, MOCK_RAW_EVENT['data'])
    self.assertEqual(event.callback_id, MOCK_RAW_EVENT['callbackId'])

  def test_wait_and_get_timeout(self):
    mock_event_client = mock.Mock()
    java_timeout_msg = ('com.google.android.mobly.snippet.event.'
                        'EventSnippet$EventSnippetException: timeout.')
    mock_event_client.eventWaitAndGet = mock.Mock(
        side_effect=jsonrpc_client_base.ApiError(mock.Mock(), java_timeout_msg))
    handler = callback_handler.CallbackHandler(callback_id=MOCK_CALLBACK_ID,
                                               event_client=mock_event_client,
                                               ret_value=None,
                                               method_name=None,
                                               ad=mock.Mock())
    expected_msg = 'Timed out after waiting .*s for event "ha" .*'
    with self.assertRaisesRegex(callback_handler.TimeoutError, expected_msg):
      handler.waitAndGet('ha')

  def test_wait_for_event(self):
    mock_event_client = mock.Mock()
    mock_event_client.eventWaitAndGet = mock.Mock(return_value=MOCK_RAW_EVENT)
    handler = callback_handler.CallbackHandler(callback_id=MOCK_CALLBACK_ID,
                                               event_client=mock_event_client,
                                               ret_value=None,
                                               method_name=None,
                                               ad=mock.Mock())

    def some_condition(event):
      return event.data['successful']

    event = handler.waitForEvent('AsyncTaskResult', some_condition, 0.01)

  def test_wait_for_event_negative(self):
    mock_event_client = mock.Mock()
    mock_event_client.eventWaitAndGet = mock.Mock(return_value=MOCK_RAW_EVENT)
    handler = callback_handler.CallbackHandler(callback_id=MOCK_CALLBACK_ID,
                                               event_client=mock_event_client,
                                               ret_value=None,
                                               method_name=None,
                                               ad=mock.Mock())
    expected_msg = (
        'Timed out after 0.01s waiting for an "AsyncTaskResult" event that'
        ' satisfies the predicate "some_condition".')

    def some_condition(event):
      return False

    with self.assertRaisesRegex(callback_handler.TimeoutError, expected_msg):
      handler.waitForEvent('AsyncTaskResult', some_condition, 0.01)

  def test_wait_for_event_max_timeout(self):
    """waitForEvent should not raise the timeout exceed threshold error.
    """
    mock_event_client = mock.Mock()
    mock_event_client.eventWaitAndGet = mock.Mock(return_value=MOCK_RAW_EVENT)
    handler = callback_handler.CallbackHandler(callback_id=MOCK_CALLBACK_ID,
                                               event_client=mock_event_client,
                                               ret_value=None,
                                               method_name=None,
                                               ad=mock.Mock())

    def some_condition(event):
      return event.data['successful']

    big_timeout = callback_handler.MAX_TIMEOUT * 2
    # This line should not raise.
    event = handler.waitForEvent('AsyncTaskResult',
                                 some_condition,
                                 timeout=big_timeout)


if __name__ == "__main__":
  unittest.main()