mudpy/tests/selftest.py

   1 # Copyright (c) 2004-2019 mudpy authors. Permission to use, copy,
   2 # modify, and distribute this software is granted under terms
   3 # provided in the LICENSE file distributed with this software.
   4
   5 import os
   6 import pathlib
   7 import re
   8 import shutil
   9 import subprocess
  10 import sys
  11 import telnetlib
  12 import time
  13
  14 pidfile = "var/mudpy.pid"
  15
  16 test_account0_setup = (
  17     (0, "Identify yourself:", "luser0"),
  18     (0, "Enter your choice:", "n"),
  19     (0, 'Enter a new password for "luser0":', "Test123"),
  20     (0, "Enter the same new password again:", "Test123"),
  21     (0, r"What would you like to do\?", "c"),
  22     (0, "Pick a birth gender for your new avatar:", "f"),
  23     (0, "Choose a name for her:", "1"),
  24     (0, "What would you like to do?", "a"),
  25     (0, "Whom would you like to awaken?", ""),
  26 )
  27
  28 test_account1_setup = (
  29     (1, "Identify yourself:", "luser1"),
  30     (1, "Enter your choice:", "n"),
  31     (1, 'Enter a new password for "luser1":', "Test456"),
  32     (1, "Enter the same new password again:", "Test456"),
  33     (1, r"What would you like to do\?", "c"),
  34     (1, "Pick a birth gender for your new avatar:", "m"),
  35     (1, "Choose a name for him:", "1"),
  36     (1, "What would you like to do?", "a"),
  37     (1, "Whom would you like to awaken?", ""),
  38 )
  39
  40 test_actor_appears = (
  41     (0, r"You suddenly realize that .* is here\.", ""),
  42 )
  43
  44 test_explicit_punctuation = (
  45     (0, "> ", "say Hello there!"),
  46     (0, r'You exclaim, "Hello there\!"', ""),
  47     (1, r'exclaims, "Hello there\!"', "say And you are?"),
  48     (1, r'You ask, "And you are\?"', ""),
  49     (0, r'asks, "And you are\?"', "say I'm me, of course."),
  50     (0, r'''You say, "I'm me, of course\."''', ""),
  51     (1, r'''says, "I'm me, of course\."''', "say I wouldn't be so sure..."),
  52     (1, r'''You muse, "I wouldn't be so sure\.\.\."''', ""),
  53     (0, r'''muses, "I wouldn't be so sure\.\.\."''', "say You mean,"),
  54     (0, 'You begin, "You mean,"', ""),
  55     (1, 'begins, "You mean,"', "say I know-"),
  56     (1, 'You begin, "I know-"', ""),
  57     (0, 'begins, "I know-"', "say Don't interrupt:"),
  58     (0, r'''You begin, "Don't interrupt:"''', ""),
  59     (1, r'''begins, "Don't interrupt:"''', "say I wasn't interrupting;"),
  60     (1, r'''You begin, "I wasn't interrupting;"''', ""),
  61     (0, r'''begins, "I wasn't interrupting;"''', ""),
  62 )
  63
  64 test_implicit_punctuation = (
  65     (0, '> ', "say Whatever"),
  66     (0, r'You say, "Whatever\."', ""),
  67     (1, r'says, "Whatever\."', ""),
  68 )
  69
  70 test_typo_replacement = (
  71     (1, '> ', "say That's what i think."),
  72     (1, r'''You say, "That's what I think\."''', ""),
  73     (0, r'''says, "That's what I think\."''', "say You know what i'd like."),
  74     (0, r'''You say, "You know what I'd like\."''', ""),
  75     (1, r'''says, "You know what I'd like\."''', "say Then i'll tell you."),
  76     (1, r'''You say, "Then I'll tell you\."''', ""),
  77     (0, r'''says, "Then I'll tell you\."''', "say Now i'm ready."),
  78     (0, r'''You say, "Now I'm ready\."''', ""),
  79     (1, r'''says, "Now I'm ready\."''', "say That's teh idea."),
  80     (1, r'''You say, "That's the idea\."''', ""),
  81     (0, r'''says, "That's the idea\."''', "say It's what theyre saying."),
  82     (0, r'''You say, "It's what they're saying\."''', ""),
  83     (1, r'''says, "It's what they're saying\."''', "say Well, youre right."),
  84     (1, r'''You say, "Well, you're right\."''', ""),
  85     (0, r'''says, "Well, you're right\."''', ""),
  86 )
  87
  88 test_sentence_capitalization = (
  89     (0, "> ", "say this sentence should start with a capital T."),
  90     (0, 'You say, "This sentence', ""),
  91     (1, 'says, "This sentence', ""),
  92 )
  93
  94 test_chat_mode = (
  95     (1, '> ', "chat"),
  96     (1, r'(?s)Entering chat mode .*> \(chat\) ', "Feeling chatty."),
  97     (1, r'You say, "Feeling chatty\."', "!chat"),
  98     (0, r'says, "Feeling chatty\."', ""),
  99     (1, '> ', "say Now less chatty."),
 100     (1, r'You say, "Now less chatty\."', ""),
 101     (0, r'says, "Now less chatty\."', ""),
 102 )
 103
 104 test_wrapping = (
 105     (0, '> ', "say " + 100 * "o"),
 106     (1, r'says,\r\n"O[o]+\."', ""),
 107 )
 108
 109 test_forbid_ansi_input = (
 110     (0, '> ', "say \x1b[35mfoo\x1b[0m"),
 111     (1, r'says, "\[35mfoo\[0m\."', ""),
 112 )
 113
 114 test_escape_macros = (
 115     (0, '> ', "say $(red)bar$(nrm)"),
 116     (1, r'says, "\$\(red\)bar\$\(nrm\)."', ""),
 117 )
 118
 119 test_movement = (
 120     (0, "> ", "move north"),
 121     (0, r"You exit to the north\.", ""),
 122     (1, r"exits to the north\.", "move north"),
 123     (0, r"arrives from the south\.", "move south"),
 124     (0, r"You exit to the south\.", ""),
 125     (1, r"exits to the south\.", "move south"),
 126     (0, r"arrives from the north\.", "move east"),
 127     (0, r"You exit to the east\.", ""),
 128     (1, r"exits to the east\.", "move east"),
 129     (0, r"arrives from the west\.", "move west"),
 130     (0, r"You exit to the west\.", ""),
 131     (1, r"exits to the west\.", "move west"),
 132     (0, r"arrives from the east\.", "move up"),
 133     (0, r"You exit upward\.", ""),
 134     (1, r"exits upward\.", "move up"),
 135     (0, r"arrives from below\.", "move down"),
 136     (0, r"You exit downward\.", ""),
 137     (1, r"exits downward\.", "move down"),
 138     (0, r"arrives from above\.", ""),
 139 )
 140
 141 test_actor_disappears = (
 142     (1, "> ", "quit"),
 143     (0, r"You suddenly wonder where .* went\.", ""),
 144 )
 145
 146 test_account1_teardown = (
 147     (1, "What would you like to do?", "d"),
 148     (1, "Whom would you like to delete?", ""),
 149     (1, "What would you like to do?", "p"),
 150     (1, "permanently delete your account?", "y"),
 151     (1, "Disconnecting...", ""),
 152 )
 153
 154 test_admin_setup = (
 155     (2, "Identify yourself:", "admin"),
 156     (2, "Enter your choice:", "n"),
 157     (2, 'Enter a new password for "admin":', "Test789"),
 158     (2, "Enter the same new password again:", "Test789"),
 159     (2, r"What would you like to do\?", "c"),
 160     (2, "Pick a birth gender for your new avatar:", "m"),
 161     (2, "Choose a name for him:", "1"),
 162     (2, "What would you like to do?", "a"),
 163     (2, "Whom would you like to awaken?", ""),
 164 )
 165
 166 test_preferences = (
 167     (0, "> ", "preferences"),
 168     (0, r"prompt \x1b\[32m.*> ", "preferences prompt $(foo)"),
 169     (0, r"\$\(foo\) ", "preferences prompt"),
 170     (0, r"\$\(foo\).*\$\(foo\) ", "preferences prompt $(time)>"),
 171     (0, "[0-9]> ", "preferences prompt >"),
 172     (2, "> ", "preferences loglevel 0"),
 173     (2, "> ", "preferences"),
 174     (2, r"loglevel \x1b\[32m0\x1b\[0m.*> ", "preferences loglevel zero"),
 175     (2, r'''cannot be set to type "<class 'str'>"\..*> ''', ""),
 176 )
 177
 178 test_crlf_eol = (
 179     # Send a CR+LF at the end of the line instead of the default CR+NUL,
 180     # to make sure they're treated the same
 181     (2, "> ", b"say I use CR+LF as my EOL, not CR+NUL.\r\n"),
 182     (2, r'You say, "I use CR\+LF as my EOL, not CR\+NUL\.".*> ', ""),
 183 )
 184
 185 test_telnet_iac = (
 186     # Send a double (escaped) IAC byte within other text, which should get
 187     # unescaped and deduplicated to a single \xff in the buffer and then
 188     # the line of input discarded as a non-ASCII sequence
 189     (2, "> ", b"say argle\xff\xffbargle\r\0"),
 190     (2, r"Non-ASCII characters from admin: b'say.*argle\\xffbargle'.*> ", ""),
 191 )
 192
 193 test_telnet_unknown_command = (
 194     # Send an unsupported negotiation command #127 which should get filtered
 195     # from the line of input
 196     (2, "> ", b"say glop\xff\x7fglyf\r\0"),
 197     (2, r'Ignored unknown command 127 from admin\..*"Glopglyf\.".*> ', ""),
 198 )
 199
 200 test_telnet_unknown_option = (
 201     # Send an unassigned negotiation option #127 which should get logged
 202     (2, "> ", b"\xff\xfe\x7f\r\0"),
 203     (2, r'''Received "don't 127" from admin\..*> ''', ""),
 204 )
 205
 206 test_admin_restriction = (
 207     (0, "> ", "help halt"),
 208     (0, r"That is not an available command\.", "halt"),
 209     (0, '(not sure what "halt" means|Arglebargle, glop-glyf)', ""),
 210 )
 211
 212 test_admin_help = (
 213     (2, "> ", "help"),
 214     (2, r"halt.*Shut down the world\.", "help halt"),
 215     (2, "This will save all active accounts", ""),
 216 )
 217
 218 test_abbrev = (
 219     (0, "> ", "h"),
 220     (0, r"h\[elp\].*m\[ove\].*> ", "he mo"),
 221     (0, r"Move in a specific direction\..*> ", "mov north"),
 222     (0, r"You exit to the north\..*> ", "m south"),
 223     (0, r"You exit to the south\..*> ", ""),
 224 )
 225
 226 test_reload = (
 227     (2, "> ", "reload"),
 228     (2, r"Reloading all code modules, configs and data\."
 229         r".* User admin reloaded the world\.",
 230      "show element account.admin"),
 231     (2, 'These are the properties of the "account.admin" element.*'
 232         r'  \x1b\[32mpasshash:\r\n\x1b\[31m\$.*> ', ""),
 233 )
 234
 235 test_set_facet = (
 236     (2, "> ", "set actor.avatar_admin_0 gender female"),
 237     (2, r'You have successfully \(re\)set the "gender" facet of element', ""),
 238 )
 239
 240 test_set_refused = (
 241     (2, "> ", "set mudpy.limit password_tries 10"),
 242     (2, r'The "mudpy\.limit" element is kept in read-only file', ""),
 243 )
 244
 245 test_show_version = (
 246     (2, "> ", "show version"),
 247     (2, r"Running mudpy .* on .* Python 3.*with.*pyyaml.*> ", ""),
 248 )
 249
 250 test_show_time = (
 251     (2, "> ", "show time"),
 252     (2, r"\r\n[0-9]+ increments elapsed.*> ", ""),
 253 )
 254
 255 test_show_files = (
 256     (2, "> ", "show files"),
 257     (2, r'These are the current files containing the universe:.*'
 258         r'  \x1b\[31m\(rw\) \x1b\[32m/.*/account.yaml\x1b\[0m'
 259         r' \x1b\[33m\[private\]\x1b\[0m.*> ', ""),
 260 )
 261
 262 test_show_file = (
 263     (2, "> ", "show file %s" %
 264         os.path.join(os.getcwd(), "data/internal.yaml")),
 265     (2, r'These are the nodes in the.*file:.*internal\.counters.*> ', ""),
 266 )
 267
 268 test_show_groups = (
 269     (2, "> ", "show groups"),
 270     (2, r'These are the element groups:.*'
 271         r'  \x1b\[32maccount\x1b\[0m.*> ', ""),
 272 )
 273
 274 test_show_group = (
 275     (2, "> ", "show group account"),
 276     (2, r'These are the elements in the "account" group:.*'
 277         r'  \x1b\[32maccount\.admin\x1b\[0m.*> ', ""),
 278 )
 279
 280 test_show_element = (
 281     (2, "> ", "show element mudpy.limit"),
 282     (2, r'These are the properties of the "mudpy\.limit" element.*'
 283         r'  \x1b\[32mpassword_tries: \x1b\[31m3.*> ',
 284      "show element actor.avatar_admin_0"),
 285     (2, r'These are the properties of the "actor.avatar_admin_0" element.*'
 286         r'  \x1b\[32mgender: \x1b\[31mfemale.*> ', ""),
 287 )
 288
 289 test_show_result = (
 290     (2, "> ", "show result 12345*67890"),
 291     (2, r"\r\n838102050\r\n.*> ", "show result 1/0"),
 292     (2, r"Your expression raised an exception.*division by zero.*> ", ""),
 293 )
 294
 295 test_show_log = (
 296     (2, "> ", "show log"),
 297     (2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
 298         r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
 299 )
 300
 301 test_custom_loglevel = (
 302     (2, "> ", "set account.admin loglevel 2"),
 303     (2, "You have successfully .*> ", "show log"),
 304     (2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
 305         r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
 306 )
 307
 308 test_invalid_loglevel = (
 309     (2, "> ", "set account.admin loglevel two"),
 310     (2, r'''Value "two" of type "<class 'str'>" cannot be coerced .*> ''', ""),
 311 )
 312
 313 test_log_no_errors = (
 314     (2, "> ", "show log 7"),
 315     (2, r"None of the [0-9]+ lines in memory matches your request\.", ""),
 316 )
 317
 318 final_cleanup = (
 319     (0, "> ", "quit"),
 320     (0, "What would you like to do?", "d"),
 321     (0, "Whom would you like to delete?", ""),
 322     (0, "What would you like to do?", "p"),
 323     (0, "permanently delete your account?", "y"),
 324     (0, "Disconnecting...", ""),
 325     (2, "> ", "quit"),
 326     (2, "What would you like to do?", "d"),
 327     (2, "Whom would you like to delete?", ""),
 328     (2, "What would you like to do?", "p"),
 329     (2, "permanently delete your account?", "y"),
 330     (2, "Disconnecting...", ""),
 331 )
 332
 333 dialogue = (
 334     (test_account0_setup, "first account setup"),
 335     (test_account1_setup, "second account setup"),
 336     (test_actor_appears, "actor spontaneous appearance"),
 337     (test_explicit_punctuation, "explicit punctuation"),
 338     (test_implicit_punctuation, "implicit punctuation"),
 339     (test_typo_replacement, "typo replacement"),
 340     (test_sentence_capitalization, "sentence capitalization"),
 341     (test_chat_mode, "chat mode"),
 342     (test_wrapping, "wrapping"),
 343     (test_forbid_ansi_input, "raw escape input is filtered"),
 344     (test_escape_macros, "replacement macros are escaped"),
 345     (test_movement, "movement"),
 346     (test_actor_disappears, "actor spontaneous disappearance"),
 347     (test_account1_teardown, "second account teardown"),
 348     (test_admin_setup, "admin account setup"),
 349     (test_preferences, "set and show preferences"),
 350     (test_crlf_eol, "send crlf from the client as eol"),
 351     (test_telnet_iac, "escape stray telnet iac bytes"),
 352     (test_telnet_unknown_command, "strip unknown telnet command"),
 353     (test_telnet_unknown_option, "log unknown telnet option"),
 354     (test_admin_restriction, "restricted admin commands"),
 355     (test_admin_help, "admin help"),
 356     (test_abbrev, "command abbreviation"),
 357     (test_reload, "reload"),
 358     (test_set_facet, "set facet"),
 359     (test_set_refused, "refuse altering read-only element"),
 360     (test_show_version, "show version and diagnostic info"),
 361     (test_show_time, "show elapsed world clock increments"),
 362     (test_show_files, "show a list of loaded files"),
 363     (test_show_file, "show nodes from a specific file"),
 364     (test_show_groups, "show groups"),
 365     (test_show_group, "show group"),
 366     (test_show_element, "show element"),
 367     (test_show_result, "show result of a python expression"),
 368     (test_show_log, "show log"),
 369     (test_custom_loglevel, "custom loglevel"),
 370     (test_invalid_loglevel, "invalid loglevel"),
 371     (test_log_no_errors, "no errors logged"),
 372     (final_cleanup, "delete remaining accounts"),
 373 )
 374
 375
 376 def start_service(config):
 377     # Clean up any previously run daemon which didn't terminate
 378     if os.path.exists(pidfile):
 379         pidfd = open(pidfile)
 380         pid = int(pidfd.read())
 381         try:
 382             # Stop the running service
 383             os.kill(pid, 15)
 384             time.sleep(1)
 385         except ProcessLookupError:
 386             # If there was no process, just remove the stale PID file
 387             os.remove(pidfile)
 388         # If there's a preexisting hung service, we can't proceed
 389         assert not os.path.exists(pidfile)
 390
 391     # Clean up any previous test output
 392     for f in pathlib.Path(".").glob("capture_*.log"):
 393         # have to use .name here since remove() doesn't support passing a
 394         # PosixPath argument until Python3.6
 395         os.remove(f.name)
 396     for d in ("data", "var"):
 397         shutil.rmtree(d, ignore_errors=True)
 398
 399     # Start the service and wait for it to be ready for connections
 400     service = subprocess.Popen(("mudpy", config),
 401                                stdout=subprocess.PIPE,
 402                                stderr=subprocess.PIPE)
 403     time.sleep(1)
 404     return(service)
 405
 406
 407 def stop_service(service):
 408     success = True
 409
 410     # The no-op case when no service was started
 411     if service is None:
 412         return(success)
 413
 414     # This handles when the service is running as a direct child process
 415     service.terminate()
 416     returncode = service.wait(10)
 417     if returncode != 0:
 418         tlog("\nERROR: Service exited with code %s." % returncode)
 419         success = False
 420
 421     # This cleans up a daemonized and disassociated service
 422     if os.path.exists(pidfile):
 423         pidfd = open(pidfile)
 424         pid = int(pidfd.read())
 425         try:
 426             # Stop the running service
 427             os.kill(pid, 15)
 428             time.sleep(1)
 429         except ProcessLookupError:
 430             # If there was no process, just remove the stale PID file
 431             os.remove(pidfile)
 432         # The PID file didn't disappear, so we have a hung service
 433         if os.path.exists(pidfile):
 434             tlog("\nERROR: Hung daemon with PID %s." % pid)
 435             success = False
 436
 437     # Log the contents of stdout and stderr, if any
 438     stdout, stderr = service.communicate()
 439     tlog("\nRecording stdout as capture_stdout.log.")
 440     serviceout = open("capture_stdout.log", "w")
 441     serviceout.write(stdout.decode("utf-8"))
 442     tlog("\nRecording stderr as capture_stderr.log.")
 443     serviceerr = open("capture_stderr.log", "w")
 444     serviceerr.write(stderr.decode("utf-8"))
 445
 446     return(success)
 447
 448
 449 def tlog(message, quiet=False):
 450     logfile = "capture_tests.log"
 451     with open(logfile, "a") as logfd:
 452         logfd.write(message + "\n")
 453     if not quiet:
 454         sys.stdout.write(message)
 455     return True
 456
 457
 458 def option_callback(telnet_socket, command, option):
 459     if option == b'\x7f':
 460         # We use this unassigned option value as a canary, so short-circuit
 461         # any response to avoid endlessly looping
 462         pass
 463     elif command in (telnetlib.DO, telnetlib.DONT):
 464         telnet_socket.send(telnetlib.IAC + telnetlib.WONT + option)
 465     elif command in (telnetlib.WILL, telnetlib.WONT):
 466         telnet_socket.send(telnetlib.IAC + telnetlib.DONT + option)
 467
 468
 469 def main():
 470     captures = ["", "", ""]
 471     lusers = [telnetlib.Telnet(), telnetlib.Telnet(), telnetlib.Telnet()]
 472     success = True
 473     start = time.time()
 474     service = None
 475     if len(sys.argv) > 1:
 476         # Start the service if a config file was provided on the command line
 477         service = start_service(sys.argv[1])
 478     for luser in lusers:
 479         luser.open("::1", 4000)
 480         luser.set_option_negotiation_callback(option_callback)
 481     for test, description in dialogue:
 482         tlog("\nTesting %s..." % description)
 483         test_start = time.time()
 484         for conversant, question, answer in test:
 485             tlog("luser%s waiting for: %s" % (conversant, question),
 486                  quiet=True)
 487             try:
 488                 index, match, received = lusers[conversant].expect(
 489                     [re.compile(question.encode("utf-8"), flags=re.DOTALL)], 5)
 490                 captures[conversant] += received.decode("utf-8")
 491             except ConnectionResetError:
 492                 tlog("\nERROR: Unable to connect to server.")
 493                 success = False
 494                 break
 495             except EOFError:
 496                 tlog("\nERROR: luser%s premature disconnection expecting:\n\n"
 497                      "%s\n\n"
 498                      "Check the end of capture_%s.log for received data."
 499                      % (conversant, question, conversant))
 500                 success = False
 501                 break
 502             try:
 503                 captures[conversant] += lusers[
 504                     conversant].read_very_eager().decode("utf-8")
 505             except Exception:
 506                 pass
 507             if index != 0:
 508                 tlog("\nERROR: luser%s did not receive expected string:\n\n"
 509                      "%s\n\n"
 510                      "Check the end of capture_%s.log for received data."
 511                      % (conversant, question, conversant))
 512                 success = False
 513                 break
 514             if type(answer) is str:
 515                 tlog("luser%s sending: %s" % (conversant, answer), quiet=True)
 516                 lusers[conversant].write(("%s\r\0" % answer).encode("utf-8"))
 517                 captures[conversant] += "%s\r\n" % answer
 518             elif type(answer) is bytes:
 519                 tlog("luser%s sending raw bytes: %s" % (conversant, answer),
 520                      quiet=True)
 521                 lusers[conversant].get_socket().send(answer)
 522                 captures[conversant] += "!!!RAW BYTES: %s" % answer
 523             else:
 524                 tlog("\nERROR: answer provided with unsupported type %s"
 525                      % type(answer))
 526                 success = False
 527                 break
 528         if not success:
 529             break
 530         tlog("Completed in %.3f seconds." % (time.time() - test_start))
 531     duration = time.time() - start
 532     for conversant in range(len(captures)):
 533         try:
 534             captures[conversant] += lusers[
 535                 conversant].read_very_eager().decode("utf-8")
 536         except Exception:
 537             pass
 538         lusers[conversant].close()
 539         logfile = "capture_%s.log" % conversant
 540         tlog("\nRecording session %s as %s." % (conversant, logfile))
 541         log = open(logfile, "w")
 542         log.write(captures[conversant])
 543         log.close()
 544     if not stop_service(service):
 545         success = False
 546     tlog("\nRan %s tests in %.3f seconds." % (len(dialogue), duration))
 547     if success:
 548         tlog("\nSUCCESS\n")
 549     else:
 550         tlog("\nFAILURE\n")
 551         sys.exit(1)
 552
 553
 554 if __name__ == '__main__':
 555     sys.exit(main())