Merge lp:~sseman/juju-chaos-monkey/description into lp:juju-chaos-monkey

[Seman]

Added a detailed description for each Chaos Monkey command.

[lp:~sseman/juju-chaos-monkey/description]

7. By Seman on 2015-05-08

Renamed a method name to test_create_chaos.

[John George (jog)]

I think this branch should include printing the new descriptions to the log.
We talked about that being done from ChaosMonkey._run_command.

I left some minor in-line comments related to formating and punctuation of the description strings.

[Seman (sseman)]

Thank John for your review. I made updates to all of your suggestions.

[John George (jog)]

Thank you.

review: Approve

[lp:~sseman/juju-chaos-monkey/description]

8. By Seman on 2015-05-10

Added detailed descriptions for each chaos monkey command.

9. By Seman on 2015-05-10

Added detailed descriptions for each chaos monkey command.

=== modified file 'chaos/kill.py'
--- chaos/kill.py	2015-04-30 22:19:31 +0000
+++ chaos/kill.py	2015-05-10 22:05:29 +0000
@@ -56,13 +56,15 @@
                 enable=self.kill_jujud,
                 disable=None,
                 group=self.group,
-                command_str='jujud'))
+                command_str='jujud',
+                description='Jujud process has been killed.'))
         chaos.append(
             Chaos(
                 enable=self.kill_jujud,
                 disable=None,
                 group=self.group,
-                command_str='mongod'))
+                command_str='mongod',
+                description='Mongod process has been killed.'))
         return chaos
 
     def shutdown(self):
 
=== modified file 'chaos/net.py'
--- chaos/net.py	2015-05-07 22:44:14 +0000
+++ chaos/net.py	2015-05-10 22:05:29 +0000
@@ -116,32 +116,37 @@
         chaos.append(
             self.create_chaos(
                 self.deny_all_incoming_and_outgoing_except_ssh,
-                self.allow_all_incoming_and_outgoing, 'deny-all'))
+                self.allow_all_incoming_and_outgoing, 'deny-all',
+                'Deny all incoming and outgoing network traffic except ssh.'))
         chaos.append(
             self.create_chaos(
                 self.deny_all_incoming_except_ssh, self.allow_all_incoming,
-                'deny-incoming'))
+                'deny-incoming',
+                'Deny all incoming network traffic except ssh.'))
         chaos.append(
             self.create_chaos(
                 self.deny_all_outgoing_except_ssh, self.allow_all_outgoing,
-                'deny-outgoing'))
-        chaos.append(self.create_chaos(self.allow_ssh, None, 'allow-ssh'))
+                'deny-outgoing',
+                'Deny all outgoing network traffic except ssh.'))
         chaos.append(
             self.create_chaos(
                 self.deny_state_server, self.allow_state_server,
-                'deny-state-server'))
+                'deny-state-server',
+                'Deny network traffic to the Juju State-Server'))
         chaos.append(
             self.create_chaos(
                 self.deny_api_server, self.allow_api_server,
-                'deny-api-server'))
+                'deny-api-server',
+                'Deny network traffic to the Juju API Server.'))
         chaos.append(
             self.create_chaos(
-                self.deny_sys_log, self.allow_sys_log, 'deny-sys-log'))
+                self.deny_sys_log, self.allow_sys_log, 'deny-sys-log',
+                'Deny network traffic to the Juju SysLog.'))
         return chaos
 
-    def create_chaos(self, enable, disable, command_str):
+    def create_chaos(self, enable, disable, command_str, description):
         return Chaos(enable=enable, disable=disable, group=self.group,
-                     command_str=command_str)
+                     command_str=command_str, description=description)
 
     def shutdown(self):
         self.reset()
 
=== modified file 'chaos_monkey.py'
--- chaos_monkey.py	2015-05-05 19:09:12 +0000
+++ chaos_monkey.py	2015-05-10 22:05:29 +0000
@@ -1,3 +1,4 @@
+import logging
 import random
 from time import sleep
 
