From 8fa7c00929fd11cc433dce616f38426ae3ea2f9a Mon Sep 17 00:00:00 2001
From: Chris Rose <offline@offby1.net>
Date: Mon, 14 May 2018 12:20:52 -0400
Subject: Test and dev dependencies cleanup and sync with Fabric

* Update invocations min version
* Update pytest to be consistent with fabric
* Add pytest-xdist to enable `guard` task
* Other dependencies as found to be inconsistent with Fabric2
---
 tasks.py | 75 +++++++++++++++++++++++++++++++++++++++-------------------------
 1 file changed, 46 insertions(+), 29 deletions(-)

(limited to 'tasks.py')

diff --git a/tasks.py b/tasks.py
index 22fd3509..6cf20377 100644
--- a/tasks.py
+++ b/tasks.py
@@ -15,13 +15,14 @@ def test(
     ctx,
     verbose=True,
     color=True,
-    capture='sys',
+    capture="sys",
     module=None,
     k=None,
     x=False,
     opts="",
     coverage=False,
     include_slow=False,
+    loop_on_fail=False,
 ):
     """
     Run unit tests via pytest.
@@ -31,19 +32,21 @@ def test(
     well with explicit ``--opts="-m=xxx"`` - if ``-m`` is found in ``--opts``,
     ``--include-slow`` will be ignored!)
     """
-    if verbose and '--verbose' not in opts and '-v' not in opts:
+    if verbose and "--verbose" not in opts and "-v" not in opts:
         opts += " --verbose"
     # TODO: forget why invocations.pytest added this; is it to force color when
     # running headless? Probably?
     if color:
         opts += " --color=yes"
-    opts += ' --capture={0}'.format(capture)
-    if '-m' not in opts and not include_slow:
+    opts += " --capture={0}".format(capture)
+    if "-m" not in opts and not include_slow:
         opts += " -m 'not slow'"
-    if k is not None and not ('-k' in opts if opts else False):
-        opts += ' -k {}'.format(k)
-    if x and not ('-x' in opts if opts else False):
-        opts += ' -x'
+    if k is not None and not ("-k" in opts if opts else False):
+        opts += " -k {}".format(k)
+    if x and not ("-x" in opts if opts else False):
+        opts += " -x"
+    if loop_on_fail and not ("-f" in opts if opts else False):
+        opts += " -f"
     modstr = ""
     if module is not None:
         # NOTE: implicit test_ prefix as we're not on pytest-relaxed yet
@@ -62,8 +65,8 @@ def test(
     # way to handle the env stuff too, then we can remove these tasks entirely
     # in favor of just "run pytest"?
     env = dict(os.environ)
-    if 'SSH_AUTH_SOCK' in env:
-        del env['SSH_AUTH_SOCK']
+    if "SSH_AUTH_SOCK" in env:
+        del env["SSH_AUTH_SOCK"]
     cmd = "{} {} {}".format(runner, opts, modstr)
     # NOTE: we have a pytest.ini and tend to use that over PYTEST_ADDOPTS.
     ctx.run(cmd, pty=True, env=env, replace_env=True)
@@ -77,6 +80,15 @@ def coverage(ctx, opts=""):
     return test(ctx, coverage=True, include_slow=True, opts=opts)
 
 
+@task
+def guard(ctx, opts=""):
+    """
+    Execute all tests and then watch for changes, re-running.
+    """
+    # TODO if coverage was run via pytest-cov, we could add coverage here too
+    return test(ctx, include_slow=True, loop_on_fail=True, opts=opts)
+
+
 # Until we stop bundling docs w/ releases. Need to discover use cases first.
 # TODO: would be nice to tie this into our own version of build() too, but
 # still have publish() use that build()...really need to try out classes!
@@ -88,35 +100,40 @@ def release(ctx, sdist=True, wheel=True, sign=True, dry_run=False, index=None):
     # Build docs first. Use terribad workaround pending invoke #146
     ctx.run("inv docs", pty=True, hide=False)
     # Move the built docs into where Epydocs used to live
-    target = 'docs'
+    target = "docs"
     rmtree(target, ignore_errors=True)
     # TODO: make it easier to yank out this config val from the docs coll
-    copytree('sites/docs/_build', target)
+    copytree("sites/docs/_build", target)
     # Publish
     publish(
         ctx, sdist=sdist, wheel=wheel, sign=sign, dry_run=dry_run, index=index,
     )
     # Remind
-    print("\n\nDon't forget to update RTD's versions page for new minor "
-          "releases!")
+    print(
+        "\n\nDon't forget to update RTD's versions page for new minor "
+        "releases!"
+    )
 
 
 # TODO: "replace one task with another" needs a better public API, this is
 # using unpublished internals & skips all the stuff add_task() does re:
 # aliasing, defaults etc.
-release_coll.tasks['publish'] = release
+release_coll.tasks["publish"] = release
 
-ns = Collection(test, coverage, release_coll, docs, www, sites, count_errors)
-ns.configure({
-    'packaging': {
-        # NOTE: many of these are also set in kwarg defaults above; but having
-        # them here too means once we get rid of our custom release(), the
-        # behavior stays.
-        'sign': True,
-        'wheel': True,
-        'changelog_file': join(
-            www.configuration()['sphinx']['source'],
-            'changelog.rst',
-        ),
-    },
-})
+ns = Collection(
+    test, coverage, guard, release_coll, docs, www, sites, count_errors
+)
+ns.configure(
+    {
+        "packaging": {
+            # NOTE: many of these are also set in kwarg defaults above; but
+            # having them here too means once we get rid of our custom
+            # release(), the behavior stays.
+            "sign": True,
+            "wheel": True,
+            "changelog_file": join(
+                www.configuration()["sphinx"]["source"], "changelog.rst"
+            ),
+        }
+    }
+)
-- 
cgit v1.2.1