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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
from unittest.mock import MagicMock
from websockets.client import WebSocketClientProtocol
from websockets.legacy.client import Connect
from websockets.exceptions import (
InvalidStatusCode,
ConnectionClosedError,
WebSocketException,
)
from websockets.frames import Close
from src.bluecurrent_api.websocket import (
Websocket,
WebsocketError,
RequestLimitReached,
InvalidApiToken,
AlreadyConnected,
)
import pytest
from pytest_mock import MockerFixture
@pytest.mark.asyncio
async def test_start(mocker: MockerFixture):
mocker.patch("src.bluecurrent_api.websocket.Websocket.validate_api_token")
mock__loop = mocker.patch("src.bluecurrent_api.websocket.Websocket._loop")
websocket = Websocket()
mock_receiver = mocker.AsyncMock()
mock_on_open = mocker.AsyncMock()
with pytest.raises(WebsocketError):
await websocket.start(mock_receiver, mock_on_open)
websocket.auth_token = "123"
await websocket.start(mock_receiver, mock_on_open)
mock__loop.assert_called_once_with(mock_receiver, mock_on_open)
mock_raise_correct_exception = mocker.patch(
"src.bluecurrent_api.websocket.Websocket.raise_correct_exception"
)
err = WebSocketException()
mock__loop.side_effect = err
await websocket.start(mock_receiver, mock_on_open)
mock_raise_correct_exception.assert_called_once_with(err)
@pytest.mark.asyncio
async def test__loop(mocker: MockerFixture):
websocket = Websocket()
mock_connect = MagicMock(spec=Connect)
mocker.patch("src.bluecurrent_api.websocket.connect", return_value=mock_connect)
mock_raise_correct_exception = mocker.patch(
"src.bluecurrent_api.websocket.Websocket.raise_correct_exception"
)
mock_receiver = mocker.AsyncMock()
mock_on_open = mocker.AsyncMock()
mock_on_open.side_effect = WebSocketException()
await websocket._loop(mock_receiver, mock_on_open)
assert websocket.conn is None
assert websocket.connected.is_set() is False
assert websocket.received_charge_points.is_set() is False
mock_raise_correct_exception.assert_called_once()
@pytest.mark.asyncio
async def test__send_recv_single_message(mocker: MockerFixture):
websocket = Websocket()
mock_connect = MagicMock(spec=Connect)
mock_ws = MagicMock(spec=WebSocketClientProtocol)
mocker.patch("src.bluecurrent_api.websocket.connect", return_value=mock_connect)
mock_connect.__aenter__.return_value = mock_ws
mock_ws.recv.return_value = '{"a": 1}'
assert await websocket._send_recv_single_message({}) == {"a": 1}
err = WebSocketException()
mock_ws.recv.side_effect = err
with pytest.raises(WebsocketError):
await websocket._send_recv_single_message({})
@pytest.mark.asyncio
async def test_validate_token(mocker: MockerFixture):
api_token = "123"
websocket = Websocket()
mocker.patch(
"src.bluecurrent_api.websocket.Websocket._send_recv_single_message",
return_value={
"object": "STATUS_API_TOKEN",
"success": True,
"token": "abc",
"customer_id": "123",
},
)
result = await websocket.validate_api_token(api_token)
assert result == "123"
assert websocket.auth_token == "Token abc"
mocker.patch(
"src.bluecurrent_api.websocket.Websocket._send_recv_single_message",
return_value={"object": "STATUS_API_TOKEN", "success": False, "error": ""},
)
with pytest.raises(InvalidApiToken):
await websocket.validate_api_token(api_token)
mocker.patch(
"src.bluecurrent_api.websocket.Websocket._send_recv_single_message",
return_value={
"object": "ERROR",
"error": 42,
"message": "Request limit reached",
},
)
with pytest.raises(RequestLimitReached):
await websocket.validate_api_token(api_token)
@pytest.mark.asyncio
async def test_get_email(mocker: MockerFixture):
websocket = Websocket()
mocker.patch(
"src.bluecurrent_api.websocket.Websocket._send_recv_single_message",
return_value={"object": "ACCOUNT", "login": "test"},
)
with pytest.raises(WebsocketError):
await websocket.get_email()
websocket.auth_token = "abc"
assert await websocket.get_email() == "test"
mocker.patch(
"src.bluecurrent_api.websocket.Websocket._send_recv_single_message",
return_value={"object": "ACCOUNT"},
)
with pytest.raises(WebsocketError):
await websocket.get_email()
mocker.patch(
"src.bluecurrent_api.websocket.Websocket._send_recv_single_message",
return_value={
"object": "ERROR",
"error": 42,
"message": "Request limit reached",
},
)
with pytest.raises(RequestLimitReached):
await websocket.get_email()
@pytest.mark.asyncio
async def test_send_request(mocker: MockerFixture):
mock_send = mocker.patch("src.bluecurrent_api.websocket.Websocket._send")
websocket = Websocket()
websocket.connected.set()
# without token
with pytest.raises(WebsocketError):
await websocket.send_request({"command": "GET_CHARGE_POINTS"})
websocket.auth_token = "123"
await websocket.send_request({"command": "GET_CHARGE_POINTS"})
mock_send.assert_called_with(
{"command": "GET_CHARGE_POINTS", "Authorization": "123"}
)
@pytest.mark.asyncio
async def test_message_handler(mocker: MockerFixture):
mock_handle_charge_points = mocker.patch(
"src.bluecurrent_api.websocket.handle_charge_points"
)
mock_handle_status = mocker.patch("src.bluecurrent_api.websocket.handle_status")
mock_handle_grid = mocker.patch("src.bluecurrent_api.websocket.handle_grid")
mock_handle_settings = mocker.patch("src.bluecurrent_api.websocket.handle_settings")
mock_handle_setting_change = mocker.patch(
"src.bluecurrent_api.websocket.handle_setting_change"
)
mock_handle_handle_session_messages = mocker.patch(
"src.bluecurrent_api.websocket.handle_session_messages"
)
websocket = Websocket()
mock_receiver = mocker.AsyncMock()
# CHARGE_POINTS flow
message = {"object": "CHARGE_POINTS"}
await websocket._message_handler(message, mock_receiver)
mock_handle_charge_points.assert_called_with(message)
mock_receiver.assert_called_with(message)
message = {"object": "CHARGE_CARDS"}
await websocket._message_handler(message, mock_receiver)
mock_receiver.assert_called_with(message)
# ch_status flow
message = {"object": "CH_STATUS"}
await websocket._message_handler(message, mock_receiver)
mock_handle_status.assert_called_with(message)
mock_receiver.assert_called_with(message)
# grid_status flow
message = {"object": "GRID_STATUS"}
await websocket._message_handler(message, mock_receiver)
mock_handle_grid.assert_called_with(message)
mock_receiver.assert_called_with(message)
# grid_current flow
message = {"object": "GRID_CURRENT"}
await websocket._message_handler(message, mock_receiver)
mock_handle_grid.assert_called_with(message)
mock_receiver.assert_called_with(message)
# ch_settings flow
message = {"object": "CH_SETTINGS"}
await websocket._message_handler(message, mock_receiver)
mock_handle_settings.assert_called_with(message)
mock_receiver.assert_called_with(message)
# setting change flow
message = {"object": "STATUS_SET_PLUG_AND_CHARGE"}
await websocket._message_handler(message, mock_receiver)
mock_handle_setting_change.assert_called_with(message)
mock_receiver.assert_called_with(message)
# session message flow
message = {"object": "STATUS_STOP_SESSION"}
await websocket._message_handler(message, mock_receiver)
mock_handle_handle_session_messages.assert_called_with(message)
mock_receiver.assert_called_with(message)
# STATUS_START_SESSION
message = {"object": "STATUS_START_SESSION", "evse_id": "BCU101"}
await websocket._message_handler(message, mock_receiver)
mock_handle_handle_session_messages.assert_called_with(message)
mock_receiver.assert_called_with(message)
# no object
message = {"value": True}
with pytest.raises(WebsocketError):
await websocket._message_handler(message, mock_receiver)
# unknown command
message = {"error": 0, "object": "ERROR", "message": "Unknown command"}
with pytest.raises(WebsocketError):
await websocket._message_handler(message, mock_receiver)
# unknown token
message = {"error": 1, "object": "ERROR", "message": "Invalid Auth Token"}
with pytest.raises(WebsocketError):
await websocket._message_handler(message, mock_receiver)
# token not autorized
message = {"error": 2, "object": "ERROR", "message": "Not authorized"}
with pytest.raises(WebsocketError):
await websocket._message_handler(message, mock_receiver)
# unknown error
message = {"error": 9, "object": "ERROR", "message": "Unknown error"}
with pytest.raises(WebsocketError):
await websocket._message_handler(message, mock_receiver)
# limit reached
message = {"error": 42, "object": "ERROR", "message": "Request limit reached"}
with pytest.raises(RequestLimitReached):
await websocket._message_handler(message, mock_receiver)
# success false
message = {"success": False, "error": "this is an error"}
with pytest.raises(WebsocketError):
await websocket._message_handler(message, mock_receiver)
# Ignore status
message = {"object": "STATUS"}
await websocket._message_handler(message, mock_receiver)
assert mock_receiver.call_count == 9
# RECEIVED without error
message = {"object": "RECEIVED_START_SESSION", "error": ""}
await websocket._message_handler(message, mock_receiver)
assert mock_receiver.call_count == 9
@pytest.mark.asyncio
async def test__send(mocker: MockerFixture):
websocket = Websocket()
with pytest.raises(WebsocketError):
await websocket._send({"command": "test"})
websocket.conn = mocker.MagicMock(spec=WebSocketClientProtocol)
await websocket._send({"command": 1})
websocket.conn.send.assert_called_with('{"command": 1}')
@pytest.mark.asyncio
async def test_disconnect(mocker: MockerFixture):
websocket = Websocket()
with pytest.raises(WebsocketError):
await websocket.disconnect()
websocket.conn = mocker.MagicMock(spec=WebSocketClientProtocol)
await websocket.disconnect()
websocket.conn.close.assert_called_once()
def test_raise_correct_exception():
websocket = Websocket()
with pytest.raises(RequestLimitReached):
websocket.raise_correct_exception(
InvalidStatusCode(
403, {"x-websocket-reject-reason": "Request limit reached"}
)
)
with pytest.raises(RequestLimitReached):
websocket.raise_correct_exception(
ConnectionClosedError(Close(4001, "Request limit reached"), None, None)
)
with pytest.raises(AlreadyConnected):
websocket.raise_correct_exception(
InvalidStatusCode(403, {"x-websocket-reject-reason": "Already connected"})
)
with pytest.raises(WebsocketError):
websocket.raise_correct_exception(Exception)
|
