From 818a3719296db56852da9a21ae06f305c15f8343 Mon Sep 17 00:00:00 2001 From: chriseth Date: Tue, 29 Aug 2017 12:06:09 +0200 Subject: Explain how to run the tests in more detail. --- docs/contributing.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'docs/contributing.rst') diff --git a/docs/contributing.rst b/docs/contributing.rst index 9d1b2ce3..01caa5b1 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -66,14 +66,19 @@ Running the compiler tests Solidity includes different types of tests. They are included in the application called ``soltest``. Some of them require the ``cpp-ethereum`` client in testing mode. -To run ``cpp-ethereum`` in testing mode: ``eth --test -d /tmp/testeth``. +To run a subset of the tests that do not require ``cpp-ethereum``, use ``./build/test/soltest -- --no-ipc``. -To run the tests: ``soltest -- --ipcpath /tmp/testeth/geth.ipc``. +For all other tests, you need to install `cpp-ethereum `_ and run it in testing mode: ``eth --test -d /tmp/testeth``. + +Then you run the actual tests: ``./build/test/soltest -- --ipcpath /tmp/testeth/geth.ipc``. To run a subset of tests, filters can be used: ``soltest -t TestSuite/TestName -- --ipcpath /tmp/testeth/geth.ipc``, where ``TestName`` can be a wildcard ``*``. -Alternatively, there is a testing script at ``scripts/test.sh`` which executes all tests. +Alternatively, there is a testing script at ``scripts/test.sh`` which executes all tests and runs +``cpp-ethereum`` automatically if it is in the path (but does not download it). + +Travis CI even runs some additional tests (including ``solc-js`` and testing third party Solidity frameworks) that require compiling the Emscripten target. Whiskers ======== -- cgit v1.2.3