Metadata-Version: 2.1
Name: cmd2-ext-test
Version: 0.1.1
Summary: External test plugin for cmd2. Allows for external invocation of commands as if from a cmd2 pyscript
Home-page: https://github.com/python-cmd2/cmd2-ext-test
Author: Eric Lin
Author-email: anselor@gmail.com
License: MIT
Description: # 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()
            app.fixture_setup()
            yield app
            app.fixture_teardown()
        
        ```
        
        ## 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.
        
Keywords: cmd2 test plugin
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.4
Description-Content-Type: text/markdown
Provides-Extra: dev
