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"\[32mprompt\x1b\[0m - <not set>.*> ", "preferences prompt $(foo)"),
 169     (0, r"\$\(foo\) ", "preferences prompt"),
 170     (0, r"\$\(foo\).*\$\(foo\) ", "preferences prompt $(time)>"),
 171     (0, "[0-9]> ", "preferences loglevel 0"),
 172     (0, "does not exist.*> ", "preferences prompt >"),
 173     (2, "> ", "preferences loglevel 0"),
 174     (2, "> ", "preferences"),
 175     (2, r"\[31mloglevel\x1b\[0m - 0.*> ", "preferences loglevel zero"),
 176     (2, r'''cannot be set to type "<class 'str'>"\..*> ''', ""),
 177 )
 178
 179 test_crlf_eol = (
 180     # Send a CR+LF at the end of the line instead of the default CR+NUL,
 181     # to make sure they're treated the same
 182     (2, "> ", b"say I use CR+LF as my EOL, not CR+NUL.\r\n"),
 183     (2, r'You say, "I use CR\+LF as my EOL, not CR\+NUL\.".*> ', ""),
 184 )
 185
 186 test_telnet_iac = (
 187     # Send a double (escaped) IAC byte within other text, which should get
 188     # unescaped and deduplicated to a single \xff in the buffer and then
 189     # the line of input discarded as a non-ASCII sequence
 190     (2, "> ", b"say argle\xff\xffbargle\r\0"),
 191     (2, r"Non-ASCII characters from admin: b'say.*argle\\xffbargle'.*> ", ""),
 192 )
 193
 194 test_telnet_unknown_command = (
 195     # Send an unsupported negotiation command #127 which should get filtered
 196     # from the line of input
 197     (2, "> ", b"say glop\xff\x7fglyf\r\0"),
 198     (2, r'Ignored unknown command 127 from admin\..*"Glopglyf\.".*> ', ""),
 199 )
 200
 201 test_telnet_unknown_option = (
 202     # Send an unassigned negotiation option #127 which should get logged
 203     (2, "> ", b"\xff\xfe\x7f\r\0"),
 204     (2, r'''Received "don't 127" from admin\..*> ''', ""),
 205 )
 206
 207 test_admin_restriction = (
 208     (0, "> ", "help halt"),
 209     (0, r"That is not an available command\.", "halt"),
 210     (0, '(not sure what "halt" means|Arglebargle, glop-glyf)', ""),
 211 )
 212
 213 test_admin_help = (
 214     (2, "> ", "help"),
 215     (2, r"halt.*Shut down the world\.", "help halt"),
 216     (2, "This will save all active accounts", ""),
 217 )
 218
 219 test_help = (
 220     (0, "> ", "help say"),
 221     (0, r"See also: .*chat.*> ", ""),
 222 )
 223
 224 test_abbrev = (
 225     (0, "> ", "h"),
 226     (0, r"h\[elp\].*m\[ove\].*> ", "he mo"),
 227     (0, r"Move in a specific direction\..*> ", "mov nor"),
 228     (0, r"You exit to the north\..*> ", "m s"),
 229     (0, r"You exit to the south\..*> ", ""),
 230 )
 231
 232 test_reload = (
 233     (2, "> ", "reload"),
 234     (2, r"Reloading all code modules, configs and data\."
 235         r".* User admin reloaded the world\.",
 236      "show element account.admin"),
 237     (2, 'These are the properties of the "account.admin" element.*'
 238         r'  \x1b\[32mpasshash:\r\n\x1b\[31m\$.*> ', ""),
 239 )
 240
 241 test_set_facet = (
 242     (2, "> ", "set actor.avatar_admin_0 gender female"),
 243     (2, r'You have successfully \(re\)set the "gender" facet of element', ""),
 244 )
 245
 246 test_set_refused = (
 247     (2, "> ", "set mudpy.limit password_tries 10"),
 248     (2, r'The "mudpy\.limit" element is kept in read-only file', ""),
 249 )
 250
 251 test_show_version = (
 252     (2, "> ", "show version"),
 253     (2, r"Running mudpy .* on .* Python 3.*with.*pyyaml.*> ", ""),
 254 )
 255
 256 test_show_time = (
 257     (2, "> ", "show time"),
 258     (2, r"\r\n[0-9]+ increments elapsed.*> ", ""),
 259 )
 260
 261 test_show_files = (
 262     (2, "> ", "show files"),
 263     (2, r'These are the current files containing the universe:.*'
 264         r'  \x1b\[31m\(rw\) \x1b\[32m/.*/account.yaml\x1b\[0m'
 265         r' \x1b\[33m\[private\]\x1b\[0m.*> ', ""),
 266 )
 267
 268 test_show_file = (
 269     (2, "> ", "show file %s" %
 270         os.path.join(os.getcwd(), "data/internal.yaml")),
 271     (2, r'These are the nodes in the.*file:.*internal\.counters.*> ', ""),
 272 )
 273
 274 test_show_groups = (
 275     (2, "> ", "show groups"),
 276     (2, r'These are the element groups:.*'
 277         r'  \x1b\[32maccount\x1b\[0m.*> ', ""),
 278 )
 279
 280 test_show_group = (
 281     (2, "> ", "show group account"),
 282     (2, r'These are the elements in the "account" group:.*'
 283         r'  \x1b\[32maccount\.admin\x1b\[0m.*> ', ""),
 284 )
 285
 286 test_show_element = (
 287     (2, "> ", "show element mudpy.limit"),
 288     (2, r'These are the properties of the "mudpy\.limit" element.*'
 289         r'  \x1b\[32mpassword_tries: \x1b\[31m3.*> ',
 290      "show element actor.avatar_admin_0"),
 291     (2, r'These are the properties of the "actor.avatar_admin_0" element.*'
 292         r'  \x1b\[32mgender: \x1b\[31mfemale.*> ', ""),
 293 )
 294
 295 test_show_result = (
 296     (2, "> ", "show result 12345*67890"),
 297     (2, r"\r\n838102050\r\n.*> ", "show result 1/0"),
 298     (2, r"Your expression raised an exception.*division by zero.*> ", ""),
 299 )
 300
 301 test_show_log = (
 302     (2, "> ", "show log"),
 303     (2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
 304         r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
 305 )
 306
 307 test_custom_loglevel = (
 308     (2, "> ", "set account.admin loglevel 2"),
 309     (2, "You have successfully .*> ", "show log"),
 310     (2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
 311         r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
 312 )
 313
 314 test_invalid_loglevel = (
 315     (2, "> ", "set account.admin loglevel two"),
 316     (2, r'''Value "two" of type "<class 'str'>" cannot be coerced .*> ''', ""),
 317 )
 318
 319 test_log_no_errors = (
 320     (2, "> ", "show log 7"),
 321     (2, r"None of the [0-9]+ lines in memory matches your request\.", ""),
 322 )
 323
 324 final_cleanup = (
 325     (0, "> ", "quit"),
 326     (0, "What would you like to do?", "d"),
 327     (0, "Whom would you like to delete?", ""),
 328     (0, "What would you like to do?", "p"),
 329     (0, "permanently delete your account?", "y"),
 330     (0, "Disconnecting...", ""),
 331     (2, "> ", "quit"),
 332     (2, "What would you like to do?", "d"),
 333     (2, "Whom would you like to delete?", ""),
 334     (2, "What would you like to do?", "p"),
 335     (2, "permanently delete your account?", "y"),
 336     (2, "Disconnecting...", ""),
 337 )
 338
 339 dialogue = (
 340     (test_account0_setup, "first account setup"),
 341     (test_account1_setup, "second account setup"),
 342     (test_actor_appears, "actor spontaneous appearance"),
 343     (test_explicit_punctuation, "explicit punctuation"),
 344     (test_implicit_punctuation, "implicit punctuation"),
 345     (test_typo_replacement, "typo replacement"),
 346     (test_sentence_capitalization, "sentence capitalization"),
 347     (test_chat_mode, "chat mode"),
 348     (test_wrapping, "wrapping"),
 349     (test_forbid_ansi_input, "raw escape input is filtered"),
 350     (test_escape_macros, "replacement macros are escaped"),
 351     (test_movement, "movement"),
 352     (test_actor_disappears, "actor spontaneous disappearance"),
 353     (test_account1_teardown, "second account teardown"),
 354     (test_admin_setup, "admin account setup"),
 355     (test_preferences, "set and show preferences"),
 356     (test_crlf_eol, "send crlf from the client as eol"),
 357     (test_telnet_iac, "escape stray telnet iac bytes"),
 358     (test_telnet_unknown_command, "strip unknown telnet command"),
 359     (test_telnet_unknown_option, "log unknown telnet option"),
 360     (test_admin_restriction, "restricted admin commands"),
 361     (test_admin_help, "admin help"),
 362     (test_help, "help command"),
 363     (test_abbrev, "command abbreviation"),
 364     (test_reload, "reload"),
 365     (test_set_facet, "set facet"),
 366     (test_set_refused, "refuse altering read-only element"),
 367     (test_show_version, "show version and diagnostic info"),
 368     (test_show_time, "show elapsed world clock increments"),
 369     (test_show_files, "show a list of loaded files"),
 370     (test_show_file, "show nodes from a specific file"),
 371     (test_show_groups, "show groups"),
 372     (test_show_group, "show group"),
 373     (test_show_element, "show element"),
 374     (test_show_result, "show result of a python expression"),
 375     (test_show_log, "show log"),
 376     (test_custom_loglevel, "custom loglevel"),
 377     (test_invalid_loglevel, "invalid loglevel"),
 378     (test_log_no_errors, "no errors logged"),
 379     (final_cleanup, "delete remaining accounts"),
 380 )
 381
 382
 383 def start_service(config):
 384     # Clean up any previously run daemon which didn't terminate
 385     if os.path.exists(pidfile):
 386         pidfd = open(pidfile)
 387         pid = int(pidfd.read())
 388         try:
 389             # Stop the running service
 390             os.kill(pid, 15)
 391             time.sleep(1)
 392         except ProcessLookupError:
 393             # If there was no process, just remove the stale PID file
 394             os.remove(pidfile)
 395         # If there's a preexisting hung service, we can't proceed
 396         assert not os.path.exists(pidfile)
 397
 398     # Clean up any previous test output
 399     for f in pathlib.Path(".").glob("capture_*.log"):
 400         # have to use .name here since remove() doesn't support passing a
 401         # PosixPath argument until Python3.6
 402         os.remove(f.name)
 403     for d in ("data", "var"):
 404         shutil.rmtree(d, ignore_errors=True)
 405
 406     # Start the service and wait for it to be ready for connections
 407     service = subprocess.Popen(("mudpy", config),
 408                                stdout=subprocess.PIPE,
 409                                stderr=subprocess.PIPE)
 410     time.sleep(1)
 411     return(service)
 412
 413
 414 def stop_service(service):
 415     success = True
 416
 417     # The no-op case when no service was started
 418     if service is None:
 419         return(success)
 420
 421     # This handles when the service is running as a direct child process
 422     service.terminate()
 423     returncode = service.wait(10)
 424     if returncode != 0:
 425         tlog("\nERROR: Service exited with code %s." % returncode)
 426         success = False
 427
 428     # This cleans up a daemonized and disassociated service
 429     if os.path.exists(pidfile):
 430         pidfd = open(pidfile)
 431         pid = int(pidfd.read())
 432         try:
 433             # Stop the running service
 434             os.kill(pid, 15)
 435             time.sleep(1)
 436         except ProcessLookupError:
 437             # If there was no process, just remove the stale PID file
 438             os.remove(pidfile)
 439         # The PID file didn't disappear, so we have a hung service
 440         if os.path.exists(pidfile):
 441             tlog("\nERROR: Hung daemon with PID %s." % pid)
 442             success = False
 443
 444     # Log the contents of stdout and stderr, if any
 445     stdout, stderr = service.communicate()
 446     tlog("\nRecording stdout as capture_stdout.log.")
 447     serviceout = open("capture_stdout.log", "w")
 448     serviceout.write(stdout.decode("utf-8"))
 449     tlog("\nRecording stderr as capture_stderr.log.")
 450     serviceerr = open("capture_stderr.log", "w")
 451     serviceerr.write(stderr.decode("utf-8"))
 452
 453     return(success)
 454
 455
 456 def tlog(message, quiet=False):
 457     logfile = "capture_tests.log"
 458     with open(logfile, "a") as logfd:
 459         logfd.write(message + "\n")
 460     if not quiet:
 461         sys.stdout.write(message)
 462     return True
 463
 464
 465 def option_callback(telnet_socket, command, option):
 466     if option == b'\x7f':
 467         # We use this unassigned option value as a canary, so short-circuit
 468         # any response to avoid endlessly looping
 469         pass
 470     elif command in (telnetlib.DO, telnetlib.DONT):
 471         telnet_socket.send(telnetlib.IAC + telnetlib.WONT + option)
 472     elif command in (telnetlib.WILL, telnetlib.WONT):
 473         telnet_socket.send(telnetlib.IAC + telnetlib.DONT + option)
 474
 475
 476 def main():
 477     captures = ["", "", ""]
 478     lusers = [telnetlib.Telnet(), telnetlib.Telnet(), telnetlib.Telnet()]
 479     success = True
 480     start = time.time()
 481     service = None
 482     if len(sys.argv) > 1:
 483         # Start the service if a config file was provided on the command line
 484         service = start_service(sys.argv[1])
 485     for luser in lusers:
 486         luser.open("::1", 4000)
 487         luser.set_option_negotiation_callback(option_callback)
 488     for test, description in dialogue:
 489         tlog("\nTesting %s..." % description)
 490         test_start = time.time()
 491         for conversant, question, answer in test:
 492             tlog("luser%s waiting for: %s" % (conversant, question),
 493                  quiet=True)
 494             try:
 495                 index, match, received = lusers[conversant].expect(
 496                     [re.compile(question.encode("utf-8"), flags=re.DOTALL)], 5)
 497                 captures[conversant] += received.decode("utf-8")
 498             except ConnectionResetError:
 499                 tlog("\nERROR: Unable to connect to server.")
 500                 success = False
 501                 break
 502             except EOFError:
 503                 tlog("\nERROR: luser%s premature disconnection expecting:\n\n"
 504                      "%s\n\n"
 505                      "Check the end of capture_%s.log for received data."
 506                      % (conversant, question, conversant))
 507                 success = False
 508                 break
 509             try:
 510                 captures[conversant] += lusers[
 511                     conversant].read_very_eager().decode("utf-8")
 512             except Exception:
 513                 pass
 514             if index != 0:
 515                 tlog("\nERROR: luser%s did not receive expected string:\n\n"
 516                      "%s\n\n"
 517                      "Check the end of capture_%s.log for received data."
 518                      % (conversant, question, conversant))
 519                 success = False
 520                 break
 521             if type(answer) is str:
 522                 tlog("luser%s sending: %s" % (conversant, answer), quiet=True)
 523                 lusers[conversant].write(("%s\r\0" % answer).encode("utf-8"))
 524                 captures[conversant] += "%s\r\n" % answer
 525             elif type(answer) is bytes:
 526                 tlog("luser%s sending raw bytes: %s" % (conversant, answer),
 527                      quiet=True)
 528                 lusers[conversant].get_socket().send(answer)
 529                 captures[conversant] += "!!!RAW BYTES: %s" % answer
 530             else:
 531                 tlog("\nERROR: answer provided with unsupported type %s"
 532                      % type(answer))
 533                 success = False
 534                 break
 535         if not success:
 536             break
 537         tlog("Completed in %.3f seconds." % (time.time() - test_start))
 538     duration = time.time() - start
 539     for conversant in range(len(captures)):
 540         try:
 541             captures[conversant] += lusers[
 542                 conversant].read_very_eager().decode("utf-8")
 543         except Exception:
 544             pass
 545         lusers[conversant].close()
 546         logfile = "capture_%s.log" % conversant
 547         tlog("\nRecording session %s as %s." % (conversant, logfile))
 548         log = open(logfile, "w")
 549         log.write(captures[conversant])
 550         log.close()
 551     if not stop_service(service):
 552         success = False
 553     tlog("\nRan %s tests in %.3f seconds." % (len(dialogue), duration))
 554     if success:
 555         tlog("\nSUCCESS\n")
 556     else:
 557         tlog("\nFAILURE\n")
 558         sys.exit(1)
 559
 560
 561 if __name__ == '__main__':
 562     sys.exit(main())