view contrib/fuzz/README.rst @ 42678:f95b59ffc307

byteify-strings: add --treat-as-kwargs argument to handle kwargs-like objects

This argument will help extensions move to Python 3 as keyword arguments
should not be byte-prefixed. Most of the time, code bases will call this
object `kwargs`, but other conventions exist like `opts`, so it should make
sense to allow for custom names.

This is a best effort solution that does minimal static checking; cases like

`options = [o for o in ('a', 'b', 'c') if kwargs.get(o)]`

and other just as complicated will not be detected.

How to add fuzzers (partially cribbed from oss-fuzz[0]):

  1) git clone https://github.com/google/oss-fuzz
  2) cd oss-fuzz
  3) python infra/helper.py build_image mercurial
  4) docker run --cap-add=SYS_PTRACE -it -v $HG_REPO_PATH:/hg-new \
         gcr.io/oss-fuzz/mercurial bash
  5) cd /src
  6) rm -r mercurial
  7) ln -s /hg-new mercurial
  8) cd mercurial
  9) compile
  10) ls $OUT

Step 9 is literally running the command "compile", which is part of
the docker container. Once you have that working, you can build the
fuzzers like this (in the oss-fuzz repo):

python infra/helper.py build_fuzzers --sanitizer address mercurial $HG_REPO_PATH

(you can also say "memory", "undefined" or "coverage" for
sanitizer). Then run the built fuzzers like this:

python infra/helper.py run_fuzzer mercurial -- $FUZZER

0: https://github.com/google/oss-fuzz/blob/master/docs/new_project_guide.md