summaryrefslogtreecommitdiffstats
path: root/vstf/vstf/agent/env/basic/commandline.py
blob: e4df9b271194a58ae3b72ff9ad7c7d3dd0b6b55b (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
##############################################################################
# Copyright (c) 2015 Huawei Technologies Co.,Ltd and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################

import subprocess
import threading
import logging
from vstf.common import constants

LOG = logging.getLogger(__name__)


class CommandLine(object):
    def __init__(self):
        super(CommandLine, self).__init__()
        self.proc = None
        self.is_timeout = False

    def __kill_proc(self):
        self.is_timeout = True
        self.proc.kill()

    def execute(self, cmd, timeout=constants.TIMEOUT, shell=False):
        """this func call subprocess.Popen(),
        here setup a timer to deal with timeout.
        :param cmd: cmd list like ['ls', 'home']
        :param timeout: for timer count for timeout
        :return: (ret, output) the output (stdout+'\n'+stderr)
        """
        # reset the timeout flag
        self.is_timeout = False
        self.proc = subprocess.Popen(cmd,
                                     stdout=subprocess.PIPE,
                                     stderr=subprocess.PIPE,
                                     shell=shell)

        timer = threading.Timer(timeout, self.__kill_proc, [])
        timer.start()
        stdout, stderr = self.proc.communicate()
        timer.cancel()

        if self.proc.returncode or self.is_timeout:
            if self.is_timeout:
                LOG.error("run cmd<%(cmd)s> timeout", {"cmd": cmd})
            ret = False
            output = "".join([stderr, stdout])
        else:
            ret = True
            output = stdout
        return ret, output