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
|
"""The Test file for CLI Formatters."""
import pathlib
import re
import textwrap
import pytest
from sqlfluff.cli.commands import fix
from sqlfluff.cli.formatters import OutputStreamFormatter
from sqlfluff.cli.outputstream import FileOutput
from sqlfluff.core import FluffConfig
from sqlfluff.core.errors import SQLLintError
from sqlfluff.core.parser import RawSegment
from sqlfluff.core.parser.markers import PositionMarker
from sqlfluff.core.rules import RuleGhost
from sqlfluff.core.templaters.base import TemplatedFile
from sqlfluff.core.types import Color
def escape_ansi(line):
"""Remove ANSI color codes for testing."""
ansi_escape = re.compile("\u001b\\[[0-9]+(;[0-9]+)?m")
return ansi_escape.sub("", line)
def test__cli__formatters__filename_nocol(tmpdir):
"""Test formatting filenames."""
formatter = OutputStreamFormatter(
FileOutput(FluffConfig(require_dialect=False), str(tmpdir / "out.txt")), False
)
res = formatter.format_filename("blahblah", success=True)
assert escape_ansi(res) == "== [blahblah] PASS"
def test__cli__formatters__violation(tmpdir):
"""Test formatting violations.
NB Position is 1 + start_pos.
"""
s = RawSegment(
"foobarbar",
PositionMarker(
slice(10, 19),
slice(10, 19),
TemplatedFile.from_string(" \n\n foobarbar"),
),
)
r = RuleGhost("A", "some-name", "DESC")
v = SQLLintError(description=r.description, segment=s, rule=r)
formatter = OutputStreamFormatter(
FileOutput(FluffConfig(require_dialect=False), str(tmpdir / "out.txt")), False
)
f = formatter.format_violation(v)
# Position is 3, 3 because foobarbar is on the third
# line (i.e. it has two newlines preceding it) and
# it's at the third position in that line (i.e. there
# are two characters between it and the preceding
# newline).
assert escape_ansi(f) == "L: 3 | P: 3 | A | DESC [some-name]"
def test__cli__helpers__colorize(tmpdir):
"""Test ANSI colouring."""
formatter = OutputStreamFormatter(
FileOutput(FluffConfig(require_dialect=False), str(tmpdir / "out.txt")), False
)
# Force color output for this test.
formatter.plain_output = False
assert formatter.colorize("foo", Color.red) == "\u001b[31mfoo\u001b[0m"
def test__cli__helpers__cli_table(tmpdir):
"""Test making tables."""
vals = [("a", 3), ("b", "c"), ("d", 4.7654), ("e", 9)]
formatter = OutputStreamFormatter(
FileOutput(FluffConfig(require_dialect=False), str(tmpdir / "out.txt")), False
)
txt = formatter.cli_table(vals, col_width=7, divider_char="|", label_color=None)
# NB: No trailing newline
assert txt == "a: 3|b: c\nd: 4.77|e: 9"
@pytest.mark.parametrize(
"sql,fix_args,expected",
[
(
(
"CREATE TABLE IF NOT EXISTS vuln.software_name_dictionary("
"id SERIAL PRIMARY KEY"
"rule VARCHAR(30)"
");"
),
["--force", "--dialect", "postgres", "--disable-progress-bar", "--nocolor"],
(
"CREATE TABLE IF NOT EXISTS vuln.software_name_dictionary("
"id SERIAL PRIMARY KEY"
"rule VARCHAR(30)"
");"
),
)
],
)
def test__cli__fix_no_corrupt_file_contents(sql, fix_args, expected, tmpdir):
"""Test how the fix cli command creates files.
Ensure there is no incorrect output from stderr
that makes it to the file.
"""
tmp_path = pathlib.Path(str(tmpdir))
filepath = tmp_path / "testing.sql"
filepath.write_text(textwrap.dedent(sql))
with tmpdir.as_cwd():
with pytest.raises(SystemExit):
fix(fix_args)
with open(tmp_path / "testing.sql", "r") as fin:
actual = fin.read()
# Ensure no corruption in formatted file
assert actual.strip() == expected.strip()
|
