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
|
#!/usr/bin/env python3
# Microsoft Azure Linux Agent
#
# Copyright 2018 Microsoft Corporation
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import threading
from subprocess import Popen, PIPE
from typing import Any
class CommandError(Exception):
"""
Exception raised by run_command when the command returns an error
"""
def __init__(self, command: Any, exit_code: int, stdout: str, stderr: str):
super().__init__(f"'{command}' failed (exit code: {exit_code}): {stderr}")
self.command: Any = command
self.exit_code: int = exit_code
self.stdout: str = stdout
self.stderr: str = stderr
def __str__(self):
return f"'{self.command}' failed (exit code: {self.exit_code})\nstdout:\n{self.stdout}\nstderr:\n{self.stderr}\n"
def run_command(command: Any, shell=False) -> str:
"""
This function is a thin wrapper around Popen/communicate in the subprocess module. It executes the given command
and returns its stdout. If the command returns a non-zero exit code, the function raises a CommandError.
Similarly to Popen, the 'command' can be a string or a list of strings, and 'shell' indicates whether to execute
the command through the shell.
NOTE: The command's stdout and stderr are read as text streams.
"""
process = Popen(command, stdout=PIPE, stderr=PIPE, shell=shell, text=True)
timer = threading.Timer(15 * 60, process.kill) # Kill process after timeout
timer.start()
try:
stdout, stderr = process.communicate()
finally:
timer.cancel()
if process.returncode == -9:
stderr = "The process was killed due to command timeout\n" + stderr
raise CommandError(command, process.returncode, stdout, stderr)
if process.returncode != 0:
raise CommandError(command, process.returncode, stdout, stderr)
return stdout
|
