forked from apache/airflow
-
Notifications
You must be signed in to change notification settings - Fork 0
/
test_pool_endpoint.py
612 lines (560 loc) · 21.8 KB
/
test_pool_endpoint.py
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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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 pytest
from parameterized import parameterized
from airflow.api_connexion.exceptions import EXCEPTIONS_LINK_MAP
from airflow.models.pool import Pool
from airflow.security import permissions
from airflow.utils.session import provide_session
from tests.test_utils.api_connexion_utils import assert_401, create_user, delete_user
from tests.test_utils.config import conf_vars
from tests.test_utils.db import clear_db_pools
@pytest.fixture(scope="module")
def configured_app(minimal_app_for_api):
app = minimal_app_for_api
create_user(
app, # type: ignore
username="test",
role_name="Test",
permissions=[
(permissions.ACTION_CAN_CREATE, permissions.RESOURCE_POOL),
(permissions.ACTION_CAN_READ, permissions.RESOURCE_POOL),
(permissions.ACTION_CAN_EDIT, permissions.RESOURCE_POOL),
(permissions.ACTION_CAN_DELETE, permissions.RESOURCE_POOL),
],
)
create_user(app, username="test_no_permissions", role_name="TestNoPermissions") # type: ignore
yield app
delete_user(app, username="test") # type: ignore
delete_user(app, username="test_no_permissions") # type: ignore
class TestBasePoolEndpoints:
@pytest.fixture(autouse=True)
def setup_attrs(self, configured_app) -> None:
self.app = configured_app
self.client = self.app.test_client() # type:ignore
clear_db_pools()
def teardown_method(self) -> None:
clear_db_pools()
class TestGetPools(TestBasePoolEndpoints):
def test_response_200(self, session):
pool_model = Pool(pool="test_pool_a", slots=3)
session.add(pool_model)
session.commit()
result = session.query(Pool).all()
assert len(result) == 2 # accounts for the default pool as well
response = self.client.get("/api/v1/pools", environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 200
assert {
"pools": [
{
"name": "default_pool",
"slots": 128,
"occupied_slots": 0,
"running_slots": 0,
"queued_slots": 0,
"scheduled_slots": 0,
"open_slots": 128,
"description": "Default pool",
},
{
"name": "test_pool_a",
"slots": 3,
"occupied_slots": 0,
"running_slots": 0,
"queued_slots": 0,
"scheduled_slots": 0,
"open_slots": 3,
"description": None,
},
],
"total_entries": 2,
} == response.json
def test_response_200_with_order_by(self, session):
pool_model = Pool(pool="test_pool_a", slots=3)
session.add(pool_model)
session.commit()
result = session.query(Pool).all()
assert len(result) == 2 # accounts for the default pool as well
response = self.client.get("/api/v1/pools?order_by=slots", environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 200
assert {
"pools": [
{
"name": "test_pool_a",
"slots": 3,
"occupied_slots": 0,
"running_slots": 0,
"queued_slots": 0,
"scheduled_slots": 0,
"open_slots": 3,
"description": None,
},
{
"name": "default_pool",
"slots": 128,
"occupied_slots": 0,
"running_slots": 0,
"queued_slots": 0,
"scheduled_slots": 0,
"open_slots": 128,
"description": "Default pool",
},
],
"total_entries": 2,
} == response.json
def test_should_raises_401_unauthenticated(self):
response = self.client.get("/api/v1/pools")
assert_401(response)
def test_should_raise_403_forbidden(self):
response = self.client.get("/api/v1/pools", environ_overrides={'REMOTE_USER': "test_no_permissions"})
assert response.status_code == 403
class TestGetPoolsPagination(TestBasePoolEndpoints):
@parameterized.expand(
[
# Offset test data
("/api/v1/pools?offset=1", [f"test_pool{i}" for i in range(1, 101)]),
("/api/v1/pools?offset=3", [f"test_pool{i}" for i in range(3, 103)]),
# Limit test data
("/api/v1/pools?limit=2", ["default_pool", "test_pool1"]),
("/api/v1/pools?limit=1", ["default_pool"]),
# Limit and offset test data
(
"/api/v1/pools?limit=100&offset=1",
[f"test_pool{i}" for i in range(1, 101)],
),
("/api/v1/pools?limit=2&offset=1", ["test_pool1", "test_pool2"]),
(
"/api/v1/pools?limit=3&offset=2",
["test_pool2", "test_pool3", "test_pool4"],
),
]
)
@provide_session
def test_limit_and_offset(self, url, expected_pool_ids, session):
pools = [Pool(pool=f"test_pool{i}", slots=1) for i in range(1, 121)]
session.add_all(pools)
session.commit()
result = session.query(Pool).count()
assert result == 121 # accounts for default pool as well
response = self.client.get(url, environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 200
pool_ids = [pool["name"] for pool in response.json["pools"]]
assert pool_ids == expected_pool_ids
def test_should_respect_page_size_limit_default(self, session):
pools = [Pool(pool=f"test_pool{i}", slots=1) for i in range(1, 121)]
session.add_all(pools)
session.commit()
result = session.query(Pool).count()
assert result == 121
response = self.client.get("/api/v1/pools", environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 200
assert len(response.json['pools']) == 100
def test_should_raise_400_for_invalid_orderby(self, session):
pools = [Pool(pool=f"test_pool{i}", slots=1) for i in range(1, 121)]
session.add_all(pools)
session.commit()
result = session.query(Pool).count()
assert result == 121
response = self.client.get(
"/api/v1/pools?order_by=open_slots", environ_overrides={'REMOTE_USER': "test"}
)
assert response.status_code == 400
msg = "Ordering with 'open_slots' is disallowed or the attribute does not exist on the model"
assert response.json['detail'] == msg
@conf_vars({("api", "maximum_page_limit"): "150"})
def test_should_return_conf_max_if_req_max_above_conf(self, session):
pools = [Pool(pool=f"test_pool{i}", slots=1) for i in range(1, 200)]
session.add_all(pools)
session.commit()
result = session.query(Pool).count()
assert result == 200
response = self.client.get("/api/v1/pools?limit=180", environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 200
assert len(response.json['pools']) == 150
class TestGetPool(TestBasePoolEndpoints):
def test_response_200(self, session):
pool_model = Pool(pool="test_pool_a", slots=3)
session.add(pool_model)
session.commit()
response = self.client.get("/api/v1/pools/test_pool_a", environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 200
assert {
"name": "test_pool_a",
"slots": 3,
"occupied_slots": 0,
"running_slots": 0,
"queued_slots": 0,
"scheduled_slots": 0,
"open_slots": 3,
"description": None,
} == response.json
def test_response_404(self):
response = self.client.get("/api/v1/pools/invalid_pool", environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 404
assert {
"detail": "Pool with name:'invalid_pool' not found",
"status": 404,
"title": "Not Found",
"type": EXCEPTIONS_LINK_MAP[404],
} == response.json
def test_should_raises_401_unauthenticated(self):
response = self.client.get("/api/v1/pools/default_pool")
assert_401(response)
class TestDeletePool(TestBasePoolEndpoints):
def test_response_204(self, session):
pool_name = "test_pool"
pool_instance = Pool(pool=pool_name, slots=3)
session.add(pool_instance)
session.commit()
response = self.client.delete(f"api/v1/pools/{pool_name}", environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 204
# Check if the pool is deleted from the db
response = self.client.get(f"api/v1/pools/{pool_name}", environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 404
def test_response_404(self):
response = self.client.delete("api/v1/pools/invalid_pool", environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 404
assert {
"detail": "Pool with name:'invalid_pool' not found",
"status": 404,
"title": "Not Found",
"type": EXCEPTIONS_LINK_MAP[404],
} == response.json
def test_should_raises_401_unauthenticated(self, session):
pool_name = "test_pool"
pool_instance = Pool(pool=pool_name, slots=3)
session.add(pool_instance)
session.commit()
response = self.client.delete(f"api/v1/pools/{pool_name}")
assert_401(response)
# Should still exists
response = self.client.get(f"/api/v1/pools/{pool_name}", environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 200
class TestPostPool(TestBasePoolEndpoints):
def test_response_200(self):
response = self.client.post(
"api/v1/pools",
json={"name": "test_pool_a", "slots": 3, "description": "test pool"},
environ_overrides={'REMOTE_USER': "test"},
)
assert response.status_code == 200
assert {
"name": "test_pool_a",
"slots": 3,
"occupied_slots": 0,
"running_slots": 0,
"queued_slots": 0,
"scheduled_slots": 0,
"open_slots": 3,
"description": "test pool",
} == response.json
def test_response_409(self, session):
pool_name = "test_pool_a"
pool_instance = Pool(pool=pool_name, slots=3)
session.add(pool_instance)
session.commit()
response = self.client.post(
"api/v1/pools",
json={"name": "test_pool_a", "slots": 3},
environ_overrides={'REMOTE_USER': "test"},
)
assert response.status_code == 409
assert {
"detail": f"Pool: {pool_name} already exists",
"status": 409,
"title": "Conflict",
"type": EXCEPTIONS_LINK_MAP[409],
} == response.json
@parameterized.expand(
[
(
"for missing pool name",
{"slots": 3},
"Missing required property(ies): ['name']",
),
(
"for missing slots",
{"name": "invalid_pool"},
"Missing required property(ies): ['slots']",
),
(
"for missing pool name AND slots",
{},
"Missing required property(ies): ['name', 'slots']",
),
(
"for extra fields",
{"name": "invalid_pool", "slots": 3, "extra_field_1": "extra"},
"{'extra_field_1': ['Unknown field.']}",
),
]
)
def test_response_400(self, name, request_json, error_detail):
del name
response = self.client.post(
"api/v1/pools", json=request_json, environ_overrides={'REMOTE_USER': "test"}
)
assert response.status_code == 400
assert {
"detail": error_detail,
"status": 400,
"title": "Bad Request",
"type": EXCEPTIONS_LINK_MAP[400],
} == response.json
def test_should_raises_401_unauthenticated(self):
response = self.client.post("api/v1/pools", json={"name": "test_pool_a", "slots": 3})
assert_401(response)
class TestPatchPool(TestBasePoolEndpoints):
def test_response_200(self, session):
pool = Pool(pool="test_pool", slots=2)
session.add(pool)
session.commit()
response = self.client.patch(
"api/v1/pools/test_pool",
json={"name": "test_pool_a", "slots": 3},
environ_overrides={'REMOTE_USER': "test"},
)
assert response.status_code == 200
assert {
"occupied_slots": 0,
"queued_slots": 0,
"name": "test_pool_a",
"open_slots": 3,
"running_slots": 0,
"scheduled_slots": 0,
"slots": 3,
"description": None,
} == response.json
@parameterized.expand(
[
# Missing properties
("Missing required property(ies): ['name']", {"slots": 3}),
("Missing required property(ies): ['slots']", {"name": "test_pool_a"}),
("Missing required property(ies): ['name', 'slots']", {}),
# Extra properties
(
"{'extra_field': ['Unknown field.']}",
{"name": "test_pool_a", "slots": 3, "extra_field": "extra"},
),
]
)
@provide_session
def test_response_400(self, error_detail, request_json, session):
pool = Pool(pool="test_pool", slots=2)
session.add(pool)
session.commit()
response = self.client.patch(
"api/v1/pools/test_pool", json=request_json, environ_overrides={'REMOTE_USER': "test"}
)
assert response.status_code == 400
assert {
"detail": error_detail,
"status": 400,
"title": "Bad Request",
"type": EXCEPTIONS_LINK_MAP[400],
} == response.json
def test_should_raises_401_unauthenticated(self, session):
pool = Pool(pool="test_pool", slots=2)
session.add(pool)
session.commit()
response = self.client.patch(
"api/v1/pools/test_pool",
json={"name": "test_pool_a", "slots": 3},
)
assert_401(response)
class TestModifyDefaultPool(TestBasePoolEndpoints):
def test_delete_400(self):
response = self.client.delete("api/v1/pools/default_pool", environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 400
assert {
"detail": "Default Pool can't be deleted",
"status": 400,
"title": "Bad Request",
"type": EXCEPTIONS_LINK_MAP[400],
} == response.json
@parameterized.expand(
[
(
"400 No update mask",
400,
"api/v1/pools/default_pool",
{"name": "test_pool_a", "slots": 3},
{
"detail": "Default Pool's name can't be modified",
"status": 400,
"title": "Bad Request",
"type": EXCEPTIONS_LINK_MAP[400],
},
),
(
"400 Update mask with both fields",
400,
"api/v1/pools/default_pool?update_mask=name, slots",
{"name": "test_pool_a", "slots": 3},
{
"detail": "Default Pool's name can't be modified",
"status": 400,
"title": "Bad Request",
"type": EXCEPTIONS_LINK_MAP[400],
},
),
(
"200 Update mask with slots",
200,
"api/v1/pools/default_pool?update_mask=slots",
{"name": "test_pool_a", "slots": 3},
{
"occupied_slots": 0,
"queued_slots": 0,
"name": "default_pool",
"open_slots": 3,
"running_slots": 0,
"scheduled_slots": 0,
"slots": 3,
"description": "Default pool",
},
),
(
"200 Update mask with slots and name",
200,
"api/v1/pools/default_pool?update_mask=name,slots",
{"name": "default_pool", "slots": 3},
{
"occupied_slots": 0,
"queued_slots": 0,
"name": "default_pool",
"open_slots": 3,
"running_slots": 0,
"scheduled_slots": 0,
"slots": 3,
"description": "Default pool",
},
),
(
"200 no update mask",
200,
"api/v1/pools/default_pool",
{
"name": "default_pool",
"slots": 3,
},
{
"occupied_slots": 0,
"queued_slots": 0,
"name": "default_pool",
"open_slots": 3,
"running_slots": 0,
"scheduled_slots": 0,
"slots": 3,
"description": "Default pool",
},
),
]
)
def test_patch(self, name, status_code, url, json, expected_response):
del name
response = self.client.patch(url, json=json, environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == status_code
assert response.json == expected_response
class TestPatchPoolWithUpdateMask(TestBasePoolEndpoints):
@parameterized.expand(
[
(
"api/v1/pools/test_pool?update_mask=name, slots",
{"name": "test_pool_a", "slots": 2},
"test_pool_a",
2,
),
(
"api/v1/pools/test_pool?update_mask=name",
{"name": "test_pool_a", "slots": 2},
"test_pool_a",
3,
),
(
"api/v1/pools/test_pool?update_mask=slots",
{"name": "test_pool_a", "slots": 2},
"test_pool",
2,
),
(
"api/v1/pools/test_pool?update_mask=slots",
{"slots": 2},
"test_pool",
2,
),
]
)
@provide_session
def test_response_200(self, url, patch_json, expected_name, expected_slots, session):
pool = Pool(pool="test_pool", slots=3)
session.add(pool)
session.commit()
response = self.client.patch(url, json=patch_json, environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 200
assert {
"name": expected_name,
"slots": expected_slots,
"occupied_slots": 0,
"running_slots": 0,
"queued_slots": 0,
"scheduled_slots": 0,
"open_slots": expected_slots,
"description": None,
} == response.json
@parameterized.expand(
[
(
"Patching read only field",
"Property is read-only - 'occupied_slots'",
"api/v1/pools/test_pool?update_mask=slots, name, occupied_slots",
{"name": "test_pool_a", "slots": 2, "occupied_slots": 1},
),
(
"Patching read only field",
"Property is read-only - 'queued_slots'",
"api/v1/pools/test_pool?update_mask=slots, name, queued_slots",
{"name": "test_pool_a", "slots": 2, "queued_slots": 1},
),
(
"Invalid update mask",
"Invalid field: names in update mask",
"api/v1/pools/test_pool?update_mask=slots, names,",
{"name": "test_pool_a", "slots": 2},
),
(
"Invalid update mask",
"Invalid field: slot in update mask",
"api/v1/pools/test_pool?update_mask=slot, name,",
{"name": "test_pool_a", "slots": 2},
),
]
)
@provide_session
def test_response_400(self, name, error_detail, url, patch_json, session):
del name
pool = Pool(pool="test_pool", slots=3)
session.add(pool)
session.commit()
response = self.client.patch(url, json=patch_json, environ_overrides={'REMOTE_USER': "test"})
assert response.status_code == 400
assert {
"detail": error_detail,
"status": 400,
"title": "Bad Request",
"type": EXCEPTIONS_LINK_MAP[400],
} == response.json