aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorchriseth <chris@ethereum.org>2016-11-30 01:15:49 +0800
committerGitHub <noreply@github.com>2016-11-30 01:15:49 +0800
commitf70f8cf06aea5dcd44b6256b040e05d2a3f7045d (patch)
treed0e322b7a6d78f60a09abb835cacc97b267707b4 /docs
parent071cbc4a9d78c3fad4136c88f0bb5919a19c28d7 (diff)
parent83892399f08aba920cdd50b36bf928fd20cfff45 (diff)
downloaddexon-solidity-f70f8cf06aea5dcd44b6256b040e05d2a3f7045d.tar.gz
dexon-solidity-f70f8cf06aea5dcd44b6256b040e05d2a3f7045d.tar.zst
dexon-solidity-f70f8cf06aea5dcd44b6256b040e05d2a3f7045d.zip
Merge pull request #1445 from ethereum/doc-testing
Explain how to run soltest
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.rst15
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 111fb932..42204d5c 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -59,3 +59,18 @@ for this project. Also, even though we do CI testing, please test your code and
ensure that it builds locally before submitting a pull request.
Thank you for your help!
+
+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 the tests: ``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.