commit 43f6d7b9512e23e19797c6dd398c8ad0d02d4239 Author: Alden S. Page <pagea@allegheny.edu> Date: Tue Dec 23 23:35:39 2014 -0500 Clarify documentation for setting up a BridgeDB test instance. * CHANGE doc/HACKING.md and README.rst to mention leekspin installation. * THANKS to Alden Page for the patch. Signed-off-by: Isis Lovecruft <isis@torproject.org> --- README.rst | 3 +++ doc/HACKING.md | 17 +++++++++++++++++ 2 files changed, 20 insertions(+) diff --git a/README.rst b/README.rst index 8a33983..617dbd1 100644 --- a/README.rst +++ b/README.rst @@ -312,6 +312,9 @@ To create a bunch of fake bridge descriptors to test BridgeDB, do:: bridgedb mock [-n NUMBER_OF_DESCRIPTORS] +Note that you will need to install ``leekspin`` in order to run the +``bridgedb mock``. See HACKING.md for details. + And finally, to run the test suites, do:: make coverage diff --git a/doc/HACKING.md b/doc/HACKING.md index 0fda25a..22f9b2b 100644 --- a/doc/HACKING.md +++ b/doc/HACKING.md @@ -9,6 +9,23 @@ big that doesn't have a ticket, you should probably make one. If you don't want to register for a Trac account, you can use the ```cypherpunks``` account with password ```writecode```. +## Generating bridge descriptors + +Developers wishing to test BridgeDB will need to generate mock bridge +descriptors. This is accomplished through the [leekspin +script](https://gitweb.torproject.org/user/isis/leekspin.git). To generate 20 +bridge descriptors, change to the bridgedb running directory and do: + + $ leekspin -n 20 + +It is recommended that you generate at least 250 descriptors for testing. +Ideally, even more descriptors should be generated, somewhere in the realm of +2000, as certain bugs do not emerge until BridgeDB is processing thousands of +descriptors. + +**Leekspin is for testing purposes only and should never be deployed on a +production server.** We do not want to distribute fake bridges. + ## Git Workflow See this article on git branching [workflow][workflow]. The only modifications