upstream/mercurial-mirror Files · contrib/fuzz/README.rst

fuzz: use a more standard approach to allow local builds of fuzzers...

fuzz: use a more standard approach to allow local builds of fuzzers This is taken from the (improved since we started fuzzing) guide on ideal integrations. Rather than have our own wonky targets for building outside the fuzzer universe, we have a driver program we carry along and use when we're not using LibFuzzer. This will let us jettison a fair amount of goo. contrib/fuzz/standalone_fuzz_target_runner.cc is https://github.com/google/oss-fuzz/ file projects/example/my-api-repo/standalone from git revision c4579d9358a73ea5dbcc99cb985de1f2bf76dcf7, reformatted with out clang-format settings and a no-check-code comment added. It allows running a single test input through a fuzzer, rather than performing ongoing fuzzing as libfuzzer would. contrib/fuzz/FuzzedDataProvider.h is https://github.com/llvm/llvm-project/ file /compiler-rt/include/fuzzer/FuzzedDataProvider.h from git revision a44ef027ebca1598892ea9b104d6189aeb3bc2f0, reformatted with our clang-format settings and a no-check-code comment added. We can discard this if we instead want to add an hghave check for a new enough llvm that includes FuzzedDataProvder.h in the fuzzer headers. Differential Revision: https://phab.mercurial-scm.org/D7564

Augie Fackler - - Load All Authors

File last commit:

r36716:e437de38 default


                r44265:5a9e2ae9

default

Download file

             README.rst
        
                    26 lines
            
             | 894 B
            
                | text/x-rst
            
             |
                RstLexer
            
             / contrib / fuzz / README.rst
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Augie Fackler
    
fuzz: add a quick README to try and document how to test new fuzzers...

              r36698
            
      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

        Augie Fackler
    
fuzz: add some more docs about building/running fuzzers...

              r36716
            
        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

        Augie Fackler
    
fuzz: add a quick README to try and document how to test new fuzzers...

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

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

Augie Fackler fuzz: add a quick README to try and document how to test new fuzzers...	r36698	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
Augie Fackler fuzz: add some more docs about building/running fuzzers...	r36716	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
Augie Fackler fuzz: add a quick README to try and document how to test new fuzzers...	r36698
		0: https://github.com/google/oss-fuzz/blob/master/docs/new_project_guide.md