zhangyiss/the-littlest-jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/the-littlest-jupyterhub.git synced 2025-12-18 21:54:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #623 from jeanmarcalkazzi/fix/616-baseurl

Browse Source 
Add base_url capability to tljh-config
This commit is contained in:
Georgiana Elena
2020-11-05 11:54:39 +02:00
committed by GitHub
parent 31c2b76358 70853059ff
commit bff3114598
5 changed files with 172 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/topic/tljh-config.rst
View File

@@ -63,6 +63,13 @@ file. If what you want is only to change the property's value, you should use
Some of the existing ``<property-path>`` are listed below by categories: Some of the existing ``<property-path>`` are listed below by categories:
.. _tljh-base_url:
Base URL
--------
Use ``base_url`` to determine the base URL used by JupyterHub. This parameter will
be passed straight to ``c.JupyterHub.base_url``.
.. _tljh-set-auth: .. _tljh-set-auth:

195
integration-tests/test_hub.py
View File

@@ -18,6 +18,7 @@ from tljh.normalize import generate_system_username
# This catches issues with PATH # This catches issues with PATH
TLJH_CONFIG_PATH = ['sudo', 'tljh-config'] TLJH_CONFIG_PATH = ['sudo', 'tljh-config']
def test_hub_up(): def test_hub_up():
r = requests.get('http://127.0.0.1') r = requests.get('http://127.0.0.1')
r.raise_for_status() r.raise_for_status()
@@ -37,13 +38,37 @@ async def test_user_code_execute():
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait() assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait()
async with User(username, hub_url, partial(login_dummy, password='')) as u: async with User(username, hub_url, partial(login_dummy, password='')) as u:
await u.login() await u.login()
await u.ensure_server_simulate() await u.ensure_server_simulate()
await u.start_kernel() await u.start_kernel()
await u.assert_code_output("5 * 4", "20", 5, 5) await u.assert_code_output("5 * 4", "20", 5, 5)
# Assert that the user exists # Assert that the user exists
assert pwd.getpwnam(f'jupyter-{username}') is not None assert pwd.getpwnam(f'jupyter-{username}') is not None
@pytest.mark.asyncio
async def test_user_server_started_with_custom_base_url():
"""
User logs in, starts a server with a custom base_url & executes code
"""
# This *must* be localhost, not an IP
# aiohttp throws away cookies if we are connecting to an IP!
base_url = "/custom-base"
hub_url = f"http://localhost{base_url}"
username = secrets.token_hex(8)
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'set', 'auth.type', 'dummyauthenticator.DummyAuthenticator')).wait()
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'set', 'base_url', base_url)).wait()
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait()
async with User(username, hub_url, partial(login_dummy, password='')) as u:
await u.login()
await u.ensure_server_simulate()
# unset base_url to avoid problems with other tests
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'unset', 'base_url')).wait()
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait()
@pytest.mark.asyncio @pytest.mark.asyncio
@@ -61,14 +86,15 @@ async def test_user_admin_add():
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait() assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait()
async with User(username, hub_url, partial(login_dummy, password='')) as u: async with User(username, hub_url, partial(login_dummy, password='')) as u:
await u.login() await u.login()
await u.ensure_server_simulate() await u.ensure_server_simulate()
# Assert that the user exists # Assert that the user exists
assert pwd.getpwnam(f'jupyter-{username}') is not None assert pwd.getpwnam(f'jupyter-{username}') is not None
# Assert that the user has admin rights # Assert that the user has admin rights
assert f'jupyter-{username}' in grp.getgrnam('jupyterhub-admins').gr_mem assert f'jupyter-{username}' in grp.getgrnam(
'jupyterhub-admins').gr_mem
# FIXME: Make this test pass # FIXME: Make this test pass
@@ -90,23 +116,25 @@ async def test_user_admin_remove():
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait() assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait()
async with User(username, hub_url, partial(login_dummy, password='')) as u: async with User(username, hub_url, partial(login_dummy, password='')) as u:
await u.login() await u.login()
await u.ensure_server_simulate() await u.ensure_server_simulate()
# Assert that the user exists # Assert that the user exists
assert pwd.getpwnam(f'jupyter-{username}') is not None assert pwd.getpwnam(f'jupyter-{username}') is not None
# Assert that the user has admin rights # Assert that the user has admin rights
assert f'jupyter-{username}' in grp.getgrnam('jupyterhub-admins').gr_mem assert f'jupyter-{username}' in grp.getgrnam(
'jupyterhub-admins').gr_mem
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'remove-item', 'users.admin', username)).wait() assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'remove-item', 'users.admin', username)).wait()
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait() assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait()
await u.stop_server() await u.stop_server()
await u.ensure_server_simulate() await u.ensure_server_simulate()
# Assert that the user does *not* have admin rights # Assert that the user does *not* have admin rights
assert f'jupyter-{username}' not in grp.getgrnam('jupyterhub-admins').gr_mem assert f'jupyter-{username}' not in grp.getgrnam(
'jupyterhub-admins').gr_mem
@pytest.mark.asyncio @pytest.mark.asyncio
@@ -124,14 +152,14 @@ async def test_long_username():
try: try:
async with User(username, hub_url, partial(login_dummy, password='')) as u: async with User(username, hub_url, partial(login_dummy, password='')) as u:
await u.login() await u.login()
await u.ensure_server_simulate() await u.ensure_server_simulate()
# Assert that the user exists # Assert that the user exists
system_username = generate_system_username(f'jupyter-{username}') system_username = generate_system_username(f'jupyter-{username}')
assert pwd.getpwnam(system_username) is not None assert pwd.getpwnam(system_username) is not None
await u.stop_server() await u.stop_server()
except: except:
# If we have any errors, print jupyterhub logs before exiting # If we have any errors, print jupyterhub logs before exiting
subprocess.check_call([ subprocess.check_call([
@@ -161,19 +189,19 @@ async def test_user_group_adding():
try: try:
async with User(username, hub_url, partial(login_dummy, password='')) as u: async with User(username, hub_url, partial(login_dummy, password='')) as u:
await u.login() await u.login()
await u.ensure_server_simulate() await u.ensure_server_simulate()
# Assert that the user exists # Assert that the user exists
system_username = generate_system_username(f'jupyter-{username}') system_username = generate_system_username(f'jupyter-{username}')
assert pwd.getpwnam(system_username) is not None assert pwd.getpwnam(system_username) is not None
# Assert that the user was added to the specified group # Assert that the user was added to the specified group
assert f'jupyter-{username}' in grp.getgrnam('somegroup').gr_mem assert f'jupyter-{username}' in grp.getgrnam('somegroup').gr_mem
await u.stop_server() await u.stop_server()
# Delete the group # Delete the group
system('groupdel somegroup') system('groupdel somegroup')
except: except:
# If we have any errors, print jupyterhub logs before exiting # If we have any errors, print jupyterhub logs before exiting
subprocess.check_call([ subprocess.check_call([
@@ -205,29 +233,30 @@ async def test_idle_server_culled():
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait() assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait()
async with User(username, hub_url, partial(login_dummy, password='')) as u: async with User(username, hub_url, partial(login_dummy, password='')) as u:
await u.login() await u.login()
# Start user's server # Start user's server
await u.ensure_server_simulate() await u.ensure_server_simulate()
# Assert that the user exists # Assert that the user exists
assert pwd.getpwnam(f'jupyter-{username}') is not None assert pwd.getpwnam(f'jupyter-{username}') is not None
# Check that we can get to the user's server # Check that we can get to the user's server
r = await u.session.get(u.hub_url / 'hub/api/users' / username,
headers={'Referer': str(u.hub_url / 'hub/')})
assert r.status == 200
async def _check_culling_done():
# Check that after 60s, the user and server have been culled and are not reacheable anymore
r = await u.session.get(u.hub_url / 'hub/api/users' / username, r = await u.session.get(u.hub_url / 'hub/api/users' / username,
headers={'Referer': str(u.hub_url / 'hub/')}) headers={'Referer': str(u.hub_url / 'hub/')})
assert r.status == 200 print(r.status)
return r.status == 403
async def _check_culling_done(): await exponential_backoff(
# Check that after 60s, the user and server have been culled and are not reacheable anymore _check_culling_done,
r = await u.session.get(u.hub_url / 'hub/api/users' / username, "Server culling failed!",
headers={'Referer': str(u.hub_url / 'hub/')}) timeout=100,
print(r.status) )
return r.status == 403
await exponential_backoff(
_check_culling_done,
"Server culling failed!",
timeout=100,
)
@pytest.mark.asyncio @pytest.mark.asyncio
async def test_active_server_not_culled(): async def test_active_server_not_culled():
@@ -250,30 +279,30 @@ async def test_active_server_not_culled():
assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait() assert 0 == await (await asyncio.create_subprocess_exec(*TLJH_CONFIG_PATH, 'reload')).wait()
async with User(username, hub_url, partial(login_dummy, password='')) as u: async with User(username, hub_url, partial(login_dummy, password='')) as u:
await u.login() await u.login()
# Start user's server # Start user's server
await u.ensure_server_simulate() await u.ensure_server_simulate()
# Assert that the user exists # Assert that the user exists
assert pwd.getpwnam(f'jupyter-{username}') is not None assert pwd.getpwnam(f'jupyter-{username}') is not None
# Check that we can get to the user's server # Check that we can get to the user's server
r = await u.session.get(u.hub_url / 'hub/api/users' / username,
headers={'Referer': str(u.hub_url / 'hub/')})
assert r.status == 200
async def _check_culling_done():
# Check that after 30s, we can still reach the user's server
r = await u.session.get(u.hub_url / 'hub/api/users' / username, r = await u.session.get(u.hub_url / 'hub/api/users' / username,
headers={'Referer': str(u.hub_url / 'hub/')}) headers={'Referer': str(u.hub_url / 'hub/')})
assert r.status == 200 print(r.status)
return r.status != 200
async def _check_culling_done(): try:
# Check that after 30s, we can still reach the user's server await exponential_backoff(
r = await u.session.get(u.hub_url / 'hub/api/users' / username, _check_culling_done,
headers={'Referer': str(u.hub_url / 'hub/')}) "User's server is still reacheable!",
print(r.status) timeout=30,
return r.status != 200 )
except TimeoutError:
try: # During the 30s timeout the user's server wasn't culled, which is what we intended.
await exponential_backoff( pass
_check_culling_done,
"User's server is still reacheable!",
timeout=30,
)
except TimeoutError:
# During the 30s timeout the user's server wasn't culled, which is what we intended.
pass

38
tests/test_configurer.py
View File

@@ -2,6 +2,7 @@
Test configurer Test configurer
""" """
from traitlets import Dict
import os import os
import sys import sys
@@ -62,6 +63,22 @@ def apply_mock_config(overrides):
return c return c
def test_default_base_url():
"""
Test default JupyterHub base_url
"""
c = apply_mock_config({})
assert c.JupyterHub.base_url == '/'
def test_set_base_url():
"""
Test set JupyterHub base_url
"""
c = apply_mock_config({'base_url': '/custom-base'})
assert c.JupyterHub.base_url == '/custom-base'
def test_default_memory_limit(): def test_default_memory_limit():
""" """
Test default per user memory limit Test default per user memory limit
@@ -129,7 +146,7 @@ def test_auth_dummy():
assert c.JupyterHub.authenticator_class == 'dummyauthenticator.DummyAuthenticator' assert c.JupyterHub.authenticator_class == 'dummyauthenticator.DummyAuthenticator'
assert c.DummyAuthenticator.password == 'test' assert c.DummyAuthenticator.password == 'test'
from traitlets import Dict
def test_user_groups(): def test_user_groups():
""" """
Test setting user groups Test setting user groups
@@ -143,9 +160,9 @@ def test_user_groups():
} }
}) })
assert c.UserCreatingSpawner.user_groups == { assert c.UserCreatingSpawner.user_groups == {
"g1": ["u1", "u2"], "g1": ["u1", "u2"],
"g2": ["u3", "u4"] "g2": ["u3", "u4"]
} }
def test_auth_firstuse(): def test_auth_firstuse():
@@ -213,9 +230,9 @@ def test_cull_service_default():
c = apply_mock_config({}) c = apply_mock_config({})
cull_cmd = [ cull_cmd = [
sys.executable, '-m', 'jupyterhub_idle_culler', sys.executable, '-m', 'jupyterhub_idle_culler',
'--timeout=600', '--cull-every=60', '--concurrency=5', '--timeout=600', '--cull-every=60', '--concurrency=5',
'--max-age=0' '--max-age=0'
] ]
assert c.JupyterHub.services == [{ assert c.JupyterHub.services == [{
'name': 'cull-idle', 'name': 'cull-idle',
@@ -238,9 +255,9 @@ def test_set_cull_service():
} }
}) })
cull_cmd = [ cull_cmd = [
sys.executable, '-m', 'jupyterhub_idle_culler', sys.executable, '-m', 'jupyterhub_idle_culler',
'--timeout=600', '--cull-every=10', '--concurrency=5', '--timeout=600', '--cull-every=10', '--concurrency=5',
'--max-age=60', '--cull-users' '--max-age=60', '--cull-users'
] ]
assert c.JupyterHub.services == [{ assert c.JupyterHub.services == [{
'name': 'cull-idle', 'name': 'cull-idle',
@@ -276,4 +293,3 @@ def test_auth_native():
}) })
assert c.JupyterHub.authenticator_class == 'nativeauthenticator.NativeAuthenticator' assert c.JupyterHub.authenticator_class == 'nativeauthenticator.NativeAuthenticator'
assert c.NativeAuthenticator.open_signup == True assert c.NativeAuthenticator.open_signup == True

