def get_linter_and_formatter(
cfg: FluffConfig,
silent: bool = False) -> Tuple[Linter, CallbackFormatter]:
"""Get a linter object given a config."""
try:
# We're just making sure it exists at this stage.
# It will be fetched properly in the linter.
dialect_selector(cfg.get("dialect"))
except KeyError: # pragma: no cover
click.echo(f"Error: Unknown dialect '{cfg.get('dialect')}'")
sys.exit(66)
if not silent:
# Instantiate the linter and return it (with an output function)
formatter = CallbackFormatter(
callback=_callback_handler(cfg=cfg),
verbosity=cfg.get("verbose"),
output_line_length=cfg.get("output_line_length"),
)
return Linter(config=cfg, formatter=formatter), formatter
else:
# Instantiate the linter and return. NB: No formatter
# in the Linter and a black formatter otherwise.
formatter = CallbackFormatter(callback=lambda m: None, verbosity=0)
return Linter(config=cfg), formatter
def test__config__get():
"""Test FluffConfig.get method."""
cfg = FluffConfig(config_b)
assert cfg.get("rules") == "L007"
assert cfg.get("rulez") is None
assert cfg.get("rulez", section="core", default=123) == 123
assert (cfg.get("operator_new_lines",
section=["rules", "L007"],
default=None) == "before")
assert (cfg.get("operator_new_lines",
section=["rules", "ASDFSDG007"],
default=None) is None)
def assert_rule_fail_in_sql(code, sql, configs=None, runaway_limit=20):
"""Assert that a given rule does fail on the given sql."""
# Configs allows overrides if we want to use them.
cfg = FluffConfig(configs=configs)
r = get_rule_from_set(code, config=cfg)
parsed, _, _ = Linter(config=cfg).parse_string(sql)
print("Parsed:\n {0}".format(parsed.stringify()))
lerrs, _, _, _ = r.crawl(parsed, dialect=cfg.get("dialect_obj"), fix=True)
print("Errors Found: {0}".format(lerrs))
if not any(v.rule.code == code for v in lerrs):
pytest.fail(
"No {0} failures found in query which should fail.".format(code),
pytrace=False,
)
fixed = parsed # use this as our buffer (yes it's a bit of misnomer right here)
loop_idx = 0
while loop_idx < runaway_limit:
# We get the errors again, but this time skip the assertion
# because we're in the loop. If we asserted on every loop then
# we're stuffed.
lerrs, _, _, _ = r.crawl(fixed,
dialect=cfg.get("dialect_obj"),
fix=True)
print("Errors Found: {0}".format(lerrs))
fixes = []
for e in lerrs:
fixes += e.fixes
if not fixes:
print("Done")
break
print("Fixes to apply: {0}".format(fixes))
l_fixes = fixes # Save the fixes to compare to later
fixed, fixes = fixed.apply_fixes(fixes)
# iterate until all fixes applied
if fixes:
if fixes == l_fixes:
raise RuntimeError(
"Fixes aren't being applied: {0!r}".format(fixes))
loop_idx += 1
else:
raise ValueError(
"Runaway loop limit reached for rule! This example never stabilises."
)
return fixed.raw
def get_linter_and_formatter(
cfg: FluffConfig, output_stream: Optional[OutputStream] = None
) -> Tuple[Linter, OutputStreamFormatter]:
"""Get a linter object given a config."""
try:
# We're just making sure it exists at this stage.
# It will be fetched properly in the linter.
dialect = cfg.get("dialect")
if dialect:
dialect_selector(dialect)
except KeyError: # pragma: no cover
click.echo(f"Error: Unknown dialect '{cfg.get('dialect')}'")
sys.exit(EXIT_ERROR)
formatter = OutputStreamFormatter(
output_stream=output_stream or make_output_stream(cfg),
nocolor=cfg.get("nocolor"),
verbosity=cfg.get("verbose"),
output_line_length=cfg.get("output_line_length"),
)
return Linter(config=cfg, formatter=formatter), formatter
def assert_rule_pass_in_sql(code, sql, configs=None):
"""Assert that a given rule doesn't fail on the given sql."""
# Configs allows overrides if we want to use them.
cfg = FluffConfig(configs=configs)
r = get_rule_from_set(code, config=cfg)
parsed, _, _ = Linter(config=cfg).parse_string(sql)
print("Parsed:\n {0}".format(parsed.stringify()))
lerrs, _, _, _ = r.crawl(parsed, dialect=cfg.get("dialect_obj"), fix=True)
print("Errors Found: {0}".format(lerrs))
if any(v.rule.code == code for v in lerrs):
pytest.fail(
"Found {0} failures in query which should pass.".format(code), pytrace=False
)
