summaryrefslogtreecommitdiff
path: root/creole/tests/utils/unittest_subprocess.py
blob: 126a6bcac544042707255c8a4b0ce3a1a718eca7 (plain)
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
"""
    unittest subprocess helper
    ~~~~~~~~~~~~~~~~~~~~~~~~~~

    :copyleft: 2015-2020 by python-creole team, see AUTHORS for more details.
    :license: GNU GPL v3 or above, see LICENSE for more details.
"""


import os
import shutil
import subprocess
import sys
from pathlib import Path


class SubprocessMixin:

    def subprocess(self, popen_args):
        assert isinstance(popen_args, (tuple, list))

        print("Call:", popen_args)

        # Expand PATH
        bin_path = str(Path(sys.executable).parent)
        if bin_path not in os.environ["PATH"]:
            # .../venv/bin will be not in PATH in tests, just add it
            # so that installed [tool.poetry.scripts] will be found
            os.environ["PATH"] += os.pathsep + bin_path

        # Check if executeable will be found
        prog = popen_args[0]
        cmd = shutil.which(prog)
        assert cmd is not None, f'{prog!r} not found in PATH: {os.environ.get("PATH")!r}!'

        try:
            process = subprocess.Popen(
                popen_args,
                stdout=subprocess.PIPE,
                stderr=subprocess.STDOUT,
                universal_newlines=True,
            )
        except Exception as err:
            self.fail(f"Error subprocess call with {popen_args!r}: {err}")

        stdout, stderr = process.communicate()
        retcode = process.poll()

        print(f"return code: {retcode!r}")
        print(f"stdout: {stdout!r}")
        print(f"stderr: {stderr!r}")

        stdout = stdout.strip()
        print("=" * 100)
        print("stdout:")
        print("-" * 100)
        print(stdout)
        print("-" * 100)
        return popen_args, retcode, stdout

    def assertSubprocess(self, popen_args, retcode, stdout):
        popen_args2, retcode2, stdout2 = self.subprocess(popen_args)
        stdout = stdout.strip()
        try:
            self.assertEqual(stdout, stdout2, "stdout wrong:")
            self.assertEqual(retcode, retcode2, "return code wrong:")
        except AssertionError as err:
            msg = (
                "Error: %s"
                "call via subprocess: %s\n"
                "return code........: %r\n"
                " ---------- [stdout] ---------- \n"
                "%s\n"
                "-------------------------------"
            ) % (
                err,
                repr(popen_args2), retcode2,
                stdout2,
            )
            self.fail(msg)