18
tljh/config.py
View File

@@ -61,6 +61,7 @@ def set_item_in_config(config, property_path, value):
return config_copy return config_copy
def unset_item_from_config(config, property_path): def unset_item_from_config(config, property_path):
""" """
Unset key at property_path in config & return new config. Unset key at property_path in config & return new config.
@@ -105,6 +106,7 @@ def unset_item_from_config(config, property_path):
return config_copy return config_copy
def add_item_to_config(config, property_path, value): def add_item_to_config(config, property_path, value):
""" """
Add an item to a list in config. Add an item to a list in config.
@@ -238,15 +240,20 @@ def remove_config_value(config_path, key_path, value):
with open(config_path, 'w') as f: with open(config_path, 'w') as f:
yaml.dump(config, f) yaml.dump(config, f)
def check_hub_ready(): def check_hub_ready():
from .configurer import load_config from .configurer import load_config
base_url = load_config()['base_url']
base_url = base_url[:-1] if base_url[-1] == '/' else base_url
http_port = load_config()['http']['port'] http_port = load_config()['http']['port']
try: try:
r = requests.get('http://127.0.0.1:%d/hub/api' % http_port, verify=False) r = requests.get('http://127.0.0.1:%d%s/hub/api' % (http_port, base_url), verify=False)
return r.status_code == 200 return r.status_code == 200
except: except:
return False return False
def reload_component(component): def reload_component(component):
""" """
Reload a TLJH component. Reload a TLJH component.
@@ -389,13 +396,16 @@ def main(argv=None):
if args.action == 'show': if args.action == 'show':
show_config(args.config_path) show_config(args.config_path)
elif args.action == 'set': elif args.action == 'set':
set_config_value(args.config_path, args.key_path, parse_value(args.value)) set_config_value(args.config_path, args.key_path,
parse_value(args.value))
elif args.action == 'unset': elif args.action == 'unset':
unset_config_value(args.config_path, args.key_path) unset_config_value(args.config_path, args.key_path)
elif args.action == 'add-item': elif args.action == 'add-item':
add_config_value(args.config_path, args.key_path, parse_value(args.value)) add_config_value(args.config_path, args.key_path,
parse_value(args.value))
elif args.action == 'remove-item': elif args.action == 'remove-item':
remove_config_value(args.config_path, args.key_path, parse_value(args.value)) remove_config_value(args.config_path, args.key_path,
parse_value(args.value))
elif args.action == 'reload': elif args.action == 'reload':
reload_component(args.component) reload_component(args.component)
else: else:

