Skip to content

Commit

Permalink
refactor: extract a separate test_hub.py file from test_spawn.py
Browse files Browse the repository at this point in the history
  • Loading branch information
@consideRatio
consideRatio committed Feb 20, 2021
1 parent 4ad1b19 commit 95408de
Show file tree
Hide file tree
Showing 3 changed files with 191 additions and 173 deletions.
20 changes: 20 additions & 0 deletions tests/conftest.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@

import os
import requests
import textwrap
import uuid

from urllib.parse import urlparse

import pytest
Expand Down Expand Up @@ -121,3 +123,21 @@ def jupyter_user(api_request):
yield username
r = api_request.delete("/users/" + username)
assert r.status_code == 204


@pytest.fixture(scope="module")
def extra_files_test_command():
return textwrap.dedent(
"""
ls -l /tmp/binaryData.txt | grep -- -rw-rw-rw- || exit 1
ls -l /tmp/dir1/binaryData.txt | grep -- -rw-rw-rw- || exit 2
ls -l /tmp/stringData.txt | grep -- -rw-rw-rw- || exit 3
ls -l /tmp/dir1/stringData.txt | grep -- -rw-rw-rw- || exit 4
ls -l /etc/test/data.yaml | grep -- -r--r--r-- || exit 5
ls -l /etc/test/data.yml | grep -- -r--r--r-- || exit 6
ls -l /etc/test/data.json | grep -- -r--r--r-- || exit 7
ls -l /etc/test/data.toml | grep -- -r--r--r-- || exit 8
cat /tmp/binaryData.txt | grep -- "hello world" || exit 9
cat /tmp/stringData.txt | grep -- "hello world" || exit 10
"""
).strip()
163 changes: 163 additions & 0 deletions tests/test_hub.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
"""
These tests commonl use JupyterHub's REST API:
http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyterhub/jupyterhub/master/docs/rest-api.yml
"""

import os
import subprocess
import time

import requests
import yaml


def test_api(api_request):
"""
Tests the hub api's root endpoint (/). The hub's version should be returned.
A typical jupyterhub logging response to this test:
[I 2019-09-25 12:03:12.051 JupyterHub log:174] 200 GET /hub/api (test@127.0.0.1) 9.57ms
"""

# load app version of chart
here = os.path.dirname(os.path.abspath(__file__))
chart_yaml = os.path.join(here, os.pardir, "jupyterhub", "Chart.yaml")

with open(chart_yaml) as f:
chart = yaml.safe_load(f)
jupyterhub_version = chart["appVersion"]

print("asking for the hub's version")
r = api_request.get("")
assert r.status_code == 200
assert r.json().get("version", "version-missing") == jupyterhub_version


def test_api_info(api_request):
"""
Tests the hub api's /info endpoint. Information about the hub should be
returned.
A typical jupyterhub logging response to this test:
[I 2019-09-25 12:03:12.086 JupyterHub log:174] 200 GET /hub/api/info (test@127.0.0.1) 10.21ms
"""

print("asking for the hub information")
r = api_request.get("/info")
assert r.status_code == 200
result = r.json()
assert result["spawner"]["class"] == "kubespawner.spawner.KubeSpawner"


