#14 Add tests. pytest_watch.command and pytest_watch.watcher

.coveragerc

@@ -0,0 +1,2 @@
+[run]
+source=pytest_watch

.gitignore

@@ -9,8 +9,14 @@ env
 .cache
 *.so
 *.py[cod]
+.eggs
+.coverage
+.coverage.*
+.pytest_cache
+.python-version
 
 # OS-specific files
 .DS_Store
 Desktop.ini
 Thumbs.db
+coverage.xml

.travis.yml

@@ -0,0 +1,22 @@
+language: python
+python:
+  - 2.7
+  - pypy2.7-5.8.0
+  - 3.4
+  - 3.5.4
+  - 3.6
+  - pypy3.5-5.8.0
+
+os:
+  - linux
+
+cache: pip
+
+install:
+  - pip install -e ".[qa]"
+
+script:
+- python -m pytest --cov=pytest_watch --cov-report=term-missing -v pytest_watch
+
+after_success:
+  - codecov --token=$CODECOV_TOKEN

README.md

@@ -111,7 +111,7 @@ Options:
   --ignore <dir>        Ignore directory from being watched and during
                         collection (multi-allowed).
   --ext <exts>          Comma-separated list of file extensions that can
-                        trigger a new test run when changed (default: .py).
+                        trigger a new test run when changed [default: .py].
                         Use --ext=* to allow any file (including .pyc).
   --config <file>       Load configuration from `file` instead of trying to
                         locate one of the implicit configuration files.
@@ -129,7 +129,7 @@ Options:
   --pdb                 Start the interactive Python debugger on errors.
                         This also enables --wait to prevent pdb interruption.
   --spool <delay>       Re-run after a delay (in milliseconds), allowing for
-                        more file system events to queue up (default: 200 ms).
+                        more file system events to queue up [default: 200].
   -p --poll             Use polling instead of OS events (useful in VMs).
   -v --verbose          Increase verbosity of the output.
   -q --quiet            Decrease verbosity of the output (precedence over -v).

appveyor.yml

@@ -0,0 +1,4 @@
+version: 1.0.{build}
+
+build_script:
+  - cmd: python setup.py test

pytest_watch/__main__.py

@@ -8,12 +8,16 @@
 :license: MIT, see LICENSE for more details.
 """
 
-import os
-import sys
 
+def run_cli():
+    import os
+    import sys
 
-if __name__ == '__main__':
     sys.path.append(os.path.dirname(__file__))
 
     from pytest_watch.command import main
     main()
+
+
+if __name__ == '__main__':
+    run_cli()

pytest_watch/command.py

@@ -11,7 +11,7 @@
   --ignore <dir>        Ignore directory from being watched and during
                         collection (multi-allowed).
   --ext <exts>          Comma-separated list of file extensions that can
-                        trigger a new test run when changed (default: .py).
+                        trigger a new test run when changed [default: .py].
                         Use --ext=* to allow any file (including .pyc).
   --config <file>       Load configuration from `file` instead of trying to
                         locate one of the implicit configuration files.
@@ -29,7 +29,7 @@
   --pdb                 Start the interactive Python debugger on errors.
                         This also enables --wait to prevent pdb interruption.
   --spool <delay>       Re-run after a delay (in milliseconds), allowing for
-                        more file system events to queue up (default: 200 ms).
+                        more file system events to queue up [default: 200].
   -p --poll             Use polling instead of OS events (useful in VMs).
   -v --verbose          Increase verbosity of the output.
   -q --quiet            Decrease verbosity of the output (precedence over -v).
@@ -55,6 +55,8 @@
 def main(argv=None):
     """
     The entry point of the application.
+
+    argv -- List of strings to parse. The default is taken from sys.argv[1:].
     """
     if argv is None:
         argv = sys.argv[1:]
@@ -68,6 +70,8 @@ def main(argv=None):
     # Get paths and initial pytest arguments
     directories = args['<directory>']
     pytest_args = list(directories)
+
+    # Merge pytest arguments and directories
     if '--' in directories:
         index = directories.index('--')
         directories = directories[:index]
@@ -76,6 +80,8 @@ def main(argv=None):
     # Adjust pytest and --collect-only args
     for ignore in args['--ignore']:
         pytest_args.extend(['--ignore', ignore])
+
+    # Set pytest config file
     if args['--config']:
         pytest_args.extend(['-c', args['--config']])
 
@@ -87,23 +93,27 @@ def main(argv=None):
     if args['--pdb']:
         pytest_args.append('--pdb')
 
-    # Parse extensions
+    # Parse extensions [default: .py]
     if args['--ext'] == '*':
         extensions = ALL_EXTENSIONS
     elif args['--ext']:
         extensions = [('.' if not e.startswith('.') else '') + e
                       for e in args['--ext'].split(',')]
-    else:
-        extensions = None
 
     # Parse numeric arguments
     spool = args['--spool']
-    if spool is not None:
-        try:
-            spool = int(spool)
-        except ValueError:
-            sys.stderr.write('Error: Spool must be an integer.\n')
-            return 2
+    try:
+        spool = int(spool)
+    except ValueError:
+        sys.stderr.write('Error: Spool (--spool {}) must be an integer.\n'
+                         .format(spool))
+        return 2
+
+    if spool < 0:
+        sys.stderr.write('Error: Spool value(--spool {}) must be positive'
+                         ' integer\n'
+                         .format(spool))
+        return 2
 
     # Run pytest and watch for changes
     return watch(directories=directories,

pytest_watch/config.py

@@ -71,8 +71,8 @@ def _collect_config(pytest_args, silent=True):
         except (Exception, SystemExit):
             pass
         # Print message and run again without silencing
-        print('Error: Could not run --collect-only to handle the pytest config '
-              'file. Trying again without silencing output...',
+        print('Error: Could not run --collect-only to handle the pytest '
+              'config file. Trying again without silencing output...',
               file=sys.stderr)
 
     return _run_pytest_collect(pytest_args)

pytest_watch/helpers.py

@@ -1,3 +1,4 @@
+import ctypes
 import os
 import signal
 import subprocess
@@ -51,12 +52,15 @@ def dequeue_all(queue, spool=None):
     return items
 
 
+def canonize_path(path):
+    return os.path.realpath(path)
+
+
 def samepath(left, right):
     """
