Merge pull request #90 from LUMC/cliimprovements

Better CLI documentation. Remove old CI tests and linting clutter.

Author: rhpvorderman

.pylintrc

@@ -23,19 +23,9 @@ matrix:
     - python: 3.5
       env: TOX_ENV=py35
       install:
-        - pip install codacy-coverage
         - pip install codecov
         - pip install tox
       after_success:
-        # Correct coverage xml for coverage services.
-        - >
-          bash -c 'set -eux;
-          pkg_path=$(find .tox/py*/lib/python*/site-packages/pytest_workflow -maxdepth 0 -type d);
-          sed -i "s:${pkg_path}:src/pytest_workflow:g" coverage.xml'
-        - >
-          bash -c ' if [[ -v CODACY_PROJECT_TOKEN ]]; then
-          python-codacy-coverage -r coverage.xml;
-          fi'
         - codecov -v  # -v to make sure coverage upload works.
 
     # FUNCTIONAL TESTS

.travis.yml

@@ -7,6 +7,14 @@ Changelog
 .. This document is user facing. Please word the changes in such a way
 .. that users understand how the changes affect the new version.
 
+version 1.3.0-dev
+---------------------------
+
++ Documentation: added usage chapter for pytest-workflow specific options.
++ Added missing `help` for `--tag`.
++ Removed redundant references to pylint in code comments and CI.
++ Remove Codacy from the CI.
+
 version 1.2.2
 ---------------------------
 + Test against python3.8

HISTORY.rst

@@ -46,9 +46,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-]
-
+extensions = ['sphinxarg.ext']
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/conf.py

@@ -1,6 +1,10 @@
 =======================
 Running pytest-workflow
 =======================
+
+Usage
+-----
+
 Run ``pytest`` from an environment with pytest-workflow installed or
 ``python3 -m pytest`` if using a system-wide or user-wide installation.
 Pytest will automatically gather files in the ``tests`` directory starting with
@@ -9,6 +13,16 @@ Pytest will automatically gather files in the ``tests`` directory starting with
 The workflows are run automatically. Each workflow gets its own temporary
 directory to run. The ``stdout`` and ``stderr`` of the workflow command are
 also saved to this directory to ``log.out`` and ``log.err`` respectively.
+
+
+.. argparse::
+    :module: pytest_workflow.plugin
+    :func: __pytest_workflow_cli
+    :prog: pytest
+
+Temporary directory cleanup
+---------------------------
+
 The temporary directories are cleaned up after the tests are completed.
 If you wish to inspect the output of a failing
 workflow you can use the ``--keep-workflow-wd`` or ``--kwd`` flag to disable
@@ -31,6 +45,9 @@ use ``--basetemp <dir>`` to change pytest's base temp directory.
   DO NOT use ``--basetemp`` on directories where none of the
   contents should be deleted.
 
+Running multiple workflows simultaneously
+-----------------------------------------
+
 To run multiple workflows simultaneously you can use
 ``--workflow-threads <int>`` or ``--wt <int>`` flag. This defines the number
 of workflows that can be run simultaneously. This will speed up things if

docs/running_pytest_workflow.rst

@@ -4,4 +4,3 @@ flake8
 flake8-import-order
 mypy
 bandit
-pylint

requirements-dev.txt

@@ -1,3 +1,4 @@
 setuptools
 sphinx
+sphinx-argparse
 sphinx_rtd_theme

requirements-docs.txt

@@ -109,8 +109,6 @@ def __init__(self, name: str, parent: pytest.Collector,
         :param content_name: The name of the content that will be displayed if
         the test fails. Defaults to filepath.
         """
-        # pylint: disable=too-many-arguments
-        # Cannot think of a better way to do this.
         super().__init__(name, parent=parent)
         self.filepath = filepath
         self.content_test = content_test
@@ -205,8 +203,6 @@ def runtest(self):
                 self.should_contain)
 
     def repr_failure(self, excinfo):
-        # pylint: disable=unused-argument
-        # excinfo needed for pytest.
         if self.parent.file_not_found:
             return (
                 "'{content}' does not exist and cannot be searched "

src/pytest_workflow/content_tests.py

@@ -101,8 +101,6 @@ def runtest(self):
         assert self.file.exists() == self.should_exist
 
     def repr_failure(self, excinfo):
-        # pylint: disable=unused-argument
-        # excinfo needed for pytest.
         message = "'{path}' does {exist} while it {should}".format(
             # self.file gives the actual path that was tested (including /tmp
             # bits). self.parent.filetest.path gives the path that the user
@@ -139,8 +137,6 @@ def runtest(self):
         assert self.observed_md5sum == self.expected_md5sum
 
     def repr_failure(self, excinfo):
-        # pylint: disable=unused-argument
-        # excinfo needed for pytest.
         message = (
             "Observed md5sum '{observed}' not equal to expected md5sum "
             "'{expected}' for file '{path}'"

src/pytest_workflow/file_tests.py

@@ -15,6 +15,7 @@
 # along with pytest-workflow.  If not, see <https://www.gnu.org/licenses/
 
 """core functionality of pytest-workflow plugin"""
+import argparse
 import shutil
 import tempfile
 import warnings
@@ -81,10 +82,25 @@ def pytest_addoption(parser: PytestParser):
         action="append",
         type=str,
         # Otherwise default is None and this does not work with list operations
-        default=[]
+        default=[],
+        help="Run workflows with this name or tag."
     )
 
 
+def __pytest_workflow_cli():  # pragma: no cover
+    """Helper function for showing all pytest-workflow specific options in the
+    documentation with sphinx argparse. The ArgParser class bypasses any
+    pytest specific implementation of the PytestParser to use a common
+    argparse.ArgumentParser instead."""
+    class ArgParser(argparse.ArgumentParser):
+        def addoption(self, *args, **kwargs):
+            self.add_argument(*args, **kwargs)
+
+    parser = ArgParser()
+    pytest_addoption(parser)
+    return parser
+
+
 def pytest_collect_file(path, parent):
     """Collection hook
     This collects the yaml files that start with "test" and end with
@@ -157,8 +173,6 @@ def pytest_configure(config: PytestConfig):
 
 def pytest_collection(session: pytest.Session):
     """This function is started at the beginning of collection"""
-    # pylint: disable=unused-argument
-    # needed for pytest
     # We print an empty line here to make the report look slightly better.
     # Without it pytest will output "Collecting ... " and the workflow commands
     # will be immediately after this: "Collecting ... queue (etc.) "
@@ -410,8 +424,6 @@ def runtest(self):
         assert self.workflow.exit_code == self.desired_exit_code
 
     def repr_failure(self, excinfo):
-        # pylint: disable=unused-argument
-        # excinfo needed for pytest.
         message = ("'{workflow_name}' exited with exit code " +
                    "'{exit_code}' instead of '{desired_exit_code}'."
                    ).format(workflow_name=self.workflow.name,