def test_hub_api_create_user_and_get_information_about_user(api_request, jupyter_user):
"""
Tests the hub api's /users/:user endpoint, both POST and GET.
A jupyter user is created and commited to the hub database through the
jupyter_user pytest fixture declared in conftest.py. Due to this, this first
test to use the jupyter_user fixture is actually testing both the pytest
fixture that creates the user as well as the ability to get information from
the hub about the user. The jupyter_user fixture will automatically clean up
the user from the hub's database when this function exits.
A typical jupyterhub logging response to this test:
[I 2019-09-25 12:03:12.126 JupyterHub log:174] 201 POST /hub/api/users/testuser-7c70eb90-035b-4d9f-92a5-482e441e307d (test@127.0.0.1) 20.74ms
[I 2019-09-25 12:03:12.153 JupyterHub log:174] 200 GET /hub/api/users/testuser-7c70eb90-035b-4d9f-92a5-482e441e307d (test@127.0.0.1) 11.91ms
[D 2019-09-25 12:03:12.180 JupyterHub user:240] Creating <class 'kubespawner.spawner.KubeSpawner'> for testuser-7c70eb90-035b-4d9f-92a5-482e441e307d:
[I 2019-09-25 12:03:12.204 JupyterHub reflector:199] watching for pods with label selector='component=singleuser-server' in namespace jh-dev
[D 2019-09-25 12:03:12.205 JupyterHub reflector:202] Connecting pods watcher
[I 2019-09-25 12:03:12.229 JupyterHub reflector:199] watching for events with field selector='involvedObject.kind=Pod' in namespace jh-dev
[D 2019-09-25 12:03:12.229 JupyterHub reflector:202] Connecting events watcher
[I 2019-09-25 12:03:12.269 JupyterHub log:174] 204 DELETE /hub/api/users/testuser-7c70eb90-035b-4d9f-92a5-482e441e307d (test@127.0.0.1) 98.85ms
"""
print("create a user, and get information about the user")
r = api_request.get("/users/" + jupyter_user)
assert r.status_code == 200
assert r.json()["name"] == jupyter_user


def test_hub_api_list_users(api_request, jupyter_user):
"""
Tests the hub api's /users endpoint. Information about users should be
returned.
A typical jupyterhub logging response to this test:
[I 2019-09-25 12:03:12.303 JupyterHub log:174] 201 POST /hub/api/users/testuser-0d2b0fc9-5ac4-4d8c-8d25-c4545665f81f (test@127.0.0.1) 15.53ms
[I 2019-09-25 12:03:12.331 JupyterHub log:174] 200 GET /hub/api/users (test@127.0.0.1) 10.83ms
[D 2019-09-25 12:03:12.358 JupyterHub user:240] Creating <class 'kubespawner.spawner.KubeSpawner'> for testuser-0d2b0fc9-5ac4-4d8c-8d25-c4545665f81f:
[I 2019-09-25 12:03:12.365 JupyterHub log:174] 204 DELETE /hub/api/users/testuser-0d2b0fc9-5ac4-4d8c-8d25-c4545665f81f (test@127.0.0.1) 18.44ms
"""

print("create a test user, get information about all users, and find the test user")
r = api_request.get("/users")
assert r.status_code == 200
assert any(u["name"] == jupyter_user for u in r.json())


def test_hub_can_talk_to_proxy(api_request, request_data):
"""
Tests the hub api's /proxy endpoint.
A typical jupyterhub logging response to this test:
[I 2019-09-25 12:03:12.395 JupyterHub log:174] 200 GET /hub/api/proxy (test@127.0.0.1) 13.48ms
"""

endtime = time.time() + request_data["test_timeout"]
while time.time() < endtime:
try:
r = api_request.get("/proxy")
if r.status_code == 200:
break
print(r.json())
except requests.RequestException as e:
print(e)
time.sleep(1)
assert r.status_code == 200, "Failed to get /proxy"


def test_hub_mounted_extra_files(extra_files_test_command):
"""
Tests the hub.extraFiles configuration. It should have mounted files to the
hub pod's container with specific file system permissions.
"""
c = subprocess.run(
[
"kubectl",
"exec",
"deploy/hub",
"--",
"sh",
"-c",
extra_files_test_command,
]
)
assert (
c.returncode == 0
), f"The hub.extraFiles configuration doesn't seem to have been honored!"


def test_hub_etc_jupyterhub_d_folder():
"""
Tests that the extra jupyterhub config file put into
/usr/local/etc/jupyterhub/jupyterhub_config.d by the hub.extraFiles
configuration was loaded.
"""
c = subprocess.run(
[
"kubectl",
"exec",
"deploy/hub",
"--",
"sh",
"-c",
"cat /tmp/created-by-extra-files-config.txt | grep -- 'hello world' || exit 1",
]
)
assert (
c.returncode == 0
), f"The hub.extraFiles configuration should have mounted a config file to /usr/local/etc/jupyterhub/jupyterhub_config.d which should have been loaded to write a dummy file for us!"
181 changes: 8 additions & 173 deletions tests/test_spawn.py
View file
Original file line number Diff line number Diff line change
@@ -1,186 +1,21 @@
import os
import subprocess
import time