@@ -22,6 +23,14 @@
         all_chaos, factory_obj = ChaosMonkey.get_all_chaos()
         return cls([], factory_obj)
 
+    @property
+    def command_tag(self):
+        return ":CHAOS_CMD:"
+
+    @property
+    def description_tag(self):
+        return ":CHAOS_DSCR:"
+
     @staticmethod
     def get_all_chaos():
         all_chaos = []
@@ -89,6 +98,9 @@
                 group, command_str))
 
     def _run_command(self, chaos, timeout=2):
+        logging.info("%s %s %s %s" % (
+            self.command_tag, chaos.command_str, self.description_tag,
+            chaos.description))
         chaos.enable()
         sleep(timeout)
         if chaos.disable:
 
=== modified file 'chaos_monkey_base.py'
--- chaos_monkey_base.py	2015-05-04 07:03:50 +0000
+++ chaos_monkey_base.py	2015-05-10 22:05:29 +0000
@@ -20,11 +20,12 @@
 
 class Chaos:
 
-    def __init__(self, enable, disable, group, command_str):
+    def __init__(self, enable, disable, group, command_str, description):
         self.enable = enable
         self.disable = disable
         self.group = group
         self.command_str = command_str
+        self.description = description
 
     def __eq__(self, other):
         return self.command_str == other.command_str
 
=== modified file 'tests/test_chaos_monkey.py'
--- tests/test_chaos_monkey.py	2015-05-07 22:44:14 +0000
+++ tests/test_chaos_monkey.py	2015-05-10 22:05:29 +0000
@@ -44,15 +44,17 @@
         cm = ChaosMonkey.factory()
         cm.include_group('all')
         with patch('utility.check_output', autospec=True) as mock:
-            cm.run_chaos('net', 'allow-ssh', timeout=0)
-        mock.assert_called_once_with(['ufw', 'allow', 'ssh'])
+            cm.run_chaos('net', 'deny-state-server', timeout=0)
+        self.assertEqual(mock.mock_calls,
+                         [call(['ufw', 'deny', '37017']),
+                          call(['ufw', 'delete', 'deny', '37017'])])
 
     def test_run_chaos_passes_timeout(self):
         cm = ChaosMonkey.factory()
         cm.include_group('all')
         with patch('chaos_monkey.ChaosMonkey._run_command',
                    autospec=True) as mock:
-            cm.run_chaos('net', 'allow-ssh', timeout=0)
+            cm.run_chaos('net', 'deny-all', timeout=0)
         self.assertEqual(0, mock.call_args_list[0][1]['timeout'])
 
     def test_run_chaos_raises_for_command_str(self):
