aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDaniel Kirchner <daniel@ekpyron.org>2018-03-12 20:33:37 +0800
committerDaniel Kirchner <daniel@ekpyron.org>2018-03-13 18:20:11 +0800
commit3232561d979954f0625102d33cf042fc5eda7211 (patch)
treed2551396fd88e5e4c7658e4a13791976ac82cb4b /docs
parent317c1f7fa36a24259a3c678fad255406df9da64d (diff)
downloaddexon-solidity-3232561d979954f0625102d33cf042fc5eda7211.tar.gz
dexon-solidity-3232561d979954f0625102d33cf042fc5eda7211.tar.zst
dexon-solidity-3232561d979954f0625102d33cf042fc5eda7211.zip
Refactoring; fuse SyntaxTestParser and SyntaxTester to SyntaxTest.
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing.rst15
1 files changed, 11 insertions, 4 deletions
diff --git a/docs/contributing.rst b/docs/contributing.rst
index a5efba8b..8b4695e4 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -69,15 +69,22 @@ 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,
some others require ``libz3`` to be installed.
-To disable the z3 tests, use ``./build/test/soltest -- --no-smt`` and
-to run a subset of the tests that do not require ``cpp-ethereum``, use ``./build/test/soltest -- --no-ipc``.
+``soltest`` reads test contracts that are annotated with expected results
+stored in ``./test/libsolidity/syntaxTests``. In order for soltest to find these
+tests the root test directory has to be specified using the ``--testpath`` command
+line option, e.g. ``./build/test/soltest -- --testpath ./test``.
+
+To disable the z3 tests, use ``./build/test/soltest -- --no-smt --testpath ./test`` and
+to run a subset of the tests that do not require ``cpp-ethereum``, use
+``./build/test/soltest -- --no-ipc --testpath ./test``.
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``.
+Then you run the actual tests: ``./build/test/soltest -- --ipcpath /tmp/testeth/geth.ipc --testpath ./test``.
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 ``*``.
+``soltest -t TestSuite/TestName -- --ipcpath /tmp/testeth/geth.ipc --testpath ./test``,
+where ``TestName`` can be a wildcard ``*``.
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).