poanetwork
/
hbbft
mirror of https://github.com/poanetwork/hbbft.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #224 from poanetwork/ag-README-testing 

Update testing instructions
This commit is contained in:
Andrew Gross 2018-09-05 22:12:36 -06:00 committed by GitHub
parent 56198e3e1f d8277ed8de
commit 6a727fd281
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -63,11 +63,15 @@ Requires `rust` and `cargo`: [installation instructions.](https://www.rust-lang.
$ cargo build [--release]
```
### Test
### Testing
```
$ cargo test --release
$ MLOCK_SECRETS=false cargo test --release
```
The [MLOCK_SECRETS](https://github.com/poanetwork/threshold_crypto#environment-variables) envvar is associated with the `threshold_crypto` dependency and **should only be used in development and testing**. The test suite can run without setting `MLOCK_SECRETS=false`, however, it runs faster when it is set and ensures tests won't fail if the testing system's locked memory limit is reached.
See the [tests README](tests/README.md) for more information on our testing toolkit.
### Example Network Simulation
@ -168,7 +172,7 @@ This project is licensed under the GNU Lesser General Public License v3.0. See t
* Other language implementations
* [Python](https://github.com/amiller/HoneyBadgerBFT)
* [Python](https://github.com/initc3/HoneyBadgerBFT-Python)
* [Go](https://github.com/anthdm/hbbft)