Add tests for examples

.travis.yml

@@ -31,6 +31,7 @@ script:
   - python runtests.py
   - python examples/django_app/manage.py test examples/django_app/
   - nosetests --with-coverage --cover-package=chatterbot
+  - nosetests examples
   - sphinx-build -nW -b html ./docs/ ./build/
   - python tests/benchmarks.py
 

examples/basic_example.py

@@ -2,9 +2,9 @@
 from chatterbot import ChatBot
 
 # Create a new chat bot named Charlie
-chatbot = ChatBot("Charlie")
+chatbot = ChatBot('Charlie')
 
-# Get a response to the input "How are you?"
-response = chatbot.get_response("How are you?")
+# Get a response to the input text 'How are you?'
+response = chatbot.get_response('How are you?')
 
 print(response)

examples/tests/readme.md

@@ -0,0 +1,6 @@
+Tests for ChatterBot examples
+=============================
+
+This directory contains tests for the ChatterBot example programs
+to make sure that things don't break and continue to work as
+expected as changes are made to the chatterbot package.

examples/tests/smoke_tests.py

@@ -0,0 +1,97 @@
+from unittest import TestCase, SkipTest
+import sys
+import os
+
+
+# Insert the examples root directory into the PYTHONPATH
+current_directory = os.path.dirname(os.path.abspath(__file__))
+parent_directory = os.path.abspath(os.path.join(current_directory, os.pardir))
+sys.path.insert(0, parent_directory)
+
+
+class ExamplesSmokeTestCase(TestCase):
+    """
+    These are just basic tests that run each example
+    to make sure no errors are triggered.
+    """
+
+    def test_basic_example(self):
+        import basic_example
+
+    def test_default_response_example(self):
+        import default_response_example
+
+    def test_export_example(self):
+        raise SkipTest(
+            'This is being skipped to avoid '
+            'creating files durring tests.'
+        )
+
+    def test_gitter_example(self):
+        raise SkipTest(
+            'This is being skipped because keys for this '
+            'API are not included in the public repository.'
+        )
+
+    def test_hipchat_bot(self):
+        raise SkipTest(
+            'This is being skipped because keys for this '
+            'API are not included in the public repository.'
+        )
+
+    def test_learning_feedback_example(self):
+        raise SkipTest(
+            'This is being skipped because it contains '
+            'a while loop in the code body and will not '
+            'terminate on its own.'
+        )
+
+    def test_mailgun_example(self):
+        raise SkipTest(
+            'This is being skipped because keys for this '
+            'API are not included in the public repository.'
+        )
+
+    def test_math_and_time(self):
+        import math_and_time
+
+    def test_microsoft_bot(self):
+        raise SkipTest(
+            'This is being skipped because keys for this '
+            'API are not included in the public repository.'
+        )
+
+    def test_specific_response_example(self):
+        import specific_response_example
+
+    def test_terminal_example(self):
+        raise SkipTest(
+            'This is being skipped because it contains '
+            'a while loop in the code body and will not '
+            'terminate on its own.'
+        )
+
+    def test_terminal_example(self):
+        raise SkipTest(
+            'This is being skipped so that we do not have '
+            'to check if Mongo DB is running before running '
+            'this test.'
+        )
+
+    def test_tkinter_gui(self):
+        raise SkipTest(
+            'This is being skipped so that we do not open up '
+            'a GUI durring testing.'
+        )
+
+    def test_twitter_training_example(self):
+        raise SkipTest(
+            'This is being skipped because keys for this '
+            'API are not included in the public repository.'
+        )
+
+    def test_ubuntu_corpus_training_example(self):
+        raise SkipTest(
+            'This test is being skipped because it takes '
+            'hours to download and train from this corpus.'
+        )