mirror of
https://github.com/jupyterhub/jupyterhub.git
synced 2025-10-08 10:34:10 +00:00
395 lines
12 KiB
Python
395 lines
12 KiB
Python
"""Tests for HTML pages"""
|
|
|
|
from urllib.parse import urlencode, urlparse
|
|
|
|
from tornado import gen
|
|
|
|
from ..handlers import BaseHandler
|
|
from ..utils import url_path_join as ujoin
|
|
from .. import orm
|
|
from ..auth import Authenticator
|
|
|
|
import mock
|
|
import pytest
|
|
|
|
from .mocking import FormSpawner, public_url, public_host
|
|
from .test_api import api_request
|
|
from .utils import async_requests
|
|
|
|
def get_page(path, app, hub=True, **kw):
|
|
if hub:
|
|
prefix = app.hub.base_url
|
|
else:
|
|
prefix = app.base_url
|
|
base_url = ujoin(public_host(app), prefix)
|
|
return async_requests.get(ujoin(base_url, path), **kw)
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_root_no_auth(app):
|
|
url = ujoin(public_host(app), app.hub.base_url)
|
|
r = yield async_requests.get(url)
|
|
r.raise_for_status()
|
|
assert r.url == ujoin(url, 'login')
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_root_auth(app):
|
|
cookies = yield app.login_user('river')
|
|
r = yield async_requests.get(public_url(app), cookies=cookies)
|
|
r.raise_for_status()
|
|
assert r.url == public_url(app, app.users['river'])
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_root_redirect(app):
|
|
name = 'wash'
|
|
cookies = yield app.login_user(name)
|
|
next_url = ujoin(app.base_url, 'user/other/test.ipynb')
|
|
url = '/?' + urlencode({'next': next_url})
|
|
r = yield get_page(url, app, cookies=cookies)
|
|
r.raise_for_status()
|
|
path = urlparse(r.url).path
|
|
assert path == ujoin(app.base_url, 'user/%s/test.ipynb' % name)
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_home_no_auth(app):
|
|
r = yield get_page('home', app, allow_redirects=False)
|
|
r.raise_for_status()
|
|
assert r.status_code == 302
|
|
assert '/hub/login' in r.headers['Location']
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_home_auth(app):
|
|
cookies = yield app.login_user('river')
|
|
r = yield get_page('home', app, cookies=cookies)
|
|
r.raise_for_status()
|
|
assert r.url.endswith('home')
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_admin_no_auth(app):
|
|
r = yield get_page('admin', app)
|
|
assert r.status_code == 403
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_admin_not_admin(app):
|
|
cookies = yield app.login_user('wash')
|
|
r = yield get_page('admin', app, cookies=cookies)
|
|
assert r.status_code == 403
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_admin(app):
|
|
cookies = yield app.login_user('admin')
|
|
r = yield get_page('admin', app, cookies=cookies, allow_redirects=False)
|
|
r.raise_for_status()
|
|
assert r.url.endswith('/admin')
|
|
|
|
|
|
@pytest.mark.parametrize('sort', [
|
|
'running',
|
|
'last_activity',
|
|
'admin',
|
|
'name',
|
|
])
|
|
@pytest.mark.gen_test
|
|
def test_admin_sort(app, sort):
|
|
cookies = yield app.login_user('admin')
|
|
r = yield get_page('admin?sort=%s' % sort, app, cookies=cookies)
|
|
r.raise_for_status()
|
|
assert r.status_code == 200
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_spawn_redirect(app):
|
|
name = 'wash'
|
|
cookies = yield app.login_user(name)
|
|
u = app.users[orm.User.find(app.db, name)]
|
|
|
|
# ensure wash's server isn't running:
|
|
r = yield api_request(app, 'users', name, 'server', method='delete', cookies=cookies)
|
|
r.raise_for_status()
|
|
status = yield u.spawner.poll()
|
|
assert status is not None
|
|
|
|
# test spawn page when no server is running
|
|
r = yield get_page('spawn', app, cookies=cookies)
|
|
r.raise_for_status()
|
|
print(urlparse(r.url))
|
|
path = urlparse(r.url).path
|
|
assert path == ujoin(app.base_url, 'user/%s/' % name)
|
|
|
|
# should have started server
|
|
status = yield u.spawner.poll()
|
|
assert status is None
|
|
|
|
# test spawn page when server is already running (just redirect)
|
|
r = yield get_page('spawn', app, cookies=cookies)
|
|
r.raise_for_status()
|
|
print(urlparse(r.url))
|
|
path = urlparse(r.url).path
|
|
assert path == ujoin(app.base_url, '/user/%s/' % name)
|
|
|
|
# stop server to ensure /user/name is handled by the Hub
|
|
r = yield api_request(app, 'users', name, 'server', method='delete', cookies=cookies)
|
|
r.raise_for_status()
|
|
|
|
# test handing of trailing slash on `/user/name`
|
|
r = yield get_page('user/' + name, app, hub=False, cookies=cookies)
|
|
r.raise_for_status()
|
|
path = urlparse(r.url).path
|
|
assert path == ujoin(app.base_url, '/user/%s/' % name)
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_spawn_page(app):
|
|
with mock.patch.dict(app.users.settings, {'spawner_class': FormSpawner}):
|
|
cookies = yield app.login_user('jones')
|
|
r = yield get_page('spawn', app, cookies=cookies)
|
|
assert r.url.endswith('/spawn')
|
|
assert FormSpawner.options_form in r.text
|
|
|
|
r = yield get_page('spawn?next=foo', app, cookies=cookies)
|
|
assert r.url.endswith('/spawn?next=foo')
|
|
assert FormSpawner.options_form in r.text
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_spawn_form(app):
|
|
with mock.patch.dict(app.users.settings, {'spawner_class': FormSpawner}):
|
|
base_url = ujoin(public_host(app), app.hub.base_url)
|
|
cookies = yield app.login_user('jones')
|
|
orm_u = orm.User.find(app.db, 'jones')
|
|
u = app.users[orm_u]
|
|
yield u.stop()
|
|
|
|
r = yield async_requests.post(ujoin(base_url, 'spawn?next=/user/jones/tree'), cookies=cookies, data={
|
|
'bounds': ['-1', '1'],
|
|
'energy': '511keV',
|
|
})
|
|
r.raise_for_status()
|
|
assert r.history
|
|
print(u.spawner)
|
|
print(u.spawner.user_options)
|
|
assert u.spawner.user_options == {
|
|
'energy': '511keV',
|
|
'bounds': [-1, 1],
|
|
'notspecified': 5,
|
|
}
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_spawn_form_with_file(app):
|
|
with mock.patch.dict(app.users.settings, {'spawner_class': FormSpawner}):
|
|
base_url = ujoin(public_host(app), app.hub.base_url)
|
|
cookies = yield app.login_user('jones')
|
|
orm_u = orm.User.find(app.db, 'jones')
|
|
u = app.users[orm_u]
|
|
yield u.stop()
|
|
|
|
r = yield async_requests.post(ujoin(base_url, 'spawn'),
|
|
cookies=cookies,
|
|
data={
|
|
'bounds': ['-1', '1'],
|
|
'energy': '511keV',
|
|
},
|
|
files={'hello': ('hello.txt', b'hello world\n')}
|
|
)
|
|
r.raise_for_status()
|
|
assert u.spawner.user_options == {
|
|
'energy': '511keV',
|
|
'bounds': [-1, 1],
|
|
'notspecified': 5,
|
|
'hello': {'filename': 'hello.txt',
|
|
'body': b'hello world\n',
|
|
'content_type': 'application/unknown'},
|
|
}
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_user_redirect(app):
|
|
name = 'wash'
|
|
cookies = yield app.login_user(name)
|
|
|
|
r = yield get_page('/user-redirect/tree/top/', app)
|
|
r.raise_for_status()
|
|
print(urlparse(r.url))
|
|
path = urlparse(r.url).path
|
|
assert path == ujoin(app.base_url, '/hub/login')
|
|
query = urlparse(r.url).query
|
|
assert query == urlencode({
|
|
'next': ujoin(app.hub.base_url, '/user-redirect/tree/top/')
|
|
})
|
|
|
|
r = yield get_page('/user-redirect/notebooks/test.ipynb', app, cookies=cookies)
|
|
r.raise_for_status()
|
|
print(urlparse(r.url))
|
|
path = urlparse(r.url).path
|
|
assert path == ujoin(app.base_url, '/user/%s/notebooks/test.ipynb' % name)
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_user_redirect_deprecated(app):
|
|
"""redirecting from /user/someonelse/ URLs (deprecated)"""
|
|
name = 'wash'
|
|
cookies = yield app.login_user(name)
|
|
|
|
r = yield get_page('/user/baduser', app, cookies=cookies, hub=False)
|
|
r.raise_for_status()
|
|
print(urlparse(r.url))
|
|
path = urlparse(r.url).path
|
|
assert path == ujoin(app.base_url, '/user/%s/' % name)
|
|
|
|
r = yield get_page('/user/baduser/test.ipynb', app, cookies=cookies, hub=False)
|
|
r.raise_for_status()
|
|
print(urlparse(r.url))
|
|
path = urlparse(r.url).path
|
|
assert path == ujoin(app.base_url, '/user/%s/test.ipynb' % name)
|
|
|
|
r = yield get_page('/user/baduser/test.ipynb', app, hub=False)
|
|
r.raise_for_status()
|
|
print(urlparse(r.url))
|
|
path = urlparse(r.url).path
|
|
assert path == ujoin(app.base_url, '/hub/login')
|
|
query = urlparse(r.url).query
|
|
assert query == urlencode({
|
|
'next': ujoin(app.base_url, '/hub/user/baduser/test.ipynb')
|
|
})
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_login_fail(app):
|
|
name = 'wash'
|
|
base_url = public_url(app)
|
|
r = yield async_requests.post(base_url + 'hub/login',
|
|
data={
|
|
'username': name,
|
|
'password': 'wrong',
|
|
},
|
|
allow_redirects=False,
|
|
)
|
|
assert not r.cookies
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_login_strip(app):
|
|
"""Test that login form doesn't strip whitespace from passwords"""
|
|
form_data = {
|
|
'username': 'spiff',
|
|
'password': ' space man ',
|
|
}
|
|
base_url = public_url(app)
|
|
called_with = []
|
|
@gen.coroutine
|
|
def mock_authenticate(handler, data):
|
|
called_with.append(data)
|
|
|
|
with mock.patch.object(app.authenticator, 'authenticate', mock_authenticate):
|
|
yield async_requests.post(base_url + 'hub/login',
|
|
data=form_data,
|
|
allow_redirects=False,
|
|
)
|
|
|
|
assert called_with == [form_data]
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_login_redirect(app):
|
|
cookies = yield app.login_user('river')
|
|
user = app.users['river']
|
|
# no next_url, server running
|
|
yield user.spawn()
|
|
r = yield get_page('login', app, cookies=cookies, allow_redirects=False)
|
|
r.raise_for_status()
|
|
assert r.status_code == 302
|
|
assert '/user/river' in r.headers['Location']
|
|
|
|
# no next_url, server not running
|
|
yield user.stop()
|
|
r = yield get_page('login', app, cookies=cookies, allow_redirects=False)
|
|
r.raise_for_status()
|
|
assert r.status_code == 302
|
|
assert '/hub/' in r.headers['Location']
|
|
|
|
# next URL given, use it
|
|
r = yield get_page('login?next=/hub/admin', app, cookies=cookies, allow_redirects=False)
|
|
r.raise_for_status()
|
|
assert r.status_code == 302
|
|
assert r.headers['Location'].endswith('/hub/admin')
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_auto_login(app, request):
|
|
class DummyLoginHandler(BaseHandler):
|
|
def get(self):
|
|
self.write('ok!')
|
|
base_url = public_url(app) + '/'
|
|
app.tornado_application.add_handlers(".*$", [
|
|
(ujoin(app.hub.base_url, 'dummy'), DummyLoginHandler),
|
|
])
|
|
# no auto_login: end up at /hub/login
|
|
r = yield async_requests.get(base_url)
|
|
assert r.url == public_url(app, path='hub/login')
|
|
# enable auto_login: redirect from /hub/login to /hub/dummy
|
|
authenticator = Authenticator(auto_login=True)
|
|
authenticator.login_url = lambda base_url: ujoin(base_url, 'dummy')
|
|
|
|
with mock.patch.dict(app.tornado_application.settings, {
|
|
'authenticator': authenticator,
|
|
}):
|
|
r = yield async_requests.get(base_url)
|
|
assert r.url == public_url(app, path='hub/dummy')
|
|
|
|
@pytest.mark.gen_test
|
|
def test_auto_login_logout(app):
|
|
name = 'burnham'
|
|
cookies = yield app.login_user(name)
|
|
|
|
with mock.patch.dict(app.tornado_application.settings, {
|
|
'authenticator': Authenticator(auto_login=True),
|
|
}):
|
|
r = yield async_requests.get(public_host(app) + app.tornado_settings['logout_url'], cookies=cookies)
|
|
r.raise_for_status()
|
|
logout_url = public_host(app) + app.tornado_settings['logout_url']
|
|
assert r.url == logout_url
|
|
assert r.cookies == {}
|
|
|
|
@pytest.mark.gen_test
|
|
def test_logout(app):
|
|
name = 'wash'
|
|
cookies = yield app.login_user(name)
|
|
r = yield async_requests.get(public_host(app) + app.tornado_settings['logout_url'], cookies=cookies)
|
|
r.raise_for_status()
|
|
login_url = public_host(app) + app.tornado_settings['login_url']
|
|
assert r.url == login_url
|
|
assert r.cookies == {}
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_login_no_whitelist_adds_user(app):
|
|
auth = app.authenticator
|
|
mock_add_user = mock.Mock()
|
|
with mock.patch.object(auth, 'add_user', mock_add_user):
|
|
cookies = yield app.login_user('jubal')
|
|
|
|
user = app.users['jubal']
|
|
assert mock_add_user.mock_calls == [mock.call(user)]
|
|
|
|
|
|
@pytest.mark.gen_test
|
|
def test_static_files(app):
|
|
base_url = ujoin(public_host(app), app.hub.base_url)
|
|
r = yield async_requests.get(ujoin(base_url, 'logo'))
|
|
r.raise_for_status()
|
|
assert r.headers['content-type'] == 'image/png'
|
|
r = yield async_requests.get(ujoin(base_url, 'static', 'images', 'jupyter.png'))
|
|
r.raise_for_status()
|
|
assert r.headers['content-type'] == 'image/png'
|
|
r = yield async_requests.get(ujoin(base_url, 'static', 'css', 'style.min.css'))
|
|
r.raise_for_status()
|
|
assert r.headers['content-type'] == 'text/css'
|