testing.md

Development & Testing

To run all of the JavaScript tests:

npm run test

To run tests against the bindings, as defined in bindings.gyp the regtest feature of Bitcoin Core is used, and to enable this feature we currently need to build with the wallet enabled (not a part of the regular build). To do this, export an environment variable and recompile:

export BITCORENODE_ENV=test
npm run build

If you do not already have mocha installed:

npm install mocha -g

To run the integration tests:

mocha -R spec integration/regtest.js

If any changes have been made to the bindings in the "src" directory, manually compile the Node.js bindings, as defined in bindings.gyp, you can run (-d for debug):

$ node-gyp -d rebuild

Note: node-gyp can be installed with npm install node-gyp -g

To be able to debug you'll need to have gdb and node compiled for debugging with gdb using --gdb (sometimes called node_g), and you can then run:

$ gdb --args node examples/node.js

To run mocha from within gdb (notice _mocha and not mocha so that the tests run in the same process):

$ gdb --args node /path/to/_mocha -R spec integration/regtest.js

To run the benchmarks:

$ cd benchmarks
$ node index.js