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

wireprotov2: allow multiple fields to follow revision maps...

wireprotov2: allow multiple fields to follow revision maps The *data wire protocol commands emit a series of CBOR values. Because revision/delta data may be large, their data is emitted outside the map as a top-level bytestring value. Before this commit, we'd emit a single optional bytestring value after the revision descriptor map. This got the job done. But it was limiting in that we could only send a single field. And, it required the consumer to know that the presence of a key in the map implied the existence of a following bytestring value. This commit changes the encoding strategy so top-level bytestring values in the stream are explicitly denoted in a "fieldsfollowing" key. This key contains an array defining what fields that follow and the expected size of each field. By defining things this way, we can easily send N bytestring values without any ambiguity about their order. In addition, clients only need to know how to parse ``fieldsfollowing`` to know if extra values are present. Because this breaks backwards compatibility, we've bumped the version number of the wire protocol version 2 API endpoint. Differential Revision: https://phab.mercurial-scm.org/D4620

Augie Fackler - - Load All Authors

File last commit:

r36716:e437de38 default


                r39839:d059cb66

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