.circleci/config.yml

@@ -0,0 +1,63 @@
+version: 2.1
+
+
+orbs:
+  orb: invocations/orb@1.2.0
+
+
+jobs:
+  # Unit+integration tests, with coverage
+  coverage:
+    executor:
+      name: orb/default
+      version: "3.6"
+    steps:
+      - orb/setup
+      - run: inv ci.make-sudouser
+      - orb/sudo-coverage
+      - orb/debug
+
+  regression:
+    executor:
+      name: orb/default
+      version: "3.6"
+    steps:
+      - orb/setup
+      - run: inv regression
+      - orb/debug
+
+  doctests:
+    executor:
+      name: orb/default
+      version: "3.6"
+    steps:
+      - orb/setup
+      - run: inv www.doctest
+      - orb/debug
+
+
+workflows:
+  main:
+    jobs:
+      - orb/lint:
+          name: Lint
+      - orb/format:
+          name: Style check
+      - coverage:
+          name: Test
+      - regression:
+          name: Regression tests
+      - orb/test-release:
+          name: Release test
+      - orb/test:
+          name: Test << matrix.version >>
+          requires: ["Test"]
+          matrix:
+            parameters:
+              version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+      - orb/docs:
+          name: "Docs"
+          requires: ["Test"]
+      - doctests:
+          name: "Doctests"
+          requires: ["Docs"]

.codecov.yml

@@ -0,0 +1,3 @@
+comment: false
+coverage:
+  precision: 0

.coveragerc

@@ -1,4 +1,6 @@
 [run]
 branch = True
-include = invoke/*
+include =
+    invoke/*
+    tests/*
 omit = invoke/vendor/*

setup.cfg → .flake8

@@ -3,12 +3,3 @@ exclude = invoke/vendor,sites,.git,build,dist,alt_env,appveyor
 ignore = E124,E125,E128,E261,E301,E302,E303,E306,W503,E731
 max-line-length = 79
 
-[metadata]
-license_file = LICENSE
-
-[tool:pytest]
-testpaths = tests
-python_files = *
-filterwarnings =
-    once::Warning
-    ignore::DeprecationWarning

MANIFEST.in

@@ -5,7 +5,6 @@ recursive-include invoke/completion *
 recursive-include sites *
 recursive-exclude sites/*/_build *
 include dev-requirements.txt
-include tasks-requirements.txt
 recursive-include tests *
 recursive-exclude * *.pyc *.pyo
 recursive-exclude **/__pycache__ *

README.rst

@@ -1,3 +1,21 @@
+|version| |python| |license| |ci| |coverage|
+
+.. |version| image:: https://img.shields.io/pypi/v/invoke
+    :target: https://pypi.org/project/invoke/
+    :alt: PyPI - Package Version
+.. |python| image:: https://img.shields.io/pypi/pyversions/invoke
+    :target: https://pypi.org/project/invoke/
+    :alt: PyPI - Python Version
+.. |license| image:: https://img.shields.io/pypi/l/invoke
+    :target: https://github.com/pyinvoke/invoke/blob/main/LICENSE
+    :alt: PyPI - License
+.. |ci| image:: https://img.shields.io/circleci/build/github/pyinvoke/invoke/main
+    :target: https://app.circleci.com/pipelines/github/pyinvoke/invoke
+    :alt: CircleCI
+.. |coverage| image:: https://img.shields.io/codecov/c/gh/pyinvoke/invoke
+    :target: https://app.codecov.io/gh/pyinvoke/invoke
+    :alt: Codecov
+
 Welcome to Invoke!
 ==================
 
@@ -6,6 +24,8 @@ subprocesses and organizing executable Python code into CLI-invokable tasks. It
 draws inspiration from various sources (``make``/``rake``, Fabric 1.x, etc) to
 arrive at a powerful & clean feature set.
 
-For a high level introduction, including example code, please see `our main
-project website <http://pyinvoke.org>`_; or for detailed API docs, see `the
-versioned API website <http://docs.pyinvoke.org>`_.
+To find out what's new in this version of Invoke, please see `the changelog
+<https://pyinvoke.org/changelog.html#{}>`_.
+
+The project maintainer keeps a `roadmap
+<https://bitprophet.org/projects#roadmap>`_ on his website.

