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_forbid_ansi_input = (
 105     (0, '> ', "say \x1b[35mfoo\x1b[0m"),
 106     (1, r'says, "\[35mfoo\[0m\."', ""),
 107 )
 108
 109 test_movement = (
 110     (0, "> ", "move north"),
 111     (0, r"You exit to the north\.", ""),
 112     (1, r"exits to the north\.", "move north"),
 113     (0, r"arrives from the south\.", "move south"),
 114     (0, r"You exit to the south\.", ""),
 115     (1, r"exits to the south\.", "move south"),
 116     (0, r"arrives from the north\.", "move east"),
 117     (0, r"You exit to the east\.", ""),
 118     (1, r"exits to the east\.", "move east"),
 119     (0, r"arrives from the west\.", "move west"),
 120     (0, r"You exit to the west\.", ""),
 121     (1, r"exits to the west\.", "move west"),
 122     (0, r"arrives from the east\.", "move up"),
 123     (0, r"You exit upward\.", ""),
 124     (1, r"exits upward\.", "move up"),
 125     (0, r"arrives from below\.", "move down"),
 126     (0, r"You exit downward\.", ""),
 127     (1, r"exits downward\.", "move down"),
 128     (0, r"arrives from above\.", ""),
 129 )
 130
 131 test_actor_disappears = (
 132     (1, "> ", "quit"),
 133     (0, r"You suddenly wonder where .* went\.", ""),
 134 )
 135
 136 test_account1_teardown = (
 137     (1, "What would you like to do?", "d"),
 138     (1, "Whom would you like to delete?", ""),
 139     (1, "What would you like to do?", "p"),
 140     (1, "permanently delete your account?", "y"),
 141     (1, "Disconnecting...", ""),
 142 )
 143
 144 test_admin_setup = (
 145     (2, "Identify yourself:", "admin"),
 146     (2, "Enter your choice:", "n"),
 147     (2, 'Enter a new password for "admin":', "Test789"),
 148     (2, "Enter the same new password again:", "Test789"),
 149     (2, r"What would you like to do\?", "c"),
 150     (2, "Pick a birth gender for your new avatar:", "m"),
 151     (2, "Choose a name for him:", "1"),
 152     (2, "What would you like to do?", "a"),
 153     (2, "Whom would you like to awaken?", ""),
 154 )
 155
 156 test_telnet_iac = (
 157     # Send a double (escaped) IAC byte within other text, which should get
 158     # unescaped and deduplicated to a single \xff in the buffer and then
 159     # the line of input discarded as a non-ASCII sequence
 160     (2, "> ", b"say argle\xff\xffbargle\r\n"),
 161     (2, r"Non-ASCII characters from admin: b'say argle\\xffbargle'.*> ", ""),
 162 )
 163
 164 test_telnet_unknown = (
 165     # Send an unsupported negotiation command #127 which should get filtered
 166     # from the line of input
 167     (2, "> ", b"say glop\xff\x7fglyf\r\n"),
 168     (2, r'Unknown Telnet IAC command 127 ignored\..*"Glopglyf\.".*> ', ""),
 169 )
 170
 171 test_admin_restriction = (
 172     (0, "> ", "help halt"),
 173     (0, r"That is not an available command\.", "halt"),
 174     (0, '(not sure what "halt" means|Arglebargle, glop-glyf)', ""),
 175 )
 176
 177 test_admin_help = (
 178     (2, "> ", "help"),
 179     (2, r"halt.*Shut down the world\.", "help halt"),
 180     (2, "This will save all active accounts", ""),
 181 )
 182
 183 test_reload = (
 184     (2, "> ", "reload"),
 185     (2, r"Reloading all code modules, configs and data\."
 186         r".* User admin reloaded the world\.", ""),
 187 )
 188
 189 test_set_facet = (
 190     (2, "> ", "set actor.avatar_admin_0 gender female"),
 191     (2, r'You have successfully \(re\)set the "gender" facet of element', ""),
 192 )
 193
 194 test_set_refused = (
 195     (2, "> ", "set mudpy.limit password_tries 10"),
 196     (2, r'The "mudpy\.limit" element is kept in read-only file', ""),
 197 )
 198
 199 test_show_version = (
 200     (2, "> ", "show version"),
 201     (2, r"Running mudpy .* on .* Python 3.*with.*pyyaml.*> ", ""),
 202 )
 203
 204 test_show_files = (
 205     (2, "> ", "show files"),
 206     (2, r'These are the current files containing the universe:.*'
 207         r'  \x1b\[31m\(rw\) \x1b\[32m/.*/account.yaml\x1b\[0m'
 208         r' \x1b\[33m\[private\]\x1b\[0m.*> ', ""),
 209 )
 210
 211 test_show_file = (
 212     (2, "> ", "show file %s" %
 213         os.path.join(os.getcwd(), "data/internal.yaml")),
 214     (2, r'These are the nodes in the.*file:.*internal\.counters.*> ', ""),
 215 )
 216
 217 test_show_groups = (
 218     (2, "> ", "show groups"),
 219     (2, r'These are the element groups:.*'
 220         r'  \x1b\[32maccount\x1b\[0m.*> ', ""),
 221 )
 222
 223 test_show_group = (
 224     (2, "> ", "show group account"),
 225     (2, r'These are the elements in the "account" group:.*'
 226         r'  \x1b\[32maccount\.admin\x1b\[0m.*> ', ""),
 227 )
 228
 229 test_show_element = (
 230     (2, "> ", "show element mudpy.limit"),
 231     (2, r'These are the properties of the "mudpy\.limit" element.*'
 232         r'  \x1b\[32mpassword_tries: \x1b\[31m3.*> ',
 233      "show element actor.avatar_admin_0"),
 234     (2, r'These are the properties of the "actor.avatar_admin_0" element.*'
 235         r'  \x1b\[32mgender: \x1b\[31mfemale.*> ', ""),
 236 )
 237
 238 test_show_log = (
 239     (2, "> ", "show log"),
 240     (2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
 241         r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
 242 )
 243
 244 test_custom_loglevel = (
 245     (2, "> ", "set account.admin loglevel 2"),
 246     (2, "You have successfully .*> ", "show log"),
 247     (2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
 248         r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
 249 )
 250
 251 test_invalid_loglevel = (
 252     (2, "> ", "set account.admin loglevel two"),
 253     (2, r'''Value "two" of type "<class 'str'>" cannot be coerced .*> ''', ""),
 254 )
 255
 256 test_log_no_errors = (
 257     (2, "> ", "show log 7"),
 258     (2, r"None of the [0-9]+ lines in memory matches your request\.", ""),
 259 )
 260
 261 dialogue = (
 262     (test_account0_setup, "first account setup"),
 263     (test_account1_setup, "second account setup"),
 264     (test_actor_appears, "actor spontaneous appearance"),
 265     (test_explicit_punctuation, " explicit punctuation"),
 266     (test_implicit_punctuation, "implicit punctuation"),
 267     (test_typo_replacement, "typo replacement"),
 268     (test_sentence_capitalization, "sentence capitalization"),
 269     (test_chat_mode, "chat mode"),
 270     (test_wrapping, "wrapping"),
 271     (test_forbid_ansi_input, "raw escape input is filtered"),
 272     (test_movement, "movement"),
 273     (test_actor_disappears, "actor spontaneous disappearance"),
 274     (test_account1_teardown, "second account teardown"),
 275     (test_admin_setup, "admin account setup"),
 276     (test_telnet_iac, "escape stray telnet iac bytes"),
 277     (test_telnet_unknown, "strip unknown telnet command"),
 278     (test_admin_restriction, "restricted admin commands"),
 279     (test_admin_help, "admin help"),
 280     (test_reload, "reload"),
 281     (test_set_facet, "set facet"),
 282     (test_set_refused, "refuse altering read-only element"),
 283     (test_show_version, "show version and diagnostic info"),
 284     (test_show_files, "show a list of loaded files"),
 285     (test_show_file, "show nodes from a specific file"),
 286     (test_show_groups, "show groups"),
 287     (test_show_group, "show group"),
 288     (test_show_element, "show element"),
 289     (test_show_log, "show log"),
 290     (test_custom_loglevel, "custom loglevel"),
 291     (test_invalid_loglevel, "invalid loglevel"),
 292     (test_log_no_errors, "no errors logged"),
 293 )
 294
 295
 296 def main():
 297     captures = ["", "", ""]
 298     lusers = [telnetlib.Telnet(), telnetlib.Telnet(), telnetlib.Telnet()]
 299     success = True
 300     start = time.time()
 301     for luser in lusers:
 302         luser.open("::1", 4000)
 303     for test, description in dialogue:
 304         print("\nTesting %s..." % description)
 305         test_start = time.time()
 306         for conversant, question, answer in test:
 307             print("luser%s waiting for: %s" % (conversant, question))
 308             try:
 309                 index, match, received = lusers[conversant].expect(
 310                     [re.compile(question.encode("utf-8"), flags=re.DOTALL)], 5)
 311                 captures[conversant] += received.decode("utf-8")
 312             except ConnectionResetError:
 313                 print("ERROR: Unable to connect to server.")
 314                 success = False
 315                 break
 316             except EOFError:
 317                 print("ERROR: luser%s premature disconnection expecting:\n\n"
 318                       "%s\n\n"
 319                       "Check the end of capture_%s.log for received data."
 320                       % (conversant, question, conversant))
 321                 success = False
 322                 break
 323             try:
 324                 captures[conversant] += lusers[
 325                     conversant].read_very_eager().decode("utf-8")
 326             except Exception:
 327                 pass
 328             if index is not 0:
 329                 print("ERROR: luser%s did not receive expected string:\n\n"
 330                       "%s\n\n"
 331                       "Check the end of capture_%s.log for received data."
 332                       % (conversant, question, conversant))
 333                 success = False
 334                 break
 335             if type(answer) is str:
 336                 print("luser%s sending: %s" % (conversant, answer))
 337                 lusers[conversant].write(("%s\r\n" % answer).encode("utf-8"))
 338                 captures[conversant] += "%s\r\n" % answer
 339             elif type(answer) is bytes:
 340                 print("luser%s sending raw bytes: %s" % (conversant, answer))
 341                 lusers[conversant].get_socket().send(answer)
 342                 captures[conversant] += "!!!RAW BYTES: %s" % answer
 343             else:
 344                 print("ERROR: answer provided with unsupported type %s"
 345                       % type(answer))
 346                 success = False
 347                 break
 348         if not success:
 349             break
 350         print("Completed in %.3f seconds." % (time.time() - test_start))
 351     duration = time.time() - start
 352     print("")
 353     for conversant in range(len(captures)):
 354         try:
 355             captures[conversant] += lusers[
 356                 conversant].read_very_eager().decode("utf-8")
 357         except Exception:
 358             pass
 359         lusers[conversant].close()
 360         logfile = "capture_%s.log" % conversant
 361         print("Recording session %s as %s." % (conversant, logfile))
 362         log = open(logfile, "w")
 363         log.write(captures[conversant])
 364         log.close()
 365     print("\nRan %s tests in %.3f seconds." % (len(dialogue), duration))
 366     if success:
 367         print("SUCCESS")
 368     else:
 369         print("FAILURE")
 370         sys.exit(1)
 371
 372
 373 if __name__ == '__main__':
 374     sys.exit(main())