-# Copyright (c) 2004-2018 Jeremy Stanley <fungi@yuggoth.org>. Permission
-# to use, copy, modify, and distribute this software is granted under
-# terms provided in the LICENSE file distributed with this software.
+# Copyright (c) 2004-2020 mudpy authors. Permission to use, copy,
+# modify, and distribute this software is granted under terms
+# provided in the LICENSE file distributed with this software.
import os
+import pathlib
import re
+import shutil
+import subprocess
import sys
import telnetlib
import time
+import yaml
+
+# TODO(fungi) Clean this up once Python 3.5 is no longer supported
+if sys.version < "3.6":
+ import collections
+ odict = collections.OrderedDict
+else:
+ odict = dict
+
+pidfile = "var/mudpy.pid"
+
test_account0_setup = (
(0, "Identify yourself:", "luser0"),
(0, "Enter your choice:", "n"),
(0, r"What would you like to do\?", "c"),
(0, "Pick a birth gender for your new avatar:", "f"),
(0, "Choose a name for her:", "1"),
- (0, "What would you like to do?", "a"),
- (0, "Whom would you like to awaken?", ""),
+ (0, r"What would you like to do\?", "a"),
+ (0, r"Whom would you like to awaken\?", ""),
)
test_account1_setup = (
(1, r"What would you like to do\?", "c"),
(1, "Pick a birth gender for your new avatar:", "m"),
(1, "Choose a name for him:", "1"),
- (1, "What would you like to do?", "a"),
- (1, "Whom would you like to awaken?", ""),
+ (1, r"What would you like to do\?", "a"),
+ (1, r"Whom would you like to awaken\?", ""),
)
test_actor_appears = (
(1, r'says,\r\n"O[o]+\."', ""),
)
+test_forbid_ansi_input = (
+ (0, '> ', "say \x1b[35mfoo\x1b[0m"),
+ (1, r'says, "\[35mfoo\[0m\."', ""),
+)
+
+test_escape_macros = (
+ (0, '> ', "say $(red)bar$(nrm)"),
+ (1, r'says, "\$\(red\)bar\$\(nrm\)\."', ""),
+)
+
test_movement = (
(0, "> ", "move north"),
(0, r"You exit to the north\.", ""),
(0, r"You suddenly wonder where .* went\.", ""),
)
-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"),
- (1, "permanently delete your account?", "y"),
- (1, "Disconnecting...", ""),
+test_abort_avatar_deletion = (
+ (1, r"What would you like to do\?", "d"),
+ (1, r"Whom would you like to delete\?", ""),
+ (1, r"delete an unwanted avatar.*What would you like to do\?", ""),
+)
+
+test_avatar_creation_limit = (
+ (1, r"What would you like to do\?", "c"),
+ (1, "Pick a birth gender for your new avatar:", "m"),
+ (1, "Choose a name for him:", "3"),
+ (1, r"What would you like to do\?", "c"),
+ (1, "Pick a birth gender for your new avatar:", "m"),
+ (1, "Choose a name for him:", "4"),
+ (1, r"What would you like to do\?", "c"),
+ (1, "Pick a birth gender for your new avatar:", "m"),
+ (1, "Choose a name for him:", "7"),
+ (1, r"What would you like to do\?", "c"),
+ (1, "Pick a birth gender for your new avatar:", "m"),
+ (1, "Choose a name for him:", "5"),
+ (1, r"What would you like to do\?", "c"),
+ (1, "Pick a birth gender for your new avatar:", "m"),
+ (1, "Choose a name for him:", "2"),
+ (1, r"What would you like to do\?", "c"),
+ (1, "Pick a birth gender for your new avatar:", "m"),
+ (1, "Choose a name for him:", "6"),
+ (1, r"What would you like to do\?", "c"),
+ (1, r"That is not a valid choice\.\.\.", ""),
+)
+
+test_avatar_deletion = (
+ (1, r"What would you like to do\?", "d"),
+ (1, r"Whom would you like to delete\?", "1"),
+ (1, r"create a new avatar.*What would you like to do\?", ""),
+)
+
+test_abort_account_deletion = (
+ (1, r"What would you like to do\?", "p"),
+ (1, r"permanently delete your account\?", ""),
+ (1, r"What would you like to do\?", ""),
+)
+
+test_account_deletion = (
+ (1, r"What would you like to do\?", "p"),
+ (1, r"permanently delete your account\?", "y"),
+ (1, r"Disconnecting\.\.\.", ""),
)
test_admin_setup = (
(2, r"What would you like to do\?", "c"),
(2, "Pick a birth gender for your new avatar:", "m"),
(2, "Choose a name for him:", "1"),
- (2, "What would you like to do?", "a"),
- (2, "Whom would you like to awaken?", ""),
+ (2, r"What would you like to do\?", "a"),
+ (2, r"Whom would you like to awaken\?", ""),
+)
+
+test_preferences = (
+ (0, "> ", "preferences"),
+ (0, r"\[32mprompt\x1b\[0m - <not set>.*> ", "preferences prompt $(foo)"),
+ (0, r"\$\(foo\) ", "preferences prompt"),
+ (0, r"\$\(foo\).*\$\(foo\) ", "preferences prompt $(time)>"),
+ (0, "[0-9]> ", "preferences loglevel 0"),
+ (0, "does not exist.*> ", "preferences prompt >"),
+ (2, "> ", "preferences loglevel 0"),
+ (2, "> ", "preferences"),
+ (2, r"\[31mloglevel\x1b\[0m - 0.*> ", "preferences loglevel zero"),
+ (2, r'''cannot be set to type "<class 'str'>"\..*> ''', ""),
+)
+
+test_crlf_eol = (
+ # Send a CR+LF at the end of the line instead of the default CR+NUL,
+ # to make sure they're treated the same
+ (2, "> ", b"say I use CR+LF as my EOL, not CR+NUL.\r\n"),
+ (2, r'You say, "I use CR\+LF as my EOL, not CR\+NUL\.".*> ', ""),
)
test_telnet_iac = (
# Send a double (escaped) IAC byte within other text, which should get
# unescaped and deduplicated to a single \xff in the buffer and then
- # the line of input discarded as a non-UTF-8 sequence
- (2, "> ", b"say argle\xff\xffbargle\r\n"),
- (2, r"Non-UTF-8 sequence from admin: b'say argle\\xffbargle'.*> ", ""),
+ # the line of input discarded as a non-ASCII sequence
+ (2, "> ", b"say argle\xff\xffbargle\r\0"),
+ (2, r"Non-ASCII characters from admin: b'say.*argle\\xffbargle'.*> ", ""),
)
-test_telnet_unknown = (
+test_telnet_unknown_command = (
# Send an unsupported negotiation command #127 which should get filtered
# from the line of input
- (2, "> ", b"say glop\xff\x7fglyf\r\n"),
- (2, r'Unknown Telnet IAC command 127 ignored\..*"Glopglyf\.".*> ', ""),
+ (2, "> ", b"say glop\xff\x7fglyf\r\0"),
+ (2, r'Ignored unknown command 127 from admin\..*"Glopglyf\.".*> ', ""),
+)
+
+test_telnet_unknown_option = (
+ # Send an unassigned negotiation option #127 which should get logged
+ (2, "> ", b"\xff\xfe\x7f\r\0"),
+ (2, r'''Received "don't 127" from admin\..*> ''', ""),
)
test_admin_restriction = (
(2, "This will save all active accounts", ""),
)
+test_help = (
+ (0, "> ", "help say"),
+ (0, r"See also: .*chat.*> ", ""),
+)
+
+test_abbrev = (
+ (0, "> ", "h"),
+ (0, r"h\[elp\].*m\[ove\].*> ", "he mo"),
+ (0, r"Move in a specific direction\..*> ", "mov nor"),
+ (0, r"You exit to the north\..*> ", "m s"),
+ (0, r"You exit to the south\..*> ", ""),
+)
+
test_reload = (
(2, "> ", "reload"),
(2, r"Reloading all code modules, configs and data\."
- r".* User admin reloaded the world\.", ""),
+ r".* User admin reloaded the world\.",
+ "show element account.admin"),
+ (2, r'These are the properties of the "account\.admin" element.*'
+ r' \x1b\[32mpasshash:\r\n\x1b\[31m\$.*> ', ""),
)
test_set_facet = (
(2, r"Running mudpy .* on .* Python 3.*with.*pyyaml.*> ", ""),
)
+test_show_time = (
+ (2, "> ", "show time"),
+ (2, r"\r\n[0-9]+ increments elapsed.*> ", ""),
+)
+
test_show_files = (
(2, "> ", "show files"),
(2, r'These are the current files containing the universe:.*'
- r' \x1b\[31m\(rw\) \x1b\[32m/.*/account.yaml\x1b\[0m'
+ r' \x1b\[31m\(rw\) \x1b\[32m/.*/account\.yaml\x1b\[0m'
r' \x1b\[33m\[private\]\x1b\[0m.*> ', ""),
)
(2, r'These are the properties of the "mudpy\.limit" element.*'
r' \x1b\[32mpassword_tries: \x1b\[31m3.*> ',
"show element actor.avatar_admin_0"),
- (2, r'These are the properties of the "actor.avatar_admin_0" element.*'
+ (2, r'These are the properties of the "actor\.avatar_admin_0" element.*'
r' \x1b\[32mgender: \x1b\[31mfemale.*> ', ""),
)
+test_evaluate = (
+ (2, "> ", "evaluate 12345*67890"),
+ (2, r"\r\n838102050\r\n.*> ", "evaluate 1/0"),
+ (2, "Your expression raised an exception.*division by zero.*> ",
+ "evaluate mudpy"),
+ (2, "<module 'mudpy' from.*> ", "evaluate re"),
+ (2, "Your expression raised an exception.*name 're' is not defined.*> ",
+ "evaluate universe"),
+ (2, r"<mudpy\.misc\.Universe object at 0x.*> ", "evaluate actor"),
+ (2, "Your expression raised an exception.*name 'actor' is not defined.*> ",
+ "evaluate dir(mudpy)"),
+ (2, "__builtins__.*> ", "evaluate mudpy.__builtins__.open"),
+ (2, "not allowed.*> ", "evaluate (lambda x: x + 1)(2)"),
+ (2, "not allowed.*> ", ""),
+)
+
+test_debug_restricted = (
+ (0, "> ", "help evaluate"),
+ (0, r"That is not an available command\.", "evaluate"),
+ (0, '(not sure what "evaluate" means|Arglebargle, glop-glyf)', ""),
+)
+
+test_debug_disabled = (
+ (2, "> ", "help evaluate"),
+ (2, r"That is not an available command\.", "evaluate"),
+ (2, '(not sure what "evaluate" means|Arglebargle, glop-glyf)', ""),
+)
+
test_show_log = (
(2, "> ", "show log"),
(2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
- r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
+ r"[0-9]+\. The matching.*from [0-9]+ to [0-9]+ are:", ""),
)
test_custom_loglevel = (
(2, "> ", "set account.admin loglevel 2"),
(2, "You have successfully .*> ", "show log"),
(2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
- r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
+ r"[0-9]+\. The matching.*from [0-9]+ to [0-9]+ are:", ""),
)
test_invalid_loglevel = (
(2, r"None of the [0-9]+ lines in memory matches your request\.", ""),
)
-dialogue = (
+final_cleanup = (
+ (0, "> ", "quit"),
+ (0, r"What would you like to do\?", "p"),
+ (0, r"permanently delete your account\?", "y"),
+ (0, r"Disconnecting\.\.\.", ""),
+ (2, "> ", "quit"),
+ (2, r"What would you like to do\?", "p"),
+ (2, r"permanently delete your account\?", "y"),
+ (2, r"Disconnecting\.\.\.", ""),
+)
+
+dialogue = odict((
(test_account0_setup, "first account setup"),
(test_account1_setup, "second account setup"),
(test_actor_appears, "actor spontaneous appearance"),
- (test_explicit_punctuation, " explicit punctuation"),
+ (test_explicit_punctuation, "explicit punctuation"),
(test_implicit_punctuation, "implicit punctuation"),
(test_typo_replacement, "typo replacement"),
(test_sentence_capitalization, "sentence capitalization"),
(test_chat_mode, "chat mode"),
(test_wrapping, "wrapping"),
+ (test_forbid_ansi_input, "raw escape input is filtered"),
+ (test_escape_macros, "replacement macros are escaped"),
(test_movement, "movement"),
(test_actor_disappears, "actor spontaneous disappearance"),
- (test_account1_teardown, "second account teardown"),
+ (test_abort_avatar_deletion, "abort avatar deletion"),
+ (test_avatar_creation_limit, "avatar creation limit"),
+ (test_avatar_deletion, "avatar deletion"),
+ (test_abort_account_deletion, "abort account deletion"),
+ (test_account_deletion, "account deletion"),
(test_admin_setup, "admin account setup"),
+ (test_preferences, "set and show preferences"),
+ (test_crlf_eol, "send crlf from the client as eol"),
(test_telnet_iac, "escape stray telnet iac bytes"),
- (test_telnet_unknown, "strip unknown telnet command"),
+ (test_telnet_unknown_command, "strip unknown telnet command"),
+ (test_telnet_unknown_option, "log unknown telnet option"),
(test_admin_restriction, "restricted admin commands"),
(test_admin_help, "admin help"),
+ (test_help, "help command"),
+ (test_abbrev, "command abbreviation"),
(test_reload, "reload"),
(test_set_facet, "set facet"),
(test_set_refused, "refuse altering read-only element"),
(test_show_version, "show version and diagnostic info"),
+ (test_show_time, "show elapsed world clock increments"),
(test_show_files, "show a list of loaded files"),
(test_show_file, "show nodes from a specific file"),
(test_show_groups, "show groups"),
(test_show_group, "show group"),
(test_show_element, "show element"),
+ (test_evaluate, "show results of python expressions"),
+ (test_debug_restricted, "only admins can run debug commands"),
+ (test_debug_disabled, "debugging commands only in debug mode"),
(test_show_log, "show log"),
(test_custom_loglevel, "custom loglevel"),
(test_invalid_loglevel, "invalid loglevel"),
(test_log_no_errors, "no errors logged"),
+ (final_cleanup, "delete remaining accounts"),
+))
+
+debug_tests = (
+ test_evaluate,
+)
+
+nondebug_tests = (
+ test_debug_disabled,
)
+def start_service(config):
+ # Clean up any previously run daemon which didn't terminate
+ if os.path.exists(pidfile):
+ with open(pidfile) as pidfd:
+ pid = int(pidfd.read())
+ try:
+ # Stop the running service
+ os.kill(pid, 15)
+ time.sleep(1)
+ except ProcessLookupError:
+ # If there was no process, just remove the stale PID file
+ os.remove(pidfile)
+ # If there's a preexisting hung service, we can't proceed
+ assert not os.path.exists(pidfile)
+
+ # Clean up any previous test output
+ for f in pathlib.Path(".").glob("capture_*.log"):
+ os.remove(f)
+ for d in ("data", "var"):
+ shutil.rmtree(d, ignore_errors=True)
+
+ # Start the service and wait for it to be ready for connections
+ service = subprocess.Popen(("mudpy", config),
+ stdout=subprocess.PIPE,
+ stderr=subprocess.PIPE)
+ time.sleep(1)
+ return service
+
+
+def stop_service(service):
+ success = True
+
+ # The no-op case when no service was started
+ if service is None:
+ return success
+
+ # This handles when the service is running as a direct child process
+ service.terminate()
+ returncode = service.wait(10)
+ if returncode != 0:
+ tlog("\nERROR: Service exited with code %s." % returncode)
+ success = False
+
+ # This cleans up a daemonized and disassociated service
+ if os.path.exists(pidfile):
+ with open(pidfile) as pidfd:
+ pid = int(pidfd.read())
+ try:
+ # Stop the running service
+ os.kill(pid, 15)
+ time.sleep(1)
+ except ProcessLookupError:
+ # If there was no process, just remove the stale PID file
+ os.remove(pidfile)
+ # The PID file didn't disappear, so we have a hung service
+ if os.path.exists(pidfile):
+ tlog("\nERROR: Hung daemon with PID %s." % pid)
+ success = False
+
+ # Log the contents of stdout and stderr, if any
+ stdout, stderr = service.communicate()
+ tlog("\nRecording stdout as capture_stdout.log.")
+ with open("capture_stdout.log", "w") as serviceout:
+ serviceout.write(stdout.decode("utf-8"))
+ tlog("\nRecording stderr as capture_stderr.log.")
+ with open("capture_stderr.log", "w") as serviceerr:
+ serviceerr.write(stderr.decode("utf-8"))
+
+ return success
+
+
+def tlog(message, quiet=False):
+ logfile = "capture_tests.log"
+ with open(logfile, "a") as logfd:
+ logfd.write(message + "\n")
+ if not quiet:
+ sys.stdout.write(message)
+ return True
+
+
+def option_callback(telnet_socket, command, option):
+ if option == b'\x7f':
+ # We use this unassigned option value as a canary, so short-circuit
+ # any response to avoid endlessly looping
+ pass
+ elif command in (telnetlib.DO, telnetlib.DONT):
+ telnet_socket.send(telnetlib.IAC + telnetlib.WONT + option)
+ elif command in (telnetlib.WILL, telnetlib.WONT):
+ telnet_socket.send(telnetlib.IAC + telnetlib.DONT + option)
+
+
+def check_debug():
+ if len(sys.argv) > 1:
+ config = yaml.safe_load(open(sys.argv[1]))
+ return config.get(".mudpy.limit.debug", False)
+ return False
+
+
def main():
captures = ["", "", ""]
lusers = [telnetlib.Telnet(), telnetlib.Telnet(), telnetlib.Telnet()]
success = True
start = time.time()
+ service = None
+ if len(sys.argv) > 1:
+ # Start the service if a config file was provided on the command line
+ service = start_service(sys.argv[1])
+ if not service:
+ tlog("\nERROR: Service did not start.\n")
+ sys.exit(1)
for luser in lusers:
luser.open("::1", 4000)
- for test, description in dialogue:
- print("\nTesting %s..." % description)
+ luser.set_option_negotiation_callback(option_callback)
+ selected_dialogue = odict(dialogue)
+ if check_debug():
+ for test in nondebug_tests:
+ del selected_dialogue[test]
+ else:
+ for test in debug_tests:
+ del selected_dialogue[test]
+ for test, description in selected_dialogue.items():
+ tlog("\nTesting %s..." % description)
test_start = time.time()
for conversant, question, answer in test:
- print("luser%s waiting for: %s" % (conversant, question))
+ tlog("luser%s waiting for: %s" % (conversant, question),
+ quiet=True)
try:
index, match, received = lusers[conversant].expect(
[re.compile(question.encode("utf-8"), flags=re.DOTALL)], 5)
captures[conversant] += received.decode("utf-8")
except ConnectionResetError:
- print("ERROR: Unable to connect to server.")
+ tlog("\nERROR: Unable to connect to server.")
success = False
break
except EOFError:
- print("ERROR: luser%s premature disconnection expecting:\n\n"
- "%s\n\n"
- "Check the end of capture_%s.log for received data."
- % (conversant, question, conversant))
+ tlog("\nERROR: luser%s premature disconnection expecting:\n\n"
+ "%s\n\n"
+ "Check the end of capture_%s.log for received data."
+ % (conversant, question, conversant))
success = False
break
try:
conversant].read_very_eager().decode("utf-8")
except Exception:
pass
- if index is not 0:
- print("ERROR: luser%s did not receive expected string:\n\n"
- "%s\n\n"
- "Check the end of capture_%s.log for received data."
- % (conversant, question, conversant))
+ if index != 0:
+ tlog("\nERROR: luser%s did not receive expected string:\n\n"
+ "%s\n\n"
+ "Check the end of capture_%s.log for received data."
+ % (conversant, question, conversant))
success = False
break
if type(answer) is str:
- print("luser%s sending: %s" % (conversant, answer))
- lusers[conversant].write(("%s\r\n" % answer).encode("utf-8"))
+ tlog("luser%s sending: %s" % (conversant, answer), quiet=True)
+ lusers[conversant].write(("%s\r\0" % answer).encode("utf-8"))
captures[conversant] += "%s\r\n" % answer
elif type(answer) is bytes:
- print("luser%s sending raw bytes: %s" % (conversant, answer))
+ tlog("luser%s sending raw bytes: %s" % (conversant, answer),
+ quiet=True)
lusers[conversant].get_socket().send(answer)
captures[conversant] += "!!!RAW BYTES: %s" % answer
else:
- print("ERROR: answer provided with unsupported type %s"
- % type(answer))
+ tlog("\nERROR: answer provided with unsupported type %s"
+ % type(answer))
success = False
break
if not success:
break
- print("Completed in %.3f seconds." % (time.time() - test_start))
+ tlog("Completed in %.3f seconds." % (time.time() - test_start))
duration = time.time() - start
- print("")
for conversant in range(len(captures)):
try:
captures[conversant] += lusers[
pass
lusers[conversant].close()
logfile = "capture_%s.log" % conversant
- print("Recording session %s as %s." % (conversant, logfile))
+ tlog("\nRecording session %s as %s." % (conversant, logfile))
log = open(logfile, "w")
log.write(captures[conversant])
log.close()
- print("\nRan %s tests in %.3f seconds." % (len(dialogue), duration))
+ if not stop_service(service):
+ success = False
+ tlog("\nRan %s tests in %.3f seconds." % (len(dialogue), duration))
if success:
- print("SUCCESS")
+ tlog("\nSUCCESS\n")
else:
- print("FAILURE")
+ tlog("\nFAILURE\n")
sys.exit(1)
projects / mudpy.git / blobdiff