Skip to content

Commit fa050bb

Browse files
author
MarcoFalke
committed
test: Update test README and lint script
1 parent 245462b commit fa050bb

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

ci/lint/04_install.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ update-alternatives --install /usr/bin/clang-format-diff clang-format-diff $(whi
1313

1414
${CI_RETRY_EXE} pip3 install codespell==2.0.0
1515
${CI_RETRY_EXE} pip3 install flake8==3.8.3
16-
${CI_RETRY_EXE} pip3 install yq
1716
${CI_RETRY_EXE} pip3 install mypy==0.781
1817
${CI_RETRY_EXE} pip3 install vulture==2.3
1918

doc/fuzzing.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@ $ FUZZ=process_message src/test/fuzz/fuzz
1616
# abort fuzzing using ctrl-c
1717
```
1818

19+
There is also a runner script to execute all fuzz targets. Refer to
20+
`./test/fuzz/test_runner.py --help` for more details.
21+
1922
## Fuzzing harnesses and output
2023

2124
[`process_message`](https://github.com/bitcoin/bitcoin/blob/master/src/test/fuzz/process_message.cpp) is a fuzzing harness for the [`ProcessMessage(...)` function (`net_processing`)](https://github.com/bitcoin/bitcoin/blob/master/src/net_processing.cpp). The available fuzzing harnesses are found in [`src/test/fuzz/`](https://github.com/bitcoin/bitcoin/tree/master/src/test/fuzz).

test/README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,24 @@ etc.
55

66
This directory contains the following sets of tests:
77

8+
- [fuzz](/test/fuzz) A runner to execute all fuzz targets from
9+
[/src/test/fuzz](/src/test/fuzz).
810
- [functional](/test/functional) which test the functionality of
911
bitcoind and bitcoin-qt by interacting with them through the RPC and P2P
1012
interfaces.
11-
- [util](/test/util) which tests the bitcoin utilities, currently only
12-
bitcoin-tx.
13+
- [util](/test/util) which tests the utilities (bitcoin-util, bitcoin-tx, ...).
1314
- [lint](/test/lint/) which perform various static analysis checks.
1415

15-
The util tests are run as part of `make check` target. The functional
16+
The util tests are run as part of `make check` target. The fuzz tests, functional
1617
tests and lint scripts can be run as explained in the sections below.
1718

1819
# Running tests locally
1920

2021
Before tests can be run locally, Bitcoin Core must be built. See the [building instructions](/doc#building) for help.
2122

23+
## Fuzz tests
24+
25+
See [/doc/fuzzing.md](/doc/fuzzing.md)
2226

2327
### Functional tests
2428

@@ -269,7 +273,6 @@ Use the `-v` option for verbose output.
269273
| [`lint-python.sh`](lint/lint-python.sh) | [flake8](https://gitlab.com/pycqa/flake8) | [3.8.3](https://github.com/bitcoin/bitcoin/pull/19348) | `pip3 install flake8==3.8.3`
270274
| [`lint-python.sh`](lint/lint-python.sh) | [mypy](https://github.com/python/mypy) | [0.781](https://github.com/bitcoin/bitcoin/pull/19348) | `pip3 install mypy==0.781`
271275
| [`lint-shell.sh`](lint/lint-shell.sh) | [ShellCheck](https://github.com/koalaman/shellcheck) | [0.7.2](https://github.com/bitcoin/bitcoin/pull/21749) | [details...](https://github.com/koalaman/shellcheck#installing)
272-
| [`lint-shell.sh`](lint/lint-shell.sh) | [yq](https://github.com/kislyuk/yq) | default | `pip3 install yq`
273276
| [`lint-spelling.sh`](lint/lint-spelling.sh) | [codespell](https://github.com/codespell-project/codespell) | [2.0.0](https://github.com/bitcoin/bitcoin/pull/20817) | `pip3 install codespell==2.0.0`
274277

275278
Please be aware that on Linux distributions all dependencies are usually available as packages, but could be outdated.

0 commit comments

Comments
 (0)