Merge pull request gregmalcolm#118 from chongkim/add-sniffer-support

gregmalcolm · gregmalcolm · commit 1afb32d2218d · 2016-01-02T03:05:35.000-05:00
Add sniffer support
diff --git a/README.rst b/README.rst
@@ -124,6 +124,37 @@ fire up the command line, recreate the scenario and run queries:
 
 .. image:: http://i442.photobucket.com/albums/qq150/gregmalcolm/DebuggingPython.png
 
+Sniffer Support
+---------------
+
+Sniffer allows you to run the tests continuously. If you modify any files files
+in the koans directory, it will rerun the tests.
+
+To set this up, you need to install sniffer::
+
+    $ pip install sniffer
+
+You should also run one of these libraries depending on your system. This will
+automatically trigger sniffer when a file changes, otherwise sniffer will have
+to poll to see if the files have changed.
+
+On Linux::
+
+    $ pip install pyinotify
+
+On Windows::
+
+    $ pip install pywin32
+
+On Mac OS X::
+
+    $ pip install MacFSEvents
+
+Once it is set up, you just run::
+
+    $ sniffer
+
+Just modify one of the koans files and you'll see that the tests are triggered automatically. Sniffer is controlled by `scent.py`
 
 Getting the Most From the Koans
 -------------------------------
diff --git a/python2/scent.py b/python2/scent.py
@@ -0,0 +1,12 @@
+from sniffer.api import *
+import os
+
+watch_paths = ['.', 'koans/']
+
+@file_validator
+def py_files(filename):
+    return filename.endswith('.py') and not os.path.basename(filename).startswith('.')
+
+@runnable
+def execute_koans(*args):
+    os.system('python -B contemplate_koans.py')
diff --git a/python3/scent.py b/python3/scent.py
@@ -0,0 +1,12 @@
+from sniffer.api import *
+import os
+
+watch_paths = ['.', 'koans/']
+
+@file_validator
+def py_files(filename):
+    return filename.endswith('.py') and not os.path.basename(filename).startswith('.')
+
+@runnable
+def execute_koans(*args):
+    os.system('python3 -B contemplate_koans.py')
