Skip to content

Commit

Permalink
README: extend the integration testing section
Browse files Browse the repository at this point in the history
  • Loading branch information
nusenu committed Mar 25, 2018
1 parent ebf10bd commit 7063837
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -284,16 +284,35 @@ We do not ultimately trust every tor relay we operate (we try to perform input v

**Be aware that the ansible control machine stores ALL your relay keys (RSA and Ed25519) - apply security measures accordingly.**

Testing
Integration Testing
-----------------------

Install `test-kitchen` and ansible plugin using `gem`:
This ansible role comes with a .kitchen.yml file, that can be used
to test relayor - using different configurations - against Vagrant Virtualbox machines.
It is primarily used for development/integration testing (spot regressions)
but you can also use it to get familiar with relayor in such a local playground environment.
These tor relays will not join the network since they are only created for testing purposes.

kitchen will download Vagrant boxes from Vagrant cloud to create test VMs.

The following platforms are currently available in the kitchen file:
* freebsd-10
* freebsd-11
* debian-9
* debian-8
* ubuntu-16.04
* centos-7
* fedora-27

To get started install the required gem packages:

```bash
gem install test-kitchen kitchen-ansiblepush kitchen-vagrant
```

Then you can run tests with `kitchen test`.
List available test instances with `kitchen list`.

Then you can run all tests or just select specific instances, for example: `kitchen test t-guard-debian-9`.

Note that to run tests, you also need Vagrant and VirtualBox.

Expand Down

0 comments on commit 7063837

Please sign in to comment.