dev-requirements.txt

@@ -1,12 +1,21 @@
+# Install self before invocations to save a bit of time
+-e .
+# Invocations, for all sorts of things
+invocations>=3.0.1
+# Coverage!
+coverage>=6.2,<7
+codecov==2.1.12
 # Docs
-# NOTE: sphinx hook is in tasks-requirements.txt
-releases>=0.6.1,<2.0
+releases>=2
 alabaster==0.7.12
-# Testing (explicit dependencies to get around a Travis/pip issue)
-pytest==4.6.3
-pytest-relaxed==1.1.5
-pytest-cov==2.5.1
-mock==1.0.1
-flake8==3.7.8
-# Stuff needed for our tasks.py to execute (broken out for ease of CI)
--r tasks-requirements.txt
+# Testing
+pytest-relaxed>=2
+pytest-cov>=4
+# Formatting
+# Flake8 5.x seems to have an odd importlib-metadata incompatibility?
+flake8>=4,<5
+black>=22.8,<22.9
+# Packaging
+setuptools>56
+# Debuggery
+icecream>=2.1

integration/_support/busywork.py

@@ -15,9 +15,7 @@
 
 for i in range(num_cycles):
     out = "[{}] This is my stdout, there are many like it, but...\n".format(i)
-    sys.stdout.write(out)
-    sys.stdout.flush()
+    print(out, file=sys.stdout, flush=True)
     err = "[{}] To err is human, to stderr is superhuman\n".format(i)
-    sys.stderr.write(err)
-    sys.stderr.flush()
+    print(out, file=sys.stderr, flush=True)
     time.sleep(0.1)

integration/_support/regression.py

@@ -32,3 +32,5 @@ def check(c):
     if failures:
         print("run() FAILED {}/{} times!".format(len(failures), count))
         sys.exit(1)
+    else:
+        print("No failures detected after {} runs, A-OK".format(count))

integration/_support/respond_base.py

@@ -1,6 +1,5 @@
 import sys
 
-from invoke.vendor.six.moves import input
 
 if input("What's the password?") != "Rosebud":
     sys.exit(1)

integration/_support/respond_both.py

@@ -1,6 +1,5 @@
 import sys
 
-from invoke.vendor.six.moves import input
 
 if input("standard out") != "with it":
     sys.exit(1)

integration/_support/respond_fail.py

@@ -1,5 +1,3 @@
-from invoke.vendor.six.moves import input
-
 if input("What's the password?") == "Rosebud":
     print("You're not Citizen Kane!")
     # This should sit around forever like e.g. a bad sudo prompt would, but the

integration/_util.py

@@ -1,9 +1,9 @@
 from contextlib import contextmanager
+from functools import wraps
 from resource import getrusage, RUSAGE_SELF
 import sys
 import time
 
-from invoke.vendor.six import wraps
 
 from pytest import skip
 

integration/context.py

@@ -1,19 +1,19 @@
-import os
-
-from pytest import skip
-
 from invoke import Context, Config
+from invocations import ci as ci_mod
 
 
 class Context_:
     class sudo:
         def base_case(self):
-            # NOTE: Assumes a user whose password is 'mypass' has been created
-            # & added to passworded (not passwordless) sudo configuration; and
-            # that this user is the one running the test suite. Only for
-            # running on Travis, basically.
-            if not os.environ.get("TRAVIS", False):
-                skip()
-            config = Config({"sudo": {"password": "mypass"}})
-            result = Context(config=config).sudo("whoami", hide=True)
-            assert result.stdout.strip() == "root"
+            c = Context()
+            # Grab CI-oriented sudo user/pass direct from invocations.ci
+            # TODO: might be nice to give Collection a way to get a Config
+            # object direct, instead of a dict?
+            ci_conf = Config(ci_mod.ns.configuration()).ci.sudo
+            user = ci_conf.user
+            c.config.sudo.password = ci_conf.password
+            # Safety 1: ensure configured user even exists
+            assert c.run("id {}".format(user), warn=True)
+            # Safety 2: make sure we ARE them (and not eg root already)
+            assert c.run("whoami", hide=True).stdout.strip() == user
+            assert c.sudo("whoami", hide=True).stdout.strip() == "root"