Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Add Terminado tests #21

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Tests

on:
push:
branches: [ $default-branch ]
pull_request:
branches: [ $default-branch ]

jobs:
build:

runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.8]

steps:
- uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pytest
pip install -r dev-requirements.txt
- name: Test
run: |
pytest -v -s ./jupyterhub_ssh/tests
7 changes: 7 additions & 0 deletions dev-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
aiohttp
asyncssh
chartpress
notebook
pytest
pyyaml
pytest-asyncio
requests
websockets
yarl
Empty file.
45 changes: 45 additions & 0 deletions jupyterhub_ssh/tests/test_terminado.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
from aiohttp import ClientSession
import os
import pytest
from yarl import URL
import sys

from notebook.tests.launchnotebook import NotebookTestBase

from ..terminado import Terminado

# Mark all tests in this file as asyncio
pytestmark = pytest.mark.asyncio

@pytest.fixture
async def notebook():
# Start the notebook
notebook = NotebookTestBase()
notebook.setup_class()
notebook.wait_until_alive()
yield notebook
notebook.teardown_class()
Comment on lines +14 to +21
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see that jupyter_server seem to have an equivalent. I'm not sure if its relevant to transition to that or not though.

Related issue: elyra-ai/elyra#831 (comment)

Related fixture from jupyter_server: https://github.com/jupyter-server/jupyter_server/blob/7d2f04f30e06e6efed90072df19824d416cb7129/jupyter_server/pytest_plugin.py#L185-L210



async def test_terminado_client_auth(notebook):
# NotebookTestBase uses "/a%40b/" as a hub prefix, we have to make sure we don't escape that
notebook_url = URL(notebook.base_url(), encoded=True)

# Connect to the terminal with a dummy token
with pytest.raises(KeyError, match="name"):
async with ClientSession() as client, Terminado(notebook_url, "fake", client) as terminado_client:
assert terminado_client.terminal_name == "1"

# Connect to the terminal with the real token
async with ClientSession() as client, Terminado(notebook_url, notebook.token, client) as terminado_client:
assert terminado_client.terminal_name == "1"


async def test_terminado_stdin(notebook):
notebook_url = URL(notebook.base_url(), encoded=True)

# Connect to the terminal with the real token
async with ClientSession() as client, Terminado(notebook_url, notebook.token, client) as terminado_client:
cmd = f'touch {notebook.home_dir}/hello.txt\n'
await terminado_client.send_stdin(cmd)
print(os.listdir(notebook.home_dir))