From 963305db6ed3370dfaaca0e5e70fc3c26aa652b9 Mon Sep 17 00:00:00 2001 From: Shay Nehmad Date: Tue, 7 May 2019 17:36:22 +0300 Subject: [PATCH] Added usage documentation to the unit tests --- monkey/monkey_island/cc/models/test_monkey.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/monkey/monkey_island/cc/models/test_monkey.py b/monkey/monkey_island/cc/models/test_monkey.py index 2c4a171df..23f26addb 100644 --- a/monkey/monkey_island/cc/models/test_monkey.py +++ b/monkey/monkey_island/cc/models/test_monkey.py @@ -12,6 +12,13 @@ from monkey_ttl import MonkeyTtl class TestMonkey(TestCase): + """ + Make sure to set server environment to `testing` in server.json! Otherwise this will mess up your mongo instance and + won't work. + + Also, the working directory needs to be the working directory from which you usually run the island so the + server.json file is found and loaded. + """ def test_is_dead(self): # Arrange alive_monkey_ttl = MonkeyTtl(expire_at=datetime.now() + timedelta(seconds=30))