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 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680
|
"""Tests for simple use cases of the public api."""
import json
from contextlib import nullcontext
import pytest
import sqlfluff
from sqlfluff.api import APIParsingError
from sqlfluff.core.errors import SQLFluffUserError
my_bad_query = "SeLEct *, 1, blah as fOO from myTable"
lint_result = [
{
"code": "AM04",
"description": "Query produces an unknown number of result columns.",
"start_line_no": 1,
"start_line_pos": 1,
"start_file_pos": 0,
"end_line_no": 1,
"end_line_pos": 41,
"end_file_pos": 40,
"name": "ambiguous.column_count",
"fixes": [],
"warning": False,
},
{
"code": "CP01",
"start_line_no": 1,
"start_line_pos": 1,
"start_file_pos": 0,
"end_line_no": 1,
"end_line_pos": 7,
"end_file_pos": 6,
"description": "Keywords must be consistently upper case.",
"name": "capitalisation.keywords",
"fixes": [
{
"type": "replace",
"edit": "SELECT",
"start_line_no": 1,
"start_line_pos": 1,
"start_file_pos": 0,
"end_line_no": 1,
"end_line_pos": 7,
"end_file_pos": 6,
}
],
"warning": False,
},
{
"code": "LT09",
"description": "Select targets should be on a new line unless there is only "
"one select target.",
"start_line_no": 1,
"start_line_pos": 1,
"start_file_pos": 0,
"end_line_no": 1,
"end_line_pos": 27,
"end_file_pos": 26,
"name": "layout.select_targets",
"fixes": [
{
"type": "delete",
"edit": "",
"start_line_no": 1,
"start_line_pos": 7,
"start_file_pos": 6,
"end_line_no": 1,
"end_line_pos": 9,
"end_file_pos": 8,
},
{
"type": "create_before",
"edit": "\n",
"start_line_no": 1,
"start_line_pos": 9,
"start_file_pos": 8,
"end_line_no": 1,
"end_line_pos": 9,
"end_file_pos": 8,
},
{
"type": "delete",
"edit": "",
"start_line_no": 1,
"start_line_pos": 11,
"start_file_pos": 10,
"end_line_no": 1,
"end_line_pos": 12,
"end_file_pos": 11,
},
{
"type": "create_before",
"edit": "\n",
"start_line_no": 1,
"start_line_pos": 12,
"start_file_pos": 11,
"end_line_no": 1,
"end_line_pos": 12,
"end_file_pos": 11,
},
{
"type": "delete",
"edit": "",
"start_line_no": 1,
"start_line_pos": 14,
"start_file_pos": 13,
"end_line_no": 1,
"end_line_pos": 15,
"end_file_pos": 14,
},
{
"type": "create_before",
"edit": "\n",
"start_line_no": 1,
"start_line_pos": 15,
"start_file_pos": 14,
"end_line_no": 1,
"end_line_pos": 15,
"end_file_pos": 14,
},
{
"type": "delete",
"edit": "",
"start_line_no": 1,
"start_line_pos": 27,
"start_file_pos": 26,
"end_line_no": 1,
"end_line_pos": 29,
"end_file_pos": 28,
},
{
"type": "create_before",
"edit": "\n",
"start_line_no": 1,
"start_line_pos": 29,
"start_file_pos": 28,
"end_line_no": 1,
"end_line_pos": 29,
"end_file_pos": 28,
},
],
"warning": False,
},
{
"code": "LT01",
"description": "Expected only single space before star '*'. Found ' '.",
"start_line_no": 1,
"start_line_pos": 7,
"start_file_pos": 6,
"end_line_no": 1,
"end_line_pos": 9,
"end_file_pos": 8,
"name": "layout.spacing",
"fixes": [
{
"type": "replace",
"edit": " ",
"start_line_no": 1,
"start_line_pos": 7,
"start_file_pos": 6,
"end_line_no": 1,
"end_line_pos": 9,
"end_file_pos": 8,
}
],
"warning": False,
},
{
"code": "AL03",
"start_line_no": 1,
"start_line_pos": 12,
"start_file_pos": 11,
"end_line_no": 1,
"end_line_pos": 13,
"end_file_pos": 12,
"description": "Column expression without alias. Use explicit `AS` clause.",
"name": "aliasing.expression",
"fixes": [],
"warning": False,
},
{
"code": "CP01",
"start_line_no": 1,
"start_line_pos": 20,
"start_file_pos": 19,
"end_line_no": 1,
"end_line_pos": 22,
"end_file_pos": 21,
"description": "Keywords must be consistently upper case.",
"name": "capitalisation.keywords",
"fixes": [
{
"type": "replace",
"edit": "AS",
"start_line_no": 1,
"start_line_pos": 20,
"start_file_pos": 19,
"end_line_no": 1,
"end_line_pos": 22,
"end_file_pos": 21,
}
],
"warning": False,
},
{
"code": "LT01",
"description": (
"Expected only single space before naked identifier. Found ' '."
),
"start_line_no": 1,
"start_line_pos": 22,
"start_file_pos": 21,
"end_line_no": 1,
"end_line_pos": 24,
"end_file_pos": 23,
"name": "layout.spacing",
"fixes": [
{
"type": "replace",
"edit": " ",
"start_line_no": 1,
"start_line_pos": 22,
"start_file_pos": 21,
"end_line_no": 1,
"end_line_pos": 24,
"end_file_pos": 23,
}
],
"warning": False,
},
{
"code": "CP02",
"start_line_no": 1,
"start_line_pos": 24,
"start_file_pos": 23,
"end_line_no": 1,
"end_line_pos": 27,
"end_file_pos": 26,
"description": "Unquoted identifiers must be consistently lower case.",
"name": "capitalisation.identifiers",
"fixes": [
{
"type": "replace",
"edit": "foo",
"start_line_no": 1,
"start_line_pos": 24,
"start_file_pos": 23,
"end_line_no": 1,
"end_line_pos": 27,
"end_file_pos": 26,
}
],
"warning": False,
},
{
"code": "LT01",
"description": "Expected only single space before 'from' keyword. Found ' '.",
"start_line_no": 1,
"start_line_pos": 27,
"start_file_pos": 26,
"end_line_no": 1,
"end_line_pos": 29,
"end_file_pos": 28,
"name": "layout.spacing",
"fixes": [
{
"type": "replace",
"edit": " ",
"start_line_no": 1,
"start_line_pos": 27,
"start_file_pos": 26,
"end_line_no": 1,
"end_line_pos": 29,
"end_file_pos": 28,
}
],
"warning": False,
},
{
"code": "CP01",
"start_line_no": 1,
"start_line_pos": 29,
"start_file_pos": 28,
"end_line_no": 1,
"end_line_pos": 33,
"end_file_pos": 32,
"description": "Keywords must be consistently upper case.",
"name": "capitalisation.keywords",
"fixes": [
{
"type": "replace",
"edit": "FROM",
"start_line_no": 1,
"start_line_pos": 29,
"start_file_pos": 28,
"end_line_no": 1,
"end_line_pos": 33,
"end_file_pos": 32,
}
],
"warning": False,
},
{
"code": "CP02",
"start_line_no": 1,
"start_line_pos": 34,
"start_file_pos": 33,
"end_line_no": 1,
"end_line_pos": 41,
"end_file_pos": 40,
"description": "Unquoted identifiers must be consistently lower case.",
"name": "capitalisation.identifiers",
"fixes": [
{
"type": "replace",
"edit": "mytable",
"start_line_no": 1,
"start_line_pos": 34,
"start_file_pos": 33,
"end_line_no": 1,
"end_line_pos": 41,
"end_file_pos": 40,
}
],
"warning": False,
},
{
"code": "LT12",
"start_line_no": 1,
"start_line_pos": 41,
"start_file_pos": 40,
"end_line_no": 1,
"end_line_pos": 41,
"end_file_pos": 40,
"description": "Files must end with a single trailing newline.",
"name": "layout.end_of_file",
"fixes": [
{
"type": "create_after",
"edit": "\n",
"start_line_no": 1,
"start_line_pos": 41,
"start_file_pos": 40,
"end_line_no": 1,
"end_line_pos": 41,
"end_file_pos": 40,
}
],
"warning": False,
},
]
def test__api__lint_string_without_violations():
"""Check lint functionality when there is no violation."""
result = sqlfluff.lint("select column from table\n")
assert result == []
def test__api__lint_string():
"""Basic checking of lint functionality."""
result = sqlfluff.lint(my_bad_query)
# Check return types.
assert isinstance(result, list)
assert all(isinstance(elem, dict) for elem in result)
# Check actual result
assert result == lint_result
def test__api__lint_string_specific():
"""Basic checking of lint functionality."""
rules = ["CP02", "LT12"]
result = sqlfluff.lint(my_bad_query, rules=rules)
# Check which rules are found
assert all(elem["code"] in rules for elem in result)
def test__api__lint_string_specific_single():
"""Basic checking of lint functionality."""
rules = ["CP02"]
result = sqlfluff.lint(my_bad_query, rules=rules)
# Check which rules are found
assert all(elem["code"] in rules for elem in result)
def test__api__lint_string_specific_exclude():
"""Basic checking of lint functionality."""
exclude_rules = ["LT12", "CP01", "AL03", "CP02", "LT09", "LT01"]
result = sqlfluff.lint(my_bad_query, exclude_rules=exclude_rules)
# Check only AM04 is found
assert len(result) == 1
assert "AM04" == result[0]["code"]
def test__api__lint_string_specific_exclude_single():
"""Basic checking of lint functionality."""
exclude_rules = ["LT01"]
result = sqlfluff.lint(my_bad_query, exclude_rules=exclude_rules)
# Check only AM04 is found
assert len(result) == 9
assert set(["LT12", "CP01", "AL03", "CP02", "LT09", "AM04"]) == set(
[r["code"] for r in result]
)
def test__api__lint_string_specific_exclude_all_failed_rules():
"""Basic checking of lint functionality."""
exclude_rules = ["LT12", "CP01", "AL03", "CP02", "LT09", "LT01", "AM04"]
result = sqlfluff.lint(my_bad_query, exclude_rules=exclude_rules)
# Check it passes
assert result == []
def test__api__fix_string():
"""Basic checking of lint functionality."""
result = sqlfluff.fix(my_bad_query)
# Check return types.
assert isinstance(result, str)
# Check actual result
assert (
result
== """SELECT
*,
1,
blah AS foo
FROM mytable
"""
)
def test__api__fix_string_specific():
"""Basic checking of lint functionality with a specific rule."""
result = sqlfluff.fix(my_bad_query, rules=["CP01"])
# Check actual result
assert result == "SELECT *, 1, blah AS fOO FROM myTable"
def test__api__fix_string_specific_exclude():
"""Basic checking of lint functionality with a specific rule exclusion."""
result = sqlfluff.fix(my_bad_query, exclude_rules=["LT09"])
# Check actual result
assert result == "SELECT *, 1, blah AS foo FROM mytable\n"
def test__api__fix_string_unparsable():
"""Test behavior with parse errors."""
bad_query = """SELECT my_col
FROM my_schema.my_table
where processdate ! 3"""
result = sqlfluff.fix(bad_query, rules=["CP01"])
# Check fix result: should be unchanged because of the parse error.
assert result == bad_query
def test__api__fix_string_unparsable_fix_even_unparsable():
"""Test behavior with parse errors."""
bad_query = """SELECT my_col
FROM my_schema.my_table
where processdate ! 3"""
result = sqlfluff.fix(bad_query, rules=["CP01"], fix_even_unparsable=True)
# Check fix result: should be fixed because we overrode fix_even_unparsable.
assert (
result
== """SELECT my_col
FROM my_schema.my_table
WHERE processdate ! 3"""
)
def test__api__parse_string():
"""Basic checking of parse functionality."""
parsed = sqlfluff.parse(my_bad_query)
# Check a JSON object is returned.
assert isinstance(parsed, dict)
# Load in expected result.
with open("test/fixtures/api/parse_test/parse_test.json", "r") as f:
expected_parsed = json.load(f)
# Compare JSON from parse to expected result.
assert parsed == expected_parsed
def test__api__parse_fail():
"""Basic failure mode of parse functionality."""
try:
sqlfluff.parse("Select (1 + 2 +++) FROM mytable as blah blah")
pytest.fail("sqlfluff.parse should have raised an exception.")
except Exception as err:
# Check it's the right kind of exception
assert isinstance(err, sqlfluff.api.APIParsingError)
# Check there are two violations in there.
assert len(err.violations) == 2
# Check it prints nicely.
assert (
str(err)
== """Found 2 issues while parsing string.
Line 1, Position 15: Found unparsable section: '+++'
Line 1, Position 41: Found unparsable section: 'blah'"""
)
def test__api__config_path():
"""Test that we can load a specified config file in the Simple API."""
# Load test SQL file.
with open("test/fixtures/api/config_path_test/config_path_test.sql", "r") as f:
sql = f.read()
# Pass a config path to the Simple API.
parsed = sqlfluff.parse(
sql,
config_path="test/fixtures/api/config_path_test/extra_configs/.sqlfluff",
)
# Load in expected result.
with open("test/fixtures/api/config_path_test/config_path_test.json", "r") as f:
expected_parsed = json.load(f)
# Compare JSON from parse to expected result.
assert parsed == expected_parsed
@pytest.mark.parametrize(
"dialect,config_path,expectation",
[
(None, "test/fixtures/api/config_dialect/.sqlfluff", nullcontext()),
(None, None, pytest.raises(APIParsingError)),
("duckdb", None, nullcontext()),
("ansi", None, pytest.raises(APIParsingError)),
],
)
def test__api__parse_dialect_config_path(dialect, config_path, expectation):
"""Test that we can load a dialect from a config file in the Simple API parse."""
# Load test SQL file.
with open("test/fixtures/api/config_dialect/config_dialect.sql", "r") as f:
sql = f.read()
# Load in expected result.
with open("test/fixtures/api/config_dialect/config_dialect_parse.json", "r") as f:
expected_parsed = json.load(f)
was_parsed = False
with expectation:
# Pass a config path to the Simple API.
parsed = sqlfluff.parse(
sql,
dialect=dialect,
config_path=config_path,
)
was_parsed = True
# Compare JSON from parse to expected result.
assert parsed == expected_parsed
if isinstance(expectation, nullcontext):
assert was_parsed
else:
assert not was_parsed
@pytest.mark.parametrize(
"dialect,config_path,fails",
[
(None, "test/fixtures/api/config_dialect/.sqlfluff", False),
(None, None, True),
("duckdb", None, False),
("ansi", None, True),
],
)
def test__api__lint_dialect_config_path(dialect, config_path, fails):
"""Test that we can load a dialect from a config file in the Simple API lint."""
# Load test SQL file.
with open("test/fixtures/api/config_dialect/config_dialect.sql", "r") as f:
sql = f.read()
# Load in expected result.
issue_type = "prs" if fails else "lt01"
with open(
f"test/fixtures/api/config_dialect/config_dialect_lint_{issue_type}.json", "r"
) as f:
expected_lint = json.load(f)
# Pass a config path to the Simple API.
linted = sqlfluff.lint(
sql,
dialect=dialect,
config_path=config_path,
)
# Compare JSON from lint to expected result.
assert linted == expected_lint
@pytest.mark.parametrize(
"dialect,config_path,fails",
[
(None, "test/fixtures/api/config_dialect/.sqlfluff", False),
(None, None, True),
("duckdb", None, False),
("ansi", None, True),
],
)
def test__api__fix_dialect_config_path(dialect, config_path, fails):
"""Test that we can load a dialect from a config file in the Simple API fix."""
# Load test SQL file.
with open("test/fixtures/api/config_dialect/config_dialect.sql", "r") as f:
sql = f.read()
# Load in expected result.
if fails:
expected_fix = sql
else:
with open("test/fixtures/api/config_dialect/config_dialect_fix.sql", "r") as f:
expected_fix = f.read()
# Pass a config path to the Simple API.
fixed = sqlfluff.fix(
sql,
dialect=dialect,
config_path=config_path,
)
# Compare to expected result.
assert fixed == expected_fix
@pytest.mark.parametrize(
"kwargs,expected",
[
(
# No override from API, so uses .sqlfluff value
{},
set(),
),
(
# API overrides, so it uses that
dict(exclude_rules=["RF02"]),
{"RF04"},
),
],
)
def test__api__config_override(kwargs, expected, tmpdir):
"""Test that parameters to lint() override .sqlfluff correctly (or not)."""
config_path = "test/fixtures/api/config_override/.sqlfluff"
sql = "SELECT TRIM(name) AS name FROM some_table"
lint_results = sqlfluff.lint(sql, config_path=config_path, **kwargs)
assert expected == {"RF02", "RF04"}.intersection(
{lr["code"] for lr in lint_results}
)
def test__api__invalid_dialect():
"""Test that SQLFluffUserError is raised for a bad dialect."""
# Load test SQL file.
with open("test/fixtures/api/config_path_test/config_path_test.sql", "r") as f:
sql = f.read()
# Pass a fake dialect to the API and test the correct error is raised.
with pytest.raises(SQLFluffUserError) as err:
sqlfluff.parse(
sql,
dialect="not_a_real_dialect",
config_path="test/fixtures/api/config_path_test/extra_configs/.sqlfluff",
)
assert str(err.value) == "Error: Unknown dialect 'not_a_real_dialect'"
def test__api__parse_exceptions():
"""Test parse behaviour with errors."""
# Parsable content
result = sqlfluff.parse("SELECT 1")
assert result
# Templater fail
with pytest.raises(APIParsingError):
sqlfluff.parse('SELECT {{ 1 > "a"}}')
# Templater success but parsing fail
with pytest.raises(APIParsingError):
sqlfluff.parse("THIS IS NOT SQL")
|