Add more coverage (#877)

* Add more coverage

* debug

* more debug

* more debug

* disable stricthostchecking

* add windows cov and depug ssh

* more debug

* try verbose

* try ssh-add

* try ssh-agent

* try ssh-add too

* try with ssh agent

* add required arg

* use real fake key

* force a run

* try again

* try again

* try again

* run just the test

* try ssh-add too

* use check call

* try another way

* simplify

* lint

* undo change

* try the test up front

* more cleanup

* cleanup

* undo changes

* add more tests

* fixups

* fix failing test and add localinterfaces tests

* fix test

* add more client tests

* add a skip

* add windows cov

* add skips on windows

Author: blink1073

.github/workflows/main.yml

@@ -57,19 +57,19 @@ jobs:
       - name: Run the tests
         if: ${{ !startsWith(matrix.python-version, 'pypy') && !startsWith(matrix.os, 'windows') }}
         run: |
-          hatch run cov:test || hatch run test:test --lf
-      - name: Run the tests on pypy and windows
-        if: ${{ startsWith(matrix.python-version, 'pypy') || startsWith(matrix.os, 'windows') }}
+          hatch run cov:test --cov-fail-under 75 || hatch run test:test --lf
+      - name: Run the tests on pypy
+        if: ${{ startsWith(matrix.python-version, 'pypy') }}
         run: |
-          # Ignore warnings on Windows and PyPI
-          pip install -e ".[test]"
-          python -m pytest -vv -W ignore || python -m pytest -vv -W ignore --lf
-
+          hatch run test:test -W default || hatch run test:test -W default --lf
+      - name: Run the tests on windows
+        if: ${{ startsWith(matrix.os, 'windows') }}
+        run: |
+          hatch run cov:test -W default || hatch run test:test -W default --lf
       - name: Code coverage
         run: |
           pip install codecov
           codecov
-
   docs:
     runs-on: ubuntu-latest
     steps:
@@ -111,7 +111,6 @@ jobs:
       - name: Run the tests
         run: |
           pytest -vv -W default || pytest -vv -W default --lf
-
   make_sdist:
     name: Make SDist
     runs-on: ubuntu-latest

jupyter_client/consoleapp.py

@@ -361,7 +361,7 @@ def initialize(self, argv: object = None) -> None:
         Classes which mix this class in should call:
                JupyterConsoleApp.initialize(self,argv)
         """
-        if self._dispatching:  # type:ignore[attr-defined]
+        if getattr(self, "_dispatching", False):
             return
         self.init_connection_file()
         self.init_ssh()

jupyter_client/kernelspecapp.py

@@ -66,6 +66,7 @@ def path_key(item):
                 print(f"  {kernelname.ljust(name_len)}    {path}")
         else:
             print(json.dumps({"kernelspecs": specs}, indent=2))
+        return specs
 
 
 class InstallKernelSpec(JupyterApp):
@@ -228,7 +229,7 @@ class InstallNativeKernelSpec(JupyterApp):
     description = """[DEPRECATED] Install the IPython kernel spec directory for this Python."""
     kernel_spec_manager = Instance(KernelSpecManager)
 
-    def _kernel_spec_manager_default(self):
+    def _kernel_spec_manager_default(self):  # pragma: no cover
         return KernelSpecManager(data_dir=self.data_dir)
 
     user = Bool(
@@ -248,7 +249,7 @@ def _kernel_spec_manager_default(self):
         "debug": base_flags["debug"],
     }
 
-    def start(self):
+    def start(self):  # pragma: no cover
         self.log.warning(
             "`jupyter kernelspec install-self` is DEPRECATED as of 4.0."
             " You probably want `ipython kernel install` to install the IPython kernelspec."

jupyter_client/session.py

@@ -69,7 +69,7 @@
 def squash_unicode(obj):
     """coerce unicode back to bytestrings."""
     if isinstance(obj, dict):
-        for key in obj.keys():
+        for key in list(obj.keys()):
             obj[key] = squash_unicode(obj[key])
             if isinstance(key, str):
                 obj[squash_unicode(key)] = obj.pop(key)
@@ -184,7 +184,7 @@ def new_id_bytes() -> bytes:
 }
 
 
-def default_secure(cfg: t.Any) -> None:
+def default_secure(cfg: t.Any) -> None:  # pragma: no cover
     """Set the default behavior for a config environment to be secure.
 
     If Session.key/keyfile have not been set, set Session.key to
@@ -255,7 +255,7 @@ def __init__(self, msg_dict: t.Dict[str, t.Any]) -> None:
 
     # Having this iterator lets dict(msg_obj) work out of the box.
     def __iter__(self) -> t.ItemsView[str, t.Any]:
-        return self.__dict__.items()
+        return iter(self.__dict__.items())  # type:ignore[return-value]
 
     def __repr__(self) -> str:
         return repr(self.__dict__)
@@ -1086,7 +1086,7 @@ def deserialize(
         # adapt to the current version
         return adapt(message)
 
-    def unserialize(self, *args: t.Any, **kwargs: t.Any) -> t.Dict[str, t.Any]:
+    def unserialize(self, *args: t.Any, **kwargs: t.Any) -> t.Dict[str, t.Any]:  # pragma: no cover
         warnings.warn(
             "Session.unserialize is deprecated. Use Session.deserialize.",
             DeprecationWarning,

jupyter_client/ssh/tunnel.py

@@ -266,6 +266,7 @@ def openssh_tunnel(
         except pexpect.TIMEOUT:
             continue
         except pexpect.EOF as e:
+            tunnel.wait()
             if tunnel.exitstatus:
                 print(tunnel.exitstatus)
                 print(tunnel.before)

pyproject.toml

@@ -52,6 +52,7 @@ test = [
     "coverage",
     "ipykernel>=6.11",
     "mypy",
+    "paramiko; sys_platform == 'win32'",
     "pre-commit",
     "pytest",
     "pytest-asyncio>=0.19",
@@ -61,7 +62,7 @@ test = [
 docs = [
     "ipykernel",
     "myst-parser",
-    "sphinx>=1.3.6",
+    "sphinx>=4",
     "pydata_sphinx_theme",
     "sphinxcontrib_github_alt",
 ]
@@ -95,7 +96,7 @@ dependencies = ["coverage", "pytest-cov"]
 [tool.hatch.envs.cov.env-vars]
 ARGS = "-vv --cov jupyter_client --cov-branch --cov-report term-missing:skip-covered"
 [tool.hatch.envs.cov.scripts]
-test = "python -m pytest $ARGS --cov-fail-under 70 {args}"
+test = "python -m pytest $ARGS {args}"
 
 [tool.black]
 line-length = 100
@@ -135,6 +136,9 @@ exclude_lines = [
   "class .*\bProtocol\\):",
 "@(abc\\.)?abstractmethod",
 ]
+omit = [
+    "jupyter_client/ssh/forward.py"
+]
 
 [tool.mypy]
 check_untyped_defs = true

tests/conftest.py

@@ -1,6 +1,8 @@
 import asyncio
+import json
 import os
 import sys
+from pathlib import Path
 
 import pytest
 
@@ -64,3 +66,13 @@ def env():
 @pytest.fixture()
 def kernel_dir():
     return pjoin(paths.jupyter_data_dir(), 'kernels')
+
+
+@pytest.fixture
+def kernel_spec(tmpdir):
+    test_dir = Path(tmpdir / "test")
+    test_dir.mkdir()
+    kernel_data = {"argv": [], "display_name": "test", "language": "test"}
+    spec_file_path = Path(test_dir / "kernel.json")
+    spec_file_path.write_text(json.dumps(kernel_data), 'utf8')
+    return str(test_dir)

tests/test_client.py

@@ -2,7 +2,10 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
 import os
+import platform
+import sys
 from threading import Event
+from unittest import mock
 from unittest import TestCase
 
 import pytest
@@ -11,6 +14,7 @@
 from traitlets import Type
 
 from .utils import test_env
+from jupyter_client.client import validate_string_dict
 from jupyter_client.kernelspec import KernelSpecManager
 from jupyter_client.kernelspec import NATIVE_KERNEL_NAME
 from jupyter_client.kernelspec import NoSuchKernel
@@ -128,6 +132,29 @@ def _check_reply(self, reply_type, reply):
         assert reply["header"]["msg_type"] == reply_type + "_reply"
         assert reply["parent_header"]["msg_type"] == reply_type + "_request"
 
+    @pytest.mark.skipif(
+        sys.platform != 'linux' or platform.python_implementation().lower() == 'pypy',
+        reason='only works with cpython on ubuntu in ci',
+    )
+    async def test_input_request(self, kc):
+        with mock.patch('builtins.input', return_value='test\n'):
+            reply = await kc.execute_interactive("a = input()", timeout=TIMEOUT)
+        assert reply["content"]["status"] == "ok"
+
+    async def test_output_hook(self, kc):
+        called = False
+
+        def output_hook(msg):
+            nonlocal called
+            if msg['header']['msg_type'] == 'stream':
+                called = True
+
+        reply = await kc.execute_interactive(
+            "print('hello')", timeout=TIMEOUT, output_hook=output_hook
+        )
+        assert reply["content"]["status"] == "ok"
+        assert called
+
     async def test_history(self, kc):
         msg_id = await kc.history(session=0)
         assert isinstance(msg_id, str)
@@ -146,6 +173,12 @@ async def test_complete(self, kc):
         reply = await kc.complete("code", reply=True, timeout=TIMEOUT)
         self._check_reply("complete", reply)
 
+    async def test_is_complete(self, kc):
+        msg_id = await kc.is_complete("who cares")
+        assert isinstance(msg_id, str)
+        reply = await kc.is_complete("code", reply=True, timeout=TIMEOUT)
+        self._check_reply("is_complete", reply)
+
     async def test_kernel_info(self, kc):
         msg_id = await kc.kernel_info()
         assert isinstance(msg_id, str)
@@ -272,3 +305,10 @@ def test_shutdown_id(self):
         kc = self.kc
         msg_id = kc.shutdown()
         self.assertIsInstance(msg_id, str)
+
+
+def test_validate_string_dict():
+    with pytest.raises(ValueError):
+        validate_string_dict(dict(a=1))
+    with pytest.raises(ValueError):
+        validate_string_dict({1: 'a'})

tests/test_consoleapp.py

@@ -0,0 +1,41 @@
+"""Tests for the JupyterConsoleApp"""
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+import os
+
+import pytest
+from jupyter_core.application import JupyterApp
+
+from jupyter_client.consoleapp import JupyterConsoleApp
+from jupyter_client.manager import start_new_kernel
+
+
+class MockConsoleApp(JupyterConsoleApp, JupyterApp):
+    pass
+
+
+def test_console_app_no_existing():
+    app = MockConsoleApp()
+    app.initialize([])
+
+
+def test_console_app_existing(tmp_path):
+    km, kc = start_new_kernel()
+    cf = kc.connection_file
+    app = MockConsoleApp(connection_file=cf, existing=cf)
+    app.initialize([])
+    kc.stop_channels()
+    km.shutdown_kernel()
+
+
+def test_console_app_ssh(tmp_path):
+    km, kc = start_new_kernel()
+    cf = kc.connection_file
+    os.chdir(tmp_path)
+    app = MockConsoleApp(
+        connection_file=cf, existing=cf, sshserver="does_not_exist", sshkey="test_console_app"
+    )
+    with pytest.raises(SystemExit):
+        app.initialize([])
+    kc.stop_channels()
+    km.shutdown_kernel()

tests/test_kernelspecapp.py

@@ -0,0 +1,49 @@
+"""Tests for the kernelspecapp"""
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
+import os
+import warnings
+
+from jupyter_client.kernelspecapp import InstallKernelSpec
+from jupyter_client.kernelspecapp import KernelSpecApp
+from jupyter_client.kernelspecapp import ListKernelSpecs
+from jupyter_client.kernelspecapp import ListProvisioners
+from jupyter_client.kernelspecapp import RemoveKernelSpec
+
+
+def test_kernelspec_sub_apps(kernel_spec):
+    app = InstallKernelSpec()
+    prefix = os.path.dirname(os.environ['JUPYTER_DATA_DIR'])
+    kernel_dir = os.path.join(prefix, 'share/jupyter/kernels')
+    app.kernel_spec_manager.kernel_dirs.append(kernel_dir)
+    app.prefix = prefix = prefix
+    app.initialize([kernel_spec])
+    with warnings.catch_warnings():
+        warnings.simplefilter("ignore")
+        app.start()
+
+    app = ListKernelSpecs()
+    app.kernel_spec_manager.kernel_dirs.append(kernel_dir)
+    specs = app.start()
+    assert 'test' in specs
+
+    app = RemoveKernelSpec(spec_names=['test'], force=True)
+    app.kernel_spec_manager.kernel_dirs.append(kernel_dir)
+    app.start()
+
+    app = ListKernelSpecs()
+    app.kernel_spec_manager.kernel_dirs.append(kernel_dir)
+    specs = app.start()
+    assert 'test' not in specs
+
+
+def test_kernelspec_app():
+    app = KernelSpecApp()
+    app.initialize(["list"])
+    app.start()
+
+
+def test_list_provisioners_app():
+    app = ListProvisioners()
+    app.initialize([])
+    app.start()