From cc30eb74e2481df108a1517a53fd536518f0ee59 Mon Sep 17 00:00:00 2001 From: Nigel Metheringham Date: Sun, 21 Oct 2012 09:41:18 +0100 Subject: [PATCH] Added some info on the unit tests requirements --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0ecb5b2c7c6..8ebbf6b43cf 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 ==============================