1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
import json
import os
from pathlib import Path
from unittest.mock import patch
import pytest
from nbformat import writes
from nbformat.v4 import new_code_cell, new_markdown_cell, new_notebook, new_output
from tornado.httpclient import HTTPClientError
from .utils import expected_http_error
@pytest.fixture(
params=[
"jupyter_server.files.handlers.FilesHandler",
"jupyter_server.base.handlers.AuthenticatedFileHandler",
]
)
def jp_argv(request):
return ["--ContentsManager.files_handler_class=" + request.param]
@pytest.fixture(
params=[
[False, ["å b"]],
[False, ["å b", "ç. d"]],
[True, [".å b"]],
[True, ["å b", ".ç d"]],
]
)
def maybe_hidden(request):
return request.param
async def fetch_expect_200(jp_fetch, *path_parts):
r = await jp_fetch("files", *path_parts, method="GET")
assert r.body.decode() == path_parts[-1], (path_parts, r.body)
async def fetch_expect_error(jp_fetch, code, *path_parts):
with pytest.raises(HTTPClientError) as e:
await jp_fetch("files", *path_parts, method="GET")
assert expected_http_error(e, code), [path_parts, e]
async def fetch_expect_404(jp_fetch, *path_parts):
return await fetch_expect_error(jp_fetch, 404, *path_parts)
async def test_file_types(jp_fetch, jp_root_dir):
path = Path(jp_root_dir, "test")
path.mkdir(parents=True, exist_ok=True)
foos = ["foo.tar.gz", "foo.bz", "foo.foo"]
for foo in foos:
(path / foo).write_text(foo)
await fetch_expect_200(jp_fetch, "test", foo)
async def test_hidden_files(jp_fetch, jp_serverapp, jp_root_dir, maybe_hidden):
is_hidden, path_parts = maybe_hidden
path = Path(jp_root_dir, *path_parts)
path.mkdir(parents=True, exist_ok=True)
foos = ["foo", ".foo"]
for foo in foos:
(path / foo).write_text(foo)
if is_hidden:
for foo in foos:
await fetch_expect_404(jp_fetch, *path_parts, foo)
else:
await fetch_expect_404(jp_fetch, *path_parts, ".foo")
await fetch_expect_200(jp_fetch, *path_parts, "foo")
jp_serverapp.contents_manager.allow_hidden = True
for foo in foos:
await fetch_expect_200(jp_fetch, *path_parts, foo)
@patch(
"jupyter_core.paths.is_hidden",
side_effect=AssertionError("Should not call is_hidden if not important"),
)
@patch(
"jupyter_server.services.contents.filemanager.is_hidden",
side_effect=AssertionError("Should not call is_hidden if not important"),
)
@patch(
"jupyter_server.base.handlers.is_hidden",
side_effect=AssertionError("Should not call is_hidden if not important"),
)
async def test_regression_is_hidden(m1, m2, m3, jp_fetch, jp_serverapp, jp_root_dir):
path_parts = [".hidden", "foo"]
path = Path(jp_root_dir, *path_parts)
path.mkdir(parents=True, exist_ok=True)
foos = ["foo", ".foo"]
for foo in foos:
(path / foo).write_text(foo)
jp_serverapp.contents_manager.allow_hidden = True
for foo in foos:
await fetch_expect_200(jp_fetch, *path_parts, foo)
jp_serverapp.contents_manager.allow_hidden = False
for foo in foos:
await fetch_expect_error(jp_fetch, 500, *path_parts, foo)
async def test_contents_manager(jp_fetch, jp_serverapp, jp_root_dir):
"""make sure ContentsManager returns right files (ipynb, bin, txt).
Also test save file hooks."""
nb = new_notebook(
cells=[
new_markdown_cell("Created by test ³"),
new_code_cell(
"print(2*6)",
outputs=[
new_output("stream", text="12"),
],
),
]
)
jp_root_dir.joinpath("testnb.ipynb").write_text(writes(nb, version=4), encoding="utf-8")
jp_root_dir.joinpath("test.bin").write_bytes(b"\xff" + os.urandom(5))
jp_root_dir.joinpath("test.txt").write_text("foobar")
r = await jp_fetch("files/testnb.ipynb", method="GET")
assert r.code == 200
assert "print(2*6)" in r.body.decode("utf-8")
r = await jp_fetch("files/test.bin", method="GET")
assert r.code == 200
assert r.headers["content-type"] == "application/octet-stream"
assert r.body[:1] == b"\xff"
assert len(r.body) == 6
r = await jp_fetch("files/test.txt", method="GET")
assert r.code == 200
assert "text/plain" in r.headers["content-type"]
assert r.body.decode() == "foobar"
async def test_save_hooks(jp_fetch, jp_serverapp):
# define a first pre-save hook that will change the content of the file before saving
def pre_save_hook1(model, **kwargs):
model["content"] += " was modified"
# define a second pre-save hook that will change the content of the file before saving
def pre_save_hook2(model, **kwargs):
model["content"] += " twice!"
# define a first post-save hook that will change the 'last_modified' date
def post_save_hook1(model, **kwargs):
model["last_modified"] = "yesterday"
# define a second post-save hook that will change the 'last_modified' date
def post_save_hook2(model, **kwargs):
model["last_modified"] += " or tomorrow!"
# register the pre-save hooks
jp_serverapp.contents_manager.register_pre_save_hook(pre_save_hook1)
jp_serverapp.contents_manager.register_pre_save_hook(pre_save_hook2)
# register the post-save hooks
jp_serverapp.contents_manager.register_post_save_hook(post_save_hook1)
jp_serverapp.contents_manager.register_post_save_hook(post_save_hook2)
# send a request to save a file, with an original content
# the 'last_modified' returned model field should have been modified by post_save_hook1 then post_save_hook2
r = await jp_fetch(
"api/contents/test.txt",
method="PUT",
body=json.dumps(
{"format": "text", "path": "test.txt", "type": "file", "content": "original content"}
),
)
assert json.loads(r.body.decode())["last_modified"] == "yesterday or tomorrow!"
# read the file back
# the original content should have been modified by pre_save_hook1 then pre_save_hook2
r = await jp_fetch("files/test.txt", method="GET")
assert r.body.decode() == "original content was modified twice!"
async def test_download(jp_fetch, jp_serverapp, jp_root_dir):
text = "hello"
jp_root_dir.joinpath("test.txt").write_text(text)
r = await jp_fetch("files", "test.txt", method="GET")
disposition = r.headers.get("Content-Disposition", "")
assert "attachment" not in disposition
r = await jp_fetch("files", "test.txt", method="GET", params={"download": True})
disposition = r.headers.get("Content-Disposition", "")
assert "attachment" in disposition
assert "filename*=utf-8''test.txt" in disposition
async def test_old_files_redirect(jp_fetch, jp_serverapp, jp_root_dir):
"""pre-2.0 'files/' prefixed links are properly redirected"""
jp_root_dir.joinpath("files").mkdir(parents=True, exist_ok=True)
jp_root_dir.joinpath("sub", "files").mkdir(parents=True, exist_ok=True)
for prefix in ("", "sub"):
jp_root_dir.joinpath(prefix, "files", "f1.txt").write_text(prefix + "/files/f1")
jp_root_dir.joinpath(prefix, "files", "f2.txt").write_text(prefix + "/files/f2")
jp_root_dir.joinpath(prefix, "f2.txt").write_text(prefix + "/f2")
jp_root_dir.joinpath(prefix, "f3.txt").write_text(prefix + "/f3")
# These depend on the tree handlers
#
# def test_download(self):
# rootdir = self.root_dir
# text = 'hello'
# with open(pjoin(rootdir, 'test.txt'), 'w') as f:
# f.write(text)
# r = self.request('GET', 'files/test.txt')
# disposition = r.headers.get('Content-Disposition', '')
# self.assertNotIn('attachment', disposition)
# r = self.request('GET', 'files/test.txt?download=1')
# disposition = r.headers.get('Content-Disposition', '')
# assert 'attachment' in disposition
# assert "filename*=utf-8''test.txt" in disposition
|
