aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Beregszaszi <alex@rtfs.hu>2017-09-06 05:33:50 +0800
committerGitHub <noreply@github.com>2017-09-06 05:33:50 +0800
commitfb1db58def97a740b70dd74bf521a15a8fb1190a (patch)
tree66e4b9c07e8f210d815e5b2ed91becf23bfe6df8
parentf242331cc0600e971fa24eede3d3dc36df30bc33 (diff)
parent818a3719296db56852da9a21ae06f305c15f8343 (diff)
downloaddexon-solidity-fb1db58def97a740b70dd74bf521a15a8fb1190a.tar.gz
dexon-solidity-fb1db58def97a740b70dd74bf521a15a8fb1190a.tar.zst
dexon-solidity-fb1db58def97a740b70dd74bf521a15a8fb1190a.zip
Merge pull request #2842 from ethereum/chriseth-patch-1
Explain how to run the tests in more detail.
-rw-r--r--docs/contributing.rst11
1 files changed, 8 insertions, 3 deletions
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 <https://github.com/ethereum/cpp-ethereum/releases/download/solidityTester/eth>`_ 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
========