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.
235 lines
6.2 KiB
Python
235 lines
6.2 KiB
Python
from dataclasses import replace
|
|
from typing import Any, Iterator
|
|
from unittest.mock import patch
|
|
|
|
import pytest
|
|
|
|
import black
|
|
from tests.util import (
|
|
DEFAULT_MODE,
|
|
PY36_VERSIONS,
|
|
THIS_DIR,
|
|
assert_format,
|
|
dump_to_stderr,
|
|
read_data,
|
|
)
|
|
|
|
SIMPLE_CASES = [
|
|
"beginning_backslash",
|
|
"bracketmatch",
|
|
"class_blank_parentheses",
|
|
"class_methods_new_line",
|
|
"collections",
|
|
"comments",
|
|
"comments2",
|
|
"comments3",
|
|
"comments4",
|
|
"comments5",
|
|
"comments6",
|
|
"comments_non_breaking_space",
|
|
"comment_after_escaped_newline",
|
|
"composition",
|
|
"composition_no_trailing_comma",
|
|
"docstring",
|
|
"empty_lines",
|
|
"expression",
|
|
"fmtonoff",
|
|
"fmtonoff2",
|
|
"fmtonoff3",
|
|
"fmtonoff4",
|
|
"fmtskip",
|
|
"fmtskip2",
|
|
"fmtskip3",
|
|
"fmtskip4",
|
|
"fmtskip5",
|
|
"fmtskip6",
|
|
"fstring",
|
|
"function",
|
|
"function2",
|
|
"function_trailing_comma",
|
|
"import_spacing",
|
|
"remove_parens",
|
|
"slices",
|
|
"string_prefixes",
|
|
"tricky_unicode_symbols",
|
|
"tupleassign",
|
|
]
|
|
|
|
SIMPLE_CASES_PY2 = [
|
|
"numeric_literals_py2",
|
|
"python2",
|
|
"python2_unicode_literals",
|
|
]
|
|
|
|
EXPERIMENTAL_STRING_PROCESSING_CASES = [
|
|
"cantfit",
|
|
"comments7",
|
|
"long_strings",
|
|
"long_strings__edge_case",
|
|
"long_strings__regression",
|
|
"percent_precedence",
|
|
]
|
|
|
|
|
|
SOURCES = [
|
|
"src/black/__init__.py",
|
|
"src/black/__main__.py",
|
|
"src/black/brackets.py",
|
|
"src/black/cache.py",
|
|
"src/black/comments.py",
|
|
"src/black/concurrency.py",
|
|
"src/black/const.py",
|
|
"src/black/debug.py",
|
|
"src/black/files.py",
|
|
"src/black/linegen.py",
|
|
"src/black/lines.py",
|
|
"src/black/mode.py",
|
|
"src/black/nodes.py",
|
|
"src/black/numerics.py",
|
|
"src/black/output.py",
|
|
"src/black/parsing.py",
|
|
"src/black/report.py",
|
|
"src/black/rusty.py",
|
|
"src/black/strings.py",
|
|
"src/black/trans.py",
|
|
"src/blackd/__init__.py",
|
|
"src/blib2to3/pygram.py",
|
|
"src/blib2to3/pytree.py",
|
|
"src/blib2to3/pgen2/conv.py",
|
|
"src/blib2to3/pgen2/driver.py",
|
|
"src/blib2to3/pgen2/grammar.py",
|
|
"src/blib2to3/pgen2/literals.py",
|
|
"src/blib2to3/pgen2/parse.py",
|
|
"src/blib2to3/pgen2/pgen.py",
|
|
"src/blib2to3/pgen2/tokenize.py",
|
|
"src/blib2to3/pgen2/token.py",
|
|
"setup.py",
|
|
"tests/test_black.py",
|
|
"tests/test_blackd.py",
|
|
"tests/test_format.py",
|
|
"tests/test_primer.py",
|
|
"tests/optional.py",
|
|
"tests/util.py",
|
|
"tests/conftest.py",
|
|
]
|
|
|
|
|
|
@pytest.fixture(autouse=True)
|
|
def patch_dump_to_file(request: Any) -> Iterator[None]:
|
|
with patch("black.dump_to_file", dump_to_stderr):
|
|
yield
|
|
|
|
|
|
def check_file(filename: str, mode: black.Mode, *, data: bool = True) -> None:
|
|
source, expected = read_data(filename, data=data)
|
|
assert_format(source, expected, mode, fast=False)
|
|
|
|
|
|
@pytest.mark.parametrize("filename", SIMPLE_CASES_PY2)
|
|
@pytest.mark.python2
|
|
def test_simple_format_py2(filename: str) -> None:
|
|
check_file(filename, DEFAULT_MODE)
|
|
|
|
|
|
@pytest.mark.parametrize("filename", SIMPLE_CASES)
|
|
def test_simple_format(filename: str) -> None:
|
|
check_file(filename, DEFAULT_MODE)
|
|
|
|
|
|
@pytest.mark.parametrize("filename", EXPERIMENTAL_STRING_PROCESSING_CASES)
|
|
def test_experimental_format(filename: str) -> None:
|
|
check_file(filename, black.Mode(experimental_string_processing=True))
|
|
|
|
|
|
@pytest.mark.parametrize("filename", SOURCES)
|
|
def test_source_is_formatted(filename: str) -> None:
|
|
path = THIS_DIR.parent / filename
|
|
check_file(str(path), DEFAULT_MODE, data=False)
|
|
|
|
|
|
# =============== #
|
|
# Complex cases
|
|
# ============= #
|
|
|
|
|
|
def test_empty() -> None:
|
|
source = expected = ""
|
|
assert_format(source, expected)
|
|
|
|
|
|
def test_pep_572() -> None:
|
|
source, expected = read_data("pep_572")
|
|
assert_format(source, expected, minimum_version=(3, 8))
|
|
|
|
|
|
def test_pep_572_remove_parens() -> None:
|
|
source, expected = read_data("pep_572_remove_parens")
|
|
assert_format(source, expected, minimum_version=(3, 8))
|
|
|
|
|
|
def test_pep_572_do_not_remove_parens() -> None:
|
|
source, expected = read_data("pep_572_do_not_remove_parens")
|
|
# the AST safety checks will fail, but that's expected, just make sure no
|
|
# parentheses are touched
|
|
assert_format(source, expected, fast=True)
|
|
|
|
|
|
@pytest.mark.parametrize("major, minor", [(3, 9), (3, 10)])
|
|
def test_pep_572_newer_syntax(major: int, minor: int) -> None:
|
|
source, expected = read_data(f"pep_572_py{major}{minor}")
|
|
assert_format(source, expected, minimum_version=(major, minor))
|
|
|
|
|
|
def test_pep_570() -> None:
|
|
source, expected = read_data("pep_570")
|
|
assert_format(source, expected, minimum_version=(3, 8))
|
|
|
|
|
|
def test_docstring_no_string_normalization() -> None:
|
|
"""Like test_docstring but with string normalization off."""
|
|
source, expected = read_data("docstring_no_string_normalization")
|
|
mode = replace(DEFAULT_MODE, string_normalization=False)
|
|
assert_format(source, expected, mode)
|
|
|
|
|
|
def test_long_strings_flag_disabled() -> None:
|
|
"""Tests for turning off the string processing logic."""
|
|
source, expected = read_data("long_strings_flag_disabled")
|
|
mode = replace(DEFAULT_MODE, experimental_string_processing=False)
|
|
assert_format(source, expected, mode)
|
|
|
|
|
|
def test_numeric_literals() -> None:
|
|
source, expected = read_data("numeric_literals")
|
|
mode = replace(DEFAULT_MODE, target_versions=PY36_VERSIONS)
|
|
assert_format(source, expected, mode)
|
|
|
|
|
|
def test_numeric_literals_ignoring_underscores() -> None:
|
|
source, expected = read_data("numeric_literals_skip_underscores")
|
|
mode = replace(DEFAULT_MODE, target_versions=PY36_VERSIONS)
|
|
assert_format(source, expected, mode)
|
|
|
|
|
|
@pytest.mark.python2
|
|
def test_python2_print_function() -> None:
|
|
source, expected = read_data("python2_print_function")
|
|
mode = replace(DEFAULT_MODE, target_versions={black.TargetVersion.PY27})
|
|
assert_format(source, expected, mode)
|
|
|
|
|
|
def test_stub() -> None:
|
|
mode = replace(DEFAULT_MODE, is_pyi=True)
|
|
source, expected = read_data("stub.pyi")
|
|
assert_format(source, expected, mode)
|
|
|
|
|
|
def test_python38() -> None:
|
|
source, expected = read_data("python38")
|
|
assert_format(source, expected, minimum_version=(3, 8))
|
|
|
|
|
|
def test_python39() -> None:
|
|
source, expected = read_data("python39")
|
|
assert_format(source, expected, minimum_version=(3, 9))
|