← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/blackbox/test_breakin.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-07-31 16:22:11 UTC
  • mfrom: (4578.1.4 1.18-sigbreak)
  • Revision ID: pqm@pqm.ubuntu.com-20090731162211-zvddnooijve9nbmu
(jam) Support SIGBREAK on Windows dropping you into the debugger.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/blackbox/test_breakin.py
1
 
# Copyright (C) 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2006, 2007, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
16
16
 
17
17
"""Blackbox tests for debugger breakin"""
18
18
 
 
19
try:
 
20
    import ctypes
 
21
    have_ctypes = True
 
22
except ImportError:
 
23
    have_ctypes = False
19
24
import errno
20
25
import os
21
26
import signal
24
29
import time
25
30
 
26
31
from bzrlib import (
 
32
    breakin,
27
33
    errors,
28
34
    tests,
29
35
    )
34
40
    # wait() waiting for the child to exit when it's not going to.
35
41
 
36
42
    def setUp(self):
37
 
        if sys.platform == 'win32':
38
 
            raise tests.TestSkipped('breakin signal not tested on win32')
39
43
        super(TestBreakin, self).setUp()
 
44
        if breakin.determine_signal() is None:
 
45
            raise tests.TestSkipped('this platform is missing SIGQUIT'
 
46
                                    ' or SIGBREAK')
 
47
        if sys.platform == 'win32':
 
48
            # Windows doesn't have os.kill, and we catch the SIGBREAK signal.
 
49
            # We trigger SIGBREAK via a Console api so we need ctypes to access
 
50
            # the function
 
51
            if not have_ctypes:
 
52
                raise tests.UnavailableFeature('ctypes')
 
53
            self._send_signal = self._send_signal_win32
 
54
        else:
 
55
            self._send_signal = self._send_signal_via_kill
 
56
 
 
57
    def _send_signal_via_kill(self, pid, sig_type):
 
58
        if sig_type == 'break':
 
59
            sig_num = signal.SIGQUIT
 
60
        elif sig_type == 'kill':
 
61
            sig_num = signal.SIGKILL
 
62
        else:
 
63
            raise ValueError("unknown signal type: %s" % (sig_type,))
 
64
        os.kill(pid, sig_num)
 
65
 
 
66
    def _send_signal_win32(self, pid, sig_type):
 
67
        """Send a 'signal' on Windows.
 
68
 
 
69
        Windows doesn't really have signals in the same way. All it really
 
70
        supports is:
 
71
            1) Sending SIGINT to the *current* process group (so self, and all
 
72
                children of self)
 
73
            2) Sending SIGBREAK to a process that shares the current console,
 
74
                which can be in its own process group.
 
75
        So we have start_bzr_subprocess create a new process group for the
 
76
        spawned process (via a flag to Popen), and then we map
 
77
            SIGQUIT to GenerateConsoleCtrlEvent(CTRL_BREAK_EVENT)
 
78
            SIGKILL to TerminateProcess
 
79
        """
 
80
        if sig_type == 'break':
 
81
            CTRL_BREAK_EVENT = 1
 
82
            # CTRL_C_EVENT = 0
 
83
            ret = ctypes.windll.kernel32.GenerateConsoleCtrlEvent(
 
84
                    CTRL_BREAK_EVENT, pid)
 
85
            if ret == 0: #error
 
86
                err = ctypes.FormatError()
 
87
                raise RuntimeError('failed to send CTRL_BREAK: %s'
 
88
                                   % (err,))
 
89
        elif sig_type == 'kill':
 
90
            # Does the exit code matter? For now we are just setting it to
 
91
            # something other than 0
 
92
            exit_code = breakin.determine_signal()
 
93
            ctypes.windll.kernel32.TerminateProcess(pid, exit_code)
 
94
 
 
95
    def _popen(self, *args, **kwargs):
 
96
        if sys.platform == 'win32':
 
97
            CREATE_NEW_PROCESS_GROUP = 512
 
98
            # This allows us to send a signal to the child, *without* also
 
99
            # sending it to ourselves
 
100
            kwargs['creationflags'] = CREATE_NEW_PROCESS_GROUP
 
