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."""
 
 
25
# this is currently test-focused, so importing bzrlib.tests is ok. We might
 
 
26
# want to move feature to its own module though.
 
 
27
from bzrlib.tests import Feature
 
 
30
def strace(function, *args, **kwargs):
 
 
31
    """Invoke strace on function.
 
 
33
    :return: a tuple: function-result, a StraceResult.
 
 
35
    # capture strace output to a file
 
 
36
    log_file = tempfile.TemporaryFile()
 
 
37
    log_file_fd = log_file.fileno()
 
 
40
    proc = subprocess.Popen(['strace',
 
 
41
        '-f', '-r', '-tt', '-p', str(pid),
 
 
45
    # TODO? confirm its started (test suite should be sufficient)
 
 
46
    # (can loop on proc.pid, but that may not indicate started and attached.)
 
 
47
    result = function(*args, **kwargs)
 
 
49
    os.kill(proc.pid, signal.SIGQUIT)
 
 
55
    return result, StraceResult(log)
 
 
58
class StraceResult(object):
 
 
59
    """The result of stracing a function."""
 
 
61
    def __init__(self, raw_log):
 
 
62
        """Create a StraceResult.
 
 
64
        :param raw_log: The output that strace created.
 
 
66
        self.raw_log = raw_log
 
 
69
class _StraceFeature(Feature):
 
 
73
            proc = subprocess.Popen(['strace'],
 
 
74
                stderr=subprocess.PIPE,
 
 
75
                stdout=subprocess.PIPE)
 
 
79
            if e.errno == errno.ENOENT:
 
 
80
                # strace is not installed
 
 
85
    def feature_name(self):
 
 
88
StraceFeature = _StraceFeature()