diff options
| author | Elliot Olds <elliotolds@gmail.com> | 2016-03-10 03:12:40 -0800 |
|---|---|---|
| committer | Elliot Olds <elliotolds@gmail.com> | 2016-03-10 15:41:13 -0800 |
| commit | 2ab835ae6c02de14264896d571c0bba230a1e9f0 (patch) | |
| tree | 9ec3ff34fabe47e7f32580502b8cf2668a821346 /qa | |
| parent | 409f843f2ed25412b8eec9c158f71eaa2e55ebd3 (diff) | |
| download | bitcoin-2ab835ae6c02de14264896d571c0bba230a1e9f0.tar.xz | |
Check if zmq is installed in tests, update docs
If ZMQ is enabled, check whether it's installed before running ZMQ tests.
If it isn't, disable ZMQ and print a warning.
Also add dependency info to test docs, so users know ZMQ is required
before running tests, and so they know how to install it.
When following the build instructions before this change then trying
to run the RPC tests, a unix user would get an error when python
tried to import zmq.
There may be other dependencies that should be added to the docs,
particularly ones for non-unix systems. This is the only unlisted
dependency I encountered using linux.
Diffstat (limited to 'qa')
| -rw-r--r-- | qa/README.md | 11 | ||||
| -rwxr-xr-x | qa/pull-tester/rpc-tests.py | 9 |
2 files changed, 20 insertions, 0 deletions
diff --git a/qa/README.md b/qa/README.md index 758d1f47e5..2b476c4d8d 100644 --- a/qa/README.md +++ b/qa/README.md @@ -5,6 +5,17 @@ Every pull request to the bitcoin repository is built and run through the regression test suite. You can also run all or only individual tests locally. +Test dependencies +================= +Before running the tests, the following must be installed. + +Unix +---- +The python-zmq library is required. On Ubuntu or Debian it can be installed via: +``` +sudo apt-get install python-zmq +``` + Running tests ============= diff --git a/qa/pull-tester/rpc-tests.py b/qa/pull-tester/rpc-tests.py index 7649c1183b..485888e9b4 100755 --- a/qa/pull-tester/rpc-tests.py +++ b/qa/pull-tester/rpc-tests.py @@ -40,6 +40,15 @@ if not vars().has_key('ENABLE_UTILS'): ENABLE_UTILS=0 if not vars().has_key('ENABLE_ZMQ'): ENABLE_ZMQ=0 + +# python-zmq may not be installed. Handle this gracefully and with some helpful info +if ENABLE_ZMQ: + try: + import zmq + except ImportError: + print("WARNING: \"import zmq\" failed. Setting ENABLE_ZMQ=0. " \ + "To run zmq tests, see dependency info in /qa/README.md.") + ENABLE_ZMQ=0 ENABLE_COVERAGE=0 |