python-maxcube-api/tests/test_commander.py at feeb5b3a119f038a5ac1219e1093479c9b5d238b · uebelack/python-maxcube-api · GitHub

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
201
import base64
from unittest import TestCase
from unittest.mock import MagicMock, call, patch

from maxcube.commander import Commander
from maxcube.connection import Connection
from maxcube.deadline import Deadline, Timeout
from maxcube.message import Message

L_CMD = Message("l")
L_CMD_SUCCESS = Message("L")
S_CMD_HEX = "FF00"
S_CMD = Message("s", base64.b64encode(bytearray.fromhex(S_CMD_HEX)).decode("utf-8"))
S_CMD_SUCCESS = Message("S", "00,0,31")
S_CMD_ERROR = Message("S", "64,1,1f")
S_CMD_THROTTLE_ERROR = Message("S", "64,1,0")
Q_CMD = Message("q")

TEST_TIMEOUT = Timeout("test", 1.0)


class TestCommander(TestCase):
    """ Test Max! Cube command handler """

    def setUp(self):
        patcher = patch("maxcube.commander.Connection", spec=True)
        self.addCleanup(patcher.stop)
        self.ClassMock = patcher.start()
        self.connection = self.ClassMock.return_value
        self.commander = Commander("host", 1234)

    def init(self, ClassMock):
        # For backwards compatibility, but prefer setUp
        if ClassMock is not None:
            self.connection = ClassMock.return_value
            self.commander = Commander("host", 1234)

    def testDisconnectIsNoopIfAlreadyDisconnected(self, ClassMock=None):
        self.init(ClassMock)
        self.commander.disconnect()

        self.ClassMock.assert_not_called()

        self.connection.send.assert_not_called()
        self.connection.recv.assert_not_called()
        self.connection.close.assert_not_called()

    def testUpdateOpensNewNonPersistantConnectionAndClosesIt(self, ClassMock=None):
        messages = [Message("H"), Message("L")]
        self.init(ClassMock)
        self.commander.use_persistent_connection = False
        self.connection.recv.side_effect = messages

        self.assertEqual(messages, self.commander.update())

        self.connection.send.assert_called_once_with(Q_CMD)
        self.assertEqual(2, self.connection.recv.call_count)
        self.connection.close.assert_called_once()

    def testUpdateSendsCommandAfterAfterTimeout(self, ClassMock=None):
        messages = [Message("H"), None]
        self.init(ClassMock)
        self.connection.recv.side_effect = messages

        self.assertEqual(messages[:1], self.commander.update())

        self.connection.send.assert_not_called()
        self.assertEqual(2, self.connection.recv.call_count)
        self.connection.close.assert_not_called()

        self.connection.recv.reset_mock()
        self.__mockCommandResponse(L_CMD_SUCCESS)

        self.assertEqual([L_CMD_SUCCESS], self.commander.update())

        self.connection.send.assert_called_once_with(Message("l"))
        self.assertEqual(2, self.connection.recv.call_count)
        self.connection.close.assert_not_called()

    def testSendRadioMsgAutoconnects(self, ClassMock=None):
        if ClassMock is None:
            ClassMock = self.ClassMock
        self.init(ClassMock)
        self.connection.recv.side_effect = [
            L_CMD_SUCCESS,  # connection preamble
            S_CMD_SUCCESS,
        ]

        self.assertTrue(self.commander.send_radio_msg(S_CMD_HEX))
        self.connection.send.assert_called_once_with(S_CMD)
        self.assertEqual(2, self.connection.recv.call_count)
        self.connection.close.assert_not_called()

    def testSendRadioMsgOpensNewNonPersistentConnectionAndClosesIt(
        self, ClassMock=None
    ):
        self.init(ClassMock)
        self.commander.use_persistent_connection = False
        self.connection.recv.side_effect = [
            L_CMD_SUCCESS,  # connection preamble
            S_CMD_SUCCESS,
        ]

        self.assertTrue(self.commander.send_radio_msg(S_CMD_HEX))
        self.connection.send.assert_has_calls([call(S_CMD), call(Q_CMD)])
        self.assertEqual(2, self.connection.recv.call_count)
        self.connection.close.assert_called_once()

    def testSendRadioMsgReusesConnection(self, ClassMock=None):
        self.testSendRadioMsgAutoconnects(None)

        self.connection.send.reset_mock()
        self.connection.recv.reset_mock()
        self.connection.recv.side_effect = [None, S_CMD_SUCCESS]

        self.assertTrue(self.commander.send_radio_msg(S_CMD_HEX))

        self.connection.send.assert_called_once_with(S_CMD)
        self.assertEqual(2, self.connection.recv.call_count)
        self.connection.close.assert_not_called()

    def testSendRadioMsgClosesConnectionOnErrorAndRetriesIfReusingConnection(
        self, ClassMock=None
    ):
        self.testSendRadioMsgAutoconnects(None)

        self.connection.recv.reset_mock()
        self.connection.send.reset_mock()
        self.connection.recv.side_effect = [
            None,  # First read before first try
        ]
        self.connection.send.side_effect = [OSError]

        newConnection = MagicMock()
        self.ClassMock.side_effect = [newConnection]
        newConnection.recv.side_effect = [
            L_CMD_SUCCESS,  # Connection preamble
            S_CMD_SUCCESS,
        ]

        self.assertTrue(self.commander.send_radio_msg(S_CMD_HEX))

        self.connection.recv.assert_called_once()
        self.connection.send.assert_called_once_with(S_CMD)
        self.connection.close.assert_called_once()

        self.assertEqual(2, newConnection.recv.call_count)
        newConnection.send.assert_called_once_with(S_CMD)
        newConnection.close.assert_not_called()

    def __send_radio_msg(self, msg: Message, deadline: Deadline):
        with patch("maxcube.commander.Deadline") as deadlineMock:
            deadlineMock.return_value = deadline
            return self.commander.send_radio_msg(msg)

    def testSendRadioMsgShouldNotRetryOnErrorWhenConnectionIsNew(self, ClassMock=None):
        self.init(ClassMock)
        self.connection.recv.side_effect = [L_CMD_SUCCESS]
        self.connection.send.side_effect = [OSError]

        deadline = MagicMock(Deadline)
        deadline.is_expired.side_effect = [False, True]
        deadline.subtimeout.return_value = Deadline(TEST_TIMEOUT)

        self.assertFalse(self.__send_radio_msg(S_CMD_HEX, deadline))

        self.connection.send.assert_called_once_with(S_CMD)
        self.connection.recv.assert_called_once()
        self.connection.close.assert_called_once()

    def testSendRadioMsgFailsOnLogicalError(self, ClassMock=None):
        self.init(ClassMock)
        self.connection.recv.side_effect = [L_CMD_SUCCESS, S_CMD_ERROR]

        deadline: Deadline = MagicMock(Deadline)
        deadline.is_expired.side_effect = [False, True]
        deadline.subtimeout.return_value = Deadline(TEST_TIMEOUT)
        self.assertFalse(self.__send_radio_msg(S_CMD_HEX, deadline))

        self.connection.send.assert_called_once_with(S_CMD)
        self.assertEqual(2, self.connection.recv.call_count)
        self.connection.close.assert_not_called()
        deadline.remaining.assert_not_called()

    def testSendRadioMsgRetriesOnThrottlingError(self, ClassMock=None):
        self.init(ClassMock)
        self.connection.recv.side_effect = [L_CMD_SUCCESS, S_CMD_THROTTLE_ERROR]

        deadline: Deadline = MagicMock(Deadline)
        deadline.is_expired.side_effect = [False, True]
        deadline.remaining.return_value = 0.1
        deadline.subtimeout.return_value = Deadline(TEST_TIMEOUT)
        self.assertFalse(self.__send_radio_msg(S_CMD_HEX, deadline))

        self.connection.send.assert_called_once_with(S_CMD)
        self.assertEqual(2, self.connection.recv.call_count)
        self.connection.close.assert_not_called()
        deadline.remaining.assert_called_once()

    def __mockCommandResponse(self, response):
        self.connection.recv.side_effect = [None, response]