import pytest
import requests
import yaml

# Makes heavy use of JupyterHub's API:
# http://petstore.swagger.io/?url=https://raw.githubusercontent.com/jupyterhub/jupyterhub/master/docs/rest-api.yml

# load app version of chart
here = os.path.dirname(os.path.abspath(__file__))
chart_yaml = os.path.join(here, os.pardir, "jupyterhub", "Chart.yaml")

extra_files_test = """
ls -l /tmp/binaryData.txt | grep -- -rw-rw-rw- || exit 1
ls -l /tmp/dir1/binaryData.txt | grep -- -rw-rw-rw- || exit 2
ls -l /tmp/stringData.txt | grep -- -rw-rw-rw- || exit 3
ls -l /tmp/dir1/stringData.txt | grep -- -rw-rw-rw- || exit 4
ls -l /etc/test/data.yaml | grep -- -r--r--r-- || exit 5
ls -l /etc/test/data.yml | grep -- -r--r--r-- || exit 6
ls -l /etc/test/data.json | grep -- -r--r--r-- || exit 7
ls -l /etc/test/data.toml | grep -- -r--r--r-- || exit 8
cat /tmp/binaryData.txt | grep -- "hello world" || exit 9
cat /tmp/stringData.txt | grep -- "hello world" || exit 10
"""

with open(chart_yaml) as f:
chart = yaml.safe_load(f)
jupyterhub_version = chart["appVersion"]


def test_api(api_request):
"""
Tests the hub api's root endpoint (/). The hub's version should be returned.
A typical jupyterhub logging response to this test:
[I 2019-09-25 12:03:12.051 JupyterHub log:174] 200 GET /hub/api (test@127.0.0.1) 9.57ms
"""

print("asking for the hub's version")
r = api_request.get("")
assert r.status_code == 200
assert r.json().get("version", "version-missing") == jupyterhub_version


def test_api_info(api_request):
"""
Tests the hub api's /info endpoint. Information about the hub should be
returned.
A typical jupyterhub logging response to this test:
[I 2019-09-25 12:03:12.086 JupyterHub log:174] 200 GET /hub/api/info (test@127.0.0.1) 10.21ms
"""

print("asking for the hub information")
r = api_request.get("/info")
assert r.status_code == 200
result = r.json()
assert result["spawner"]["class"] == "kubespawner.spawner.KubeSpawner"


def test_hub_api_create_user_and_get_information_about_user(api_request, jupyter_user):
"""
Tests the hub api's /users/:user endpoint, both POST and GET.
A jupyter user is created and commited to the hub database through the
jupyter_user pytest fixture declared in conftest.py. Due to this, this first
test to use the jupyter_user fixture is actually testing both the pytest
fixture that creates the user as well as the ability to get information from
the hub about the user. The jupyter_user fixture will automatically clean up
the user from the hub's database when this function exits.
A typical jupyterhub logging response to this test:
[I 2019-09-25 12:03:12.126 JupyterHub log:174] 201 POST /hub/api/users/testuser-7c70eb90-035b-4d9f-92a5-482e441e307d (test@127.0.0.1) 20.74ms
[I 2019-09-25 12:03:12.153 JupyterHub log:174] 200 GET /hub/api/users/testuser-7c70eb90-035b-4d9f-92a5-482e441e307d (test@127.0.0.1) 11.91ms
[D 2019-09-25 12:03:12.180 JupyterHub user:240] Creating <class 'kubespawner.spawner.KubeSpawner'> for testuser-7c70eb90-035b-4d9f-92a5-482e441e307d:
[I 2019-09-25 12:03:12.204 JupyterHub reflector:199] watching for pods with label selector='component=singleuser-server' in namespace jh-dev
[D 2019-09-25 12:03:12.205 JupyterHub reflector:202] Connecting pods watcher
[I 2019-09-25 12:03:12.229 JupyterHub reflector:199] watching for events with field selector='involvedObject.kind=Pod' in namespace jh-dev
[D 2019-09-25 12:03:12.229 JupyterHub reflector:202] Connecting events watcher
[I 2019-09-25 12:03:12.269 JupyterHub log:174] 204 DELETE /hub/api/users/testuser-7c70eb90-035b-4d9f-92a5-482e441e307d (test@127.0.0.1) 98.85ms
"""
print("create a user, and get information about the user")
r = api_request.get("/users/" + jupyter_user)
assert r.status_code == 200
assert r.json()["name"] == jupyter_user


