Add descriptions for end-to-end tests

Author: mnaberez

supervisor/tests/test_end_to_end.py

@@ -21,6 +21,8 @@
 class EndToEndTests(BaseTestCase):
 
     def test_issue_550(self):
+        """When an environment variable is set in the [supervisord] section,
+        it should be put into the environment of the subprocess."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-550.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
@@ -35,6 +37,8 @@ def test_issue_550(self):
         supervisorctl.expect(pexpect.EOF)
 
     def test_issue_565(self):
+        """When a log file has Unicode characters in it, 'supervisorctl
+        tail -f name' should still work."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-565.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
@@ -50,6 +54,8 @@ def test_issue_565(self):
             supervisorctl.expect_exact(line, timeout=30)
 
     def test_issue_638(self):
+        """When a process outputs something on its stdout or stderr file
+        descriptor that is not valid UTF-8, supervisord should not crash."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-638.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
@@ -67,6 +73,8 @@ def test_issue_638(self):
                                      'too many start retries too quickly', timeout=60)
 
     def test_issue_663(self):
+        """When Supervisor is run on Python 3, the eventlistener protocol
+        should work."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-663.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
@@ -76,11 +84,15 @@ def test_issue_663(self):
             supervisord.expect_exact('BUSY -> ACKNOWLEDGED', timeout=30)
 
     def test_issue_664(self):
+        """When a subprocess name has Unicode characters, 'supervisord'
+        should not send incomplete XML-RPC responses and 'supervisorctl
+        status' should work."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-664.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
         self.addCleanup(supervisord.kill, signal.SIGINT)
         supervisord.expect_exact('test_öäü entered RUNNING state', timeout=60)
+
         args = ['-m', 'supervisor.supervisorctl', '-c', filename, 'status']
         supervisorctl = pexpect.spawn(sys.executable, args, encoding='utf-8')
         self.addCleanup(supervisorctl.kill, signal.SIGINT)
@@ -92,6 +104,8 @@ def test_issue_664(self):
         self.assertTrue(seen)
 
     def test_issue_733(self):
+        """When a subprocess enters the FATAL state, a one-line eventlistener
+        can be used to signal supervisord to shut down."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-733.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
@@ -138,6 +152,8 @@ def test_issue_836(self):
         self.assertTrue(seen)
 
     def test_issue_1054(self):
+        """When run on Python 3, the 'supervisorctl avail' command
+        should work."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-1054.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
@@ -153,34 +169,51 @@ def test_issue_1054(self):
         self.assertTrue(seen)
 
     def test_issue_1170a(self):
+        """When the [supervisord] section has a variable defined in
+        environment=, that variable should be able to be used in an
+        %(ENV_x) expansion in a [program] section."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-1170a.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
         self.addCleanup(supervisord.kill, signal.SIGINT)
         supervisord.expect_exact("set from [supervisord] section")
 
     def test_issue_1170b(self):
+        """When the [supervisord] section has a variable defined in
+        environment=, and a variable by the same name is defined in
+        enviroment= of a [program] section, the one in the [program]
+        section should be used."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-1170b.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
         self.addCleanup(supervisord.kill, signal.SIGINT)
         supervisord.expect_exact("set from [program] section")
 
     def test_issue_1170c(self):
+        """When the [supervisord] section has a variable defined in
+        environment=, and a variable by the same name is defined in
+        enviroment= of an [eventlistener] section, the one in the
+        [eventlistener] section should be used."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-1170c.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
         self.addCleanup(supervisord.kill, signal.SIGINT)
         supervisord.expect_exact("set from [eventlistener] section")
 
     def test_issue_1224(self):
+        """When the main log file does not need rotation (logfile_maxbyte=0)
+        then the non-rotating logger will be used to avoid an
+        IllegalSeekError in the case that the user has configured a
+        non-seekable file like /dev/stdout."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-1224.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
         self.addCleanup(supervisord.kill, signal.SIGINT)
         supervisord.expect_exact('cat entered RUNNING state', timeout=60)
 
     def test_issue_1231a(self):
+        """When 'supervisorctl tail -f name' is run and the log contains
+        unicode, it should not fail."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-1231a.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
@@ -195,8 +228,9 @@ def test_issue_1231a(self):
             line = '%d - hash=57d94b…381088' % i
             supervisorctl.expect_exact(line, timeout=30)
 
-
     def test_issue_1231b(self):
+        """When 'supervisorctl tail -f name' is run and the log contains
+        unicode, it should not fail."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-1231b.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
@@ -229,6 +263,8 @@ def test_issue_1231b(self):
                 break
 
     def test_issue_1231c(self):
+        """When 'supervisorctl tail -f name' is run and the log contains
+        unicode, it should not fail."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-1231c.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
@@ -251,6 +287,8 @@ def test_issue_1231c(self):
             supervisorctl.expect('Unicode output may fail.', timeout=30)
 
     def test_issue_1251(self):
+        """When -? is given to supervisord or supervisorctl, help should be
+        displayed like -h does."""
         args = ['-m', 'supervisor.supervisord', '-?']
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
         self.addCleanup(supervisord.kill, signal.SIGINT)
@@ -266,6 +304,9 @@ def test_issue_1251(self):
         supervisorctl.expect(pexpect.EOF)
 
     def test_issue_1298(self):
+        """When the output of 'supervisorctl tail -f worker' is piped such as
+        'supervisor tail -f worker | grep something', 'supervisorctl' should
+        not crash."""
         filename = pkg_resources.resource_filename(__name__, 'fixtures/issue-1298.conf')
         args = ['-m', 'supervisor.supervisord', '-c', filename]
         supervisord = pexpect.spawn(sys.executable, args, encoding='utf-8')
@@ -280,13 +321,17 @@ def test_issue_1298(self):
         bash.expect('spewage 2', timeout=30)
 
     def test_issue_1481_pidproxy_cmd_with_no_args(self):
+        """When pidproxy is given a command to run that has no arguments, it
+        runs that command."""
         args = ['-m', 'supervisor.pidproxy', 'nonexistent-pidfile', "/bin/echo"]
         pidproxy = pexpect.spawn(sys.executable, args, encoding='utf-8')
         self.addCleanup(pidproxy.kill, signal.SIGINT)
         pidproxy.expect(pexpect.EOF)
         self.assertEqual(pidproxy.before.strip(), "")
 
     def test_issue_1481_pidproxy_cmd_with_args(self):
+        """When pidproxy is given a command to run that has arguments, it
+        runs that command."""
         args = ['-m', 'supervisor.pidproxy', 'nonexistent-pidfile', "/bin/echo", "1", "2"]
         pidproxy = pexpect.spawn(sys.executable, args, encoding='utf-8')
         self.addCleanup(pidproxy.kill, signal.SIGINT)