Initial contribution of the cmd2 external test plugin

Author: anselor

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## 1.0.0 (2020-03-09)
+
+### Added
+- Initial contribution
+
+

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jared Crapo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,81 @@
+# cmd2 External Test Plugin
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Example cmd2 Application](#example-cmd2-application)
+- [Defining the test fixture](#defining-the-test-fixture)
+- [Writing Tests](#writing-tests)
+- [License](#license)
+
+
+## Overview
+
+This plugin supports testing of a cmd2 application by exposing access cmd2 commands with the same context 
+as from within a cmd2 pyscript.  This allows for verification of an application's support for pyscripts.
+
+
+## Example cmd2 Application
+
+The following short example shows how to mix in the external test plugin to create a fixture for testing
+your cmd2 application.
+
+Define your cmd2 application
+
+```python
+import cmd2
+class ExampleApp(cmd2.Cmd):
+    """An class to show how to use a plugin"""
+    def __init__(self, *args, **kwargs):
+        # gotta have this or neither the plugin or cmd2 will initialize
+        super().__init__(*args, **kwargs)
+
+    def do_something(self, arg):
+        self.last_result = 5
+        self.poutput('this is the something command')
+```
+
+## Defining the test fixture
+
+In your test, define a fixture for your cmd2 application
+
+```python
+import cmd2_ext_test
+import pytest
+
+class ExampleAppTester(cmd2_ext_test.ExternalTestMixin, ExampleApp):
+    def __init__(self, *args, **kwargs):
+        # gotta have this or neither the plugin or cmd2 will initialize
+        super().__init__(*args, **kwargs)
+
+@pytest.fixture
+def example_app():
+    app = ExampleAppTester()
+    return app
+```
+
+## Writing Tests
+
+Now write your tests that validate your application using the `app_cmd` function to access
+the cmd2 application's commands. This allows invocation of the application's commands in the
+same format as a user would type. The results from calling a command matches what is returned
+from running an python script with cmd2's pyscript command, which provides stdout, stderr, and 
+the command's result data.
+
+```python
+from cmd2 import CommandResult
+
+def test_something(example_app):
+    # execute a command
+    out = example_app.app_cmd("something")
+
+    # validate the command output and result data
+    assert isinstance(out, CommandResult)
+    assert str(out.stdout).strip() == 'this is the something command'
+    assert out.data == 5
+```
+
+## License
+
+cmd2 [uses the very liberal MIT license](https://github.com/python-cmd2/cmd2/blob/master/LICENSE).
+We invite plugin authors to consider doing the same.

build-pyenvs.sh

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+#
+
+# create pyenv environments for each minor version of python
+# supported by this project
+#
+# this script uses terms from Semantic Versioning https://semver.org/
+# version numbers are: major.minor.patch
+#
+# this script will delete and recreate existing virtualenvs named
+# cmd2-3.7, etc. It will also create a .python-version
+#
+# Prerequisites:
+#   - *nix-ish environment like macOS or Linux
+#   - pyenv installed
+#   - pyenv-virtualenv installed
+#   - readline and openssl libraries installed so pyenv can
+#     build pythons
+#
+
+# Make a array of the python minor versions we want to install.
+# Order matters in this list, because it's the order that the
+# virtualenvs will be added to '.python-version'. Feel free to modify
+# this list, but note that this script intentionally won't install
+# dev, rc, or beta python releases
+declare -a pythons=("3.7" "3.6" "3.5" "3.4")
+
+# function to find the latest patch of a minor version of python
+function find_latest_version {
+    pyenv install -l | \
+    sed -En -e "s/^ *//g" -e "/(dev|b|rc)/d" -e "/^$1/p" | \
+    tail -1
+}
+
+# empty out '.python-version'
+> .python-version
+
+# loop through the pythons
+for minor_version in "${pythons[@]}"
+do
+    patch_version=$( find_latest_version "$minor_version" )
+    # use pyenv to install the latest versions of python
+    # if it's already installed don't install it again
+    pyenv install -s "$patch_version"
+
+    envname="cmd2-$minor_version"
+    # remove the associated virtualenv
+    pyenv uninstall -f "$envname"
+    # create a new virtualenv
+    pyenv virtualenv -p "python$minor_version" "$patch_version" "$envname"
+    # append the virtualenv to .python-version
+    echo "$envname" >> .python-version
+done

cmd2_ext_test/__init__.py

@@ -0,0 +1,15 @@
+#
+# coding=utf-8
+"""Description of myplugin
+
+An overview of what myplugin does.
+"""
+
+from pkg_resources import get_distribution, DistributionNotFound
+
+from .cmd2_ext_test import ExternalTestMixin
+
+try:
+    __version__ = get_distribution(__name__).version
+except DistributionNotFound:
+    __version__ = 'unknown'

cmd2_ext_test/cmd2_ext_test.py

@@ -0,0 +1,32 @@
+#
+# coding=utf-8
+"""External test interface plugin"""
+
+from typing import Optional
+
+import cmd2
+
+
+class ExternalTestMixin:
+    """A cmd2 plugin (mixin class) that exposes an interface to execute application commands from python"""
+
+    def __init__(self, *args, **kwargs):
+        # code placed here runs before cmd2 initializes
+        super().__init__(*args, **kwargs)
+        # code placed here runs after cmd2 initializes
+        self._pybridge = cmd2.py_bridge.PyBridge(self)
+
+    def app_cmd(self, command: str, echo: Optional[bool] = None) -> cmd2.CommandResult:
+        """
+        Run the application command
+        :param command: The application command as it would be written on the cmd2 application prompt
+        :param echo: Flag whether the command's output should be echoed to stdout/stderr
+        :return: A CommandResult object that captures stdout, stderr, and the command's result object
+        """
+        try:
+            self._in_py = True
+
+            return self._pybridge(command, echo)
+
+        finally:
+            self._in_py = False

cmd2_ext_test/pylintrc

@@ -0,0 +1,10 @@
+#
+# pylint configuration
+#
+#   $ pylint --rcfile=cmd2_myplugin/pylintrc cmd2_myplugin
+#
+
+[messages control]
+# too-few-public-methods          pylint expects a class to have at
+#                                 least two public methods
+disable=too-few-public-methods

examples/example.py

@@ -0,0 +1,32 @@
+#
+# coding=utf-8
+# import cmd2
+import cmd2
+import cmd2_ext_test
+import cmd2.py_bridge
+
+
+class Example(cmd2.Cmd):
+    """An class to show how to use a plugin"""
+    def __init__(self, *args, **kwargs):
+        # gotta have this or neither the plugin or cmd2 will initialize
+        super().__init__(*args, **kwargs)
+
+    def do_something(self, arg):
+        self.last_result = 5
+        self.poutput('this is the something command')
+
+
+class ExampleTester(cmd2_ext_test.ExternalTestMixin, Example):
+    def __init__(self, *args, **kwargs):
+        # gotta have this or neither the plugin or cmd2 will initialize
+        super().__init__(*args, **kwargs)
+
+
+if __name__ == '__main__':
+    app = ExampleTester()
+
+    out = app.app_cmd("something")
+    assert isinstance(out, cmd2.CommandResult)
+
+    assert out.data == 5

setup.py

@@ -0,0 +1,52 @@
+#
+# coding=utf-8
+
+import os
+import setuptools
+
+#
+# get the long description from the README file
+here = os.path.abspath(os.path.dirname(__file__))
+with open(os.path.join(here, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setuptools.setup(
+    name='cmd2-ext-test',
+    use_scm_version=True,
+
+    description='External test plugin for cmd2. Allows for external invocation of commands as if from a cmd2 pyscript',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    keywords='cmd2 test plugin',
+
+    author='Eric Lin',
+    author_email='[email protected]',
+    url='https://github.com/python-cmd2/cmd2-ext-test',
+    license='MIT',
+
+    packages=['cmd2_ext_test'],
+
+    python_requires='>=3.4',
+    install_requires=['cmd2 >= 0.9.4, <=2'],
+    setup_requires=['setuptools_scm'],
+
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: Console',
+        'Operating System :: OS Independent',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 3.4',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+    ],
+
+    # dependencies for development and testing
+    # $ pip install -e .[dev]
+    extras_require={
+        'dev': ['setuptools_scm', 'pytest', 'codecov', 'pytest-cov',
+                'pylint', 'invoke', 'wheel', 'twine']
+    },
+)