From 5204516dee1dda49b81a76dc7343bad3ec24996b Mon Sep 17 00:00:00 2001 From: Jesse Schwartzentruber Date: Mon, 10 Apr 2017 14:14:01 -0400 Subject: [PATCH] Update README with test structure. --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3874036..3d53c59 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,19 @@ -![](http://people.mozilla.com/~cdiehl/img/octo.png) +[![Build Status](https://api.travis-ci.org/MozillaSecurity/octo.svg?branch=master)](https://travis-ci.org/MozillaSecurity/octo) [![Coverage Status](https://coveralls.io/repos/github/MozillaSecurity/octo/badge.svg?branch=master)](https://coveralls.io/github/MozillaSecurity/octo?branch=master) +![](http://people.mozilla.com/~cdiehl/img/octo.png) A fuzzing framework for JavaScript -[![Build Status](https://api.travis-ci.org/MozillaSecurity/octo.svg?branch=master)](https://travis-ci.org/MozillaSecurity/octo) [![Coverage Status](https://coveralls.io/repos/github/MozillaSecurity/octo/badge.svg?branch=master)](https://coveralls.io/github/MozillaSecurity/octo?branch=master) - - - This is WIP. +## Testing +Tests live in the `tests/` subdirectory, and are written for [QUnit](https://qunitjs.com/). +To run tests locally, open `tests/index.html` in a browser. +The automated tests are run in Firefox/Chrome using [Karma](https://karma-runner.github.io/). +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.