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
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
|
"""Tests for the OpenSky Library."""
import asyncio
from dataclasses import asdict
import aiohttp
import pytest
from aiohttp import BasicAuth, ClientError
from aiohttp.web_request import BaseRequest
from aresponses import Response, ResponsesMockServer
from syrupy.assertion import SnapshotAssertion
from python_opensky import (
BoundingBox,
OpenSky,
OpenSkyConnectionError,
OpenSkyError,
StatesResponse,
)
from python_opensky.exceptions import OpenSkyUnauthenticatedError
from . import load_fixture
OPENSKY_URL = "opensky-network.org"
async def test_states(
aresponses: ResponsesMockServer,
snapshot: SnapshotAssertion,
) -> None:
"""Test retrieving states."""
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixture("states.json"),
),
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
response: StatesResponse = await opensky.get_states()
assert asdict(response) == snapshot
await opensky.close()
async def test_unavailable_states(
aresponses: ResponsesMockServer,
) -> None:
"""Test retrieving no states."""
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixture("unavailable_states.json"),
),
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
response: StatesResponse = await opensky.get_states()
assert response.states is not None
assert len(response.states) == 0
assert response.time == 1683488744
await opensky.close()
async def test_own_states(
aresponses: ResponsesMockServer,
) -> None:
"""Test retrieving own states."""
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixture("states.json"),
),
)
aresponses.add(
OPENSKY_URL,
"/api/states/own",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixture("states.json"),
),
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
await opensky.authenticate(
BasicAuth(login="test", password="test"),
contributing_user=True,
)
response: StatesResponse = await opensky.get_own_states()
assert len(response.states) == 4
assert opensky.opensky_credits == 8000
assert opensky.remaining_credits() == 7999
await opensky.close()
async def test_unavailable_own_states(
aresponses: ResponsesMockServer,
) -> None:
"""Test retrieving no own states."""
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixture("states.json"),
),
)
aresponses.add(
OPENSKY_URL,
"/api/states/own",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixture("unavailable_states.json"),
),
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
await opensky.authenticate(
BasicAuth(login="test", password="test"),
contributing_user=True,
)
response: StatesResponse = await opensky.get_own_states()
assert response.states is not None
assert len(response.states) == 0
assert response.time == 1683488744
await opensky.close()
async def test_states_with_bounding_box(
aresponses: ResponsesMockServer,
) -> None:
"""Test retrieving states."""
aresponses.add(
OPENSKY_URL,
"/api/states/all?time=0&extended=true&lamin=0&lamax=0&lomin=0&lomax=0",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixture("states.json"),
),
match_querystring=True,
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
bounding_box = BoundingBox(
min_latitude=0,
max_latitude=0,
min_longitude=0,
max_longitude=0,
)
await opensky.get_states(bounding_box=bounding_box)
await opensky.close()
async def test_credit_usage(
aresponses: ResponsesMockServer,
) -> None:
"""Test credit usage."""
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixture("states.json"),
),
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
await opensky.get_states()
assert opensky.remaining_credits() == opensky.opensky_credits - 4
await opensky.close()
async def test_new_session(
aresponses: ResponsesMockServer,
) -> None:
"""Test that it creates a new session if not given one."""
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixture("states.json"),
),
)
async with OpenSky() as opensky:
assert not opensky.session
await opensky.get_states()
assert opensky.session
async def test_timeout(aresponses: ResponsesMockServer) -> None:
"""Test request timeout."""
# Faking a timeout by sleeping
async def response_handler(_: BaseRequest) -> Response:
"""Response handler for this test."""
await asyncio.sleep(2)
return aresponses.Response(body="Goodmorning!")
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
response_handler,
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session, request_timeout=1)
with pytest.raises(OpenSkyConnectionError):
assert await opensky.get_states()
await opensky.close()
async def test_auth(aresponses: ResponsesMockServer) -> None:
"""Test request authentication."""
def response_handler(request: BaseRequest) -> Response:
"""Response handler for this test."""
assert request.headers
assert request.headers["Authorization"]
assert request.headers["Authorization"] == "Basic dGVzdDp0ZXN0"
return aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixture("states.json"),
)
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
response_handler,
repeat=2,
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
await opensky.authenticate(BasicAuth(login="test", password="test"))
await opensky.get_states()
await opensky.close()
async def test_unauthorized(aresponses: ResponsesMockServer) -> None:
"""Test request authentication."""
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
aresponses.Response(
status=401,
headers={"Content-Type": "application/json"},
text=load_fixture("states.json"),
),
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
try:
await opensky.authenticate(BasicAuth(login="test", password="test"))
pytest.fail("Should've thrown exception")
except OpenSkyUnauthenticatedError:
pass
assert opensky.is_authenticated is False
await opensky.close()
async def test_user_credits(aresponses: ResponsesMockServer) -> None:
"""Test authenticated user credits."""
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "application/json"},
text=load_fixture("states.json"),
),
repeat=2,
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
assert opensky.opensky_credits == 400
await opensky.authenticate(BasicAuth(login="test", password="test"))
assert opensky.opensky_credits == 4000
await opensky.authenticate(
BasicAuth(login="test", password="test"),
contributing_user=True,
)
assert opensky.opensky_credits == 8000
assert opensky.is_contributing_user is True
await opensky.close()
async def test_request_error(aresponses: ResponsesMockServer) -> None:
"""Test request error."""
async def response_handler(_: BaseRequest) -> Response:
"""Response handler for this test."""
raise ClientError
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
response_handler,
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
with pytest.raises(OpenSkyConnectionError):
assert await opensky.get_states()
await opensky.close()
async def test_unexpected_server_response(
aresponses: ResponsesMockServer,
) -> None:
"""Test handling a server error."""
aresponses.add(
OPENSKY_URL,
"/api/states/all",
"GET",
aresponses.Response(
status=200,
headers={"Content-Type": "plain/text"},
text="Yes",
),
)
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
with pytest.raises(OpenSkyError):
assert await opensky.get_states()
await opensky.close()
async def test_unauthenticated_own_states() -> None:
"""Test unauthenticated access to own states."""
async with aiohttp.ClientSession() as session:
opensky = OpenSky(session=session)
with pytest.raises(OpenSkyUnauthenticatedError):
assert await opensky.get_own_states()
await opensky.close()
async def test_calculating_credit_usage() -> None:
"""Test calculating credit usage."""
opensky = OpenSky()
bounding_box = BoundingBox(
min_latitude=49.7,
max_latitude=50.5,
min_longitude=3.2,
max_longitude=4.6,
)
assert opensky.calculate_credit_costs(bounding_box) == 1
bounding_box = BoundingBox(
min_latitude=46.5,
max_latitude=49.9,
min_longitude=-1.4,
max_longitude=6.8,
)
assert opensky.calculate_credit_costs(bounding_box) == 2
bounding_box = BoundingBox(
min_latitude=42.2,
max_latitude=49.8,
min_longitude=-4.7,
max_longitude=10.9,
)
assert opensky.calculate_credit_costs(bounding_box) == 3
bounding_box = BoundingBox(
min_latitude=42.2,
max_latitude=49.8,
min_longitude=-80.7,
max_longitude=10.9,
)
assert opensky.calculate_credit_costs(bounding_box) == 4
|