def test_hub_api_list_users(api_request, jupyter_user):
"""
Tests the hub api's /users endpoint. Information about users should be
returned.
A typical jupyterhub logging response to this test:
[I 2019-09-25 12:03:12.303 JupyterHub log:174] 201 POST /hub/api/users/testuser-0d2b0fc9-5ac4-4d8c-8d25-c4545665f81f (test@127.0.0.1) 15.53ms
[I 2019-09-25 12:03:12.331 JupyterHub log:174] 200 GET /hub/api/users (test@127.0.0.1) 10.83ms
[D 2019-09-25 12:03:12.358 JupyterHub user:240] Creating <class 'kubespawner.spawner.KubeSpawner'> for testuser-0d2b0fc9-5ac4-4d8c-8d25-c4545665f81f:
[I 2019-09-25 12:03:12.365 JupyterHub log:174] 204 DELETE /hub/api/users/testuser-0d2b0fc9-5ac4-4d8c-8d25-c4545665f81f (test@127.0.0.1) 18.44ms
"""

print("create a test user, get information about all users, and find the test user")
r = api_request.get("/users")
assert r.status_code == 200
assert any(u["name"] == jupyter_user for u in r.json())


def test_hub_can_talk_to_proxy(api_request, request_data):
"""
Tests the hub api's /proxy endpoint.
A typical jupyterhub logging response to this test:
[I 2019-09-25 12:03:12.395 JupyterHub log:174] 200 GET /hub/api/proxy (test@127.0.0.1) 13.48ms
"""

endtime = time.time() + request_data["test_timeout"]
while time.time() < endtime:
try:
r = api_request.get("/proxy")
if r.status_code == 200:
break
print(r.json())
except requests.RequestException as e:
print(e)
time.sleep(1)
assert r.status_code == 200, "Failed to get /proxy"


def test_hub_mounted_extra_files():
"""
Tests the hub.extraFiles configuration. It should have mounted files to the
hub pod's container with specific file system permissions.
"""
c = subprocess.run(
[
"kubectl",
"exec",
"deploy/hub",
"--",
"sh",
"-c",
extra_files_test,
]
)
assert (
c.returncode == 0
), f"The hub.extraFiles configuration doesn't seem to have been honored!"


def test_hub_etc_jupyterhub_d_folder():
"""
Tests that the extra jupyterhub config file put into
/usr/local/etc/jupyterhub/jupyterhub_config.d by the hub.extraFiles
configuration was loaded.
"""
c = subprocess.run(
[
"kubectl",
"exec",
"deploy/hub",
"--",
"sh",
"-c",
"cat /tmp/created-by-extra-files-config.txt | grep -- 'hello world' || exit 1",
]
)
assert (
c.returncode == 0
), f"The hub.extraFiles configuration should have mounted a config file to /usr/local/etc/jupyterhub/jupyterhub_config.d which should have been loaded to write a dummy file for us!"


def test_hub_api_request_user_spawn(
api_request, jupyter_user, request_data, pebble_acme_ca_cert
api_request,
jupyter_user,
request_data,
pebble_acme_ca_cert,
extra_files_test_command,
):
"""
Tests the hub api's /users/:user/server POST endpoint. A user pod should be
created with environment variables defined in singleuser.extraEnv etc.
created with environment variables defined in singleuser.extraEnv,
singleuser.extraFiles should be mounted, etc.
"""

print("asking kubespawner to spawn a server for a test user")
Expand Down Expand Up @@ -227,7 +62,7 @@ def test_hub_api_request_user_spawn(
"--",
"sh",
"-c",
extra_files_test,
extra_files_test_command,
]
)
assert (
Expand Down

0 comments on commit 95408de

Please sign in to comment.