File: test_processresult.py

package info (click to toggle)
python-pytest-shell-utilities 1.9.7-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 604 kB
  • sloc: python: 2,996; makefile: 19
file content (179 lines) | stat: -rw-r--r-- 5,569 bytes parent folder | download
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
# Copyright 2021-2024 VMware, Inc.
# SPDX-License-Identifier: Apache-2.0
"""
Test ``pytestshellutils.utils.processes.ProcessResult``.
"""
import json as jsonlib
import logging
import textwrap

import pytest

from pytestshellutils.utils.processes import ProcessResult

log = logging.getLogger(__name__)


@pytest.mark.parametrize("returncode", [None, 1.0, -1.0, "0"])
def test_non_int_returncode_raises_exception(returncode: int) -> None:
    with pytest.raises(ValueError):
        ProcessResult(returncode=returncode, stdout="", stderr="")


def test_attributes(subtests) -> None:
    returncode = 0
    stdout = "STDOUT"
    stderr = "STDERR"
    cmdline = None
    data = None

    with subtests.test(returncode=returncode, stdout=stdout, stderr=stderr):
        ret = ProcessResult(returncode=returncode, stdout=stdout, stderr=stderr)
        assert ret.returncode == returncode
        assert ret.stdout == stdout
        assert ret.stderr == stderr
        assert ret.data == data
        assert ret.cmdline == cmdline

    cmdline = ["1", "2", "3"]
    with subtests.test(returncode=returncode, stdout=stdout, stderr=stderr, cmdline=cmdline):
        ret = ProcessResult(returncode=returncode, stdout=stdout, stderr=stderr, cmdline=cmdline)
        assert ret.returncode == returncode
        assert ret.stdout == stdout
        assert ret.stderr == stderr
        assert ret.data == data
        assert ret.cmdline == cmdline

    data = {"ret": {"a": 1}}
    stdout = jsonlib.dumps(data)
    with subtests.test(
        returncode=returncode, stdout=stdout, stderr=stderr, cmdline=cmdline, data=data
    ):
        ret = ProcessResult(returncode=returncode, stdout=stdout, stderr=stderr, cmdline=cmdline)
        assert ret.returncode == returncode
        assert ret.stdout == stdout
        assert ret.stderr == stderr
        assert ret.data == data
        assert ret.cmdline == cmdline

    data_key = "ret"
    with subtests.test(
        returncode=returncode,
        stdout=stdout,
        stderr=stderr,
        cmdline=cmdline,
        data=data,
        data_key=data_key,
    ):
        ret = ProcessResult(
            returncode=returncode, stdout=stdout, stderr=stderr, cmdline=cmdline, data_key="ret"
        )
        assert ret.returncode == returncode
        assert ret.stdout == stdout
        assert ret.stderr == stderr
        assert ret.data == data[data_key]
        assert ret.cmdline == cmdline


def test_str_formatting(subtests) -> None:
    returncode = 0
    stdout = "STDOUT"
    stderr = "STDERR"
    cmdline = None
    data = {"ret": {"a": 1}}
    data_key = None

    with subtests.test(returncode=returncode, stdout=stdout, stderr=stderr):
        ret = ProcessResult(returncode=returncode, stdout=stdout, stderr=stderr)
        expected = textwrap.dedent(
            """\
            ProcessResult
             Returncode: {}
             Process Output:
               >>>>> STDOUT >>>>>
            {}
               <<<<< STDOUT <<<<<
               >>>>> STDERR >>>>>
            {}
               <<<<< STDERR <<<<<
        """.format(
                returncode, stdout, stderr
            )
        )
        assert str(ret) == expected

    cmdline = ["1", "2", "3"]
    with subtests.test(returncode=returncode, stdout=stdout, stderr=stderr, cmdline=cmdline):
        ret = ProcessResult(returncode=returncode, stdout=stdout, stderr=stderr, cmdline=cmdline)
        expected = textwrap.dedent(
            """\
            ProcessResult
             Command Line: {!r}
             Returncode: {}
             Process Output:
               >>>>> STDOUT >>>>>
            {}
               <<<<< STDOUT <<<<<
               >>>>> STDERR >>>>>
            {}
               <<<<< STDERR <<<<<
        """.format(
                cmdline,
                returncode,
                stdout,
                stderr,
            )
        )
        assert str(ret) == expected

    stdout = jsonlib.dumps(data)
    with subtests.test(returncode=returncode, stdout=stdout, stderr=stderr, cmdline=cmdline):
        ret = ProcessResult(returncode=returncode, stdout=stdout, stderr=stderr, cmdline=cmdline)
        expected = (
            textwrap.dedent(
                f"""\
            ProcessResult
             Command Line: {cmdline!r}
             Returncode: {returncode}
             Process Output:
               >>>>> STDOUT >>>>>
            {stdout}
               <<<<< STDOUT <<<<<
               >>>>> STDERR >>>>>
            {stderr}
               <<<<< STDERR <<<<<
             Parsed JSON Data:
        """
            )
            + ProcessResult._to_printable_data(data)
            + "\n"
        )
        assert str(ret) == expected

    data_key = "ret"
    with subtests.test(
        returncode=returncode, stdout=stdout, stderr=stderr, cmdline=cmdline, data_key=data_key
    ):
        ret = ProcessResult(
            returncode=returncode, stdout=stdout, stderr=stderr, cmdline=cmdline, data_key=data_key
        )
        expected = (
            textwrap.dedent(
                f"""\
            ProcessResult
             Command Line: {cmdline!r}
             Returncode: {returncode}
             Process Output:
               >>>>> STDOUT >>>>>
            {stdout}
               <<<<< STDOUT <<<<<
               >>>>> STDERR >>>>>
            {stderr}
               <<<<< STDERR <<<<<
             Parsed JSON Data:
        """
            )
            + ProcessResult._to_printable_data(data[data_key])
            + "\n"
        )
        assert str(ret) == expected