mudpy/tests/selftest.py

   1 # Copyright (c) 2004-2018 Jeremy Stanley <fungi@yuggoth.org>. Permission
   2 # to use, copy, modify, and distribute this software is granted under
   3 # terms provided in the LICENSE file distributed with this software.
   4
   5 import os
   6 import re
   7 import sys
   8 import telnetlib
   9 import time
  10
  11 test_account0_setup = (
  12     (0, "Identify yourself:", "luser0"),
  13     (0, "Enter your choice:", "n"),
  14     (0, 'Enter a new password for "luser0":', "Test123"),
  15     (0, "Enter the same new password again:", "Test123"),
  16     (0, r"What would you like to do\?", "c"),
  17     (0, "Pick a birth gender for your new avatar:", "f"),
  18     (0, "Choose a name for her:", "1"),
  19     (0, "What would you like to do?", "a"),
  20     (0, "Whom would you like to awaken?", ""),
  21 )
  22
  23 test_account1_setup = (
  24     (1, "Identify yourself:", "luser1"),
  25     (1, "Enter your choice:", "n"),
  26     (1, 'Enter a new password for "luser1":', "Test456"),
  27     (1, "Enter the same new password again:", "Test456"),
  28     (1, r"What would you like to do\?", "c"),
  29     (1, "Pick a birth gender for your new avatar:", "m"),
  30     (1, "Choose a name for him:", "1"),
  31     (1, "What would you like to do?", "a"),
  32     (1, "Whom would you like to awaken?", ""),
  33 )
  34
  35 test_actor_appears = (
  36     (0, r"You suddenly realize that .* is here\.", ""),
  37 )
  38
  39 test_explicit_punctuation = (
  40     (0, "> ", "say Hello there!"),
  41     (0, r'You exclaim, "Hello there\!"', ""),
  42     (1, r'exclaims, "Hello there\!"', "say And you are?"),
  43     (1, r'You ask, "And you are\?"', ""),
  44     (0, r'asks, "And you are\?"', "say I'm me, of course."),
  45     (0, r'''You say, "I'm me, of course\."''', ""),
  46     (1, r'''says, "I'm me, of course\."''', "say I wouldn't be so sure..."),
  47     (1, r'''You muse, "I wouldn't be so sure\.\.\."''', ""),
  48     (0, r'''muses, "I wouldn't be so sure\.\.\."''', "say You mean,"),
  49     (0, 'You begin, "You mean,"', ""),
  50     (1, 'begins, "You mean,"', "say I know-"),
  51     (1, 'You begin, "I know-"', ""),
  52     (0, 'begins, "I know-"', "say Don't interrupt:"),
  53     (0, r'''You begin, "Don't interrupt:"''', ""),
  54     (1, r'''begins, "Don't interrupt:"''', "say I wasn't interrupting;"),
  55     (1, r'''You begin, "I wasn't interrupting;"''', ""),
  56     (0, r'''begins, "I wasn't interrupting;"''', ""),
  57 )
  58
  59 test_implicit_punctuation = (
  60     (0, '> ', "say Whatever"),
  61     (0, r'You say, "Whatever\."', ""),
  62     (1, r'says, "Whatever\."', ""),
  63 )
  64
  65 test_typo_replacement = (
  66     (1, '> ', "say That's what i think."),
  67     (1, r'''You say, "That's what I think\."''', ""),
  68     (0, r'''says, "That's what I think\."''', "say You know what i'd like."),
  69     (0, r'''You say, "You know what I'd like\."''', ""),
  70     (1, r'''says, "You know what I'd like\."''', "say Then i'll tell you."),
  71     (1, r'''You say, "Then I'll tell you\."''', ""),
  72     (0, r'''says, "Then I'll tell you\."''', "say Now i'm ready."),
  73     (0, r'''You say, "Now I'm ready\."''', ""),
  74     (1, r'''says, "Now I'm ready\."''', "say That's teh idea."),
  75     (1, r'''You say, "That's the idea\."''', ""),
  76     (0, r'''says, "That's the idea\."''', "say It's what theyre saying."),
  77     (0, r'''You say, "It's what they're saying\."''', ""),
  78     (1, r'''says, "It's what they're saying\."''', "say Well, youre right."),
  79     (1, r'''You say, "Well, you're right\."''', ""),
  80     (0, r'''says, "Well, you're right\."''', ""),
  81 )
  82
  83 test_sentence_capitalization = (
  84     (0, "> ", "say this sentence should start with a capital T."),
  85     (0, 'You say, "This sentence', ""),
  86     (1, 'says, "This sentence', ""),
  87 )
  88
  89 test_chat_mode = (
  90     (1, '> ', "chat"),
  91     (1, r'(?s)Entering chat mode .*> \(chat\) ', "Feeling chatty."),
  92     (1, r'You say, "Feeling chatty\."', "!chat"),
  93     (0, r'says, "Feeling chatty\."', ""),
  94     (1, '> ', "say Now less chatty."),
  95     (1, r'You say, "Now less chatty\."', ""),
  96     (0, r'says, "Now less chatty\."', ""),
  97 )
  98
  99 test_wrapping = (
 100     (0, '> ', "say " + 100 * "o"),
 101     (1, r'says,\r\n"O[o]+\."', ""),
 102 )
 103
 104 test_movement = (
 105     (0, "> ", "move north"),
 106     (0, r"You exit to the north\.", ""),
 107     (1, r"exits to the north\.", "move north"),
 108     (0, r"arrives from the south\.", "move south"),
 109     (0, r"You exit to the south\.", ""),
 110     (1, r"exits to the south\.", "move south"),
 111     (0, r"arrives from the north\.", "move east"),
 112     (0, r"You exit to the east\.", ""),
 113     (1, r"exits to the east\.", "move east"),
 114     (0, r"arrives from the west\.", "move west"),
 115     (0, r"You exit to the west\.", ""),
 116     (1, r"exits to the west\.", "move west"),
 117     (0, r"arrives from the east\.", "move up"),
 118     (0, r"You exit upward\.", ""),
 119     (1, r"exits upward\.", "move up"),
 120     (0, r"arrives from below\.", "move down"),
 121     (0, r"You exit downward\.", ""),
 122     (1, r"exits downward\.", "move down"),
 123     (0, r"arrives from above\.", ""),
 124 )
 125
 126 test_actor_disappears = (
 127     (1, "> ", "quit"),
 128     (0, r"You suddenly wonder where .* went\.", ""),
 129 )
 130
 131 test_account1_teardown = (
 132     (1, "What would you like to do?", "d"),
 133     (1, "Whom would you like to delete?", ""),
 134     (1, "What would you like to do?", "p"),
 135     (1, "permanently delete your account?", "y"),
 136     (1, "Disconnecting...", ""),
 137 )
 138
 139 test_admin_setup = (
 140     (2, "Identify yourself:", "admin"),
 141     (2, "Enter your choice:", "n"),
 142     (2, 'Enter a new password for "admin":', "Test789"),
 143     (2, "Enter the same new password again:", "Test789"),
 144     (2, r"What would you like to do\?", "c"),
 145     (2, "Pick a birth gender for your new avatar:", "m"),
 146     (2, "Choose a name for him:", "1"),
 147     (2, "What would you like to do?", "a"),
 148     (2, "Whom would you like to awaken?", ""),
 149 )
 150
 151 test_telnet_iac = (
 152     # Send a double (escaped) IAC byte within other text, which should get
 153     # unescaped and deduplicated to a single \xff in the buffer and then
 154     # the line of input discarded as a non-ASCII sequence
 155     (2, "> ", b"say argle\xff\xffbargle\r\n"),
 156     (2, r"Non-ASCII characters from admin: b'say argle\\xffbargle'.*> ", ""),
 157 )
 158
 159 test_telnet_unknown = (
 160     # Send an unsupported negotiation command #127 which should get filtered
 161     # from the line of input
 162     (2, "> ", b"say glop\xff\x7fglyf\r\n"),
 163     (2, r'Unknown Telnet IAC command 127 ignored\..*"Glopglyf\.".*> ', ""),
 164 )
 165
 166 test_admin_restriction = (
 167     (0, "> ", "help halt"),
 168     (0, r"That is not an available command\.", "halt"),
 169     (0, '(not sure what "halt" means|Arglebargle, glop-glyf)', ""),
 170 )
 171
 172 test_admin_help = (
 173     (2, "> ", "help"),
 174     (2, r"halt.*Shut down the world\.", "help halt"),
 175     (2, "This will save all active accounts", ""),
 176 )
 177
 178 test_reload = (
 179     (2, "> ", "reload"),
 180     (2, r"Reloading all code modules, configs and data\."
 181         r".* User admin reloaded the world\.", ""),
 182 )
 183
 184 test_set_facet = (
 185     (2, "> ", "set actor.avatar_admin_0 gender female"),
 186     (2, r'You have successfully \(re\)set the "gender" facet of element', ""),
 187 )
 188
 189 test_set_refused = (
 190     (2, "> ", "set mudpy.limit password_tries 10"),
 191     (2, r'The "mudpy\.limit" element is kept in read-only file', ""),
 192 )
 193
 194 test_show_version = (
 195     (2, "> ", "show version"),
 196     (2, r"Running mudpy .* on .* Python 3.*with.*pyyaml.*> ", ""),
 197 )
 198
 199 test_show_files = (
 200     (2, "> ", "show files"),
 201     (2, r'These are the current files containing the universe:.*'
 202         r'  \x1b\[31m\(rw\) \x1b\[32m/.*/account.yaml\x1b\[0m'
 203         r' \x1b\[33m\[private\]\x1b\[0m.*> ', ""),
 204 )
 205
 206 test_show_file = (
 207     (2, "> ", "show file %s" %
 208         os.path.join(os.getcwd(), "data/internal.yaml")),
 209     (2, r'These are the nodes in the.*file:.*internal\.counters.*> ', ""),
 210 )
 211
 212 test_show_groups = (
 213     (2, "> ", "show groups"),
 214     (2, r'These are the element groups:.*'
 215         r'  \x1b\[32maccount\x1b\[0m.*> ', ""),
 216 )
 217
 218 test_show_group = (
 219     (2, "> ", "show group account"),
 220     (2, r'These are the elements in the "account" group:.*'
 221         r'  \x1b\[32maccount\.admin\x1b\[0m.*> ', ""),
 222 )
 223
 224 test_show_element = (
 225     (2, "> ", "show element mudpy.limit"),
 226     (2, r'These are the properties of the "mudpy\.limit" element.*'
 227         r'  \x1b\[32mpassword_tries: \x1b\[31m3.*> ',
 228      "show element actor.avatar_admin_0"),
 229     (2, r'These are the properties of the "actor.avatar_admin_0" element.*'
 230         r'  \x1b\[32mgender: \x1b\[31mfemale.*> ', ""),
 231 )
 232
 233 test_show_log = (
 234     (2, "> ", "show log"),
 235     (2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
 236         r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
 237 )
 238
 239 test_custom_loglevel = (
 240     (2, "> ", "set account.admin loglevel 2"),
 241     (2, "You have successfully .*> ", "show log"),
 242     (2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
 243         r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
 244 )
 245
 246 test_invalid_loglevel = (
 247     (2, "> ", "set account.admin loglevel two"),
 248     (2, r'''Value "two" of type "<class 'str'>" cannot be coerced .*> ''', ""),
 249 )
 250
 251 test_log_no_errors = (
 252     (2, "> ", "show log 7"),
 253     (2, r"None of the [0-9]+ lines in memory matches your request\.", ""),
 254 )
 255
 256 dialogue = (
 257     (test_account0_setup, "first account setup"),
 258     (test_account1_setup, "second account setup"),
 259     (test_actor_appears, "actor spontaneous appearance"),
 260     (test_explicit_punctuation, " explicit punctuation"),
 261     (test_implicit_punctuation, "implicit punctuation"),
 262     (test_typo_replacement, "typo replacement"),
 263     (test_sentence_capitalization, "sentence capitalization"),
 264     (test_chat_mode, "chat mode"),
 265     (test_wrapping, "wrapping"),
 266     (test_movement, "movement"),
 267     (test_actor_disappears, "actor spontaneous disappearance"),
 268     (test_account1_teardown, "second account teardown"),
 269     (test_admin_setup, "admin account setup"),
 270     (test_telnet_iac, "escape stray telnet iac bytes"),
 271     (test_telnet_unknown, "strip unknown telnet command"),
 272     (test_admin_restriction, "restricted admin commands"),
 273     (test_admin_help, "admin help"),
 274     (test_reload, "reload"),
 275     (test_set_facet, "set facet"),
 276     (test_set_refused, "refuse altering read-only element"),
 277     (test_show_version, "show version and diagnostic info"),
 278     (test_show_files, "show a list of loaded files"),
 279     (test_show_file, "show nodes from a specific file"),
 280     (test_show_groups, "show groups"),
 281     (test_show_group, "show group"),
 282     (test_show_element, "show element"),
 283     (test_show_log, "show log"),
 284     (test_custom_loglevel, "custom loglevel"),
 285     (test_invalid_loglevel, "invalid loglevel"),
 286     (test_log_no_errors, "no errors logged"),
 287 )
 288
 289
 290 def main():
 291     captures = ["", "", ""]
 292     lusers = [telnetlib.Telnet(), telnetlib.Telnet(), telnetlib.Telnet()]
 293     success = True
 294     start = time.time()
 295     for luser in lusers:
 296         luser.open("::1", 4000)
 297     for test, description in dialogue:
 298         print("\nTesting %s..." % description)
 299         test_start = time.time()
 300         for conversant, question, answer in test:
 301             print("luser%s waiting for: %s" % (conversant, question))
 302             try:
 303                 index, match, received = lusers[conversant].expect(
 304                     [re.compile(question.encode("utf-8"), flags=re.DOTALL)], 5)
 305                 captures[conversant] += received.decode("utf-8")
 306             except ConnectionResetError:
 307                 print("ERROR: Unable to connect to server.")
 308                 success = False
 309                 break
 310             except EOFError:
 311                 print("ERROR: luser%s premature disconnection expecting:\n\n"
 312                       "%s\n\n"
 313                       "Check the end of capture_%s.log for received data."
 314                       % (conversant, question, conversant))
 315                 success = False
 316                 break
 317             try:
 318                 captures[conversant] += lusers[
 319                     conversant].read_very_eager().decode("utf-8")
 320             except Exception:
 321                 pass
 322             if index is not 0:
 323                 print("ERROR: luser%s did not receive expected string:\n\n"
 324                       "%s\n\n"
 325                       "Check the end of capture_%s.log for received data."
 326                       % (conversant, question, conversant))
 327                 success = False
 328                 break
 329             if type(answer) is str:
 330                 print("luser%s sending: %s" % (conversant, answer))
 331                 lusers[conversant].write(("%s\r\n" % answer).encode("utf-8"))
 332                 captures[conversant] += "%s\r\n" % answer
 333             elif type(answer) is bytes:
 334                 print("luser%s sending raw bytes: %s" % (conversant, answer))
 335                 lusers[conversant].get_socket().send(answer)
 336                 captures[conversant] += "!!!RAW BYTES: %s" % answer
 337             else:
 338                 print("ERROR: answer provided with unsupported type %s"
 339                       % type(answer))
 340                 success = False
 341                 break
 342         if not success:
 343             break
 344         print("Completed in %.3f seconds." % (time.time() - test_start))
 345     duration = time.time() - start
 346     print("")
 347     for conversant in range(len(captures)):
 348         try:
 349             captures[conversant] += lusers[
 350                 conversant].read_very_eager().decode("utf-8")
 351         except Exception:
 352             pass
 353         lusers[conversant].close()
 354         logfile = "capture_%s.log" % conversant
 355         print("Recording session %s as %s." % (conversant, logfile))
 356         log = open(logfile, "w")
 357         log.write(captures[conversant])
 358         log.close()
 359     print("\nRan %s tests in %.3f seconds." % (len(dialogue), duration))
 360     if success:
 361         print("SUCCESS")
 362     else:
 363         print("FAILURE")
 364         sys.exit(1)
 365
 366
 367 if __name__ == '__main__':
 368     sys.exit(main())