Modularize functional testing

Break functional test dialogue groups into separate modules and add
a description to each for ease of debugging.

diff --git a/bin/test b/bin/test
index 76cebe0..e9b28dc 100755 (executable)
--- a/bin/test
+++ b/bin/test
@@ -8,8 +8,7 @@
 import sys
 import telnetlib
 
-dialogue = (
-    # Create account 0
+test_account0_setup = (
     (0, "Identify yourself:", "luser0"),
     (0, "Enter your choice:", "n"),
     (0, "Enter a new password for \"luser0\":", "Test123"),
@@ -19,8 +18,9 @@ dialogue = (
     (0, "Choose a name for her:", "1"),
     (0, "What would you like to do?", "a"),
     (0, "Whom would you like to awaken?", ""),
+)
 
-    # Create account 1
+test_account1_setup = (
     (1, "Identify yourself:", "luser1"),
     (1, "Enter your choice:", "n"),
     (1, "Enter a new password for \"luser1\":", "Test456"),
@@ -30,11 +30,13 @@ dialogue = (
     (1, "Choose a name for him:", "1"),
     (1, "What would you like to do?", "a"),
     (1, "Whom would you like to awaken?", ""),
+)
 
-    # Actor appears from nowhere
+test_actor_appears = (
     (0, "You suddenly realize that .* is here\.", ""),
+)
 
-    # Explicit punctuation
+test_explicit_punctuation = (
     (0, "> ", "say Hello there!"),
     (0, 'You exclaim, "Hello there\!"', ""),
     (1, 'exclaims, "Hello there\!"', "say And you are?"),
@@ -52,13 +54,15 @@ dialogue = (
     (1, 'begins, "Don\'t interrupt:"', "say I wasn't interrupting;"),
     (1, 'You begin, "I wasn\'t interrupting;"', ""),
     (0, 'begins, "I wasn\'t interrupting;"', ""),
+)
 
-    # Implicit punctuation
+test_implicit_punctuation = (
     (0, '> ', "say Whatever"),
     (0, 'You say, "Whatever."', ""),
     (1, 'says, "Whatever."', ""),
+)
 
-    # Typo replacement
+test_typo_replacement = (
     (1, '> ', "say That's what i think."),
     (1, 'You say, "That\'s what I think."', ""),
     (0, 'says, "That\'s what I think."', "say You know what i'd like."),
@@ -74,27 +78,29 @@ dialogue = (
     (1, 'says, "It\'s what they\'re saying."', "say Well, youre right."),
     (1, 'You say, "Well, you\'re right."', ""),
     (0, 'says, "Well, you\'re right."', ""),
+)
 
-    # Sentence capitalization
+test_sentence_capitalization = (
     (0, "> ", "say this sentence should start with a capital T."),
     (0, 'You say, "This sentence', ""),
     (1, 'says, "This sentence', ""),
+)
 
-    # Actor disappears
+test_actor_disappears = (
     (1, "> ", "quit"),
     (0, "You suddenly wonder where .* went\.", ""),
+)
 
-    # Quit
+test_account0_teardown = (
     (0, "> ", "quit"),
-
-    # Delete account 0
     (0, "What would you like to do?", "d"),
     (0, "Whom would you like to delete?", ""),
     (0, "What would you like to do?", "p"),
     (0, "permanently delete your account?", "y"),
     (0, "Disconnecting...", ""),
+)
 
-    # Delete account 1
+test_account1_teardown = (
     (1, "What would you like to do?", "d"),
     (1, "Whom would you like to delete?", ""),
     (1, "What would you like to do?", "p"),
@@ -102,29 +108,44 @@ dialogue = (
     (1, "Disconnecting...", ""),
 )
 
+dialogue = (
+    (test_account0_setup, "first account setup"),
+    (test_account1_setup, "second account setup"),
+    (test_actor_appears, "actor spontaneous appearance"),
+    (test_explicit_punctuation, " explicit punctuation"),
+    (test_implicit_punctuation, "implicit punctuation"),
+    (test_typo_replacement, "typo replacement"),
+    (test_sentence_capitalization, "sentence capitalization"),
+    (test_actor_disappears, "actor spontaneous disappearance"),
+    (test_account0_teardown, "first account teardown"),
+    (test_account1_teardown, "second account teardown"),
+)
+
 captures = ["", ""]
 lusers = [telnetlib.Telnet(), telnetlib.Telnet()]
 success = True
 for luser in lusers:
     luser.open("::1", 6669)
-for conversant, question, answer in dialogue:
-    print("luser%s waiting for: %s" % (conversant, question))
-    index, match, received = lusers[conversant].expect(
-        [question.encode("utf-8")], 5)
-    captures[conversant] += received.decode("utf-8")
-    try:
-        captures[conversant] += lusers[
-            conversant].read_very_eager().decode("utf-8")
-    except:
-        pass
-    if index is not 0:
-        print("ERROR: luser%s did not receive expected string:\n\n%s"
-              % (conversant, question))
-        success = False
-        break
-    print("luser%s sending: %s" % (conversant, answer))
-    lusers[conversant].write(("%s\r\n" % answer).encode("utf-8"))
-    captures[conversant] += "%s\r\n" % answer
+for test, description in dialogue:
+    print("\nTesting %s..." % description)
+    for conversant, question, answer in test:
+        print("luser%s waiting for: %s" % (conversant, question))
+        index, match, received = lusers[conversant].expect(
+            [question.encode("utf-8")], 5)
+        captures[conversant] += received.decode("utf-8")
+        try:
+            captures[conversant] += lusers[
+                conversant].read_very_eager().decode("utf-8")
+        except:
+            pass
+        if index is not 0:
+            print("ERROR: luser%s did not receive expected string:\n\n%s"
+                  % (conversant, question))
+            success = False
+            break
+        print("luser%s sending: %s" % (conversant, answer))
+        lusers[conversant].write(("%s\r\n" % answer).encode("utf-8"))
+        captures[conversant] += "%s\r\n" % answer
 for conversant in range(len(captures)):
     try:
         captures[conversant] += lusers[