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
|
import locale
import re
import subprocess
import sys
from pathlib import Path
from typing import List
import pytest
from click.testing import CliRunner
from sqlfmt.cli import sqlfmt as sqlfmt_main
from tests.util import copy_config_file_to_dst
def run_cli_command(commands: List[str]) -> subprocess.CompletedProcess:
process = subprocess.run(
commands,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
universal_newlines=True,
shell=True,
)
return process
@pytest.mark.skipif(
sys.platform.startswith("win"),
reason="Fails on GHA windows runner, can't repro locally",
)
@pytest.mark.parametrize(
"cmd",
[
"sqlfmt --no-progressbar",
"python -m sqlfmt --no-progressbar",
],
)
def test_click_cli_runner_is_equivalent_to_py_subprocess(
sqlfmt_runner: CliRunner, cmd: str
) -> None:
builtin_results = run_cli_command([cmd])
click_results = sqlfmt_runner.invoke(sqlfmt_main)
assert builtin_results.returncode == click_results.exit_code
assert builtin_results.stdout == click_results.stdout
assert builtin_results.stderr == click_results.stderr
assert "https://sqlfmt.com" in click_results.stderr
assert "sqlfmt ." in click_results.stderr
def test_help_command(sqlfmt_runner: CliRunner) -> None:
# Sally installs sqlfmt; not knowing where to start, she types "sqlfmt --help" into
# her command line, and sees that it displays the version and a help menu
help_option = "--help"
help_results = sqlfmt_runner.invoke(sqlfmt_main, args=help_option)
assert help_results.exit_code == 0
assert help_results.stdout.startswith("Usage: sqlfmt")
def test_version_command(sqlfmt_runner: CliRunner) -> None:
version_option = "--version"
results = sqlfmt_runner.invoke(sqlfmt_main, args=version_option)
assert results.exit_code == 0
assert results.stdout.startswith("sqlfmt, version ")
semver_pattern = r"\d+\.\d+.\d+"
match = re.search(semver_pattern, results.stdout)
assert match, "Semantic version number not in output"
def test_stdin(sqlfmt_runner: CliRunner) -> None:
stream_input = "select 1"
results = sqlfmt_runner.invoke(sqlfmt_main, args="-", input=stream_input)
assert results.exit_code == 0
assert results.stdout == "select 1\n"
def test_preformatted_check(sqlfmt_runner: CliRunner, preformatted_dir: Path) -> None:
args = f"{preformatted_dir.as_posix()} --check"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 0
assert "passed formatting check" in results.stderr
args = f"{preformatted_dir.as_posix()}"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args, env={"SQLFMT_CHECK": "1"})
assert results.exit_code == 0
assert "passed formatting check" in results.stderr
def test_preformatted_short_lines_env(
sqlfmt_runner: CliRunner, preformatted_dir: Path
) -> None:
args = f"{preformatted_dir.as_posix()}"
results = sqlfmt_runner.invoke(
sqlfmt_main, args=args, env={"SQLFMT_LINE_LENGTH": "1"}
)
assert results.exit_code == 0
print(results.stderr)
assert "5 files formatted" in results.stderr
# test that CLI flag overrides ENV VAR
args = f"{preformatted_dir.as_posix()} -l 88 --check"
results = sqlfmt_runner.invoke(
sqlfmt_main, args=args, env={"SQLFMT_LINE_LENGTH": "1"}
)
assert results.exit_code == 0
print(results.stderr)
assert "6 files passed formatting check" in results.stderr
def test_unformatted_check(sqlfmt_runner: CliRunner, unformatted_dir: Path) -> None:
args = f"{unformatted_dir.as_posix()} --check"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 1
assert "failed formatting check" in results.stderr
args = f"{unformatted_dir.as_posix()}"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args, env={"SQLFMT_CHECK": "1"})
assert results.exit_code == 1
assert "failed formatting check" in results.stderr
def test_error_check(sqlfmt_runner: CliRunner, error_dir: Path) -> None:
args = f"{error_dir.as_posix()} --check"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 2
def test_preformatted_single_process(
sqlfmt_runner: CliRunner, preformatted_dir: Path
) -> None:
args = f"{preformatted_dir.as_posix()} --single-process"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 0
def test_preformatted_config_file(
sqlfmt_runner: CliRunner, preformatted_dir: Path
) -> None:
# config file sets line length to 100 and enables check mode
copy_config_file_to_dst("valid_sqlfmt_config.toml", preformatted_dir)
args = f"{preformatted_dir.as_posix()}"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
# 3 files should fail formatting with longer line length in config
assert results.exit_code == 1
assert results.stderr.startswith("3 files failed formatting check")
# supply CLI args to override config file so checks pass
args = f"{preformatted_dir.as_posix()} --line-length 88"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 0
def test_preformatted_exclude_all(
sqlfmt_runner: CliRunner, preformatted_dir: Path
) -> None:
args = (
f"{preformatted_dir.as_posix()} --exclude {preformatted_dir.as_posix()}/*.sql"
)
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 0
assert results.stderr.startswith("0 files left unchanged")
def test_preformatted_clickhouse(
sqlfmt_runner: CliRunner, preformatted_dir: Path
) -> None:
args = f"{preformatted_dir.as_posix()} --check --dialect clickhouse"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 0
def test_preformatted_no_progressbar(
sqlfmt_runner: CliRunner, preformatted_dir: Path
) -> None:
args = f"{preformatted_dir.as_posix()} --check --no-progressbar"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 0
@pytest.mark.parametrize("option", ["--fast", "--safe"])
def test_preformatted_fast_safe(
sqlfmt_runner: CliRunner, preformatted_dir: Path, option: str
) -> None:
args = f"{preformatted_dir.as_posix()} --check {option}"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 0
def test_preformatted_utf_8_sig_encoding(
sqlfmt_runner: CliRunner, preformatted_dir: Path
) -> None:
args = f"{preformatted_dir.as_posix()} --check --encoding utf-8-sig"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 0
def test_preformatted_inherit_encoding(
sqlfmt_runner: CliRunner, preformatted_dir: Path
) -> None:
args = f"{preformatted_dir.as_posix()} --check --encoding inherit"
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
if locale.getpreferredencoding().lower().replace("-", "_") == "utf_8":
assert results.exit_code == 0
else:
# this directory includes a file that starts with a BOM. We'll
# get a weird symbol if decoded with anything other than utf-8,
# like cp-1252, which is the default on many Windows machines
assert results.exit_code == 2
assert results.stderr.startswith("1 file had errors")
assert "006_has_bom.sql" in results.stderr
assert "Could not parse SQL at position 1" in results.stderr
def test_config_option(sqlfmt_runner: CliRunner, preformatted_dir: Path) -> None:
copy_config_file_to_dst("valid_sqlfmt_config.toml", preformatted_dir)
args = (
f"{preformatted_dir.as_posix()} "
f"--config {(preformatted_dir / 'pyproject.toml').as_posix()} "
"--check"
)
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
# 3 files should fail formatting with longer line length in config
assert results.exit_code == 1
assert results.stderr.startswith("3 files failed formatting check")
args = f"{preformatted_dir.as_posix()} --check"
results = sqlfmt_runner.invoke(
sqlfmt_main,
args=args,
env={"SQLFMT_CONFIG": f"{preformatted_dir.as_posix()}/pyproject.toml"},
)
assert results.exit_code == 1
assert results.stderr.startswith("3 files failed formatting check")
# supply CLI args to override config file so checks pass
args = (
f"{preformatted_dir.as_posix()} "
f"--config {(preformatted_dir / 'pyproject.toml').as_posix()} "
"--line-length 88 --check"
)
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 0
# supply CLI args to override config file so checks pass
args = f"{preformatted_dir.as_posix()} --line-length 88 --check"
results = sqlfmt_runner.invoke(
sqlfmt_main,
args=args,
env={"SQLFMT_CONFIG": f"{preformatted_dir.as_posix()}/pyproject.toml"},
)
assert results.exit_code == 0
def test_config_does_not_exist(
sqlfmt_runner: CliRunner, preformatted_dir: Path
) -> None:
# make sure sqlfmt fails fast if the passed config doesn't exist
args = (
f"--config {preformatted_dir.as_posix()}/does_not_exist.toml "
f"{preformatted_dir.as_posix()}"
)
results = sqlfmt_runner.invoke(sqlfmt_main, args=args)
assert results.exit_code == 2
assert "Error: Invalid value for '--config'" in results.stderr
assert "does not exist" in results.stderr
args = f"{preformatted_dir.as_posix()}"
results = sqlfmt_runner.invoke(
sqlfmt_main,
args=args,
env={"SQLFMT_CONFIG": f"{preformatted_dir.as_posix()}/does_not_exist.toml"},
)
assert results.exit_code == 2
assert "Error: Invalid value for '--config'" in results.stderr
assert "does not exist" in results.stderr
|