diff options
| author | Nigel Metheringham <nigel.metheringham@jrtheatre.co.uk> | 2012-10-21 10:41:18 +0200 |
|---|---|---|
| committer | Nigel Metheringham <nigel.metheringham@jrtheatre.co.uk> | 2012-10-21 10:41:18 +0200 |
| commit | cc30eb74e2481df108a1517a53fd536518f0ee59 (patch) | |
| tree | df6cfd6d464a6caf00cd1407548f696ef2034b95 /CONTRIBUTING.md | |
| parent | Added comment about long lines in playbooks (diff) | |
| download | ansible-cc30eb74e2481df108a1517a53fd536518f0ee59.tar.xz ansible-cc30eb74e2481df108a1517a53fd536518f0ee59.zip | |
Added some info on the unit tests requirements
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0ecb5b2c7c..8ebbf6b43c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -49,6 +49,17 @@ We're not too strict on style considerations, but we require: * no single-line if statements, deeply nested list comprehensions, or clever use of metaclasses -- keep it simple * comments where appropriate +Testing Requirements +==================== + +Tests are run by "make tests". To run the tests you need the following:- + + * nose must be installed - https://nose.readthedocs.org/en/latest/ + * ansible tests require paramiko, PyYAML and json modules + * The (optional) facter test requires facter to be installed. + * Your user environment should allow "ssh myip" (where myip is your ip address) + without a password - so a key held in ssh-agent and an authorised_keys entry. + Contributors License Agreement ============================== |