Port Perl unit tests to Python and fix relevant bugs

kirsle · kirsle · commit e0408acdf0ca · 2014-03-06T17:58:41.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+*.pyc
diff --git a/rivescript/python.py b/rivescript/python.py
@@ -53,6 +53,8 @@ def load(self, name, code):
     def call(self, rs, name, user, fields):
         """Invoke a previously loaded object."""
         # Call the dynamic method.
+        if not name in self._objects:
+            return '[ERR: Object Not Found]'
         func = self._objects[name]
         reply = ''
         try:
diff --git a/rivescript/rivescript.py b/rivescript/rivescript.py
@@ -16,7 +16,7 @@
 # Common regular expressions.
 re_equals  = re.compile('\s*=\s*')
 re_ws      = re.compile('\s+')
-re_objend  = re.compile('<\s*object')
+re_objend  = re.compile('^\s*<\s*object')
 re_weight  = re.compile('\{weight=(\d+)\}')
 re_inherit = re.compile('\{inherits=(\d+)\}')
 re_wilds   = re.compile('[\s\*\#\_]+')
@@ -25,6 +25,10 @@
 # Version of RiveScript we support.
 rs_version = 2.0
 
+# Exportable constants.
+RS_ERR_MATCH = "ERR: No Reply Matched"
+RS_ERR_REPLY = "ERR: No Reply Found"
+
 
 class RiveScript:
     """A RiveScript interpreter for Python 2 and 3."""
@@ -80,7 +84,7 @@ def VERSION(self=None):
 
     def _say(self, message):
         if self._debug:
-            print("[RS]", message)
+            print("[RS] {}".format(message))
         if self._log:
             # Log it to the file.
             fh = open(self._log, 'a')
@@ -455,7 +459,7 @@ def _parse(self, fname, code):
                     # Only try to parse a language we support.
                     ontrig = ''
                     if lang is None:
-                        self._warn("Trying to parse unknown programming language", fname, fileno)
+                        self._warn("Trying to parse unknown programming language", fname, lineno)
                         lang = 'python'  # Assume it's Python.
 
                     # See if we have a defined handler for this language.
@@ -1203,7 +1207,7 @@ def reply(self, user, msg):
 
         return reply
 
-    def _format_message(self, msg):
+    def _format_message(self, msg, botreply=False):
         """Format a user's message for safe processing."""
 
         # Make sure the string is Unicode for Python 2.
@@ -1220,6 +1224,10 @@ def _format_message(self, msg):
         # (to protect from obvious XSS attacks).
         if self._utf8:
             msg = re.sub(r'[\\<>]', '', msg)
+
+            # For the bot's reply, also strip common punctuation.
+            if botreply:
+                msg = re.sub(r'[.?,!;:@#$%^&*()]', '', msg)
         else:
             # For everything else, strip all non-alphanumerics.
             msg = self._strip_nasties(msg)
@@ -1301,7 +1309,7 @@ def _getreply(self, user, msg, context='normal', step=0):
                     lastReply = self._users[user]["__history__"]["reply"][0]
 
                     # Format the bot's last reply the same way as the human's.
-                    lastReply = self._format_message(lastReply)
+                    lastReply = self._format_message(lastReply, botreply=True)
 
                     self._say("lastReply: " + lastReply)
 
@@ -1474,9 +1482,9 @@ def _getreply(self, user, msg, context='normal', step=0):
 
         # Still no reply?
         if not foundMatch:
-            reply = "ERR: No Reply Matched"
+            reply = RS_ERR_MATCH
         elif len(reply) == 0:
-            reply = "ERR: No Reply Found"
+            reply = RS_ERR_FOUND
 
         self._say("Reply: " + reply)
 
@@ -1554,7 +1562,7 @@ def _reply_regexp(self, user, regexp):
         # Simple replacements.
         regexp = re.sub(r'\*', r'(.+?)', regexp)  # Convert * into (.+?)
         regexp = re.sub(r'#', r'(\d+?)', regexp)  # Convert # into (\d+?)
-        regexp = re.sub(r'_', r'([A-Za-z]+?)', regexp)  # Convert _ into (\w+?)
+        regexp = re.sub(r'_', r'(\w+?)', regexp)  # Convert _ into (\w+?)
         regexp = re.sub(r'\{weight=\d+\}', '', regexp) # Remove {weight} tags
         regexp = re.sub(r'<zerowidthstar>', r'(.*?)', regexp)
 
@@ -1577,6 +1585,9 @@ def _reply_regexp(self, user, regexp):
 
             regexp = re.sub(r'\s*\[' + re.escape(match) + '\]\s*', '(?:' + pipes + ')', regexp)
 
+        # _ wildcards can't match numbers!
+        regexp = re.sub(r'\\w', r'[A-Za-z]', regexp)
+
         # Filter in arrays.
         arrays = re.findall(r'\@(.+?)\b', regexp)
         for array in arrays:
@@ -1943,7 +1954,6 @@ def _find_trigger_by_inheritence(self, topic, trig, depth=0):
                         return match
 
         # Don't know what else to do!
-        self._warn("User matched a trigger, " + trig + ", but I can't find out what topic it belongs to!")
         return None
 
     def _get_topic_tree(self, topic, depth=0):
diff --git a/tests/__init__.py b/tests/__init__.py
diff --git a/tests/config.py b/tests/config.py
@@ -0,0 +1,42 @@
+#!/usr/bin/env python
+
+"""Utility functions for the unit tests."""
+
+import unittest
+from rivescript import RiveScript
+
+class RiveScriptTestCase(unittest.TestCase):
+    """Base class for all RiveScript test cases, with helper functions."""
+    
+    def setUp(self, **kwargs):
+        self.rs = None # Local RiveScript bot object
+        self.username = "localuser"
+
+
+    def tearDown(self):
+        pass
+    
+
+    def new(self, code, **kwargs):
+        """Make a bot and stream in the code."""
+        self.rs = RiveScript(**kwargs)
+        self.extend(code)
+
+
+    def extend(self, code):
+        """Stream code into the bot."""
+        lines = code.split("\n")
+        self.rs.stream(lines)
+        self.rs.sort_replies()
+
+
+    def reply(self, message, expected):
+        """Test that the user's message gets the expected response."""
+        reply = self.rs.reply(self.username, message)
+        self.assertEqual(reply, expected)
+
+
+    def uservar(self, var, expected):
+        """Test the value of a user variable."""
+        value = self.rs.get_uservar(self.username, var)
+        self.assertEqual(value, expected)
diff --git a/tests/test_rivescript.py b/tests/test_rivescript.py
