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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
|
import sys
from pathlib import Path
from typing import Awaitable, Callable, List, NamedTuple, Type
from unittest.mock import MagicMock
import pytest
from textual.geometry import Offset
from harlequin import Harlequin
from harlequin.catalog import InteractiveCatalogItem
from harlequin_duckdb.adapter import DuckDbAdapter
class MockS3Object(NamedTuple):
key: str
@pytest.fixture
def mock_boto3(monkeypatch: pytest.MonkeyPatch) -> None:
mock_boto3 = MagicMock(name="mock_boto3")
mock_s3 = MagicMock(name="mock_s3")
mock_boto3.resource.return_value = mock_s3
mock_bucket = MagicMock(name="mock_bucket")
mock_bucket.name = "my-bucket"
mock_s3.Bucket.return_value = mock_bucket
mock_s3.buckets.all.return_value = [mock_bucket]
objects = [
MockS3Object(key="one/alpha/foo.csv"),
MockS3Object(key="one/bravo/bar.csv"),
MockS3Object(key="two/apple/baz/qux.csv"),
]
mock_bucket.objects.all.return_value = objects
mock_bucket.objects.filter.return_value = objects
monkeypatch.setattr("harlequin.components.data_catalog.boto3", mock_boto3)
monkeypatch.setattr("harlequin.components.data_catalog.s3_tree.boto3", mock_boto3)
@pytest.mark.asyncio
async def test_data_catalog(
app_multi_duck: Harlequin,
app_snapshot: Callable[..., Awaitable[bool]],
wait_for_workers: Callable[[Harlequin], Awaitable[None]],
mock_pyperclip: MagicMock,
) -> None:
snap_results: List[bool] = []
app = app_multi_duck
async with app.run_test(size=(120, 36)) as pilot:
await wait_for_workers(app)
while app.editor is None:
await pilot.pause()
catalog = app.data_catalog
assert not catalog.database_tree.show_root
# this test app has two databases attached.
dbs = catalog.database_tree.root.children
assert len(dbs) == 2
# the first db is called "small"
assert str(dbs[0].label) == "small db"
assert dbs[0].data is not None
assert dbs[0].data.qualified_identifier == '"small"'
assert dbs[0].data.query_name == '"small"'
assert dbs[0].is_expanded is False
# the small db has two schemas, but you can't see them yet
# pause while the children are loaded
assert isinstance(dbs[0].data, InteractiveCatalogItem)
while not dbs[0].data.loaded:
await pilot.pause(0.1)
assert len(dbs[0].children) == 2
assert all(not node.is_expanded for node in dbs[0].children)
snap_results.append(await app_snapshot(app, "Initialization"))
assert str(dbs[1].label) == "tiny db"
assert dbs[0].is_expanded is False
# click on "small" and see it expand.
await pilot.click(catalog.__class__, offset=Offset(x=6, y=1))
assert dbs[0].is_expanded is True
assert dbs[1].is_expanded is False
assert all(not node.is_expanded for node in dbs[0].children)
snap_results.append(await app_snapshot(app, "small expanded"))
# small's second schema is "main". click "main"
schema_main = dbs[0].children[1]
await pilot.click(catalog.__class__, offset=Offset(x=8, y=3))
await pilot.pause()
assert schema_main.is_expanded is True
assert catalog.database_tree.cursor_line == 2 # main is selected
snap_results.append(await app_snapshot(app, "small.main expanded"))
# ctrl+enter to insert into editor; editor gets focus
await pilot.press("ctrl+j")
await pilot.pause()
assert schema_main.is_expanded is True
assert app.editor.text == '"small"."main"'
assert not catalog.has_focus
snap_results.append(await app_snapshot(app, "Inserted small.main"))
# use keys to navigate the tree into main.drivers
await pilot.press("f6")
await pilot.pause()
assert catalog.database_tree.has_focus
await pilot.press("down")
await pilot.press("space")
await pilot.press("down")
await pilot.press("down")
await pilot.press("enter")
await pilot.pause()
col_node = catalog.database_tree.cursor_node
assert col_node is not None
assert col_node.data is not None
assert col_node.data.qualified_identifier == '"small"."main"."drivers"."dob"'
assert col_node.data.query_name == '"dob"'
snap_results.append(await app_snapshot(app, "small.main.drivers.dob selected"))
# copy it
await pilot.press("ctrl+c")
assert mock_pyperclip.paste() == '"dob"'
# reset the editor, then insert "dob"
app.editor.text = ""
await pilot.press("ctrl+j")
await pilot.pause()
assert app.editor.text == '"dob"'
snap_results.append(await app_snapshot(app, "small.main.drivers.dob inserted"))
assert all(snap_results)
@pytest.mark.asyncio
async def test_file_tree(
duckdb_adapter: Type[DuckDbAdapter],
data_dir: Path,
app_snapshot: Callable[..., Awaitable[bool]],
mock_pyperclip: MagicMock,
) -> None:
snap_results: List[bool] = []
test_dir = data_dir / "functional_tests" / "files"
relative_test_dir = test_dir.relative_to(Path.cwd())
app = Harlequin(
duckdb_adapter((":memory:",)),
show_files=relative_test_dir,
)
async with app.run_test(size=(120, 36)) as pilot:
while app.editor is None:
await pilot.pause()
catalog = app.data_catalog
assert catalog.file_tree is not None
await pilot.press("f6") # focus catalog
await pilot.press("k") # show files
snap_results.append(await app_snapshot(app, "Initialization"))
await pilot.press("down")
await pilot.press("enter")
snap_results.append(await app_snapshot(app, "expanded foo dir"))
await pilot.press("ctrl+c")
assert mock_pyperclip.paste() == str(test_dir / "foo")
assert all(snap_results)
@pytest.mark.py12
@pytest.mark.skipif(
sys.version_info < (3, 12), reason="3.12 renders CSS differently for this test..."
)
@pytest.mark.asyncio
async def test_s3_tree(
duckdb_adapter: Type[DuckDbAdapter],
app_snapshot: Callable[..., Awaitable[bool]],
wait_for_workers: Callable[[Harlequin], Awaitable[None]],
mock_pyperclip: MagicMock,
mock_boto3: None,
) -> None:
snap_results: List[bool] = []
app = Harlequin(
duckdb_adapter((":memory:",)),
show_s3="my-bucket",
)
async with app.run_test(size=(120, 36)) as pilot:
await wait_for_workers(app)
while app.editor is None:
await pilot.pause()
catalog = app.data_catalog
assert catalog.s3_tree is not None
while not catalog.s3_tree.is_mounted:
await pilot.pause()
await pilot.press("f6") # focus catalog
await pilot.press("k") # show s3
snap_results.append(await app_snapshot(app, "Initialization"))
await pilot.press("down")
await pilot.press("enter")
await pilot.press("down")
await pilot.press("enter")
snap_results.append(await app_snapshot(app, "expanded one dir"))
await pilot.press("ctrl+c")
assert mock_pyperclip.paste() == "s3://my-bucket/one"
assert all(snap_results)
@pytest.mark.skipif("boto3" in sys.modules, reason="boto3 is installed.")
@pytest.mark.asyncio
async def test_s3_tree_does_not_crash_without_boto3(
duckdb_adapter: Type[DuckDbAdapter],
app_snapshot: Callable[..., Awaitable[bool]],
wait_for_workers: Callable[[Harlequin], Awaitable[None]],
) -> None:
app = Harlequin(
duckdb_adapter((":memory:",)),
show_s3="my-bucket",
)
async with app.run_test(size=(120, 36)) as pilot:
await wait_for_workers(app)
while app.editor is None:
await pilot.pause()
assert await app_snapshot(app, "Error visible")
@pytest.mark.asyncio
async def test_context_menu(
app_small_duck: Harlequin,
app_snapshot: Callable[..., Awaitable[bool]],
wait_for_workers: Callable[[Harlequin], Awaitable[None]],
) -> None:
app = app_small_duck
snap_results: List[bool] = []
async with app.run_test(size=(120, 36)) as pilot:
await wait_for_workers(app)
while app.editor is None:
await pilot.pause()
# we need to expand the data catalog to load items into the completer
while (
app.data_catalog.database_tree.loading
or not app.data_catalog.database_tree.root.children
):
await pilot.pause()
for db_node in app.data_catalog.database_tree.root.children:
db_node.expand()
while not db_node.children:
if getattr(db_node.data, "loaded", True):
break
await pilot.pause()
for schema_node in db_node.children:
schema_node.expand()
app.data_catalog.focus()
await pilot.press("full_stop")
await pilot.pause()
await wait_for_workers(app)
await pilot.pause()
await pilot.wait_for_scheduled_animations()
snap_results.append(await app_snapshot(app, "db context menu expanded"))
await pilot.press("enter")
await pilot.pause()
await wait_for_workers(app)
await pilot.pause()
await pilot.wait_for_scheduled_animations()
snap_results.append(await app_snapshot(app, "db name inserted"))
app.data_catalog.focus()
await pilot.press("down")
await pilot.press("full_stop")
await pilot.pause()
await wait_for_workers(app)
await pilot.pause()
await pilot.wait_for_scheduled_animations()
snap_results.append(await app_snapshot(app, "schema context menu expanded"))
await pilot.press("escape")
await pilot.press("down")
await pilot.press("down")
await pilot.press("full_stop")
await pilot.pause()
await wait_for_workers(app)
await pilot.pause()
await pilot.wait_for_scheduled_animations()
snap_results.append(await app_snapshot(app, "table context menu expanded"))
assert all(snap_results)
|
