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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
|
# coding: utf-8
import io
import os
import re
import time
import signal
import shutil
import inspect
import logging
import tempfile
import subprocess
import errno
import packaging.version
import six
try:
# yatest.common should try to be hermetic, otherwise, PYTEST_SCRIPT (aka USE_ARCADIA_PYTHON=no) won't work.
import library.python.cores as cores
except ImportError:
cores = None
from . import runtime
from . import path
from . import environment
MAX_OUT_LEN = 64 * 1024 # 64K
MAX_MESSAGE_LEN = 1500
SANITIZER_ERROR_PATTERN = br": ([A-Z][\w]+Sanitizer)"
GLIBC_PATTERN = re.compile(r"\S+@GLIBC_([0-9.]+)")
yatest_logger = logging.getLogger("ya.test")
def truncate(s, size):
if s is None:
return None
elif len(s) <= size:
return s
else:
return (b'...' if isinstance(s, bytes) else '...') + s[-(size - 3) :]
def get_command_name(command):
return os.path.basename(command.split()[0] if isinstance(command, six.string_types) else command[0])
class ExecutionError(Exception):
def __init__(self, execution_result):
if not isinstance(execution_result.command, six.string_types):
command = " ".join(str(arg) for arg in execution_result.command)
else:
command = execution_result.command
message = "Command '{command}' has failed with code {code}.\nErrors:\n{err}\n".format(
command=command, code=execution_result.exit_code, err=_format_error(execution_result.std_err)
)
if cores:
if execution_result.backtrace:
message += "Backtrace:\n[[rst]]{}[[bad]]\n".format(
cores.colorize_backtrace(execution_result._backtrace)
)
else:
message += "Backtrace is not available: module cores isn't available"
super(ExecutionError, self).__init__(message)
self.execution_result = execution_result
class TimeoutError(Exception):
pass
class ExecutionTimeoutError(TimeoutError):
def __init__(self, execution_result, *args, **kwargs):
super(ExecutionTimeoutError, self).__init__(args, kwargs)
self.execution_result = execution_result
class InvalidExecutionStateError(Exception):
pass
class SignalInterruptionError(Exception):
def __init__(self, message=None):
super(SignalInterruptionError, self).__init__(message)
self.res = None
class InvalidCommandError(Exception):
pass
class _Execution(object):
def __init__(
self,
command,
process,
out_file,
err_file,
process_progress_listener=None,
cwd=None,
collect_cores=True,
check_sanitizer=True,
started=0,
user_stdout=False,
user_stderr=False,
core_pattern=None,
):
self._command = command
self._process = process
self._out_file = out_file
self._err_file = err_file
self._std_out = None
self._std_err = None
self._elapsed = None
self._start = time.time()
self._process_progress_listener = process_progress_listener
self._cwd = cwd or os.getcwd()
self._collect_cores = collect_cores
self._backtrace = ''
self._check_sanitizer = check_sanitizer
self._metrics = {}
self._started = started
self._user_stdout = bool(user_stdout)
self._user_stderr = bool(user_stderr)
self._exit_code = None
self._core_pattern = core_pattern
if process_progress_listener:
process_progress_listener.open(command, process, out_file, err_file)
@property
def running(self):
return self._process.poll() is None
def kill(self):
if self.running:
self._save_outputs(False)
_kill_process_tree(self._process.pid)
self._clean_files()
# DEVTOOLS-2347
yatest_logger.debug("Process status before wait_for: %s", self.running)
try:
wait_for(
lambda: not self.running,
timeout=5,
fail_message="Could not kill process {}".format(self._process.pid),
sleep_time=0.1,
)
except TimeoutError:
yatest_logger.debug("Process status after wait_for: %s", self.running)
yatest_logger.debug("Process %d info: %s", self._process.pid, _get_proc_tree_info([self._process.pid]))
raise
else:
raise InvalidExecutionStateError("Cannot kill a stopped process")
def terminate(self):
if self.running:
self._process.terminate()
@property
def process(self):
return self._process
@property
def command(self):
return self._command
@property
def core_pattern(self):
return self._core_pattern
@property
def returncode(self):
return self.exit_code
@property
def exit_code(self):
"""
Deprecated, use returncode
"""
if self._exit_code is None:
self._exit_code = self._process.returncode
return self._exit_code
@property
def stdout(self):
return self.std_out
@property
def std_out(self):
"""
Deprecated, use stdout
"""
if self._std_out is not None:
return self._std_out
if self._process.stdout and not self._user_stdout:
self._std_out = six.ensure_str(self._process.stdout.read())
return self._std_out
@property
def stderr(self):
return self.std_err
@property
def std_err(self):
"""
Deprecated, use stderr
"""
# TODO: Fix bytes/str, maybe need to change a lot of tests
if self._std_err is not None:
return self._std_err
if self._process.stderr and not self._user_stderr:
self._std_err = six.ensure_str(self._process.stderr.read())
return self._std_err
@property
def elapsed(self):
return self._elapsed
@property
def backtrace(self):
return self._backtrace
@property
def metrics(self):
return self._metrics
def _save_outputs(self, clean_files=True):
if self._process_progress_listener:
self._process_progress_listener()
self._process_progress_listener.close()
if not self._user_stdout:
if self._out_file is None:
pass
elif self._out_file != subprocess.PIPE:
self._out_file.flush()
self._out_file.seek(0, os.SEEK_SET)
self._std_out = self._out_file.read()
self._out_file.close()
else:
self._std_out = self._process.stdout.read()
if not self._user_stderr:
if self._err_file is None:
pass
elif self._err_file != subprocess.PIPE:
self._err_file.flush()
self._err_file.seek(0, os.SEEK_SET)
self._std_err = self._err_file.read()
self._err_file.close()
else:
self._std_err = self._process.stderr.read()
if clean_files:
self._clean_files()
yatest_logger.debug("Command (pid %s) rc: %s", self._process.pid, self.exit_code)
yatest_logger.debug("Command (pid %s) elapsed time (sec): %s", self._process.pid, self.elapsed)
if self._metrics:
for key, value in six.iteritems(self._metrics):
yatest_logger.debug("Command (pid %s) %s: %s", self._process.pid, key, value)
# Since this code is Python2/3 compatible, we don't know is _std_out/_std_err is real bytes or bytes-str.
printable_std_out, err = _try_convert_bytes_to_string(self._std_out)
if err:
yatest_logger.debug("Got error during parse process stdout: %s", err)
yatest_logger.debug("stdout will be displayed as raw bytes.")
printable_std_err, err = _try_convert_bytes_to_string(self._std_err)
if err:
yatest_logger.debug("Got error during parse process stderr: %s", err)
yatest_logger.debug("stderr will be displayed as raw bytes.")
yatest_logger.debug("Command (pid %s) output:\n%s", self._process.pid, truncate(printable_std_out, MAX_OUT_LEN))
yatest_logger.debug("Command (pid %s) errors:\n%s", self._process.pid, truncate(printable_std_err, MAX_OUT_LEN))
def _clean_files(self):
if self._err_file and not self._user_stderr and self._err_file != subprocess.PIPE:
self._err_file.close()
self._err_file = None
if self._out_file and not self._user_stdout and self._out_file != subprocess.PIPE:
self._out_file.close()
self._out_file = None
def _recover_core(self):
core_path = cores.recover_core_dump_file(self.command[0], self._cwd, self.process.pid, self.core_pattern)
if core_path:
# Core dump file recovering may be disabled (for distbuild for example) - produce only bt
store_cores = runtime._get_ya_config().collect_cores
if store_cores:
new_core_path = path.get_unique_file_path(
runtime.output_path(), "{}.{}.core".format(os.path.basename(self.command[0]), self._process.pid)
)
# Copy core dump file, because it may be overwritten
yatest_logger.debug("Coping core dump file from '%s' to the '%s'", core_path, new_core_path)
shutil.copyfile(core_path, new_core_path)
core_path = new_core_path
bt_filename = None
pbt_filename = None
if os.path.exists(runtime.gdb_path()):
yatest_logger.debug("Getting full backtrace from core file")
self._backtrace = cores.get_gdb_full_backtrace(self.command[0], core_path, runtime.gdb_path())
bt_filename = path.get_unique_file_path(
runtime.output_path(),
"{}.{}.backtrace".format(os.path.basename(self.command[0]), self._process.pid),
)
with open(bt_filename, "wb") as afile:
afile.write(six.ensure_binary(self._backtrace))
# generate pretty html version of backtrace aka Tri Korochki
pbt_filename = bt_filename + ".html"
backtrace_to_html(bt_filename, pbt_filename)
yatest_logger.debug("Register coredump")
if store_cores:
runtime._register_core(
os.path.basename(self.command[0]), self.command[0], core_path, bt_filename, pbt_filename
)
else:
runtime._register_core(os.path.basename(self.command[0]), None, None, bt_filename, pbt_filename)
def wait(self, check_exit_code=True, timeout=None, on_timeout=None):
def _wait():
finished = None
interrupted = False
try:
if hasattr(os, "wait4"):
try:
if hasattr(subprocess, "_eintr_retry_call"):
pid, sts, rusage = subprocess._eintr_retry_call(os.wait4, self._process.pid, 0)
else:
# PEP 475
pid, sts, rusage = os.wait4(self._process.pid, 0)
finished = time.time()
self._process._handle_exitstatus(sts)
for field in [
"ru_idrss",
"ru_inblock",
"ru_isrss",
"ru_ixrss",
"ru_majflt",
"ru_maxrss",
"ru_minflt",
"ru_msgrcv",
"ru_msgsnd",
"ru_nivcsw",
"ru_nsignals",
"ru_nswap",
"ru_nvcsw",
"ru_oublock",
"ru_stime",
"ru_utime",
]:
if hasattr(rusage, field):
self._metrics[field.replace("ru_", "")] = getattr(rusage, field)
except OSError as exc:
if exc.errno == errno.ECHILD:
yatest_logger.debug(
"Process resource usage is not available as process finished before wait4 was called"
)
else:
raise
except SignalInterruptionError:
interrupted = True
raise
finally:
if not interrupted:
self._process.wait() # this has to be here unconditionally, so that all process properties are set
if not finished:
finished = time.time()
self._metrics["wtime"] = round(finished - self._started, 3)
try:
if timeout:
def process_is_finished():
return not self.running
fail_message = "Command '%s' stopped by %d seconds timeout" % (self._command, timeout)
try:
wait_for(
process_is_finished,
timeout,
fail_message,
sleep_time=0.1,
on_check_condition=self._process_progress_listener,
)
except TimeoutError as e:
if on_timeout:
yatest_logger.debug("Calling user specified on_timeout function")
try:
on_timeout(self, timeout)
except Exception:
yatest_logger.exception("Exception while calling on_timeout")
raise ExecutionTimeoutError(self, str(e))
# Wait should be always called here, it finalizes internal states of its process and sets up return code
_wait()
except BaseException as e:
_kill_process_tree(self._process.pid)
_wait()
yatest_logger.debug("Command exception: %s", e)
raise
finally:
self._elapsed = time.time() - self._start
self._save_outputs()
self.verify_no_coredumps()
self._finalise(check_exit_code)
def _finalise(self, check_exit_code):
# Set the signal (negative number) which caused the process to exit
if check_exit_code and self.exit_code != 0:
yatest_logger.error(
"Execution failed with exit code: %s\n\t,std_out:%s\n\tstd_err:%s\n",
self.exit_code,
truncate(self.std_out, MAX_OUT_LEN),
truncate(self.std_err, MAX_OUT_LEN),
)
raise ExecutionError(self)
# Don't search for sanitize errors if stderr was redirected
self.verify_sanitize_errors()
def verify_no_coredumps(self):
"""
Verify there is no coredump from this binary. If there is then report backtrace.
"""
if self.exit_code < 0 and self._collect_cores:
if cores:
try:
self._recover_core()
except Exception:
yatest_logger.exception("Exception while recovering core")
else:
yatest_logger.warning("Core dump file recovering is skipped: module cores isn't available")
def verify_sanitize_errors(self):
"""
Verify there are no sanitizer (ASAN, MSAN, TSAN, etc) errors for this binary. If there are any report them.
"""
if self._std_err and self._check_sanitizer and runtime._get_ya_config().sanitizer_extra_checks:
build_path = runtime.build_path()
if self.command[0].startswith(build_path):
match = re.search(SANITIZER_ERROR_PATTERN, six.ensure_binary(self._std_err))
if match:
yatest_logger.error(
"%s sanitizer found errors:\n\tstd_err:%s\n",
match.group(1),
truncate(self.std_err, MAX_OUT_LEN),
)
raise ExecutionError(self)
else:
yatest_logger.debug("No sanitizer errors found")
else:
yatest_logger.debug(
"'%s' doesn't belong to '%s' - no check for sanitize errors", self.command[0], build_path
)
def on_timeout_gen_coredump(exec_obj, _):
"""
Function can be passed to the execute(..., timeout=X, on_timeout=on_timeout_gen_coredump)
to generate core dump file, backtrace ahd html-version of the backtrace in case of timeout.
All files will be available in the testing_out_stuff and via links.
"""
try:
os.kill(exec_obj.process.pid, signal.SIGQUIT)
exec_obj.process.wait()
except OSError:
# process might be already terminated
pass
def execute(
command,
check_exit_code=True,
shell=False,
timeout=None,
cwd=None,
env=None,
stdin=None,
stdout=None,
stderr=None,
text=False,
creationflags=0,
wait=True,
process_progress_listener=None,
close_fds=False,
collect_cores=True,
check_sanitizer=True,
preexec_fn=None,
on_timeout=None,
executor=_Execution,
core_pattern=None,
popen_kwargs=None,
):
"""
Executes a command
:param command: command: can be a list of arguments or a string
:param check_exit_code: will raise ExecutionError if the command exits with non zero code
:param shell: use shell to run the command
:param timeout: execution timeout
:param cwd: working directory
:param env: command environment
:param stdin: command stdin
:param stdout: command stdout
:param stderr: command stderr
:param text: 'subprocess.Popen'-specific argument, specifies the type of returned data https://docs.python.org/3/library/subprocess.html#subprocess.run
:type text: bool
:param creationflags: command creation flags
:param wait: should wait until the command finishes
:param process_progress_listener=object that is polled while execution is in progress
:param close_fds: subrpocess.Popen close_fds args
:param collect_cores: recover core dump files if shell == False
:param check_sanitizer: raise ExecutionError if stderr contains sanitize errors
:param preexec_fn: subrpocess.Popen preexec_fn arg
:param on_timeout: on_timeout(<execution object>, <timeout value>) callback
:param popen_kwargs: subrpocess.Popen args dictionary. Useful for python3-only arguments
:return _Execution: Execution object
"""
if env is None:
env = os.environ.copy()
else:
# Certain environment variables must be present for programs to work properly.
# For more info see DEVTOOLSSUPPORT-4907
mandatory_env_name = 'YA_MANDATORY_ENV_VARS'
mandatory_vars = env.get(mandatory_env_name, os.environ.get(mandatory_env_name)) or ''
if mandatory_vars:
env[mandatory_env_name] = mandatory_vars
mandatory_system_vars = filter(None, mandatory_vars.split(':'))
else:
mandatory_system_vars = ['TMPDIR']
for var in mandatory_system_vars:
if var not in env and var in os.environ:
env[var] = os.environ[var]
if not wait and timeout is not None:
raise ValueError("Incompatible arguments 'timeout' and wait=False")
if popen_kwargs is None:
popen_kwargs = {}
# if subprocess.PIPE in [stdout, stderr]:
# raise ValueError("Don't use pipe to obtain stream data - it may leads to the deadlock")
def get_out_stream(stream, default_name):
mode = 'w+t' if text else 'w+b'
open_kwargs = {'errors': 'ignore', 'encoding': 'utf-8'} if text else {'buffering': 0}
if stream is None:
# No stream is supplied: open new temp file
return _get_command_output_file(command, default_name, mode, open_kwargs), False
if isinstance(stream, six.string_types):
is_block = stream.startswith('/dev/')
if is_block:
mode = 'w+b'
open_kwargs = {'buffering': 0}
# User filename is supplied: open file for writing
return io.open(stream, mode, **open_kwargs), is_block
# Open file or PIPE sentinel is supplied
is_pipe = stream == subprocess.PIPE
return stream, not is_pipe
# to be able to have stdout/stderr and track the process time execution, we don't use subprocess.PIPE,
# as it can cause processes hangs, but use tempfiles instead
out_file, user_stdout = get_out_stream(stdout, 'out')
err_file, user_stderr = get_out_stream(stderr, 'err')
in_file = stdin
if shell and isinstance(command, list):
command = " ".join(command)
if shell:
collect_cores = False
check_sanitizer = False
else:
if isinstance(command, (list, tuple)):
executable = command[0]
else:
executable = command
if not executable:
raise InvalidCommandError("Target program is invalid: {}".format(command))
elif os.path.isabs(executable):
if not os.path.isfile(executable) and not os.path.isfile(executable + ".exe"):
exists = os.path.exists(executable)
if exists:
stat = os.stat(executable)
else:
stat = None
raise InvalidCommandError(
"Target program is not a file: {} (exists: {} stat: {})".format(executable, exists, stat)
)
if not os.access(executable, os.X_OK) and not os.access(executable + ".exe", os.X_OK):
raise InvalidCommandError("Target program is not executable: {}".format(executable))
if check_sanitizer:
env["LSAN_OPTIONS"] = environment.extend_env_var(os.environ, "LSAN_OPTIONS", "exitcode=100")
if stdin:
name = "PIPE" if stdin == subprocess.PIPE else stdin.name
yatest_logger.debug(
"Executing '%s' with input '%s' in '%s' (%s)", command, name, cwd, 'waiting' if wait else 'no wait'
)
else:
yatest_logger.debug("Executing '%s' in '%s' (%s)", command, cwd, 'waiting' if wait else 'no wait')
# XXX
started = time.time()
process = subprocess.Popen(
command,
shell=shell,
universal_newlines=text,
stdout=out_file,
stderr=err_file,
stdin=in_file,
cwd=cwd,
env=env,
creationflags=creationflags,
close_fds=close_fds,
preexec_fn=preexec_fn,
**popen_kwargs
)
yatest_logger.debug("Command pid: %s", process.pid)
kwargs = {
'user_stdout': user_stdout,
'user_stderr': user_stderr,
}
if six.PY2:
executor_args = inspect.getargspec(executor.__init__).args
else:
executor_args = inspect.getfullargspec(executor.__init__).args
if 'core_pattern' in executor_args:
kwargs.update([('core_pattern', core_pattern)])
res = executor(
command,
process,
out_file,
err_file,
process_progress_listener,
cwd,
collect_cores,
check_sanitizer,
started,
**kwargs
)
if wait:
res.wait(check_exit_code, timeout, on_timeout)
return res
def _get_command_output_file(cmd, ext, mode, open_kwargs=None):
if open_kwargs is None:
open_kwargs = {}
parts = [get_command_name(cmd)]
if 'YA_RETRY_INDEX' in os.environ:
parts.append('retry{}'.format(os.environ.get('YA_RETRY_INDEX')))
if int(os.environ.get('YA_SPLIT_COUNT', '0')) > 1:
parts.append('chunk{}'.format(os.environ.get('YA_SPLIT_INDEX', '0')))
filename = '.'.join(parts + [ext])
try:
# if execution is performed from test, save out / err to the test logs dir
import yatest.common
import library.python.pytest.plugins.ya
if getattr(library.python.pytest.plugins.ya, 'pytest_config', None) is None:
raise ImportError("not in test")
filename = path.get_unique_file_path(yatest.common.output_path(), filename)
yatest_logger.debug("Command %s will be placed to %s", ext, os.path.basename(filename))
return io.open(filename, mode, **open_kwargs)
except ImportError:
return tempfile.NamedTemporaryFile(mode=mode, delete=False, suffix=filename, **(open_kwargs if six.PY3 else {}))
def _get_proc_tree_info(pids):
if os.name == 'nt':
return 'Not supported'
else:
stdout, _ = subprocess.Popen(
["/bin/ps", "-wufp"] + [str(p) for p in pids], stdout=subprocess.PIPE, stderr=subprocess.PIPE
).communicate()
return stdout
def py_execute(
command,
check_exit_code=True,
shell=False,
timeout=None,
cwd=None,
env=None,
stdin=None,
stdout=None,
stderr=None,
creationflags=0,
wait=True,
process_progress_listener=None,
close_fds=False,
text=False,
):
"""
Executes a command with the arcadia python
:param command: command to pass to python
:param check_exit_code: will raise ExecutionError if the command exits with non zero code
:param shell: use shell to run the command
:param timeout: execution timeout
:param cwd: working directory
:param env: command environment
:param stdin: command stdin
:param stdout: command stdout
:param stderr: command stderr
:param creationflags: command creation flags
:param wait: should wait until the command finishes
:param process_progress_listener=object that is polled while execution is in progress
:param text: Return original str
:return _Execution: Execution object
"""
if isinstance(command, six.string_types):
command = [command]
command = [runtime.python_path()] + command
if shell:
command = " ".join(command)
return execute(**locals())
def _format_error(error):
return truncate(error, MAX_MESSAGE_LEN)
def wait_for(check_function, timeout, fail_message="", sleep_time=1.0, on_check_condition=None):
"""
Tries to execute `check_function` for `timeout` seconds.
Continue until function returns nonfalse value.
If function doesn't return nonfalse value for `timeout` seconds
OperationTimeoutException is raised.
Return first nonfalse result returned by `checkFunction`.
"""
if sleep_time <= 0:
raise ValueError("Incorrect sleep time value {}".format(sleep_time))
if timeout < 0:
raise ValueError("Incorrect timeout value {}".format(timeout))
start = time.time()
while start + timeout > time.time():
if on_check_condition:
on_check_condition()
res = check_function()
if res:
return res
time.sleep(sleep_time)
message = "{} second(s) wait timeout has expired".format(timeout)
if fail_message:
message += ": {}".format(fail_message)
raise TimeoutError(truncate(message, MAX_MESSAGE_LEN))
def _kill_process_tree(process_pid, target_pid_signal=None):
"""
Kills child processes, req. Note that psutil should be installed
@param process_pid: parent id to search for descendants
"""
yatest_logger.debug("Killing process %s", process_pid)
if os.name == 'nt':
_win_kill_process_tree(process_pid)
else:
_nix_kill_process_tree(process_pid, target_pid_signal)
def _nix_get_proc_children(pid):
try:
cmd = ["pgrep", "-P", str(pid)]
return [int(p) for p in subprocess.check_output(cmd).split()]
except Exception:
return []
def _get_binname(pid):
try:
return os.path.basename(os.readlink('/proc/{}/exe'.format(pid)))
except Exception as e:
return "error({})".format(e)
def _nix_kill_process_tree(pid, target_pid_signal=None):
"""
Kills the process tree.
"""
yatest_logger.debug("Killing process tree for pid {} (bin:'{}')".format(pid, _get_binname(pid)))
def try_to_send_signal(pid, sig):
try:
os.kill(pid, sig)
yatest_logger.debug("Sent signal %d to the pid %d", sig, pid)
except Exception as exc:
yatest_logger.debug(
"Error while sending signal {sig} to pid {pid}: {error}".format(sig=sig, pid=pid, error=str(exc))
)
try_to_send_signal(pid, signal.SIGSTOP) # Stop the process to prevent it from starting any child processes.
# Get the child process PID list.
child_pids = _nix_get_proc_children(pid)
# Stop the child processes.
for child_pid in child_pids:
try:
# Kill the child recursively.
_kill_process_tree(int(child_pid))
except Exception as e:
# Skip the error and continue killing.
yatest_logger.debug("Killing child pid {pid} failed: {error}".format(pid=child_pid, error=e))
continue
try_to_send_signal(pid, target_pid_signal or signal.SIGKILL) # Kill the root process.
# sometimes on freebsd sigkill cannot kill the process and either sigkill or sigcont should be sent
# https://www.mail-archive.com/freebsd-hackers@freebsd.org/msg159646.html
try_to_send_signal(pid, signal.SIGCONT)
def _win_kill_process_tree(pid):
subprocess.call(['taskkill', '/F', '/T', '/PID', str(pid)])
def _run_readelf(binary_path):
return str(
subprocess.check_output(
[runtime.binary_path('contrib/python/pyelftools/py3/bin/readelf'), '-s', runtime.binary_path(binary_path)]
)
)
def check_glibc_version(binary_path):
lucid_glibc_version = packaging.version.parse("2.11")
for line in _run_readelf(binary_path).split('\n'):
match = GLIBC_PATTERN.search(line)
if not match:
continue
assert packaging.version.parse(match.group(1)) <= lucid_glibc_version, match.group(0)
def backtrace_to_html(bt_filename, output):
try:
from library.python import coredump_filter
# XXX reduce noise from core_dumpfilter
logging.getLogger("sandbox.sdk2.helpers.coredump_filter").setLevel(logging.ERROR)
with open(output, "w") as afile:
coredump_filter.filter_stackdump(bt_filename, stream=afile)
except ImportError as e:
yatest_logger.debug("Failed to import coredump_filter: %s", e)
with open(output, "w") as afile:
afile.write("<html>Failed to import coredump_filter in USE_ARCADIA_PYTHON=no mode</html>")
def _try_convert_bytes_to_string(source):
"""Function is necessary while this code Python2/3 compatible, because bytes in Python3 is a real bytes and in Python2 is not"""
# Bit ugly typecheck, because in Python2 isinstance(str(), bytes) and "type(str()) is bytes" working as True as well
if 'bytes' not in str(type(source)):
# We already got not bytes. Nothing to do here.
return source, False
result = source
error = False
try:
result = source.decode(encoding='utf-8')
except ValueError as e:
error = e
return result, error
|