New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Add dependency info to test docs #7635

Merged
merged 1 commit into from Mar 11, 2016

Conversation

Projects
None yet
5 participants
@elliotolds
Contributor

elliotolds commented Mar 3, 2016

When following the build instructions and then trying to run the RPC tests,
a unix user would get an error when python tried to import zmq.

This change updates the docs to let the user know how to install
the required dependencies before running the RPC tests.

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.

@elliotolds

This comment has been minimized.

Show comment
Hide comment
@elliotolds

elliotolds Mar 3, 2016

Contributor

I could also make the following change to the test itself, to check whether zmq is installed and warn the user if not: elliotolds@ed067f7

However, I'm not planning to submit that pull request unless people request it, because I feel the benefit is minor and not worth the extra code complexity.

Contributor

elliotolds commented Mar 3, 2016

I could also make the following change to the test itself, to check whether zmq is installed and warn the user if not: elliotolds@ed067f7

However, I'm not planning to submit that pull request unless people request it, because I feel the benefit is minor and not worth the extra code complexity.

@laanwj

This comment has been minimized.

Show comment
Hide comment
@laanwj

laanwj Mar 3, 2016

Member

elliotolds/bitcoin@ed067f7 makes a lot of sense to me in combination with this documentation change.
A few extra, independent, lines in the test runner won't be rejected for "code complexity" reasons :)

Member

laanwj commented Mar 3, 2016

elliotolds/bitcoin@ed067f7 makes a lot of sense to me in combination with this documentation change.
A few extra, independent, lines in the test runner won't be rejected for "code complexity" reasons :)

@laanwj laanwj added the Docs label Mar 3, 2016

@jmcorgan

This comment has been minimized.

Show comment
Hide comment
@jmcorgan

jmcorgan Mar 3, 2016

Contributor

ACK. I agree also on ed067f7, except it has a typo ("import zmp") on line 49.

Contributor

jmcorgan commented Mar 3, 2016

ACK. I agree also on ed067f7, except it has a typo ("import zmp") on line 49.

@paveljanik

View changes

Show outdated Hide outdated README.md
=================
Before running the tests, the following must be installed.
Unix

This comment has been minimized.

@paveljanik

paveljanik Mar 3, 2016

Contributor

Looks like the command here doesn't even apply to all GNU/Linux based systems but only to apt-get based systems. Unix -> Linux at least?

@paveljanik

paveljanik Mar 3, 2016

Contributor

Looks like the command here doesn't even apply to all GNU/Linux based systems but only to apt-get based systems. Unix -> Linux at least?

This comment has been minimized.

@elliotolds

elliotolds Mar 3, 2016

Contributor

Just updated with a clarification that the instructions are for Ubuntu and Debian, as done in /doc/build-unix.md

@elliotolds

elliotolds Mar 3, 2016

Contributor

Just updated with a clarification that the instructions are for Ubuntu and Debian, as done in /doc/build-unix.md

```
sudo apt-get install python-zmq
```
Running tests

This comment has been minimized.

@MarcoFalke

MarcoFalke Mar 3, 2016

Member

Nit: As you are already touching this file, mind to add a line to mention an undocumented arg below?

--coverage (this generates a basic coverage report for the RPC)

@MarcoFalke

MarcoFalke Mar 3, 2016

Member

Nit: As you are already touching this file, mind to add a line to mention an undocumented arg below?

--coverage (this generates a basic coverage report for the RPC)

@laanwj

This comment has been minimized.

Show comment
Hide comment
@laanwj

laanwj Mar 7, 2016

Member

utACK after squash

Member

laanwj commented Mar 7, 2016

utACK after squash

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.

@laanwj laanwj merged commit 2ab835a into bitcoin:master Mar 11, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

laanwj added a commit that referenced this pull request Mar 11, 2016

Merge #7635: [Documentation] Add dependency info to test docs
2ab835a Check if zmq is installed in tests, update docs (Elliot Olds)

@elliotolds elliotolds deleted the elliotolds:docs4 branch Mar 19, 2016

MarcoFalke added a commit to MarcoFalke/bitcoin that referenced this pull request Jun 9, 2016

nomnombtc added a commit to nomnombtc/bitcoin that referenced this pull request Nov 12, 2016

codablock added a commit to codablock/dash that referenced this pull request Sep 16, 2017

Merge #7635: [Documentation] Add dependency info to test docs
2ab835a Check if zmq is installed in tests, update docs (Elliot Olds)

codablock added a commit to codablock/dash that referenced this pull request Sep 19, 2017

Merge #7635: [Documentation] Add dependency info to test docs
2ab835a Check if zmq is installed in tests, update docs (Elliot Olds)

codablock added a commit to codablock/dash that referenced this pull request Dec 9, 2017

Merge #7635: [Documentation] Add dependency info to test docs
2ab835a Check if zmq is installed in tests, update docs (Elliot Olds)

codablock added a commit to codablock/dash that referenced this pull request Dec 19, 2017

Merge #7635: [Documentation] Add dependency info to test docs
2ab835a Check if zmq is installed in tests, update docs (Elliot Olds)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment