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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
Provide a behave shell to simplify creation of feature files
and running features, etc.
context.command_result = behave_shell.behave(cmdline, cwd=context.workdir)
behave_shell.create_scenario(scenario_text, cwd=context.workdir)
behave_shell.create_step_definition(context.text, cwd=context.workdir)
context.command_result = behave_shell.run_feature_with_formatter(
context.features[0], formatter=formatter, cwd=context.workdir)
"""
from __future__ import absolute_import, print_function, with_statement
from behave4cmd0.__setup import TOP
from behave.textutil import text as _text
import os.path
import six
import subprocess
import sys
import shlex
if six.PY2:
import codecs
# HERE = os.path.dirname(__file__)
# TOP = os.path.join(HERE, "..")
# -----------------------------------------------------------------------------
# CLASSES:
# -----------------------------------------------------------------------------
class CommandResult(object):
"""
ValueObject to store the results of a subprocess command call.
"""
def __init__(self, **kwargs):
self.command = kwargs.pop("command", None)
self.returncode = kwargs.pop("returncode", 0)
self.stdout = kwargs.pop("stdout", "")
self.stderr = kwargs.pop("stderr", "")
self._output = None
if kwargs:
names = ", ".join(kwargs.keys())
raise ValueError("Unexpected: %s" % names)
@property
def output(self):
if self._output is None:
output = self.stdout
if self.stderr:
if self.stdout:
output += "\n"
output += self.stderr
self._output = output
return self._output
@property
def failed(self):
return self.returncode != 0
def clear(self):
self.command = None
self.returncode = 0
self.stdout = ""
self.stderr = ""
self._output = None
class Command(object):
"""
Helper class to run commands as subprocess,
collect their output and subprocess returncode.
"""
DEBUG = False
COMMAND_MAP = {
"behave": os.path.normpath("{0}/bin/behave".format(TOP))
}
PREPROCESSOR_MAP = {}
POSTPROCESSOR_MAP = {}
USE_SHELL = sys.platform.startswith("win")
@staticmethod
def preprocess_command(preprocessors, cmdargs, command=None, cwd="."):
if not os.path.isdir(cwd):
return cmdargs
elif not command:
command = " ".join(cmdargs)
for preprocess in preprocessors:
cmdargs = preprocess(command, cmdargs, cwd)
return cmdargs
@staticmethod
def postprocess_command(postprocessors, command_result):
for postprocess in postprocessors:
command_result = postprocess(command_result)
return command_result
@classmethod
def run(cls, command, cwd=".", **kwargs):
"""
Make a subprocess call, collect its output and returncode.
Returns CommandResult instance as ValueObject.
"""
assert isinstance(command, six.string_types)
command_result = CommandResult()
command_result.command = command
use_shell = cls.USE_SHELL
if "shell" in kwargs:
use_shell = kwargs.pop("shell")
# -- BUILD COMMAND ARGS:
if six.PY2 and isinstance(command, six.text_type):
# -- PREPARE-FOR: shlex.split()
# In PY2, shlex.split() requires bytes string (non-unicode).
# In PY3, shlex.split() accepts unicode string.
command = codecs.encode(command, "utf-8")
cmdargs = shlex.split(command)
# -- TRANSFORM COMMAND (optional)
command0 = cmdargs[0]
real_command = cls.COMMAND_MAP.get(command0, None)
if real_command:
cmdargs0 = real_command.split()
cmdargs = cmdargs0 + cmdargs[1:]
preprocessors = cls.PREPROCESSOR_MAP.get(command0)
if preprocessors:
cmdargs = cls.preprocess_command(preprocessors, cmdargs, command, cwd)
# -- RUN COMMAND:
try:
process = subprocess.Popen(cmdargs,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
universal_newlines=True,
shell=use_shell,
cwd=cwd, **kwargs)
out, err = process.communicate()
if six.PY2: # py3: we get unicode strings, py2 not
# default_encoding = "UTF-8"
out = _text(out, process.stdout.encoding)
err = _text(err, process.stderr.encoding)
process.poll()
assert process.returncode is not None
command_result.stdout = out
command_result.stderr = err
command_result.returncode = process.returncode
if cls.DEBUG:
print("shell.cwd={0}".format(kwargs.get("cwd", None)))
print("shell.command: {0}".format(" ".join(cmdargs)))
print("shell.command.output:\n{0};".format(command_result.output))
except OSError as e:
command_result.stderr = u"OSError: %s" % e
command_result.returncode = e.errno
assert e.errno != 0
postprocessors = cls.POSTPROCESSOR_MAP.get(command0)
if postprocessors:
command_result = cls.postprocess_command(postprocessors, command_result)
return command_result
# -----------------------------------------------------------------------------
# PREPROCESSOR:
# -----------------------------------------------------------------------------
def path_glob(command, cmdargs, cwd="."):
import glob
if not glob.has_magic(command):
return cmdargs
assert os.path.isdir(cwd)
try:
current_cwd = os.getcwd()
os.chdir(cwd)
new_cmdargs = []
for cmdarg in cmdargs:
if not glob.has_magic(cmdarg):
new_cmdargs.append(cmdarg)
continue
more_args = glob.glob(cmdarg)
if more_args:
new_cmdargs.extend(more_args)
else:
# -- BAD-CASE: Require at least one match.
# Otherwise, restore original arg.
new_cmdargs.append(cmdarg)
cmdargs = new_cmdargs
finally:
os.chdir(current_cwd)
return cmdargs
# -----------------------------------------------------------------------------
# FUNCTIONS:
# -----------------------------------------------------------------------------
def run(command, cwd=".", **kwargs):
return Command.run(command, cwd=cwd, **kwargs)
def behave(cmdline, cwd=".", **kwargs):
"""
Run behave as subprocess command and return process/shell instance
with results (collected output, returncode).
"""
assert isinstance(cmdline, six.string_types)
return run("behave " + cmdline, cwd=cwd, **kwargs)
# -----------------------------------------------------------------------------
# TEST MAIN:
# -----------------------------------------------------------------------------
if __name__ == "__main__":
command = " ".join(sys.argv[1:])
output = Command.run(sys.argv[1:])
print("command: {0}\n{1}\n".format(command, output))
|
