Build docs: document fuzz testing for control protocol.
authorDavin McCall <davmac@davmac.org>
Thu, 13 Sep 2018 18:20:53 +0000 (19:20 +0100)
committerDavin McCall <davmac@davmac.org>
Thu, 13 Sep 2018 18:20:53 +0000 (19:20 +0100)
BUILD

diff --git a/BUILD b/BUILD
index 2f1f13213b9f0ebc7d7b22562f792d026a884b2e..4895ecf658dbf2df891d56d3fc9554249f7f482f 100644 (file)
--- a/BUILD
+++ b/BUILD
@@ -50,6 +50,20 @@ If you get this, either disable the address sanitizer or make sure you have over
 
 Any test failures will abort the test suite run immediately.
 
+In addition to the standard test suite, there is experimental support for fuzzing the control
+protocol handling using LLVM/clang's fuzzer (libFuzzer). Change to the `src/tests/cptests`
+directory and build the "fuzz" target:
+
+    make fuzz
+
+Then create a "corpus" directory and run the fuzzer:
+
+    mkdir corpus
+    ./fuzz corpus
+
+This will auto-generate test data as it finds input which triggers new execution paths. Check
+libFuzzer documentation for further details.
+
 
 Special note for GCC/Libstdc++
 =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-