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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
|
# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.
"""Test the Settings service API.
"""
import json
from pathlib import Path
import json5 # type:ignore
import pytest
from strict_rfc3339 import rfc3339_to_timestamp # type:ignore
from tornado.httpclient import HTTPClientError
from jupyterlab_server.test_utils import big_unicode_string, expected_http_error, validate_request
async def test_get_settings_overrides_dicts(jp_fetch, labserverapp):
# Check that values that are dictionaries in overrides.json are
# merged with the schema.
id = "@jupyterlab/apputils-extension:themes"
r = await jp_fetch("lab", "api", "settings", id)
validate_request(r)
res = r.body.decode()
data = json.loads(res)
assert data["id"] == id
schema = data["schema"]
# Check that overrides.json file is respected.
assert schema["properties"]["codeCellConfig"]["default"]["lineNumbers"] is True
assert len(schema["properties"]["codeCellConfig"]["default"]) == 15
@pytest.mark.parametrize("ext", ["json", "json5"])
async def test_get_settings_overrides_d_dicts(
jp_fetch, jp_serverapp, make_labserver_extension_app, ext
):
# Check that values that are dictionaries in overrides.d/*.json are
# merged with the schema.
labserverapp = make_labserver_extension_app()
labserverapp._link_jupyter_server_extension(jp_serverapp)
id = "@jupyterlab/apputils-extension:themes"
overrides_d = Path(labserverapp.app_settings_dir) / "overrides.d"
overrides_d.mkdir(exist_ok=True, parents=True)
for i in range(10):
text = json.dumps({id: {"codeCellConfig": {"cursorBlinkRate": 530 + i}}})
if ext == "json5":
text += "\n// a comment"
(overrides_d / f"foo-{i}.{ext}").write_text(text, encoding="utf-8")
# Initialize labserverapp only after the overrides were created
labserverapp.initialize()
r = await jp_fetch("lab", "api", "settings", id)
validate_request(r)
res = r.body.decode()
data = json.loads(res)
assert data["id"] == id
schema = data["schema"]
# Check that the last overrides.d/*.json file is respected.
assert schema["properties"]["codeCellConfig"]["default"]["cursorBlinkRate"] == 539
async def test_get_settings(jp_fetch, labserverapp):
id = "@jupyterlab/apputils-extension:themes"
r = await jp_fetch("lab", "api", "settings", id)
validate_request(r)
res = r.body.decode()
data = json.loads(res)
assert data["id"] == id
schema = data["schema"]
# Check that overrides.json file is respected.
assert schema["properties"]["theme"]["default"] == "JupyterLab Dark"
assert "raw" in res
async def test_get_federated(jp_fetch, labserverapp):
id = "@jupyterlab/apputils-extension-federated:themes"
r = await jp_fetch("lab", "api", "settings", id)
validate_request(r)
res = r.body.decode()
assert "raw" in res
async def test_get_bad(jp_fetch, labserverapp):
with pytest.raises(HTTPClientError) as e:
await jp_fetch("foo")
assert expected_http_error(e, 404)
async def test_listing(jp_fetch, labserverapp):
ids = [
"@jupyterlab/apputils-extension:themes",
"@jupyterlab/apputils-extension-federated:themes",
"@jupyterlab/codemirror-extension:commands",
"@jupyterlab/codemirror-extension-federated:commands",
"@jupyterlab/shortcuts-extension:plugin",
"@jupyterlab/translation-extension:plugin",
"@jupyterlab/unicode-extension:plugin",
]
versions = ["N/A", "N/A", "test-version"]
r = await jp_fetch("lab", "api", "settings/")
validate_request(r)
res = r.body.decode()
response = json.loads(res)
response_ids = [item["id"] for item in response["settings"]]
response_schemas = [item["schema"] for item in response["settings"]]
response_versions = [item["version"] for item in response["settings"]]
assert set(response_ids) == set(ids)
assert all(response_schemas)
assert set(response_versions) == set(versions)
last_modifieds = [item["last_modified"] for item in response["settings"]]
createds = [item["created"] for item in response["settings"]]
assert {None} == set(last_modifieds + createds)
async def test_listing_ids(jp_fetch, labserverapp):
ids = [
"@jupyterlab/apputils-extension:themes",
"@jupyterlab/apputils-extension-federated:themes",
"@jupyterlab/codemirror-extension:commands",
"@jupyterlab/codemirror-extension-federated:commands",
"@jupyterlab/shortcuts-extension:plugin",
"@jupyterlab/translation-extension:plugin",
"@jupyterlab/unicode-extension:plugin",
]
r = await jp_fetch("lab", "api", "settings/", params={"ids_only": "true"})
validate_request(r)
res = r.body.decode()
response = json.loads(res)
response_ids = [item["id"] for item in response["settings"]]
# Checks the IDs list is correct
assert set(response_ids) == set(ids)
# Checks there is only the 'id' key in each item
assert all(
(len(item.keys()) == 1 and next(iter(item.keys())) == "id") for item in response["settings"]
)
async def test_patch(jp_fetch, labserverapp):
id = "@jupyterlab/shortcuts-extension:plugin"
r = await jp_fetch(
"lab", "api", "settings", id, method="PUT", body=json.dumps(dict(raw=json5.dumps(dict())))
)
validate_request(r)
r = await jp_fetch(
"lab",
"api",
"settings",
id,
method="GET",
)
validate_request(r)
data = json.loads(r.body.decode())
first_created = rfc3339_to_timestamp(data["created"])
first_modified = rfc3339_to_timestamp(data["last_modified"])
r = await jp_fetch(
"lab", "api", "settings", id, method="PUT", body=json.dumps(dict(raw=json5.dumps(dict())))
)
validate_request(r)
r = await jp_fetch(
"lab",
"api",
"settings",
id,
method="GET",
)
validate_request(r)
data = json.loads(r.body.decode())
second_created = rfc3339_to_timestamp(data["created"])
second_modified = rfc3339_to_timestamp(data["last_modified"])
assert first_created <= second_created
assert first_modified < second_modified
r = await jp_fetch(
"lab",
"api",
"settings/",
method="GET",
)
validate_request(r)
data = json.loads(r.body.decode())
listing = data["settings"]
list_data = next(item for item in listing if item["id"] == id)
# TODO(@echarles) Check this...
# assert list_data['created'] == data['created']
# assert list_data['last_modified'] == data['last_modified']
async def test_patch_unicode(jp_fetch, labserverapp):
id = "@jupyterlab/unicode-extension:plugin"
settings = dict(comment=big_unicode_string[::-1])
payload = dict(raw=json5.dumps(settings))
r = await jp_fetch("lab", "api", "settings", id, method="PUT", body=json.dumps(payload))
validate_request(r)
r = await jp_fetch(
"lab",
"api",
"settings",
id,
method="GET",
)
validate_request(r)
data = json.loads(r.body.decode())
assert data["settings"]["comment"] == big_unicode_string[::-1]
async def test_patch_wrong_id(jp_fetch, labserverapp):
with pytest.raises(HTTPClientError) as e:
await jp_fetch("foo", method="PUT", body=json.dumps(dict(raw=json5.dumps(dict()))))
assert expected_http_error(e, 404)
async def test_patch_bad_data(jp_fetch, labserverapp):
with pytest.raises(HTTPClientError) as e:
settings = dict(keyMap=10)
payload = dict(raw=json5.dumps(settings))
await jp_fetch("foo", method="PUT", body=json.dumps(payload))
assert expected_http_error(e, 404)
async def test_patch_invalid_payload_format(jp_fetch, labserverapp):
id = "@jupyterlab/apputils-extension:themes"
with pytest.raises(HTTPClientError) as e:
settings = dict(keyMap=10)
payload = dict(foo=json5.dumps(settings))
await jp_fetch("lab", "api", "settings", id, method="PUT", body=json.dumps(payload))
assert expected_http_error(e, 400)
async def test_patch_invalid_json(jp_fetch, labserverapp):
id = "@jupyterlab/apputils-extension:themes"
with pytest.raises(HTTPClientError) as e:
payload_str = "eh"
await jp_fetch("lab", "api", "settings", id, method="PUT", body=json.dumps(payload_str))
assert expected_http_error(e, 400)
|
