1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
# 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.
|
