Add culling test

Author: kevin-bates

jupyter_server/terminal/__init__.py

@@ -8,7 +8,6 @@
     raise ImportError("terminado >= 0.8.3 required, found %s" % terminado.__version__)
 
 from ipython_genutils.py3compat import which
-from tornado.log import app_log
 from jupyter_server.utils import url_path_join as ujoin
 from . import api_handlers
 from .handlers import TerminalHandler, TermSocket

jupyter_server/terminal/api_handlers.py

@@ -3,7 +3,6 @@
 from ..base.handlers import APIHandler
 
 
-
 class TerminalRootHandler(APIHandler):
 
     @web.authenticated

jupyter_server/tests/test_terminal.py

@@ -5,6 +5,9 @@
 import asyncio
 import sys
 
+from tornado.httpclient import HTTPClientError
+from traitlets.config import Config
+
 # Skip this whole module on Windows. The terminal API leads
 # to timeouts on Windows CI.
 if sys.platform.startswith('win'):
@@ -30,12 +33,42 @@ def terminal_path(tmp_path):
     shutil.rmtree(str(subdir), ignore_errors=True)
 
 
+CULL_TIMEOUT = 2
+CULL_INTERVAL = 3
+
+
+@pytest.fixture
+def jp_server_config():
+    return Config({
+        'ServerApp': {
+            'TerminalManager': {
+                'cull_inactive_timeout': CULL_TIMEOUT,
+                'cull_interval': CULL_INTERVAL
+            }
+        }
+    })
+
+
+async def test_no_terminals(jp_fetch):
+    resp_list = await jp_fetch(
+        'api', 'terminals',
+        method='GET',
+        allow_nonstandard_methods=True,
+    )
+
+    data = json.loads(resp_list.body.decode())
+
+    assert len(data) == 0
+
+
 async def test_terminal_create(jp_fetch, kill_all):
-    await jp_fetch(
+    resp = await jp_fetch(
         'api', 'terminals',
         method='POST',
         allow_nonstandard_methods=True,
     )
+    term = json.loads(resp.body.decode())
+    assert term['name'] == "1"
 
     resp_list = await jp_fetch(
         'api', 'terminals',
@@ -46,6 +79,7 @@ async def test_terminal_create(jp_fetch, kill_all):
     data = json.loads(resp_list.body.decode())
 
     assert len(data) == 1
+    assert data[0] == term
     await kill_all()
 
 
@@ -104,3 +138,41 @@ async def test_terminal_create_with_cwd(jp_fetch, jp_ws_fetch, terminal_path):
     ws.close()
 
     assert str(terminal_path) in message_stdout
+
+
+async def test_culling_config(jp_server_config, jp_configurable_serverapp):
+    terminal_mgr_config = jp_configurable_serverapp().config.ServerApp.TerminalManager
+    assert terminal_mgr_config.cull_inactive_timeout == CULL_TIMEOUT
+    assert terminal_mgr_config.cull_interval == CULL_INTERVAL
+    terminal_mgr_settings = jp_configurable_serverapp().web_app.settings['terminal_manager']
+    assert terminal_mgr_settings.cull_inactive_timeout == CULL_TIMEOUT
+    assert terminal_mgr_settings.cull_interval == CULL_INTERVAL
+
+
+async def test_culling(jp_server_config, jp_fetch):
+    # POST request
+    resp = await jp_fetch(
+        'api', 'terminals',
+        method='POST',
+        allow_nonstandard_methods=True,
+    )
+    term = json.loads(resp.body.decode())
+    term_1 = term['name']
+    last_activity = term['last_activity']
+
+    culled = False
+    for i in range(10):  # Culling should occur in a few seconds
+        try:
+            resp = await jp_fetch(
+                'api', 'terminals', term_1,
+                method='GET',
+                allow_nonstandard_methods=True,
+            )
+        except HTTPClientError as e:
+            assert e.code == 404
+            culled = True
+            break
+        else:
+            await asyncio.sleep(1)
+
+    assert culled