doc: Describe log files + consistent paths in test READMEs

This commit is contained in:
Martin Erlandsson
2019-04-16 14:49:42 +02:00
committed by Fabian Jahr
parent 561a7d3047
commit 9576614d2d
2 changed files with 31 additions and 19 deletions

View File

@@ -88,7 +88,7 @@ By default, up to 4 tests will be run in parallel by test_runner. To specify
how many jobs to run, append `--jobs=n`
The individual tests and the test_runner harness have many command-line
options. Run `test_runner.py -h` to see them all.
options. Run `test/functional/test_runner.py -h` to see them all.
#### Troubleshooting and debugging test failures
@@ -101,7 +101,7 @@ killed all its bitcoind nodes), then there may be a port conflict which will
cause the test to fail. It is recommended that you run the tests on a system
where no other bitcoind processes are running.
On linux, the test_framework will warn if there is another
On linux, the test framework will warn if there is another
bitcoind process running when the tests are started.
If there are zombie bitcoind processes after test failure, you can kill them
@@ -130,7 +130,7 @@ tests will fail. If this happens, remove the cache directory (and make
sure bitcoind processes are stopped as above):
```bash
rm -rf cache
rm -rf test/cache
killall bitcoind
```
@@ -149,6 +149,15 @@ levels using the logger included in the test_framework, e.g.
fails, the `test_framework.log` and bitcoind `debug.log`s will all be dumped
to the console to help troubleshooting.
These log files can be located under the test data directory (which is always
printed in the first line of test output):
- `<test data directory>/test_framework.log`
- `<test data directory>/node<node number>/regtest/debug.log`.
The node number identifies the relevant test node, starting from `node0`, which
corresponds to its position in the nodes list of the specific test,
e.g. `self.nodes[0]`.
To change the level of logs output to the console, use the `-l` command line
argument.
@@ -157,7 +166,7 @@ aggregate log by running the `combine_logs.py` script. The output can be plain
text, colorized text or html. For example:
```
combine_logs.py -c <test data directory> | less -r
test/functional/combine_logs.py -c <test data directory> | less -r
```
will pipe the colorized logs from the test into less.