Skip to content

Commit

Permalink
Clarify documentation for setting up a BridgeDB test instance.
Browse files Browse the repository at this point in the history
 * 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>
  • Loading branch information
pagea authored and isislovecruft committed Jan 8, 2015
1 parent 3972bfa commit 43f6d7b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.rst
Expand Up @@ -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
Expand Down
17 changes: 17 additions & 0 deletions doc/HACKING.md
Expand Up @@ -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
Expand Down

0 comments on commit 43f6d7b

Please sign in to comment.