101
        return super(TestBreakin, self)._popen(*args, **kwargs)
40
102
 
41
103
    def _dont_SIGQUIT_on_darwin(self):
42
104
        if sys.platform == 'darwin':
54
116
        for i in range(100):
55
117
            time.sleep(0.1)
56
118
            if sig is not None:
57
 
                os.kill(pid, sig)
 
119
                self._send_signal(pid, sig)
58
120
            # Use WNOHANG to ensure we don't get blocked, doing so, we may
59
121
            # leave the process continue after *we* die...
 
122
            # Win32 doesn't support WNOHANG, so we just pass 0
 
123
            opts = getattr(os, 'WNOHANG', 0)
60
124
            try:
61
 
                # note: waitpid is different on win32, but this test only runs
62
 
                # on unix
63
 
                pid_killed, returncode = os.waitpid(pid, os.WNOHANG)
 
125
                # TODO: waitpid doesn't work well on windows, we might consider
 
126
                #       using WaitForSingleObject(proc._handle, TIMEOUT)
 
127
                #       instead. Most notably, the WNOHANG isn't allowed, so
 
128
                #       this can hang indefinitely.
 
129
                pid_killed, returncode = os.waitpid(pid, opts)
64
130
                if (pid_killed, returncode) != (0, 0):
65
131
                    if sig is not None:
66
132
                        # high bit in low byte says if core was dumped; we
88
154
        # wait for it to get started, and print the 'listening' line
89
155
        proc.stderr.readline()
90
156
        # first sigquit pops into debugger
91
 
        os.kill(proc.pid, signal.SIGQUIT)
 
157
        self._send_signal(proc.pid, 'break')
92
158
        # Wait for the debugger to acknowledge the signal reception
 
159
        # Note that it is possible for this to deadlock if the child doesn't
 
160
        # acknowlege the signal and write to stderr. Perhaps we should try
 
161
        # os.read(proc.stderr.fileno())?
93
162
        err = proc.stderr.readline()
94
163
        self.assertContainsRe(err, r'entering debugger')
95
164
        # Now that the debugger is entered, we can ask him to quit
99
168
        dead, sig = self._wait_for_process(proc.pid)
100
169
        if not dead:
101
170
            # The process didn't finish, let's kill it before reporting failure
102
 
            dead, sig = self._wait_for_process(proc.pid, signal.SIGKILL)
 
171
            dead, sig = self._wait_for_process(proc.pid, 'kill')
103
172
            if dead:
104
173
                raise tests.KnownFailure(
105
174
                    "subprocess wasn't terminated, it had to be killed")
115
184
        # wait for it to get started, and print the 'listening' line
116
185
        proc.stderr.readline()
117
186
        # break into the debugger
118
 
        os.kill(proc.pid, signal.SIGQUIT)
 
187
        self._send_signal(proc.pid, 'break')
119
188
        # Wait for the debugger to acknowledge the signal reception (since we
120
189
        # want to send a second signal, we ensure it doesn't get lost by
121
190
        # validating the first get received and produce its effect).
122
191
        err = proc.stderr.readline()
123
192
        self.assertContainsRe(err, r'entering debugger')
124
 
        dead, sig = self._wait_for_process(proc.pid, signal.SIGQUIT)
125
 
        self.assertTrue((dead and sig == signal.SIGQUIT),
126
 
                        msg="subprocess wasn't terminated by repeated SIGQUIT")
 
193
        dead, sig = self._wait_for_process(proc.pid, 'break')
 
194
        self.assertTrue(dead)
 
195
        # Either the child was dead before we could read its status, or the
 
196
        # child was dead from the signal we sent it.
 
197
        self.assertTrue(sig in (None, breakin.determine_signal()))
127
198
 
128
199
    def test_breakin_disabled(self):
129
200
        self._dont_SIGQUIT_on_darwin()
132
203
        # wait for it to get started, and print the 'listening' line
133
204
        proc.stderr.readline()
134
205
        # first hit should just kill it
135
 
        os.kill(proc.pid, signal.SIGQUIT)
 
206
        self._send_signal(proc.pid, 'break')
136
207
        proc.wait()