octo-deno/README.md
2017-06-10 13:00:08 +02:00

2.2 KiB

Build Status Coverage Status JavaScript Style
Guide IRC Current Release Downloads

Octo.js is a unified shared library which aids in building fuzzers for browsers or as complement for an already existing fuzzing framework.

It bundles core functions and generic boilerplate code commonly used in most frameworks for fuzzing browsers. It is designed for the sharing of improvements between our individual fuzzers, and with the purpose of reducing the maintainability of those core features with minimal effort.

Octo's future is a stable, well-tested and well-documented standard library for fuzzing in a JavaScript environment.

Usage

<!-- Latest -->
https://mozillasecurity.github.io/octo/octo.js

<!-- Release -->
https://github.com/mozillasecurity/octo/releases/download/0.1/octo.js

Development

./build.py -l lib -d deploy

Testing

Tests live in the tests/ subdirectory, and are written for QUnit. To run tests locally, open tests/index.html in a browser. The automated tests are run in Firefox or Chrome using Karma. To run the automated tests:

npm install
CHROME_BIN=chromium npm test

When adding new files, add them in index.html and karma.conf.js so they can be tested and included in coverage reports.