@@ -70,14 +72,14 @@
         with patch('utility.check_output', autospec=True):
             with self.assertRaisesRegexp(
                     NotFound,
-                    "Command not found: group: bar command_str:allow-ssh"):
-                cm.run_chaos('bar', 'allow-ssh', timeout=0)
+                    "Command not found: group: bar command_str:deny-all"):
+                cm.run_chaos('bar', 'deny-all', timeout=0)
 
     def test_run_command(self):
         cm = ChaosMonkey.factory()
         net = Net()
         chaos = Chaos(enable=net.deny_ssh, disable=net.allow_ssh,
-                      group='net', command_str='deny-ssh')
+                      group='net', command_str='deny-ssh', description='fake')
         with patch('utility.check_output', autospec=True) as mock:
             cm._run_command(chaos, timeout=0)
         self.assertEqual(mock.mock_calls, [
@@ -173,7 +175,7 @@
             all(c.command_str == 'deny-incoming' for c in cm.chaos))
 
     def test_include_command_multiple_commands(self):
-        commands = ['deny-incoming', 'allow-ssh']
+        commands = ['deny-incoming', 'deny-all']
         cm = ChaosMonkey.factory()
         cm.include_command(commands)
         self.assertEqual(len(cm.chaos), 2)
@@ -186,15 +188,15 @@
         self.assertEqual(cm.chaos, [])
 
     def test_exclude_command(self):
-        commands = ['allow-ssh']
+        commands = ['deny-all']
         cm = ChaosMonkey.factory()
         cm.include_group('all')
         cm.exclude_command(commands)
         self.assertGreaterEqual(len(cm.chaos), 1)
-        self.assertTrue(all(c.command_str != 'allow-ssh' for c in cm.chaos))
+        self.assertTrue(all(c.command_str != 'deny-all' for c in cm.chaos))
 
     def test_exclude_commands(self):
-        commands = ['allow-ssh', 'jujud']
+        commands = ['deny-all', 'jujud']
         cm = ChaosMonkey.factory()
         cm.include_group('all')
         cm.exclude_command(commands)
@@ -202,7 +204,7 @@
         self.assertTrue(all(c.command_str not in commands for c in cm.chaos))
 
     def test_include_and_exclude_commands(self):
-        commands = ['allow-ssh', 'jujud']
+        commands = ['deny-all', 'jujud']
         cm = ChaosMonkey.factory()
         cm.include_command(commands)
         self.assertGreaterEqual(len(cm.chaos), 1)
@@ -250,7 +252,7 @@
 
     def test_exclude_group_and_include_command(self):
         groups = ['net']
-        commands = ['allow-ssh']
+        commands = ['deny-all']
         cm = ChaosMonkey.factory()
         cm.include_group('all')
         cm.exclude_group(groups)
@@ -258,7 +260,7 @@
         self.assertTrue(all(c.group != 'net' for c in cm.chaos))
         cm.include_command(commands)
         self.assertGreaterEqual(len(cm.chaos), 1)
-        self.assertTrue(any(c.command_str == 'allow-ssh' for c in cm.chaos))
+        self.assertTrue(any(c.command_str == 'deny-all' for c in cm.chaos))
         self.assertTrue(any(c.group == 'net' for c in cm.chaos))
 
     def test_find_command(self):
 
=== modified file 'tests/test_net.py'
--- tests/test_net.py	2015-05-08 18:29:03 +0000
+++ tests/test_net.py	2015-05-10 22:05:29 +0000
@@ -105,12 +105,13 @@
 
     def test_create_chaos(self):
         net = Net()
-        chaos = net.create_chaos('enable', 'disable', 'command')
+        chaos = net.create_chaos('enable', 'disable', 'command', 'description')
         self.assertIs(type(chaos), Chaos)
         self.assertEqual(chaos.enable, 'enable')
         self.assertEqual(chaos.disable, 'disable')
         self.assertEqual(chaos.group, 'net')
         self.assertEqual(chaos.command_str, 'command')
+        self.assertEqual(chaos.description, 'description')
 
     def test_shutdown(self):
         self._run_test('reset', ['ufw', 'reset'])
@@ -126,5 +127,5 @@
 
 
 def get_all_net_commands():
-    return ['deny-all', 'deny-incoming', 'deny-outgoing', 'allow-ssh',
-            'deny-state-server', 'deny-api-server', 'deny-sys-log']
+    return ['deny-all', 'deny-incoming', 'deny-outgoing',  'deny-state-server',
+            'deny-api-server', 'deny-sys-log']
 
=== modified file 'tests/test_runner.py'
--- tests/test_runner.py	2015-05-05 19:09:12 +0000
+++ tests/test_runner.py	2015-05-10 22:05:29 +0000
@@ -258,5 +258,5 @@
 
 
 def add_fake_group(chaos_monkey):
-    chaos = Chaos(None, None, 'fake_group', 'fake_command_str')
+    chaos = Chaos(None, None, 'fake_group', 'fake_command_str', 'description')
     chaos_monkey.append(chaos)