-
Notifications
You must be signed in to change notification settings - Fork 44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add a CLI helper #66
Add a CLI helper #66
Conversation
`pulp_smash.cli` | ||
================ | ||
|
||
Location: :doc:`/index` → :doc:`/api` → :doc:`/api/pulp_smash.cli` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Breadcrumbs++
Does this need any representation in the docs or do the docstrings create the docs? If not, I think the docstring examples can be moved into the docs or have the docs build from them so we don't duplicate them. |
The documentation is built directly from the docstrings. |
The travis failure is |
Add, document and test module `pulp_smash.cli`. This module provides "tools for working with Pulp's CLI." This fixes #32: > It'd be nice if we could inspect the state of remote systems under test. For > example, it may be useful to log in to a remote system and determine whether > certain files are lying around in certain places in the file system. Here's a simple example of how to use the new module: >>> from pulp_smash import cli, config >>> server_config = config.ServerConfig('localhost') >>> client = cli.Client(server_config) >>> response = client.run(('echo', '-n', 'foo')) >>> response.returncode == 0 True >>> response.stdout == 'foo' True >>> response.stderr == '' True The `Client` class is flexible enough that both request and response handling can be customized on a per-instance basis. See the docstrings in module `pulp_smash.cli` for details. Add "plumbum" as a dependency. It is used by the CLI helper. Many thanks to @elyezer for help in brainstorming a solution to this issue. This commit does not affect test results (107 tests): ============ ============================= Pulp Version Test Suite Results ============ ============================= 2.7 OK dev (2.8) FAILED (errors=2, skipped=13) ============ =============================
Updated. |
ACK |
This looks good to me. +1 to merging it. |
Add, document and test module
pulp_smash.cli
. This module provides "tools forworking with Pulp's CLI." This fixes #32:
Here's a simple example of how to use the new module:
The
Client
class is flexible enough that both request and response handlingcan be customized on a per-instance basis. See the docstrings in module
pulp_smash.cli
for details.Add "plumbum" as a dependency. It is used by the CLI helper.
Many thanks to @elyezer for help in brainstorming a solution to this issue.
This commit does not affect test results (107 tests):