Skip to content

Commit ebcd378

Browse files
committed
docs: documents the existing outputs
1 parent 00a0465 commit ebcd378

File tree

2 files changed

+15
-1
lines changed

2 files changed

+15
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you observe an incorrect behavior while using Hathor headless wallet, see [th
2323
The Hathor headless wallet is tested automatically with unit tests and integration tests. See the following documentation for more information:
2424
- [Testing guidelines](/docs/testing.md)
2525

26-
Eventually, some changes to plugins or scripts may require specific testing not covered by those automated tests, but those should be analysed case by case on each PR.
26+
Eventually, some changes to plugins or scripts may require specific testing not covered by those automated tests, but those should be analyzed case by case on each PR.
2727

2828
## Contributing
2929

docs/testing.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,20 @@ On the [`./setupTests-integration.js` file](https://github.com/HathorNetwork/hat
4747
- All benchmarks files are handled to measure test times
4848
- The precalculated wallets persistent file is handled between test suites
4949

50+
### Log and debug outputs
51+
52+
All the logs generated by the integration tests are stored in the `tmp/` folder.
53+
- Each test suite has its own log file named after the suite file name
54+
- The application logs are stored on the `tmp/app.log` file
55+
- Other helper logs are stored in their respective files
56+
57+
On the CI context, all logs inside the `tmp` folder are collected and attached to the test run as _artifacts_ for further investigation. On the CI console, only `warn` and `error` logs are printed to avoid cluttering the output.
58+
59+
To find this artifact:
60+
- Open the GitHub Actions run page
61+
- Scroll to the bottom and find the `Upload debug transaction logs` section
62+
- Find the `Artifact download URL` and click it
63+
5064
### Sequential running
5165

5266
Currently the integration tests must be executed in sequence using the `--runInBand` jest feature. This means many of the tests expects the previous ones to have been run sucessfully and put the network state in a specific condition.

0 commit comments

Comments
 (0)