\d+)
52 | (?P((a|b|rc)\d+)|)
53 | \.?
54 | (?P(?<=\.)dev\d*|)
55 | '''
56 |
57 | [tool.tbump.git]
58 | message_template = "Bump to {new_version}"
59 | tag_template = "v{new_version}"
60 |
61 | [[tool.tbump.file]]
62 | src = "setup.py"
63 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | import os
2 | from subprocess import check_call
3 |
4 | from setuptools import find_packages, setup
5 | from setuptools.command.build_py import build_py
6 | from setuptools.command.sdist import sdist
7 |
8 | HERE = os.path.dirname(__file__)
9 |
10 |
11 | def webpacked_command(command):
12 | """
13 | Return a command that inherits from command, but adds webpack JS building
14 | """
15 |
16 | class WebPackedCommand(command):
17 | """
18 | Run npm webpack to generate appropriate output files before given command.
19 |
20 | This generates all the js & css we need, and that is included via an
21 | entry in MANIFEST.in
22 | """
23 |
24 | description = "build frontend files with webpack"
25 |
26 | def run(self):
27 | """
28 | Call npm install & npm run webpack before packaging
29 | """
30 | check_call(
31 | ["npm", "install", "--progress=false", "--unsafe-perm"],
32 | cwd=HERE,
33 | )
34 |
35 | check_call(["npm", "run", "webpack"], cwd=HERE)
36 |
37 | return super().run()
38 |
39 | return WebPackedCommand
40 |
41 |
42 | with open("README.md") as f:
43 | readme = f.read()
44 |
45 |
46 | setup(
47 | name="jupyter-remote-desktop-proxy",
48 | packages=find_packages(),
49 | version='3.0.2.dev',
50 | author="Jupyter Development Team",
51 | author_email="jupyter@googlegroups.com",
52 | classifiers=[
53 | "Intended Audience :: Developers",
54 | "Intended Audience :: System Administrators",
55 | "Intended Audience :: Science/Research",
56 | "License :: OSI Approved :: BSD License",
57 | "Programming Language :: Python",
58 | "Programming Language :: Python :: 3",
59 | ],
60 | description="Run a desktop environments on Jupyter",
61 | entry_points={
62 | 'jupyter_serverproxy_servers': [
63 | 'desktop-websockify = jupyter_remote_desktop_proxy.setup_websockify:setup_websockify',
64 | ]
65 | },
66 | install_requires=[
67 | 'jupyter-server-proxy>=4.3.0',
68 | ],
69 | include_package_data=True,
70 | keywords=["Interactive", "Desktop", "Jupyter"],
71 | license="BSD",
72 | long_description=readme,
73 | long_description_content_type="text/markdown",
74 | platforms="Linux",
75 | project_urls={
76 | "Source": "https://github.com/jupyterhub/jupyter-remote-desktop-proxy/",
77 | "Tracker": "https://github.com/jupyterhub/jupyter-remote-desktop-proxy/issues",
78 | },
79 | python_requires=">=3.8",
80 | url="https://jupyter.org",
81 | zip_safe=False,
82 | cmdclass={
83 | # Handles making sdists and wheels
84 | "sdist": webpacked_command(sdist),
85 | # Handles `pip install` directly
86 | "build_py": webpacked_command(build_py),
87 | },
88 | data_files=[
89 | (
90 | 'etc/jupyter/jupyter_server_config.d',
91 | [
92 | 'jupyter-config/jupyter_server_config.d/jupyter_remote_desktop_proxy.json'
93 | ],
94 | ),
95 | (
96 | 'etc/jupyter/jupyter_notebook_config.d',
97 | [
98 | 'jupyter-config/jupyter_notebook_config.d/jupyter_remote_desktop_proxy.json'
99 | ],
100 | ),
101 | ],
102 | )
103 |
--------------------------------------------------------------------------------
/tests/conftest.py:
--------------------------------------------------------------------------------
1 | from os import getenv
2 |
3 | import pytest
4 | from playwright.sync_api import sync_playwright
5 |
6 | HEADLESS = getenv("HEADLESS", "1") == "1"
7 |
8 |
9 | @pytest.fixture()
10 | def browser():
11 | # browser_type in ["chromium", "firefox", "webkit"]
12 | with sync_playwright() as playwright:
13 | browser = playwright.firefox.launch(headless=HEADLESS)
14 | context = browser.new_context()
15 | page = context.new_page()
16 | yield page
17 | context.clear_cookies()
18 | browser.close()
19 |
--------------------------------------------------------------------------------
/tests/reference/desktop-turbovnc.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jupyterhub/jupyter-remote-desktop-proxy/7971fa44153c6fe4e58fc8ba436c327df611ac03/tests/reference/desktop-turbovnc.png
--------------------------------------------------------------------------------
/tests/reference/desktop.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/jupyterhub/jupyter-remote-desktop-proxy/7971fa44153c6fe4e58fc8ba436c327df611ac03/tests/reference/desktop.png
--------------------------------------------------------------------------------
/tests/test_browser.py:
--------------------------------------------------------------------------------
1 | from os import getenv
2 | from pathlib import Path
3 | from shutil import which
4 | from subprocess import check_output
5 | from uuid import uuid4
6 |
7 | from PIL import Image, ImageChops
8 | from playwright.sync_api import expect
9 |
10 | HERE = Path(__file__).absolute().parent
11 |
12 | CONTAINER_ID = getenv("CONTAINER_ID", "test")
13 | JUPYTER_HOST = getenv("JUPYTER_HOST", "http://localhost:8888")
14 | JUPYTER_TOKEN = getenv("JUPYTER_TOKEN", "secret")
15 | VNCSERVER = getenv("VNCSERVER")
16 |
17 |
18 | def compare_screenshot(test_image):
19 | # Compare images by calculating the mean absolute difference
20 | # Images must be the same size
21 | # threshold: Average difference per pixel, this depends on the image type
22 | # e.g. for 24 bit images (8 bit RGB pixels) threshold=1 means a maximum
23 | # difference of 1 bit per pixel per channel
24 | reference = Image.open(HERE / "reference" / "desktop.png")
25 | threshold = 2
26 | if VNCSERVER == "turbovnc":
27 | reference = Image.open(HERE / "reference" / "desktop-turbovnc.png")
28 | # The TurboVNC screenshot varies a lot more than TigerVNC
29 | threshold = 6
30 | test = Image.open(test_image)
31 |
32 | # Absolute difference
33 | # Convert to RGB, alpha channel breaks ImageChops
34 | diff = ImageChops.difference(reference.convert("RGB"), test.convert("RGB"))
35 | diff_data = diff.getdata()
36 |
37 | m = sum(sum(px) for px in diff_data) / diff_data.size[0] / diff_data.size[1]
38 | assert m < threshold
39 |
40 |
41 | # To debug this set environment variable HEADLESS=0
42 | def test_desktop(browser):
43 | page = browser
44 | page.goto(f"{JUPYTER_HOST}/lab?token={JUPYTER_TOKEN}")
45 | page.wait_for_url(f"{JUPYTER_HOST}/lab")
46 |
47 | # JupyterLab extension icon
48 | expect(page.get_by_text("Desktop [↗]")).to_be_visible()
49 | with page.expect_popup() as page1_info:
50 | page.get_by_text("Desktop [↗]").click()
51 | page1 = page1_info.value
52 | page1.wait_for_url(f"{JUPYTER_HOST}/desktop/")
53 |
54 | expect(page1.get_by_text("Status: Connected")).to_be_visible()
55 | expect(page1.locator("canvas")).to_be_visible()
56 |
57 | # Screenshot the desktop element only
58 | # May take a few seconds to load
59 | page1.wait_for_timeout(5000)
60 | # Use a non temporary folder so we can check it manually if necessary
61 | screenshot = Path("screenshots") / "desktop.png"
62 | page1.locator("body").screenshot(path=screenshot)
63 |
64 | # Open clipboard, enter random text, close clipboard
65 | clipboard_text = str(uuid4())
66 | page1.get_by_role("link", name="Remote Clipboard").click()
67 | expect(page1.locator("#clipboard-text")).to_be_visible()
68 | page1.locator("#clipboard-text").click()
69 | page1.locator("#clipboard-text").fill(clipboard_text)
70 | # Click outside clipboard, it should be closed
71 | page1.locator("canvas").click(position={"x": 969, "y": 273})
72 | expect(page1.locator("#clipboard-text")).not_to_be_visible()
73 |
74 | # Exec into container to check clipboard contents
75 | for engine in ["docker", "podman"]:
76 | if which(engine):
77 | break
78 | else:
79 | raise RuntimeError("Container engine not found")
80 | clipboard = check_output(
81 | [engine, "exec", "-eDISPLAY=:1", CONTAINER_ID, "xclip", "-o"]
82 | )
83 | assert clipboard.decode() == clipboard_text
84 |
85 | compare_screenshot(screenshot)
86 |
--------------------------------------------------------------------------------
/webpack.config.js:
--------------------------------------------------------------------------------
1 | const webpack = require("webpack");
2 | const MiniCssExtractPlugin = require("mini-css-extract-plugin");
3 | const path = require("path");
4 |
5 | module.exports = {
6 | entry: path.resolve(__dirname, "js/index.js"),
7 | plugins: [
8 | new MiniCssExtractPlugin({
9 | filename: "index.css",
10 | }),
11 | ],
12 | devtool: "source-map",
13 | mode: "production",
14 | module: {
15 | rules: [
16 | {
17 | test: /\.(js|jsx)/,
18 | exclude: /node_modules/,
19 | use: "babel-loader",
20 | },
21 | {
22 | test: /\.(css)/,
23 | use: [MiniCssExtractPlugin.loader, "css-loader"],
24 | },
25 | ],
26 | },
27 | output: {
28 | publicPath: "/",
29 | filename: "viewer.js",
30 | path: path.resolve(__dirname, "jupyter_remote_desktop_proxy/static/dist"),
31 | },
32 | resolve: {
33 | extensions: [".css", ".js", ".jsx"],
34 | },
35 | };
36 |
--------------------------------------------------------------------------------
23 |
24 |
38 |