LBRYCommunity/lbrycrd
1
0
Fork 0
Code Issues 29 Pull requests 1 Projects Releases 32 Packages Wiki Activity

Merge #14526: docs: Document lint tests

Browse source 
8640631ebc docs: Document lint tests (Mason Simon)

Pull request description:

  Replaces #13708.
  Fixed the macOS nit, and added `codespell` as a requirement.

Tree-SHA512: efdef8238f9d4433cc6403f58075b906d39d6a2114821cb113a16f2fc45d0c10c603588272865edd40a0498d9685ff8ac25d2491d9fcf0f1f328b6d65751ac2c
This commit is contained in:
MarcoFalke 2018-10-20 23:08:59 -03:00
commit 73cddb36a8
No known key found for this signature in database
GPG key ID: D2EA4850E7528B25
1 changed files with 25 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
test/README.md
View file

@ -3,17 +3,18 @@ utilities in their entirety. It does not contain unit tests, which
can be found in [/src/test](/src/test), [/src/wallet/test](/src/wallet/test),
etc.
There are currently two sets of tests in this directory:
This directory contains the following sets of tests:
- [functional](/test/functional) which test the functionality of
bitcoind and bitcoin-qt by interacting with them through the RPC and P2P
interfaces.
- [util](/test/util) which tests the bitcoin utilities, currently only
bitcoin-tx.
- [lint](/test/lint/) which perform various static analysis checks.
The util tests are run as part of `make check` target. The functional
tests are run by the travis continuous build process whenever a pull
request is opened. Both sets of tests can also be run locally.
tests and lint scripts are run by the travis continuous build process whenever a pull
request is opened. All sets of tests can also be run locally.
# Running tests locally
@ -30,7 +31,7 @@ The ZMQ functional test requires a python ZMQ library. To install it:
#### Running the tests
Individual tests can be run by directly calling the test script, eg:
Individual tests can be run by directly calling the test script, e.g.:
```
test/functional/feature_rbf.py
@ -180,6 +181,26 @@ Note: gdb attach step may require `sudo`
Util tests can be run locally by running `test/util/bitcoin-util-test.py`.
Use the `-v` option for verbose output.
### Lint tests
#### Dependencies
The lint tests require codespell and flake8. To install: `pip3 install codespell flake8`.
#### Running the tests
Individual tests can be run by directly calling the test script, e.g.:
```
test/lint/lint-filenames.sh
```
You can run all the shell-based lint tests by running:
```
test/lint/lint-all.sh
```
# Writing functional tests
You are encouraged to write functional tests for new or existing features.