Putting back the fuzzer badge and extending the documentation. (#587)

This commit is contained in:
Daniel Lemire 2020-03-24 05:50:27 -04:00 committed by GitHub
parent d1eef242c6
commit 5af0dfb031
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 3 deletions

View File

@ -12,6 +12,7 @@ This library is part of the [Awesome Modern C++](https://awesomecpp.com) list.
[![Build Status](https://cloud.drone.io/api/badges/simdjson/simdjson/status.svg)](https://cloud.drone.io/simdjson/simdjson)
[![CircleCI](https://circleci.com/gh/simdjson/simdjson.svg?style=svg)](https://circleci.com/gh/simdjson/simdjson)
[![Fuzzing Status](https://oss-fuzz-build-logs.storage.googleapis.com/badges/simdjson.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&q=proj%3Asimdjson&can=2)
[![Build status](https://ci.appveyor.com/api/projects/status/ae77wp5v3lebmu6n/branch/master?svg=true)](https://ci.appveyor.com/project/lemire/simdjson-jmmti/branch/master)
[![][license img]][license]

View File

@ -6,9 +6,15 @@
- https://github.com/lemire/simdjson/issues/351
- https://github.com/lemire/simdjson/issues/345
Simdjson tries to follow [fuzzing best practises](https://google.github.io/oss-fuzz/advanced-topics/ideal-integration/#summary).
The simdjson library tries to follow [fuzzing best practises](https://google.github.io/oss-fuzz/advanced-topics/ideal-integration/#summary).
The simdjson library is continuously fuzzed on [oss-fuzz](https://github.com/google/oss-fuzz).
## Currently open bugs
You can find the currently opened bugs, if any at [bugs.chromium.org](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&q=proj%3Asimdjson&can=2): make sure not to miss the "Open Issues" selector. Bugs that are fixed by follow-up commits are automatically closed.
Simdjson is continuously fuzzed on [oss-fuzz](https://github.com/google/oss-fuzz).
## Fuzzing as a CI job
@ -29,7 +35,7 @@ The corpus will grow over time and easy to find bugs will be detected already du
## Corpus
Simdjson does not benefit from a corpus as much as other projects, because the library is very fast and explores the input space very well. With that said, it is still beneficial to have one. The CI job stores the corpus on bintray between runs, and is available here: https://dl.bintray.com/pauldreik/simdjson-fuzz-corpus/corpus/corpus.tar
The simdjson library does not benefit from a corpus as much as other projects, because the library is very fast and explores the input space very well. With that said, it is still beneficial to have one. The CI job stores the corpus on bintray between runs, and is available here: https://dl.bintray.com/pauldreik/simdjson-fuzz-corpus/corpus/corpus.tar
One can also grab the corpus as an artifact from the github actions job. Pick a run, then go to artifacts and download.