14
tljh/configurer.py
View File

@@ -17,6 +17,7 @@ from .yaml import yaml
# Default configuration for tljh # Default configuration for tljh
# User provided config is merged into this # User provided config is merged into this
default = { default = {
'base_url': '/',
'auth': { 'auth': {
'type': 'firstuseauthenticator.FirstUseAuthenticator', 'type': 'firstuseauthenticator.FirstUseAuthenticator',
'FirstUseAuthenticator': { 'FirstUseAuthenticator': {
@@ -69,6 +70,7 @@ default = {
} }
} }
def load_config(config_file=CONFIG_FILE): def load_config(config_file=CONFIG_FILE):
"""Load the current config as a dictionary """Load the current config as a dictionary
@@ -92,6 +94,7 @@ def apply_config(config_overrides, c):
""" """
tljh_config = _merge_dictionaries(dict(default), config_overrides) tljh_config = _merge_dictionaries(dict(default), config_overrides)
update_base_url(c, tljh_config)
update_auth(c, tljh_config) update_auth(c, tljh_config)
update_userlists(c, tljh_config) update_userlists(c, tljh_config)
update_usergroups(c, tljh_config) update_usergroups(c, tljh_config)
@@ -115,7 +118,7 @@ def load_traefik_api_credentials():
proxy_secret_path = os.path.join(STATE_DIR, 'traefik-api.secret') proxy_secret_path = os.path.join(STATE_DIR, 'traefik-api.secret')
if not os.path.exists(proxy_secret_path): if not os.path.exists(proxy_secret_path):
return {} return {}
with open(proxy_secret_path,'r') as f: with open(proxy_secret_path, 'r') as f:
password = f.read() password = f.read()
return { return {
'traefik_api': { 'traefik_api': {
@@ -134,6 +137,13 @@ def load_secrets():
return config return config
def update_base_url(c, config):
"""
Update base_url of JupyterHub through tljh config
"""
c.JupyterHub.base_url = config['base_url']
def update_auth(c, config): def update_auth(c, config):
""" """
Set auth related configuration from YAML config file Set auth related configuration from YAML config file
@@ -218,7 +228,7 @@ def set_cull_idle_service(config):
Set Idle Culler service Set Idle Culler service
""" """
cull_cmd = [ cull_cmd = [
sys.executable, '-m', 'jupyterhub_idle_culler' sys.executable, '-m', 'jupyterhub_idle_culler'
] ]
cull_config = config['services']['cull'] cull_config = config['services']['cull']
print() print()