8713be52e435d0c574c39fb56e3c1b97fc5907f5
[mudpy.git] / mudpy / tests / selftest.py
1 # Copyright (c) 2004-2017 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 re
6 import sys
7 import telnetlib
8 import time
9
10 test_account0_setup = (
11     (0, "Identify yourself:", "luser0"),
12     (0, "Enter your choice:", "n"),
13     (0, 'Enter a new password for "luser0":', "Test123"),
14     (0, "Enter the same new password again:", "Test123"),
15     (0, r"What would you like to do\?", "c"),
16     (0, "Pick a birth gender for your new avatar:", "f"),
17     (0, "Choose a name for her:", "1"),
18     (0, "What would you like to do?", "a"),
19     (0, "Whom would you like to awaken?", ""),
20 )
21
22 test_account1_setup = (
23     (1, "Identify yourself:", "luser1"),
24     (1, "Enter your choice:", "n"),
25     (1, 'Enter a new password for "luser1":', "Test456"),
26     (1, "Enter the same new password again:", "Test456"),
27     (1, r"What would you like to do\?", "c"),
28     (1, "Pick a birth gender for your new avatar:", "m"),
29     (1, "Choose a name for him:", "1"),
30     (1, "What would you like to do?", "a"),
31     (1, "Whom would you like to awaken?", ""),
32 )
33
34 test_actor_appears = (
35     (0, r"You suddenly realize that .* is here\.", ""),
36 )
37
38 test_explicit_punctuation = (
39     (0, "> ", "say Hello there!"),
40     (0, r'You exclaim, "Hello there\!"', ""),
41     (1, r'exclaims, "Hello there\!"', "say And you are?"),
42     (1, r'You ask, "And you are\?"', ""),
43     (0, r'asks, "And you are\?"', "say I'm me, of course."),
44     (0, r'''You say, "I'm me, of course\."''', ""),
45     (1, r'''says, "I'm me, of course\."''', "say I wouldn't be so sure..."),
46     (1, r'''You muse, "I wouldn't be so sure\.\.\."''', ""),
47     (0, r'''muses, "I wouldn't be so sure\.\.\."''', "say You mean,"),
48     (0, 'You begin, "You mean,"', ""),
49     (1, 'begins, "You mean,"', "say I know-"),
50     (1, 'You begin, "I know-"', ""),
51     (0, 'begins, "I know-"', "say Don't interrupt:"),
52     (0, r'''You begin, "Don't interrupt:"''', ""),
53     (1, r'''begins, "Don't interrupt:"''', "say I wasn't interrupting;"),
54     (1, r'''You begin, "I wasn't interrupting;"''', ""),
55     (0, r'''begins, "I wasn't interrupting;"''', ""),
56 )
57
58 test_implicit_punctuation = (
59     (0, '> ', "say Whatever"),
60     (0, r'You say, "Whatever\."', ""),
61     (1, r'says, "Whatever\."', ""),
62 )
63
64 test_typo_replacement = (
65     (1, '> ', "say That's what i think."),
66     (1, r'''You say, "That's what I think\."''', ""),
67     (0, r'''says, "That's what I think\."''', "say You know what i'd like."),
68     (0, r'''You say, "You know what I'd like\."''', ""),
69     (1, r'''says, "You know what I'd like\."''', "say Then i'll tell you."),
70     (1, r'''You say, "Then I'll tell you\."''', ""),
71     (0, r'''says, "Then I'll tell you\."''', "say Now i'm ready."),
72     (0, r'''You say, "Now I'm ready\."''', ""),
73     (1, r'''says, "Now I'm ready\."''', "say That's teh idea."),
74     (1, r'''You say, "That's the idea\."''', ""),
75     (0, r'''says, "That's the idea\."''', "say It's what theyre saying."),
76     (0, r'''You say, "It's what they're saying\."''', ""),
77     (1, r'''says, "It's what they're saying\."''', "say Well, youre right."),
78     (1, r'''You say, "Well, you're right\."''', ""),
79     (0, r'''says, "Well, you're right\."''', ""),
80 )
81
82 test_sentence_capitalization = (
83     (0, "> ", "say this sentence should start with a capital T."),
84     (0, 'You say, "This sentence', ""),
85     (1, 'says, "This sentence', ""),
86 )
87
88 test_chat_mode = (
89     (1, '> ', "chat"),
90     (1, r'(?s)Entering chat mode .*> \(chat\) ', "Feeling chatty."),
91     (1, r'You say, "Feeling chatty\."', "!chat"),
92     (0, r'says, "Feeling chatty\."', ""),
93     (1, '> ', "say Now less chatty."),
94     (1, r'You say, "Now less chatty\."', ""),
95     (0, r'says, "Now less chatty\."', ""),
96 )
97
98 test_movement = (
99     (0, "> ", "move north"),
100     (0, r"You exit to the north\.", ""),
101     (1, r"exits to the north\.", "move north"),
102     (0, r"arrives from the south\.", "move south"),
103     (0, r"You exit to the south\.", ""),
104     (1, r"exits to the south\.", "move south"),
105     (0, r"arrives from the north\.", "move east"),
106     (0, r"You exit to the east\.", ""),
107     (1, r"exits to the east\.", "move east"),
108     (0, r"arrives from the west\.", "move west"),
109     (0, r"You exit to the west\.", ""),
110     (1, r"exits to the west\.", "move west"),
111     (0, r"arrives from the east\.", "move up"),
112     (0, r"You exit upward\.", ""),
113     (1, r"exits upward\.", "move up"),
114     (0, r"arrives from below\.", "move down"),
115     (0, r"You exit downward\.", ""),
116     (1, r"exits downward\.", "move down"),
117     (0, r"arrives from above\.", ""),
118 )
119
120 test_actor_disappears = (
121     (1, "> ", "quit"),
122     (0, r"You suddenly wonder where .* went\.", ""),
123 )
124
125 test_account1_teardown = (
126     (1, "What would you like to do?", "d"),
127     (1, "Whom would you like to delete?", ""),
128     (1, "What would you like to do?", "p"),
129     (1, "permanently delete your account?", "y"),
130     (1, "Disconnecting...", ""),
131 )
132
133 test_admin_setup = (
134     (2, "Identify yourself:", "admin"),
135     (2, "Enter your choice:", "n"),
136     (2, 'Enter a new password for "admin":', "Test789"),
137     (2, "Enter the same new password again:", "Test789"),
138     (2, r"What would you like to do\?", "c"),
139     (2, "Pick a birth gender for your new avatar:", "m"),
140     (2, "Choose a name for him:", "1"),
141     (2, "What would you like to do?", "a"),
142     (2, "Whom would you like to awaken?", ""),
143 )
144
145 test_admin_restriction = (
146     (0, "> ", "help halt"),
147     (0, r"That is not an available command\.", "halt"),
148     (0, '(not sure what "halt" means|Arglebargle, glop-glyf)', ""),
149 )
150
151 test_admin_help = (
152     (2, "> ", "help"),
153     (2, r"halt.*Shut down the world\.", "help halt"),
154     (2, "This will save all active accounts", ""),
155 )
156
157 test_reload = (
158     (2, "> ", "reload"),
159     (2, r"Reloading all code modules, configs and data\."
160         r".* User admin reloaded the world\.", ""),
161 )
162
163 test_show_element = (
164     (2, "> ", "show element mudpy.limit"),
165     (2, r'These are the properties of the "mudpy.limit" element '
166         r'\(in.*\.yaml"\):.*   \x1b\[32mpassword_tries: '
167         r'\x1b\[31m[0-9]+\x1b\[0m.*> ', "show element internal:counters"),
168     (2, r'These are the properties of the "internal:counters" element '
169         r'\(in.*\.yaml"\):.*   \x1b\[32melapsed: '
170         r'\x1b\[31m[0-9]+\x1b\[0m', ""),
171 )
172
173 test_show_log = (
174     (2, "> ", "show log"),
175     (2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
176         r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
177 )
178
179 test_custom_loglevel = (
180     (2, "> ", "set account:admin loglevel 2"),
181     (2, "You have successfully .*> ", "show log"),
182     (2, r"There are [0-9]+ log lines in memory and [0-9]+ at or above level "
183         r"[0-9]+\. The matching lines\r\nfrom [0-9]+ to [0-9]+ are:", ""),
184 )
185
186 test_invalid_loglevel = (
187     (2, "> ", "set account:admin loglevel two"),
188     (2, r'''Value "two" of type "<class 'str'>" cannot be coerced .*> ''', ""),
189 )
190
191 test_log_no_errors = (
192     (2, "> ", "show log 7"),
193     (2, r"None of the [0-9]+ lines in memory matches your request\.", ""),
194 )
195
196 dialogue = (
197     (test_account0_setup, "first account setup"),
198     (test_account1_setup, "second account setup"),
199     (test_actor_appears, "actor spontaneous appearance"),
200     (test_explicit_punctuation, " explicit punctuation"),
201     (test_implicit_punctuation, "implicit punctuation"),
202     (test_typo_replacement, "typo replacement"),
203     (test_sentence_capitalization, "sentence capitalization"),
204     (test_chat_mode, "chat mode"),
205     (test_movement, "movement"),
206     (test_actor_disappears, "actor spontaneous disappearance"),
207     (test_account1_teardown, "second account teardown"),
208     (test_admin_setup, "admin account setup"),
209     (test_admin_restriction, "restricted admin commands"),
210     (test_admin_help, "admin help"),
211     (test_reload, "reload"),
212     (test_show_element, "show element"),
213     (test_show_log, "show log"),
214     (test_custom_loglevel, "custom loglevel"),
215     (test_invalid_loglevel, "invalid loglevel"),
216     (test_log_no_errors, "no errors logged"),
217 )
218
219
220 def main():
221     captures = ["", "", ""]
222     lusers = [telnetlib.Telnet(), telnetlib.Telnet(), telnetlib.Telnet()]
223     success = True
224     start = time.time()
225     for luser in lusers:
226         luser.open("::1", 4000)
227     for test, description in dialogue:
228         print("\nTesting %s..." % description)
229         test_start = time.time()
230         for conversant, question, answer in test:
231             print("luser%s waiting for: %s" % (conversant, question))
232             index, match, received = lusers[conversant].expect(
233                 [re.compile(question.encode("utf-8"), flags=re.DOTALL)], 5)
234             captures[conversant] += received.decode("utf-8")
235             try:
236                 captures[conversant] += lusers[
237                     conversant].read_very_eager().decode("utf-8")
238             except:
239                 pass
240             if index is not 0:
241                 print("ERROR: luser%s did not receive expected string:\n\n"
242                       "%s\n\n"
243                       "Check the end of capture_%s.log for received data."
244                       % (conversant, question, conversant))
245                 success = False
246                 break
247             print("luser%s sending: %s" % (conversant, answer))
248             lusers[conversant].write(("%s\r\n" % answer).encode("utf-8"))
249             captures[conversant] += "%s\r\n" % answer
250         if not success:
251             break
252         print("Completed in %.3f seconds." % (time.time() - test_start))
253     duration = time.time() - start
254     print("")
255     for conversant in range(len(captures)):
256         try:
257             captures[conversant] += lusers[
258                 conversant].read_very_eager().decode("utf-8")
259         except:
260             pass
261         lusers[conversant].close()
262         logfile = "capture_%s.log" % conversant
263         print("Recording session %s as %s." % (conversant, logfile))
264         log = open(logfile, "w")
265         log.write(captures[conversant])
266         log.close()
267     print("\nRan %s tests in %.3f seconds." % (len(dialogue), duration))
268     if success:
269         print("SUCCESS")
270     else:
271         print("FAILURE")
272         sys.exit(1)
273
274
275 if __name__ == '__main__':
276     sys.exit(main())