3500e1cda5
The main goals of this commit include: * improving consistency on how strict the test suite is -- Jelle has seen cases where a test did not fail to an incomplete test setup even though it should've * simplifying tests for both ease of creation and reading via parametrization and helpers * reorganizing the test suite by grouping more tests * dropping test suite dependencies that aren't strictly necessary The test suite could definitely do with more refactoring, but this is a good first pass. Anyway it would've gotten too big to review effectively if I did continue on this PR. Commit history before squash merge: * Drop parameterized dep and refactor format tests Since the test suite is already using pytest-only features we can drop the parameterized test dependency in favour of pytest's own offering. I also added an utility function called assert_format that makes it even easier to verify Black formats some code correctly. We already have great tooling if the case is very simple in test_format.py but any sort of complication makes it hard to use. Also if you're writing a non-standard test case, you have to be careful to include all of the steps so issues don't go undetected. assert_format aims to 1) improve consistency, 2) avoid wasted CPU cycles, and 3) avoid logical errors that hide issues. Finally, quite a few tests were either moved and/or simplified with the new setup. * Move file collection tests * Add assert_collected_sources helper function Testing source collection involves a lot of repetitive boilerplate, something that black.files.get_sources's signature does not help with. So to cut down on boilerplate like `report=black.Report()` I added a convenience function to tests/test_black.py which wraps black.get_sources. Its signature is designed to be much more lax to make it much easier to use. Somehow this leads to cutting 100 lines! Also IMO the test cases are much easier to read since it's more declarative than really procedural now. * Run isort on some test files * Move cache tests * Use pytest-style asserts & add parametrization * Drop now unnecessary test dependencies *pytest-cases might be interesting for further refactoring but I haven't been able to wrap my head around it for the time being. We can always revisit anyway.
126 lines
4.0 KiB
Python
126 lines
4.0 KiB
Python
import os
|
|
import sys
|
|
import unittest
|
|
from contextlib import contextmanager
|
|
from functools import partial
|
|
from pathlib import Path
|
|
from typing import Any, Iterator, List, Optional, Tuple
|
|
|
|
import black
|
|
from black.debug import DebugVisitor
|
|
from black.mode import TargetVersion
|
|
from black.output import err, out
|
|
|
|
THIS_DIR = Path(__file__).parent
|
|
DATA_DIR = THIS_DIR / "data"
|
|
PROJECT_ROOT = THIS_DIR.parent
|
|
EMPTY_LINE = "# EMPTY LINE WITH WHITESPACE" + " (this comment will be removed)"
|
|
DETERMINISTIC_HEADER = "[Deterministic header]"
|
|
|
|
PY36_VERSIONS = {
|
|
TargetVersion.PY36,
|
|
TargetVersion.PY37,
|
|
TargetVersion.PY38,
|
|
TargetVersion.PY39,
|
|
}
|
|
|
|
DEFAULT_MODE = black.Mode()
|
|
ff = partial(black.format_file_in_place, mode=DEFAULT_MODE, fast=True)
|
|
fs = partial(black.format_str, mode=DEFAULT_MODE)
|
|
|
|
|
|
def _assert_format_equal(expected: str, actual: str) -> None:
|
|
if actual != expected and not os.environ.get("SKIP_AST_PRINT"):
|
|
bdv: DebugVisitor[Any]
|
|
out("Expected tree:", fg="green")
|
|
try:
|
|
exp_node = black.lib2to3_parse(expected)
|
|
bdv = DebugVisitor()
|
|
list(bdv.visit(exp_node))
|
|
except Exception as ve:
|
|
err(str(ve))
|
|
out("Actual tree:", fg="red")
|
|
try:
|
|
exp_node = black.lib2to3_parse(actual)
|
|
bdv = DebugVisitor()
|
|
list(bdv.visit(exp_node))
|
|
except Exception as ve:
|
|
err(str(ve))
|
|
|
|
assert actual == expected
|
|
|
|
|
|
def assert_format(
|
|
source: str,
|
|
expected: str,
|
|
mode: black.Mode = DEFAULT_MODE,
|
|
*,
|
|
fast: bool = False,
|
|
minimum_version: Optional[Tuple[int, int]] = None,
|
|
) -> None:
|
|
"""Convenience function to check that Black formats as expected.
|
|
|
|
You can pass @minimum_version if you're passing code with newer syntax to guard
|
|
safety guards so they don't just crash with a SyntaxError. Please note this is
|
|
separate from TargetVerson Mode configuration.
|
|
"""
|
|
actual = black.format_str(source, mode=mode)
|
|
_assert_format_equal(expected, actual)
|
|
# It's not useful to run safety checks if we're expecting no changes anyway. The
|
|
# assertion right above will raise if reality does actually make changes. This just
|
|
# avoids wasted CPU cycles.
|
|
if not fast and source != expected:
|
|
# Unfortunately the AST equivalence check relies on the built-in ast module
|
|
# being able to parse the code being formatted. This doesn't always work out
|
|
# when checking modern code on older versions.
|
|
if minimum_version is None or sys.version_info >= minimum_version:
|
|
black.assert_equivalent(source, actual)
|
|
black.assert_stable(source, actual, mode=mode)
|
|
|
|
|
|
def dump_to_stderr(*output: str) -> str:
|
|
return "\n" + "\n".join(output) + "\n"
|
|
|
|
|
|
class BlackBaseTestCase(unittest.TestCase):
|
|
def assertFormatEqual(self, expected: str, actual: str) -> None:
|
|
_assert_format_equal(expected, actual)
|
|
|
|
|
|
def read_data(name: str, data: bool = True) -> Tuple[str, str]:
|
|
"""read_data('test_name') -> 'input', 'output'"""
|
|
if not name.endswith((".py", ".pyi", ".out", ".diff")):
|
|
name += ".py"
|
|
base_dir = DATA_DIR if data else PROJECT_ROOT
|
|
return read_data_from_file(base_dir / name)
|
|
|
|
|
|
def read_data_from_file(file_name: Path) -> Tuple[str, str]:
|
|
with open(file_name, "r", encoding="utf8") as test:
|
|
lines = test.readlines()
|
|
_input: List[str] = []
|
|
_output: List[str] = []
|
|
result = _input
|
|
for line in lines:
|
|
line = line.replace(EMPTY_LINE, "")
|
|
if line.rstrip() == "# output":
|
|
result = _output
|
|
continue
|
|
|
|
result.append(line)
|
|
if _input and not _output:
|
|
# If there's no output marker, treat the entire file as already pre-formatted.
|
|
_output = _input[:]
|
|
return "".join(_input).strip() + "\n", "".join(_output).strip() + "\n"
|
|
|
|
|
|
@contextmanager
|
|
def change_directory(path: Path) -> Iterator[None]:
|
|
"""Context manager to temporarily chdir to a different directory."""
|
|
previous_dir = os.getcwd()
|
|
try:
|
|
os.chdir(path)
|
|
yield
|
|
finally:
|
|
os.chdir(previous_dir)
|