aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Beregszaszi <alex@rtfs.hu>2016-11-28 21:13:42 +0800
committerAlex Beregszaszi <alex@rtfs.hu>2016-11-29 04:33:09 +0800
commit83892399f08aba920cdd50b36bf928fd20cfff45 (patch)
treeb5e5cc6342658432d68baff98720be069233237c
parent4a67a2862c34b5c0ce86f6a2508da20d9e1bcdc4 (diff)
downloaddexon-solidity-83892399f08aba920cdd50b36bf928fd20cfff45.tar.gz
dexon-solidity-83892399f08aba920cdd50b36bf928fd20cfff45.tar.zst
dexon-solidity-83892399f08aba920cdd50b36bf928fd20cfff45.zip
Explain how to run soltest
-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.