Merge pull request #1051 from python-cmd2/github_actions

tleonhardt · web-flow · commit 3f67a3eff33c · 2021-01-31T16:23:32.000-05:00
Use GitHub Actions for CI
diff --git a/.appveyor.yml b/.appveyor.yml
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,3 +1,12 @@
+# -------------------------------------------------
+# CODEOWNERS - For automated review request for
+# high impact files.
+#
+# Important: The order in this file cascades.
+#
+# https://help.github.com/articles/about-codeowners
+# -------------------------------------------------
+
 # Lines starting with '#' are comments.
 # Each line is a file pattern followed by one or more owners.
 # Owners of code are automatically nominated to review PRs involving that code.
@@ -60,7 +69,8 @@ tests/test_transcript.py      @kotfu
 tests_isolated/test_commandset/*    @anselor
 
 # Top-level project stuff
-CONTRIBUTING.md         @tleonhardt @kotfu
 setup.py                @tleonhardt @kotfu
 tasks.py                @kotfu
 
+# GitHub stuff
+.github/*               @tleonhardt
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -458,7 +458,8 @@ how to do it.
 
 7.  Creating the PR causes our continuous integration (CI) systems to automatically run all of the
     unit tests on all supported OSes and all supported versions of Python. You should watch your PR
-    to make sure that all unit tests pass on TravisCI (Linux), AppVeyor (Windows), and VSTS (macOS).
+    to make sure that all unit tests pass on every version of Python for each of Linux, Windows, and
+    macOS.
 
 8.  If any unit tests fail, you should look at the details and fix the failures. You can then push
     the fix to the same branch in your fork. The PR will automatically get updated and the CI system
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,30 @@
+# For documentation on GitHub Actions Workflows, see:
+# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  ci:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.6, 3.7, 3.8, 3.9]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2  # https://github.com/actions/checkout
+        with:
+          # Only a single commit is fetched by default, for the ref/SHA that triggered the workflow.
+          # Set fetch-depth: 0 to fetch all history for all branches and tags.
+          fetch-depth: 0 # Needed for setuptools_scm to work correctly
+      - name: Set up Python
+        uses: actions/setup-python@v2  # https://github.com/actions/setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install python prerequisites
+        run: pip install -U --user pip setuptools setuptools-scm nox
+      - name: Run tests and post coverage results
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: python -m nox --non-interactive --session tests-${{ matrix.python-version }}  # Run nox for a single version of Python
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -0,0 +1,28 @@
+# For documentation on GitHub Actions Workflows, see:
+# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+name: Doc
+
+on: [push, pull_request]
+
+jobs:
+  doc:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.9]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2  # https://github.com/actions/checkout
+        with:
+          # Only a single commit is fetched by default, for the ref/SHA that triggered the workflow.
+          # Set fetch-depth: 0 to fetch all history for all branches and tags.
+          fetch-depth: 0 # Needed for setuptools_scm to work correctly
+      - name: Set up Python
+        uses: actions/setup-python@v2  # https://github.com/actions/setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install python prerequisites
+        run: pip install -U --user pip setuptools setuptools-scm nox
+      - name: Sphinx documentation build
+        run: python -m nox --non-interactive --session docs
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,28 @@
+# For documentation on GitHub Actions Workflows, see:
+# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+name: Lint
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python-version: [3.9]
+      fail-fast: false
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2  # https://github.com/actions/checkout
+        with:
+          # Only a single commit is fetched by default, for the ref/SHA that triggered the workflow.
+          # Set fetch-depth: 0 to fetch all history for all branches and tags.
+          fetch-depth: 0 # Needed for setuptools_scm to work correctly
+      - name: Set up Python
+        uses: actions/setup-python@v2  # https://github.com/actions/setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install python prerequisites
+        run: pip install -U --user pip setuptools setuptools-scm flake8
+      - name: Lint
+        run: python -m flake8 . --count --ignore=E252,W503 --max-complexity=26 --max-line-length=127 --show-source --statistics ;
diff --git a/.travis.yml b/.travis.yml
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,6 +1,6 @@
-include LICENSE README.md CHANGELOG.md CONTRIBUTING.md noxfile.py Pipfile
+include LICENSE README.md CHANGELOG.md noxfile.py Pipfile
 recursive-include examples *
 recursive-include tests *
 recursive-include docs *
 recursive-exclude docs/_build *
-exclude .appveyor.yml .gitignore .travis.yml azure-pipelines.yml CODEOWNERS tasks.py
+exclude .github .gitignore azure-pipelines.yml tasks.py
diff --git a/README.md b/README.md
@@ -1,8 +1,7 @@
 cmd2: a tool for building interactive command line apps
 =======================================================
 [![Latest Version](https://img.shields.io/pypi/v/cmd2.svg?style=flat-square&label=latest%20stable%20version)](https://pypi.python.org/pypi/cmd2/)
-[![Build status](https://img.shields.io/travis/python-cmd2/cmd2.svg?style=flat-square&label=unix%20build)](https://travis-ci.org/python-cmd2/cmd2)
-[![Appveyor build status](https://img.shields.io/appveyor/ci/FedericoCeratto/cmd2.svg?style=flat-square&label=windows%20build)](https://ci.appveyor.com/project/FedericoCeratto/cmd2)
+[![GitHub Actions](https://github.com/python-cmd2/cmd2/workflows/CI/badge.svg)](https://github.com/python-cmd2/cmd2/actions?query=workflow%3ACI)
 [![Azure Build status](https://python-cmd2.visualstudio.com/cmd2/_apis/build/status/python-cmd2.cmd2?branch=master)](https://python-cmd2.visualstudio.com/cmd2/_build/latest?definitionId=1&branch=master)
 [![codecov](https://codecov.io/gh/python-cmd2/cmd2/branch/master/graph/badge.svg)](https://codecov.io/gh/python-cmd2/cmd2)
 [![Documentation Status](https://readthedocs.org/projects/cmd2/badge/?version=latest)](http://cmd2.readthedocs.io/en/latest/?badge=latest)
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -14,9 +14,6 @@ jobs:
   # Run the pipeline with multiple Python versions
   strategy:
     matrix:
-      Python35:
-        python.version: '3.5'
-        NOXSESSION: 'tests-3.5'
       Python36:
         python.version: '3.6'
         NOXSESSION: 'tests-3.6'
@@ -26,6 +23,9 @@ jobs:
       Python38:
         python.version: '3.8'
         NOXSESSION: 'tests-3.8'
+      Python39:
+        python.version: '3.9'
+        NOXSESSION: 'tests-3.9'
     # Increase the maxParallel value to simultaneously run the job for all versions in the matrix (max 10 for free open-source)
     maxParallel: 4
 
diff --git a/cmd2/cmd2.py b/cmd2/cmd2.py
@@ -4001,36 +4001,11 @@ def do_history(self, args: argparse.Namespace) -> Optional[bool]:
                 readline.clear_history()
             return
 
-        # If an argument was supplied, then retrieve partial contents of the history
-        cowardly_refuse_to_run = False
-        if args.arg:
-            # If a character indicating a slice is present, retrieve
-            # a slice of the history
-            arg = args.arg
-            arg_is_int = False
-            try:
-                int(arg)
-                arg_is_int = True
-            except ValueError:
-                pass
-
-            if '..' in arg or ':' in arg:
-                # Get a slice of history
-                history = self.history.span(arg, args.all)
-            elif arg_is_int:
-                history = [self.history.get(arg)]
-            elif arg.startswith(r'/') and arg.endswith(r'/'):
-                history = self.history.regex_search(arg, args.all)
-            else:
-                history = self.history.str_search(arg, args.all)
-        else:
-            # If no arg given, then retrieve the entire history
-            cowardly_refuse_to_run = True
-            # Get a copy of the history so it doesn't get mutated while we are using it
-            history = self.history.span(':', args.all)
+        # If an argument was supplied, then retrieve partial contents of the history, otherwise retrieve it all
+        history = self._get_history(args)
 
         if args.run:
-            if cowardly_refuse_to_run:
+            if not args.arg:
                 self.perror("Cowardly refusing to run all previously entered commands.")
                 self.perror("If this is what you want to do, specify '1:' as the range of history.")
             else:
@@ -4070,6 +4045,32 @@ def do_history(self, args: argparse.Namespace) -> Optional[bool]:
             for hi in history:
                 self.poutput(hi.pr(script=args.script, expanded=args.expanded, verbose=args.verbose))
 
+    def _get_history(self, args: argparse.Namespace) -> List[HistoryItem]:
+        """If an argument was supplied, then retrieve partial contents of the history; otherwise retrieve entire history."""
+        if args.arg:
+            # If a character indicating a slice is present, retrieve a slice of the history
+            arg = args.arg
+            arg_is_int = False
+            try:
+                int(arg)
+                arg_is_int = True
+            except ValueError:
+                pass
+
+            if '..' in arg or ':' in arg:
+                # Get a slice of history
+                history = self.history.span(arg, args.all)
+            elif arg_is_int:
+                history = [self.history.get(arg)]
+            elif arg.startswith(r'/') and arg.endswith(r'/'):
+                history = self.history.regex_search(arg, args.all)
+            else:
+                history = self.history.str_search(arg, args.all)
+        else:
+            # Get a copy of the history so it doesn't get mutated while we are using it
+            history = self.history.span(':', args.all)
+        return history
+
     def _initialize_history(self, hist_file):
         """Initialize history using history related attributes
 
diff --git a/noxfile.py b/noxfile.py
@@ -1,7 +1,7 @@
 import nox
 
 
-@nox.session(python=['3.7'])
+@nox.session(python=['3.9'])
 def docs(session):
     session.install('sphinx',
                     'sphinx-rtd-theme',
@@ -15,7 +15,7 @@ def docs(session):
                 '-d', '{}/doctrees'.format(tmpdir), '.', '{}/html'.format(tmpdir))
 
 
-@nox.session(python=['3.5.2', '3.5.3', '3.5', '3.6', '3.7', '3.8', '3.9'])
+@nox.session(python=['3.6', '3.7', '3.8', '3.9'])
 @nox.parametrize('plugin', [None,
                             'ext_test',
                             'template',
diff --git a/plugins/template/README.md b/plugins/template/README.md
@@ -210,8 +210,8 @@ tiered testing strategy to accomplish this objective.
 - [pytest](https://pytest.org) runs the unit tests
 - [nox](https://nox.thea.codes/en/stable/) runs the unit tests on multiple versions
   of python
-- [AppVeyor](https://www.appveyor.com/) and [TravisCI](https://travis-ci.com)
-  run the tests on the various supported platforms
+- [GitHub Actions](https://github.com/features/actions) runs the tests on the various 
+  supported platforms
 
 This plugin template is set up to use the same strategy.
 
@@ -307,9 +307,7 @@ $ nox
 
 ### Run unit tests on multiple platforms
 
-[AppVeyor](https://github.com/marketplace/appveyor) and
-[TravisCI](https://docs.travis-ci.com/user/getting-started/) offer free plans
-for open source projects.
+[GitHub Actions](https://github.com/features/actions) offers free plans for open source projects
 
 
 ## Packaging and Distribution
diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,2 @@
+[build-system]
+requires = ["setuptools>=42", "wheel", "setuptools_scm[toml]>=3.4"]
diff --git a/tests/test_completion.py b/tests/test_completion.py
@@ -491,8 +491,6 @@ def test_path_completion_doesnt_match_wildcards(cmd2_app, request):
     # Currently path completion doesn't accept wildcards, so will always return empty results
     assert cmd2_app.path_complete(text, line, begidx, endidx) == []
 
-@pytest.mark.skipif(sys.platform == 'win32', reason="getpass.getuser() does not work on Windows in AppVeyor because "
-                                                    "no user name environment variables are set")
 def test_path_completion_complete_user(cmd2_app):
     import getpass
     user = getpass.getuser()
