1
# Copyright (C) 2007 Canonical Ltd
 
 
2
#   Authors: Robert Collins <robert.collins@canonical.com>
 
 
4
# This program is free software; you can redistribute it and/or modify
 
 
5
# it under the terms of the GNU General Public License as published by
 
 
6
# the Free Software Foundation; either version 2 of the License, or
 
 
7
# (at your option) any later version.
 
 
9
# This program is distributed in the hope that it will be useful,
 
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
12
# GNU General Public License for more details.
 
 
14
# You should have received a copy of the GNU General Public License
 
 
15
# along with this program; if not, write to the Free Software
 
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
18
"""Support for running strace against the current process."""
 
 
26
# this is currently test-focused, so importing bzrlib.tests is ok. We might
 
 
27
# want to move feature to its own module though.
 
 
28
from bzrlib.tests import Feature
 
 
31
def strace(function, *args, **kwargs):
 
 
32
    """Invoke strace on function.
 
 
34
    :return: a tuple: function-result, a StraceResult.
 
 
36
    # capture strace output to a file
 
 
37
    log_file = tempfile.NamedTemporaryFile()
 
 
38
    log_file_fd = log_file.fileno()
 
 
41
    proc = subprocess.Popen(['strace',
 
 
42
        '-f', '-r', '-tt', '-p', str(pid), '-o', log_file.name
 
 
44
        stdout=subprocess.PIPE,
 
 
45
        stderr=subprocess.STDOUT)
 
 
46
    # Wait for strace to attach
 
 
47
    attached_notice = proc.stdout.readline()
 
 
48
    # Run the function to strace
 
 
49
    result = function(*args, **kwargs)
 
 
51
    os.kill(proc.pid, signal.SIGQUIT)
 
 
57
    return result, StraceResult(log)
 
 
60
class StraceResult(object):
 
 
61
    """The result of stracing a function."""
 
 
63
    def __init__(self, raw_log):
 
 
64
        """Create a StraceResult.
 
 
66
        :param raw_log: The output that strace created.
 
 
68
        self.raw_log = raw_log
 
 
71
class _StraceFeature(Feature):
 
 
75
            proc = subprocess.Popen(['strace'],
 
 
76
                stderr=subprocess.PIPE,
 
 
77
                stdout=subprocess.PIPE)
 
 
81
            if e.errno == errno.ENOENT:
 
 
82
                # strace is not installed
 
 
87
    def feature_name(self):
 
 
90
StraceFeature = _StraceFeature()