-
Notifications
You must be signed in to change notification settings - Fork 304
/
test_spawner.py
589 lines (469 loc) · 17.1 KB
/
test_spawner.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
import json
import os
import time
from unittest.mock import Mock
import pytest
from jupyterhub.objects import Hub
from jupyterhub.objects import Server
from jupyterhub.orm import Spawner
from kubernetes.client.models import V1Capabilities
from kubernetes.client.models import V1Container
from kubernetes.client.models import V1PersistentVolumeClaim
from kubernetes.client.models import V1Pod
from kubernetes.client.models import V1SecurityContext
from traitlets.config import Config
from kubespawner import KubeSpawner
class MockUser(Mock):
name = 'fake'
server = Server()
def __init__(self, **kwargs):
super().__init__()
for key, value in kwargs.items():
setattr(self, key, value)
@property
def escaped_name(self):
return self.name
@property
def url(self):
return self.server.url
class MockOrmSpawner(Mock):
name = 'server'
server = None
def test_deprecated_config():
"""Deprecated config is handled correctly"""
with pytest.warns(DeprecationWarning):
c = Config()
# both set, non-deprecated wins
c.KubeSpawner.singleuser_fs_gid = 5
c.KubeSpawner.fs_gid = 10
# only deprecated set, should still work
c.KubeSpawner.hub_connect_ip = '10.0.1.1'
c.KubeSpawner.singleuser_extra_pod_config = extra_pod_config = {"key": "value"}
c.KubeSpawner.image_spec = 'abc:123'
c.KubeSpawner.image_pull_secrets = 'k8s-secret-a'
spawner = KubeSpawner(hub=Hub(), config=c, _mock=True)
assert spawner.hub.connect_ip == '10.0.1.1'
assert spawner.fs_gid == 10
assert spawner.extra_pod_config == extra_pod_config
# deprecated access gets the right values, too
assert spawner.singleuser_fs_gid == spawner.fs_gid
assert spawner.singleuser_extra_pod_config == spawner.extra_pod_config
assert spawner.image == 'abc:123'
assert spawner.image_pull_secrets[0]["name"] == 'k8s-secret-a'
def test_deprecated_runtime_access():
"""Runtime access/modification of deprecated traits works"""
spawner = KubeSpawner(_mock=True)
spawner.singleuser_uid = 10
assert spawner.uid == 10
assert spawner.singleuser_uid == 10
spawner.uid = 20
assert spawner.uid == 20
assert spawner.singleuser_uid == 20
spawner.image_spec = 'abc:latest'
assert spawner.image_spec == 'abc:latest'
assert spawner.image == 'abc:latest'
spawner.image = 'abc:123'
assert spawner.image_spec == 'abc:123'
assert spawner.image == 'abc:123'
spawner.image_pull_secrets = 'k8s-secret-a'
assert spawner.image_pull_secrets[0]["name"] == 'k8s-secret-a'
def test_spawner_values():
"""Spawner values are set correctly"""
spawner = KubeSpawner(_mock=True)
def set_id(spawner):
return 1
assert spawner.uid == None
spawner.uid = 10
assert spawner.uid == 10
spawner.uid = set_id
assert spawner.uid == set_id
spawner.uid = None
assert spawner.uid == None
assert spawner.gid == None
spawner.gid = 20
assert spawner.gid == 20
spawner.gid = set_id
assert spawner.gid == set_id
spawner.gid = None
assert spawner.gid == None
assert spawner.fs_gid == None
spawner.fs_gid = 30
assert spawner.fs_gid == 30
spawner.fs_gid = set_id
assert spawner.fs_gid == set_id
spawner.fs_gid = None
assert spawner.fs_gid == None
def check_up(url, ssl_ca=None, ssl_client_cert=None, ssl_client_key=None):
"""Check that a url responds with a non-error code
For use in exec_python_in_pod,
which means imports need to be in the function
Uses stdlib only because requests isn't always available in the target pod
"""
from urllib import request
import ssl
if ssl_ca:
context = ssl.create_default_context(
purpose=ssl.Purpose.SERVER_AUTH, cafile=ssl_ca
)
if ssl_client_cert:
context.load_cert_chain(certfile=ssl_client_cert, keyfile=ssl_client_key)
else:
context = None
# disable redirects (this would be easier if we ran exec in an image with requests)
class NoRedirect(request.HTTPRedirectHandler):
def redirect_request(self, req, fp, code, msg, headers, newurl):
return None
opener = request.build_opener(NoRedirect, request.HTTPSHandler(context=context))
try:
u = opener.open(url)
except request.HTTPError as e:
if e.status >= 400:
raise
u = e
print(u.status)
@pytest.mark.asyncio
async def test_spawn_start(
kube_ns,
kube_client,
config,
hub,
exec_python,
):
spawner = KubeSpawner(
hub=hub,
user=MockUser(name="start"),
config=config,
api_token="abc123",
oauth_client_id="unused",
)
# empty spawner isn't running
status = await spawner.poll()
assert isinstance(status, int)
pod_name = spawner.pod_name
# start the spawner
url = await spawner.start()
# verify the pod exists
pods = kube_client.list_namespaced_pod(kube_ns).items
pod_names = [p.metadata.name for p in pods]
assert pod_name in pod_names
# pod should be running when start returns
pod = kube_client.read_namespaced_pod(namespace=kube_ns, name=pod_name)
assert pod.status.phase == "Running"
# verify poll while running
status = await spawner.poll()
assert status is None
# make sure spawn url is correct
r = exec_python(check_up, {"url": url}, _retries=3)
assert r == "302"
# stop the pod
await spawner.stop()
# verify pod is gone
pods = kube_client.list_namespaced_pod(kube_ns).items
pod_names = [p.metadata.name for p in pods]
assert pod_name not in pod_names
# verify exit status
status = await spawner.poll()
assert isinstance(status, int)
@pytest.mark.asyncio
async def test_spawn_internal_ssl(
kube_ns,
kube_client,
ssl_app,
hub_pod_ssl,
hub_ssl,
config,
exec_python_pod,
):
hub_pod_name = hub_pod_ssl.metadata.name
spawner = KubeSpawner(
config=config,
hub=hub_ssl,
user=MockUser(name="ssl"),
api_token="abc123",
oauth_client_id="unused",
internal_ssl=True,
internal_trust_bundles=ssl_app.internal_trust_bundles,
internal_certs_location=ssl_app.internal_certs_location,
)
# initialize ssl config
hub_paths = await spawner.create_certs()
spawner.cert_paths = await spawner.move_certs(hub_paths)
# start the spawner
url = await spawner.start()
pod_name = "jupyter-%s" % spawner.user.name
# verify the pod exists
pods = kube_client.list_namespaced_pod(kube_ns).items
pod_names = [p.metadata.name for p in pods]
assert pod_name in pod_names
# verify poll while running
status = await spawner.poll()
assert status is None
# verify service and secret exist
secret_name = spawner.secret_name
secrets = kube_client.list_namespaced_secret(kube_ns).items
secret_names = [s.metadata.name for s in secrets]
assert secret_name in secret_names
service_name = pod_name
services = kube_client.list_namespaced_service(kube_ns).items
service_names = [s.metadata.name for s in services]
assert service_name in service_names
# resolve internal-ssl paths in hub-ssl pod
# these are in /etc/jupyterhub/internal-ssl
hub_ssl_dir = "/etc/jupyterhub"
hub_ssl_ca = os.path.join(hub_ssl_dir, ssl_app.internal_trust_bundles["hub-ca"])
# use certipy to resolve these?
hub_internal = os.path.join(hub_ssl_dir, "internal-ssl", "hub-internal")
hub_internal_cert = os.path.join(hub_internal, "hub-internal.crt")
hub_internal_key = os.path.join(hub_internal, "hub-internal.key")
r = exec_python_pod(
hub_pod_name,
check_up,
{
"url": url,
"ssl_ca": hub_ssl_ca,
"ssl_client_cert": hub_internal_cert,
"ssl_client_key": hub_internal_key,
},
_retries=3,
)
assert r == "302"
# stop the pod
await spawner.stop()
# verify pod is gone
pods = kube_client.list_namespaced_pod(kube_ns).items
pod_names = [p.metadata.name for p in pods]
assert "jupyter-%s" % spawner.user.name not in pod_names
# verify service and secret are gone
# it may take a little while for them to get cleaned up
for i in range(5):
secrets = kube_client.list_namespaced_secret(kube_ns).items
secret_names = {s.metadata.name for s in secrets}
services = kube_client.list_namespaced_service(kube_ns).items
service_names = {s.metadata.name for s in services}
if secret_name in secret_names or service_name in service_names:
time.sleep(1)
else:
break
assert secret_name not in secret_names
assert service_name not in service_names
@pytest.mark.asyncio
async def test_spawn_progress(kube_ns, kube_client, config, hub_pod, hub):
spawner = KubeSpawner(
hub=hub,
user=MockUser(name="progress"),
config=config,
)
# empty spawner isn't running
status = await spawner.poll()
assert isinstance(status, int)
# start the spawner
start_future = spawner.start()
# check progress events
messages = []
async for progress in spawner.progress():
assert 'progress' in progress
assert isinstance(progress['progress'], int)
assert 'message' in progress
assert isinstance(progress['message'], str)
messages.append(progress['message'])
# ensure we can serialize whatever we return
with open(os.devnull, "w") as devnull:
json.dump(progress, devnull)
assert 'Started container' in '\n'.join(messages)
await start_future
# stop the pod
await spawner.stop()
@pytest.mark.asyncio
async def test_get_pod_manifest_tolerates_mixed_input():
"""
Test that the get_pod_manifest function can handle a either a dictionary or
an object both representing V1Container objects and that the function
returns a V1Pod object containing V1Container objects.
"""
c = Config()
dict_model = {
'name': 'mock_name_1',
'image': 'mock_image_1',
'command': ['mock_command_1'],
}
object_model = V1Container(
name="mock_name_2",
image="mock_image_2",
command=['mock_command_2'],
security_context=V1SecurityContext(
privileged=True,
run_as_user=0,
capabilities=V1Capabilities(add=['NET_ADMIN']),
),
)
c.KubeSpawner.init_containers = [dict_model, object_model]
spawner = KubeSpawner(config=c, _mock=True)
# this test ensures the following line doesn't raise an error
manifest = await spawner.get_pod_manifest()
# and tests the return value's types
assert isinstance(manifest, V1Pod)
assert isinstance(manifest.spec.init_containers[0], V1Container)
assert isinstance(manifest.spec.init_containers[1], V1Container)
_test_profiles = [
{
'display_name': 'Training Env - Python',
'slug': 'training-python',
'default': True,
'kubespawner_override': {
'image': 'training/python:label',
'cpu_limit': 1,
'mem_limit': 512 * 1024 * 1024,
},
},
{
'display_name': 'Training Env - Datascience',
'slug': 'training-datascience',
'kubespawner_override': {
'image': 'training/datascience:label',
'cpu_limit': 4,
'mem_limit': 8 * 1024 * 1024 * 1024,
},
},
]
@pytest.mark.asyncio
async def test_user_options_set_from_form():
spawner = KubeSpawner(_mock=True)
spawner.profile_list = _test_profiles
# render the form
await spawner.get_options_form()
spawner.user_options = spawner.options_from_form(
{'profile': [_test_profiles[1]['slug']]}
)
assert spawner.user_options == {
'profile': _test_profiles[1]['slug'],
}
# nothing should be loaded yet
assert spawner.cpu_limit is None
await spawner.load_user_options()
for key, value in _test_profiles[1]['kubespawner_override'].items():
assert getattr(spawner, key) == value
@pytest.mark.asyncio
async def test_user_options_api():
spawner = KubeSpawner(_mock=True)
spawner.profile_list = _test_profiles
# set user_options directly (e.g. via api)
spawner.user_options = {'profile': _test_profiles[1]['slug']}
# nothing should be loaded yet
assert spawner.cpu_limit is None
await spawner.load_user_options()
for key, value in _test_profiles[1]['kubespawner_override'].items():
assert getattr(spawner, key) == value
@pytest.mark.asyncio
async def test_default_profile():
spawner = KubeSpawner(_mock=True)
spawner.profile_list = _test_profiles
spawner.user_options = {}
# nothing should be loaded yet
assert spawner.cpu_limit is None
await spawner.load_user_options()
for key, value in _test_profiles[0]['kubespawner_override'].items():
assert getattr(spawner, key) == value
def test_pod_name_no_named_servers():
c = Config()
c.JupyterHub.allow_named_servers = False
user = Config()
user.name = "user"
orm_spawner = Spawner()
spawner = KubeSpawner(config=c, user=user, orm_spawner=orm_spawner, _mock=True)
assert spawner.pod_name == "jupyter-user"
def test_pod_name_named_servers():
c = Config()
c.JupyterHub.allow_named_servers = True
user = Config()
user.name = "user"
orm_spawner = Spawner()
orm_spawner.name = "server"
spawner = KubeSpawner(config=c, user=user, orm_spawner=orm_spawner, _mock=True)
assert spawner.pod_name == "jupyter-user--server"
def test_pod_name_escaping():
c = Config()
c.JupyterHub.allow_named_servers = True
user = Config()
user.name = "some_user"
orm_spawner = Spawner()
orm_spawner.name = "test-server!"
spawner = KubeSpawner(config=c, user=user, orm_spawner=orm_spawner, _mock=True)
assert spawner.pod_name == "jupyter-some-5fuser--test-2dserver-21"
def test_pod_name_custom_template():
user = MockUser()
user.name = "some_user"
pod_name_template = "prefix-{username}-suffix"
spawner = KubeSpawner(user=user, pod_name_template=pod_name_template, _mock=True)
assert spawner.pod_name == "prefix-some-5fuser-suffix"
def test_pod_name_collision():
user1 = MockUser()
user1.name = "user-has-dash"
orm_spawner1 = Spawner()
orm_spawner1.name = ""
user2 = MockUser()
user2.name = "user-has"
orm_spawner2 = Spawner()
orm_spawner2.name = "2ddash"
spawner = KubeSpawner(user=user1, orm_spawner=orm_spawner1, _mock=True)
assert spawner.pod_name == "jupyter-user-2dhas-2ddash"
assert spawner.pvc_name == "claim-user-2dhas-2ddash"
named_spawner = KubeSpawner(user=user2, orm_spawner=orm_spawner2, _mock=True)
assert named_spawner.pod_name == "jupyter-user-2dhas--2ddash"
assert spawner.pod_name != named_spawner.pod_name
assert named_spawner.pvc_name == "claim-user-2dhas--2ddash"
assert spawner.pvc_name != named_spawner.pvc_name
def test_spawner_can_use_list_of_image_pull_secrets():
secrets = ["ecr", "regcred", "artifactory"]
c = Config()
c.KubeSpawner.image_spec = "private.docker.registry/jupyter:1.2.3"
c.KubeSpawner.image_pull_secrets = secrets
spawner = KubeSpawner(hub=Hub(), config=c, _mock=True)
assert spawner.image_pull_secrets == secrets
secrets = [dict(name=secret) for secret in secrets]
c = Config()
c.KubeSpawner.image_spec = "private.docker.registry/jupyter:1.2.3"
c.KubeSpawner.image_pull_secrets = secrets
spawner = KubeSpawner(hub=Hub(), config=c, _mock=True)
assert spawner.image_pull_secrets == secrets
@pytest.mark.asyncio
async def test_pod_connect_ip(kube_ns, kube_client, config, hub_pod, hub):
config.KubeSpawner.pod_connect_ip = (
"jupyter-{username}--{servername}.foo.example.com"
)
user = MockUser(name="connectip")
# w/o servername
spawner = KubeSpawner(hub=hub, user=user, config=config)
# start the spawner
res = await spawner.start()
# verify the pod IP and port
assert res == "http://jupyter-connectip.foo.example.com:8888"
await spawner.stop()
# w/ servername
spawner = KubeSpawner(
hub=hub,
user=user,
config=config,
orm_spawner=MockOrmSpawner(),
)
# start the spawner
res = await spawner.start()
# verify the pod IP and port
assert res == "http://jupyter-connectip--server.foo.example.com:8888"
await spawner.stop()
def test_get_pvc_manifest():
c = Config()
c.KubeSpawner.pvc_name_template = "user-{username}"
c.KubeSpawner.storage_extra_labels = {"user": "{username}"}
c.KubeSpawner.storage_selector = {"matchLabels": {"user": "{username}"}}
spawner = KubeSpawner(config=c, _mock=True)
manifest = spawner.get_pvc_manifest()
assert isinstance(manifest, V1PersistentVolumeClaim)
assert manifest.metadata.name == "user-mock-5fname"
assert manifest.metadata.labels == {
"user": "mock-5fname",
"hub.jupyter.org/username": "mock-5fname",
"app": "jupyterhub",
"component": "singleuser-storage",
"heritage": "jupyterhub",
}
assert manifest.spec.selector == {"matchLabels": {"user": "mock-5fname"}}