-    Determines whether two paths are the same.
+    Determines whether two paths are the same based on their absolute paths.
     """
-    return (os.path.abspath(os.path.normcase(left)) ==
-            os.path.abspath(os.path.normcase(right)))
+    return canonize_path(left) == canonize_path(right)
 
 
 def send_keyboard_interrupt(proc):
@@ -70,7 +74,6 @@ def send_keyboard_interrupt(proc):
                 os.kill(0, signal.CTRL_C_EVENT)
             except AttributeError:
                 # Python 2.6 and below
-                import ctypes
                 ctypes.windll.kernel32.GenerateConsoleCtrlEvent(0, 0)
             # Immediately throws KeyboardInterrupt from the simulated CTRL-C
             proc.wait()

pytest_watch/summary.py

@@ -0,0 +1,81 @@
+import time
+
+from colorama import Fore, Style
+
+
+STYLE_BRIGHT = Fore.WHITE + Style.NORMAL + Style.BRIGHT
+STYLE_HIGHLIGHT = Fore.CYAN + Style.NORMAL + Style.BRIGHT
+
+
+def _reduce_events(events):
+    # FUTURE: Reduce ['a -> b', 'b -> c'] renames to ['a -> c']
+
+    creates = []
+    moves = []
+    for event, src, dest in events:
+        if event == FileCreatedEvent:
+            creates.append(dest)
+        if event == FileMovedEvent:
+            moves.append(dest)
+
+    seen = []
+    filtered = []
+    for event, src, dest in events:
+        # Skip 'modified' event during 'created'
+        if src in creates and event != FileCreatedEvent:
+            continue
+
+        # Skip 'modified' event during 'moved'
+        if src in moves:
+            continue
+
+        # Skip duplicate events
+        if src in seen:
+            continue
+        seen.append(src)
+
+        filtered.append((event, src, dest))
+    return filtered
+
+
+def _bright(arg):
+    return STYLE_BRIGHT + arg + Style.RESET_ALL
+
+
+def _highlight(arg):
+    return STYLE_HIGHLIGHT + arg + Style.RESET_ALL
+
+
+def show_summary(argv, events, verbose=False):
+    command = ' '.join(argv)
+    bright = _bright
+    highlight = _highlight
+
+    time_stamp = time.strftime("%c", time.localtime(time.time()))
+    run_command_info = '[{}] Running: {}'.format(time_stamp,
+                                                 highlight(command))
+    if not events:
+        print(run_command_info)
+        return
+
+    events = _reduce_events(events)
+    if verbose:
+        lines = ['Changes detected:']
+        m = max(map(len, map(lambda e: VERBOSE_EVENT_NAMES[e[0]], events)))
+        for event, src, dest in events:
+            event = VERBOSE_EVENT_NAMES[event].ljust(m)
+            lines.append('  {} {}'.format(
+                event,
+                highlight(src + (' -> ' + dest if dest else ''))))
+        lines.append('')
+        lines.append(run_command_info)
+    else:
+        lines = []
+        for event, src, dest in events:
+            lines.append('{} detected: {}'.format(
+                EVENT_NAMES[event],
+                bright(src + (' -> ' + dest if dest else ''))))
+        lines.append('')
+        lines.append(run_command_info)
+
+    print('\n'.join(lines))

pytest_watch/tests/conftest.py

@@ -0,0 +1,20 @@
+import pytest
+
+
+@pytest.fixture
+def merge_config_callee(mocker):
+    m = mocker.patch("pytest_watch.command.merge_config",
+                     side_effect=lambda *args, **kwargs: True)
+    return m
+
+
+@pytest.fixture
+def beep_mock(mocker):
+    return mocker.patch("pytest_watch.helpers.beep")
+
+
+@pytest.fixture
+def watch_callee(mocker):
+    watch_mock = mocker.patch("pytest_watch.command.watch")
+    watch_mock.return_value.side_effect = lambda *args, **kwargs: 0
+    return watch_mock