fuzz.py

   1 """Property-based tests for Black.
   2
   3 By Zac Hatfield-Dodds, based on my Hypothesmith tool for source code
   4 generation.  You can run this file with `python`, `pytest`, or (soon)
   5 a coverage-guided fuzzer I'm working on.
   6 """
   7
   8 import re
   9
  10 import hypothesmith
  11 from hypothesis import HealthCheck, given, settings, strategies as st
  12
  13 import black
  14 from blib2to3.pgen2.tokenize import TokenError
  15
  16
  17 # This test uses the Hypothesis and Hypothesmith libraries to generate random
  18 # syntatically-valid Python source code and run Black in odd modes.
  19 @settings(
  20     max_examples=1000,  # roughly 1k tests/minute, or half that under coverage
  21     derandomize=True,  # deterministic mode to avoid CI flakiness
  22     deadline=None,  # ignore Hypothesis' health checks; we already know that
  23     suppress_health_check=HealthCheck.all(),  # this is slow and filter-heavy.
  24 )
  25 @given(
  26     # Note that while Hypothesmith might generate code unlike that written by
  27     # humans, it's a general test that should pass for any *valid* source code.
  28     # (so e.g. running it against code scraped of the internet might also help)
  29     src_contents=hypothesmith.from_grammar() | hypothesmith.from_node(),
  30     # Using randomly-varied modes helps us to exercise less common code paths.
  31     mode=st.builds(
  32         black.FileMode,
  33         line_length=st.just(88) | st.integers(0, 200),
  34         string_normalization=st.booleans(),
  35         preview=st.booleans(),
  36         is_pyi=st.booleans(),
  37         magic_trailing_comma=st.booleans(),
  38     ),
  39 )
  40 def test_idempotent_any_syntatically_valid_python(
  41     src_contents: str, mode: black.FileMode
  42 ) -> None:
  43     # Before starting, let's confirm that the input string is valid Python:
  44     compile(src_contents, "<string>", "exec")  # else the bug is in hypothesmith
  45
  46     # Then format the code...
  47     try:
  48         dst_contents = black.format_str(src_contents, mode=mode)
  49     except black.InvalidInput:
  50         # This is a bug - if it's valid Python code, as above, Black should be
  51         # able to cope with it.  See issues #970, #1012, #1358, and #1557.
  52         # TODO: remove this try-except block when issues are resolved.
  53         return
  54     except TokenError as e:
  55         if (  # Special-case logic for backslashes followed by newlines or end-of-input
  56             e.args[0] == "EOF in multi-line statement"
  57             and re.search(r"\\($|\r?\n)", src_contents) is not None
  58         ):
  59             # This is a bug - if it's valid Python code, as above, Black should be
  60             # able to cope with it.  See issue #1012.
  61             # TODO: remove this block when the issue is resolved.
  62             return
  63         raise
  64
  65     # And check that we got equivalent and stable output.
  66     black.assert_equivalent(src_contents, dst_contents)
  67     black.assert_stable(src_contents, dst_contents, mode=mode)
  68
  69     # Future test: check that pure-python and mypyc versions of black
  70     # give identical output for identical input?
  71
  72
  73 if __name__ == "__main__":
  74     # Run tests, including shrinking and reporting any known failures.
  75     test_idempotent_any_syntatically_valid_python()
  76
  77     # If Atheris is available, run coverage-guided fuzzing.
  78     # (if you want only bounded fuzzing, just use `pytest fuzz.py`)
  79     try:
  80         import sys
  81         import atheris
  82     except ImportError:
  83         pass
  84     else:
  85         test = test_idempotent_any_syntatically_valid_python
  86         atheris.Setup(sys.argv, test.hypothesis.fuzz_one_input)
  87         atheris.Fuzz()