90 lines
3.1 KiB
Python
90 lines
3.1 KiB
Python
|
"""Testing utils for jupyter_client tests
|
||
|
|
|
||
|
|
"""
|
||
|
|
import os
|
||
|
|
pjoin = os.path.join
|
||
|
|
import sys
|
||
|
|
from unittest.mock import patch
|
||
|
|
|
||
|
|
import pytest
|
||
|
|
from jupyter_client import AsyncKernelManager
|
||
|
|
from ipython_genutils.tempdir import TemporaryDirectory
|
||
|
|
|
||
|
|
|
||
|
|
skip_win32 = pytest.mark.skipif(sys.platform.startswith('win'), reason="Windows")
|
||
|
|
|
||
|
|
|
||
|
|
class test_env(object):
|
||
|
|
"""Set Jupyter path variables to a temporary directory
|
||
|
|
|
||
|
|
Useful as a context manager or with explicit start/stop
|
||
|
|
"""
|
||
|
|
def start(self):
|
||
|
|
self.test_dir = td = TemporaryDirectory()
|
||
|
|
self.env_patch = patch.dict(os.environ, {
|
||
|
|
'JUPYTER_CONFIG_DIR': pjoin(td.name, 'jupyter'),
|
||
|
|
'JUPYTER_DATA_DIR': pjoin(td.name, 'jupyter_data'),
|
||
|
|
'JUPYTER_RUNTIME_DIR': pjoin(td.name, 'jupyter_runtime'),
|
||
|
|
'IPYTHONDIR': pjoin(td.name, 'ipython'),
|
||
|
|
'TEST_VARS': 'test_var_1',
|
||
|
|
})
|
||
|
|
self.env_patch.start()
|
||
|
|
|
||
|
|
def stop(self):
|
||
|
|
self.env_patch.stop()
|
||
|
|
self.test_dir.cleanup()
|
||
|
|
|
||
|
|
def __enter__(self):
|
||
|
|
self.start()
|
||
|
|
return self.test_dir.name
|
||
|
|
|
||
|
|
def __exit__(self, *exc_info):
|
||
|
|
self.stop()
|
||
|
|
|
||
|
|
def execute(code='', kc=None, **kwargs):
|
||
|
|
"""wrapper for doing common steps for validating an execution request"""
|
||
|
|
from .test_message_spec import validate_message
|
||
|
|
if kc is None:
|
||
|
|
kc = KC
|
||
|
|
msg_id = kc.execute(code=code, **kwargs)
|
||
|
|
reply = kc.get_shell_msg(timeout=TIMEOUT)
|
||
|
|
validate_message(reply, 'execute_reply', msg_id)
|
||
|
|
busy = kc.get_iopub_msg(timeout=TIMEOUT)
|
||
|
|
validate_message(busy, 'status', msg_id)
|
||
|
|
assert busy['content']['execution_state'] == 'busy'
|
||
|
|
|
||
|
|
if not kwargs.get('silent'):
|
||
|
|
execute_input = kc.get_iopub_msg(timeout=TIMEOUT)
|
||
|
|
validate_message(execute_input, 'execute_input', msg_id)
|
||
|
|
assert execute_input['content']['code'] == code
|
||
|
|
|
||
|
|
return msg_id, reply['content']
|
||
|
|
|
||
|
|
|
||
|
|
class AsyncKernelManagerSubclass(AsyncKernelManager):
|
||
|
|
"""Used to test deprecation "routes" that are determined by superclass' detection of methods.
|
||
|
|
|
||
|
|
This class represents a current subclass that overrides both cleanup() and cleanup_resources()
|
||
|
|
in order to be compatible with older jupyter_clients. We should find that cleanup_resources()
|
||
|
|
is called on these instances vix TestAsyncKernelManagerSubclass.
|
||
|
|
"""
|
||
|
|
|
||
|
|
def cleanup(self, connection_file=True):
|
||
|
|
super().cleanup(connection_file=connection_file)
|
||
|
|
self.which_cleanup = 'cleanup'
|
||
|
|
|
||
|
|
def cleanup_resources(self, restart=False):
|
||
|
|
super().cleanup_resources(restart=restart)
|
||
|
|
self.which_cleanup = 'cleanup_resources'
|
||
|
|
|
||
|
|
class AsyncKernelManagerWithCleanup(AsyncKernelManager):
|
||
|
|
"""Used to test deprecation "routes" that are determined by superclass' detection of methods.
|
||
|
|
|
||
|
|
This class represents the older subclass that overrides cleanup(). We should find that
|
||
|
|
cleanup() is called on these instances via TestAsyncKernelManagerWithCleanup.
|
||
|
|
"""
|
||
|
|
|
||
|
|
def cleanup(self, connection_file=True):
|
||
|
|
super().cleanup(connection_file=connection_file)
|
||
|
|
self.which_cleanup = 'cleanup'
|