pytest-dev/pytest-testinfra

Allow disabling argument quoting with `run` function for WinRM backends

Open

#310 opened on May 4, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (318 forks)batch import
help wantedwindows

Repository metrics

Stars
 (2,156 stars)
PR merge metrics
 (Avg merge 1d 15h) (1 merged PR in 30d)

Description

Hello,

Consider the following basic WinRM test:

def test_echo(host):
    hello = 'Hello, world!'
    res = host.run('echo %s', hello)
    assert res.stdout == hello # Fails

    assert res.stdout== hello
E   assert '"Hello, world!"\r\n' == 'Hello, world!'
# I'm fine with that extra CRLF, but the quotes bugged me for some time...

Related log entry: INFO:testinfra:RUN CommandResult(command='echo "Hello, world!"', exit_status=0, stdout=b'"Hello, world!"\r\n', stderr=None)

It would be nice to be able to turn off argument quoting for executables which behave like MS echo (they echo back quotes, apparently :panda_face: ). Pywinrm already seems to handle arguments escaping/quoting, but I haven't played much with this library yet. It could be possible to let pywinrm handle the command formatting/escaping.

Unrelated to this issue, worth mentioning: the CommandResult.stdout value is a binary string instead of a string when using run with WinRM. Is it intended?

Contributor guide

Research direction
Investigate how the `run` function in testinfra formats arguments for different backends, especially WinRM. Look for where quoting is applied and consider adding a parameter to disable quoting for commands that don't need it.
Tech stack
python
Domain
testingbackenddevops
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60