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 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
|
import sqlite3
from pathlib import Path
from unittest.mock import MagicMock
import pytest
from click.testing import CliRunner
from harlequin import Harlequin
from harlequin.cli import DEFAULT_KEYMAP_NAMES, DEFAULT_LIMIT, DEFAULT_THEME, build_cli
from harlequin.config import Config
from harlequin_duckdb import DUCKDB_OPTIONS, DuckDbAdapter
from harlequin_sqlite import SQLITE_OPTIONS, HarlequinSqliteAdapter
@pytest.fixture()
def mock_adapter(monkeypatch: pytest.MonkeyPatch) -> MagicMock:
mock_adapter = MagicMock(name="mock_duckdb_adapter", spec=DuckDbAdapter)
mock_adapter.ADAPTER_OPTIONS = DUCKDB_OPTIONS
mock_adapter.profile_name = None
mock_entrypoint = MagicMock(name="mock_entrypoint")
mock_entrypoint.name = "duckdb"
mock_entrypoint.load.return_value = mock_adapter
mock_entry_points = MagicMock()
mock_entry_points.return_value = [mock_entrypoint]
monkeypatch.setattr("harlequin.plugins.entry_points", mock_entry_points)
return mock_adapter
@pytest.fixture()
def mock_sqlite_adapter(monkeypatch: pytest.MonkeyPatch) -> MagicMock:
mock_adapter = MagicMock(name="mock_sqlite_adapter", spec=HarlequinSqliteAdapter)
mock_adapter.ADAPTER_OPTIONS = SQLITE_OPTIONS
mock_entrypoint = MagicMock(name="mock_entrypoint")
mock_entrypoint.name = "sqlite"
mock_entrypoint.load.return_value = mock_adapter
mock_entry_points = MagicMock()
mock_entry_points.return_value = [mock_entrypoint]
monkeypatch.setattr("harlequin.plugins.entry_points", mock_entry_points)
return mock_adapter
@pytest.fixture()
def mock_harlequin(monkeypatch: pytest.MonkeyPatch) -> MagicMock:
mock = MagicMock(spec=Harlequin)
monkeypatch.setattr("harlequin.cli.Harlequin", mock)
return mock
@pytest.fixture()
def mock_empty_config(monkeypatch: pytest.MonkeyPatch) -> None:
monkeypatch.setattr(
"harlequin.cli.get_config_for_profile", lambda **_: (dict(), [])
)
@pytest.fixture()
def mock_load_config(monkeypatch: pytest.MonkeyPatch) -> Config:
config: Config = {"profiles": {"test-profile": {"theme": "fruity"}}}
monkeypatch.setattr("harlequin.config.load_config", lambda *_: config)
return config
@pytest.mark.parametrize("harlequin_args", ["", ":memory:"])
def test_default(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
harlequin_args: str,
mock_empty_config: None,
) -> None:
runner = CliRunner()
res = runner.invoke(build_cli(), args=harlequin_args)
assert res.exit_code == 0
expected_conn_str = (harlequin_args,) if harlequin_args else tuple()
mock_adapter.assert_called_once_with(conn_str=expected_conn_str)
mock_harlequin.assert_called_once_with(
adapter=mock_adapter.return_value,
profile_name=None,
connection_hash=mock_adapter.return_value.connection_id,
max_results=DEFAULT_LIMIT,
keymap_names=DEFAULT_KEYMAP_NAMES,
user_defined_keymaps=[],
theme=DEFAULT_THEME,
show_files=None,
show_s3=None,
)
@pytest.mark.parametrize(
"harlequin_args", ["--init-path foo", ":memory: -i foo", "-init foo"]
)
def test_custom_init_script(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
harlequin_args: str,
mock_empty_config: None,
) -> None:
runner = CliRunner()
res = runner.invoke(build_cli(), args=harlequin_args)
assert res.exit_code == 0
mock_adapter.assert_called_once()
assert mock_adapter.call_args
assert mock_adapter.call_args.kwargs["init_path"] == Path("foo").resolve()
@pytest.mark.parametrize("harlequin_args", ["--no-init", ":memory: --no-init"])
def test_no_init_script(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
harlequin_args: str,
mock_empty_config: None,
) -> None:
runner = CliRunner()
res = runner.invoke(build_cli(), args=harlequin_args)
assert res.exit_code == 0
mock_adapter.assert_called_once()
assert mock_adapter.call_args
assert mock_adapter.call_args.kwargs["no_init"] is True
@pytest.mark.parametrize(
"harlequin_args", ["--theme one-dark", ":memory: -t one-dark", "foo.db -t one-dark"]
)
def test_theme(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
harlequin_args: str,
mock_empty_config: None,
) -> None:
runner = CliRunner()
res = runner.invoke(build_cli(), args=harlequin_args)
assert res.exit_code == 0
mock_harlequin.assert_called_once()
assert mock_harlequin.call_args
assert mock_harlequin.call_args.kwargs["theme"] == "one-dark"
@pytest.mark.parametrize(
"harlequin_args",
[
"--limit 10",
"-l 1000000",
":memory: -l 10",
"foo.db --limit 5000000000",
"--limit 0",
],
)
def test_limit(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
harlequin_args: str,
mock_empty_config: None,
) -> None:
runner = CliRunner()
res = runner.invoke(build_cli(), args=harlequin_args)
assert res.exit_code == 0
mock_harlequin.assert_called_once()
assert mock_harlequin.call_args
assert mock_harlequin.call_args.kwargs["max_results"] != 100_000
@pytest.mark.parametrize("harlequin_args", ["--show-files .", "-f .", "foo.db -f ."])
def test_show_files(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
harlequin_args: str,
mock_empty_config: None,
) -> None:
runner = CliRunner()
res = runner.invoke(build_cli(), args=harlequin_args)
assert res.exit_code == 0
mock_harlequin.assert_called_once()
assert mock_harlequin.call_args
assert mock_harlequin.call_args.kwargs["show_files"] == Path(".")
@pytest.mark.parametrize(
"harlequin_args",
[
"--adapter duckdb",
"-a duckdb",
"-a DUCKDB",
],
)
def test_adapter_opt(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
harlequin_args: str,
mock_empty_config: None,
) -> None:
runner = CliRunner()
res = runner.invoke(build_cli(), args=harlequin_args)
assert res.exit_code == 0
mock_harlequin.assert_called_once()
assert mock_harlequin.call_args
assert mock_harlequin.call_args.kwargs["adapter"] == mock_adapter.return_value
@pytest.mark.parametrize(
"harlequin_args",
[
"--adapter foo",
"-a bar",
],
)
def test_bad_adapter_opt(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
harlequin_args: str,
mock_empty_config: None,
) -> None:
runner = CliRunner()
res = runner.invoke(build_cli(), args=harlequin_args)
assert res.exit_code == 2
key_words = ["Error", "Invalid", "-a", "-adapter", "duckdb"]
assert all([w in res.stdout for w in key_words])
@pytest.mark.parametrize(
"harlequin_args",
[
"--profile test-profile",
"-P test-profile",
],
)
def test_profile_opt(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
harlequin_args: str,
mock_load_config: Config,
) -> None:
runner = CliRunner()
res = runner.invoke(build_cli(), args=harlequin_args)
assert res.exit_code == 0
mock_harlequin.assert_called_once()
assert mock_harlequin.call_args
assert mock_harlequin.call_args.kwargs["theme"] == "fruity"
@pytest.mark.parametrize(
"harlequin_args",
[
"--profile test-profile -t zenburn",
"-P test-profile --theme zenburn",
],
)
def test_profile_override(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
harlequin_args: str,
mock_load_config: Config,
) -> None:
runner = CliRunner()
res = runner.invoke(build_cli(), args=harlequin_args)
assert res.exit_code == 0
mock_harlequin.assert_called_once()
assert mock_harlequin.call_args
assert mock_harlequin.call_args.kwargs["theme"] == "zenburn"
@pytest.mark.parametrize(
"harlequin_args",
[
"--profile foo",
"-P bar",
],
)
def test_bad_profile_opt(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
harlequin_args: str,
mock_load_config: Config,
) -> None:
runner = CliRunner()
res = runner.invoke(build_cli(), args=harlequin_args)
assert res.exit_code == 2
key_words = ["profile", "config"]
assert all([w in res.stdout for w in key_words])
@pytest.mark.parametrize("filename", ["good_config.toml", "pyproject.toml"])
def test_config_path(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
data_dir: Path,
filename: str,
) -> None:
runner = CliRunner()
config_path = data_dir / "unit_tests" / "config" / filename
res = runner.invoke(build_cli(), args=f"--config-path {config_path.as_posix()}")
assert res.exit_code == 0
mock_harlequin.assert_called_once()
assert mock_harlequin.call_args
# should use default profile of my-duckdb-profile
assert mock_harlequin.call_args.kwargs["max_results"] == 200_000
mock_adapter.assert_called_once()
assert mock_adapter.call_args.kwargs["conn_str"] == ["my-database.db"]
assert mock_adapter.call_args.kwargs["read_only"] is False
assert mock_adapter.call_args.kwargs["extension"] == ["httpfs", "spatial"]
@pytest.mark.parametrize("filename", ["good_config.toml", "pyproject.toml"])
def test_config_path_fron_env(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
data_dir: Path,
filename: str,
) -> None:
runner = CliRunner()
config_path = data_dir / "unit_tests" / "config" / filename
res = runner.invoke(
build_cli(), env={"HARLEQUIN_CONFIG_PATH": config_path.as_posix()}
)
assert res.exit_code == 0
mock_harlequin.assert_called_once()
assert mock_harlequin.call_args
# should use default profile of my-duckdb-profile
assert mock_harlequin.call_args.kwargs["max_results"] == 200_000
mock_adapter.assert_called_once()
assert mock_adapter.call_args.kwargs["conn_str"] == ["my-database.db"]
assert mock_adapter.call_args.kwargs["read_only"] is False
assert mock_adapter.call_args.kwargs["extension"] == ["httpfs", "spatial"]
def test_bad_config_exits(
mock_harlequin: MagicMock,
mock_adapter: MagicMock,
data_dir: Path,
) -> None:
runner = CliRunner()
config_path = data_dir / "unit_tests" / "config" / "default_no_exist.toml"
res = runner.invoke(build_cli(), args=f"--config-path {config_path.as_posix()}")
assert res.exit_code == 2
key_words = ["default_profile", "foo"]
assert all([w in res.stdout for w in key_words])
@pytest.mark.skipif(
not hasattr(sqlite3.Connection, "enable_load_extension"),
reason="Extension option not supported on many pythons.",
)
def test_sqlite_extensions(
mock_harlequin: MagicMock,
mock_sqlite_adapter: MagicMock,
mock_empty_config: None,
data_dir: Path,
) -> None:
extension_path = data_dir / "unit_tests" / "sqlite_extension" / "hello0"
runner = CliRunner()
res = runner.invoke(
build_cli(), args=f"-a sqlite --extension {extension_path.as_posix()}"
)
assert res.exit_code == 0
@pytest.mark.skipif(
hasattr(sqlite3.Connection, "enable_load_extension"),
reason="Extension option not supported on many pythons.",
)
def test_sqlite_extension_not_supported(
mock_harlequin: MagicMock,
mock_sqlite_adapter: MagicMock,
mock_empty_config: None,
data_dir: Path,
) -> None:
extension_path = data_dir / "unit_tests" / "sqlite_extension" / "hello0"
runner = CliRunner()
res = runner.invoke(
build_cli(), args=f"-a sqlite --extension {extension_path.as_posix()}"
)
assert res.exit_code == 2
assert "No such option" in res.stdout
|