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 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
|
#![cfg(not(windows))]
extern crate signal_hook;
use std::collections::HashSet;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::mpsc::{self, RecvTimeoutError};
use std::sync::Arc;
use std::thread::{self, JoinHandle};
use std::time::Duration;
use signal_hook::consts::{SIGUSR1, SIGUSR2};
#[cfg(feature = "iterator")]use signal_hook::iterator::{Handle, Signals};
use signal_hook::low_level::raise;
use serial_test::serial;
fn send_sigusr1() {
raise(SIGUSR1).unwrap();
}
fn send_sigusr2() {
raise(SIGUSR2).unwrap();
}
#[cfg(feature = "iterator")]fn setup_without_any_signals() -> (Signals, Handle) {
let signals = Signals::new(&[]).unwrap();
let controller = signals.handle();
(signals, controller)
}
#[cfg(feature = "iterator")]fn setup_for_sigusr2() -> (Signals, Handle) {
let signals = Signals::new(&[SIGUSR2]).unwrap();
let controller = signals.handle();
(signals, controller)
}
macro_rules! assert_signals {
($actual:expr, $($expected:expr),+ $(,)?) => {
let actual = $actual.collect::<HashSet<libc::c_int>>();
let expected = vec!($($expected),+).into_iter().collect::<HashSet<libc::c_int>>();
assert_eq!(actual, expected);
};
}
macro_rules! assert_no_signals {
($signals:expr) => {
assert_eq!($signals.next(), None);
};
}
#[cfg(feature = "iterator")]#[test]
#[serial]
fn forever_terminates_when_closed() {
let (mut signals, controller) = setup_for_sigusr2();
// Detect early terminations.
let stopped = Arc::new(AtomicBool::new(false));
let stopped_bg = Arc::clone(&stopped);
let thread = thread::spawn(move || {
// Eat all the signals there are (might come from a concurrent test, in theory).
// Would wait forever, but it should be terminated by the close below.
for _sig in &mut signals {}
stopped_bg.store(true, Ordering::SeqCst);
});
// Wait a bit to see if the thread terminates by itself.
thread::sleep(Duration::from_millis(100));
assert!(!stopped.load(Ordering::SeqCst));
controller.close();
thread.join().unwrap();
assert!(stopped.load(Ordering::SeqCst));
}
// A reproducer for #16: if we had the mio-support enabled (which is enabled also by the
// tokio-support feature), blocking no longer works. The .wait() would return immediately (an empty
// iterator, possibly), .forever() would do a busy loop.
// flag)
#[cfg(feature = "iterator")]#[test]
#[serial]
fn signals_block_wait() {
let mut signals = Signals::new(&[SIGUSR2]).unwrap();
let (s, r) = mpsc::channel();
let finish = Arc::new(AtomicBool::new(false));
let thread_id = thread::spawn({
let finish = Arc::clone(&finish);
move || {
// Technically, it may spuriously return early. But it shouldn't be doing it too much,
// so we just try to wait multiple times ‒ if they *all* return right away, it is
// broken.
for _ in 0..10 {
for _ in signals.wait() {
if finish.load(Ordering::SeqCst) {
// Asked to terminate at the end of the thread. Do so (but without
// signalling the receipt).
return;
} else {
panic!("Someone really did send us SIGUSR2, which breaks the test");
}
}
}
let _ = s.send(());
}
});
// A RAII guard to make sure we shut down the thread even if the test fails.
struct ThreadGuard {
thread: Option<JoinHandle<()>>,
finish: Arc<AtomicBool>,
}
impl ThreadGuard {
fn shutdown(&mut self) {
// Tell it to shut down
self.finish.store(true, Ordering::SeqCst);
// Wake it up
send_sigusr2();
// Wait for it to actually terminate.
if let Some(thread) = self.thread.take() {
thread.join().unwrap(); // Propagate panics
}
}
}
impl Drop for ThreadGuard {
fn drop(&mut self) {
self.shutdown(); // OK if done twice, won't have the thread any more.
}
}
let mut bg_thread = ThreadGuard {
thread: Some(thread_id),
finish,
};
let err = r
.recv_timeout(Duration::from_millis(100))
.expect_err("Wait didn't wait properly");
assert_eq!(err, RecvTimeoutError::Timeout);
bg_thread.shutdown();
}
#[cfg(feature = "iterator")]#[test]
#[serial]
fn pending_doesnt_block() {
let (mut signals, _) = setup_for_sigusr2();
let mut recieved_signals = signals.pending();
assert_no_signals!(recieved_signals);
}
#[cfg(feature = "iterator")]#[test]
#[serial]
fn wait_returns_recieved_signals() {
let (mut signals, _) = setup_for_sigusr2();
send_sigusr2();
let recieved_signals = signals.wait();
assert_signals!(recieved_signals, SIGUSR2);
}
#[cfg(feature = "iterator")]#[test]
#[serial]
fn forever_returns_recieved_signals() {
let (mut signals, _) = setup_for_sigusr2();
send_sigusr2();
let signal = signals.forever().take(1);
assert_signals!(signal, SIGUSR2);
}
#[cfg(feature = "iterator")]#[test]
#[serial]
fn wait_doesnt_block_when_closed() {
let (mut signals, controller) = setup_for_sigusr2();
controller.close();
let mut recieved_signals = signals.wait();
assert_no_signals!(recieved_signals);
}
#[cfg(feature = "iterator")]#[test]
#[serial]
fn wait_unblocks_when_closed() {
let (mut signals, controller) = setup_without_any_signals();
let thread = thread::spawn(move || {
signals.wait();
});
controller.close();
thread.join().unwrap();
}
#[cfg(feature = "iterator")]#[test]
#[serial]
fn forever_doesnt_block_when_closed() {
let (mut signals, controller) = setup_for_sigusr2();
controller.close();
let mut signal = signals.forever();
assert_no_signals!(signal);
}
#[cfg(feature = "iterator")]#[test]
#[serial]
fn add_signal_after_creation() {
let (mut signals, _) = setup_without_any_signals();
signals.add_signal(SIGUSR1).unwrap();
send_sigusr1();
assert_signals!(signals.pending(), SIGUSR1);
}
#[cfg(feature = "iterator")]#[test]
#[serial]
fn delayed_signal_consumed() {
let (mut signals, _) = setup_for_sigusr2();
signals.add_signal(SIGUSR1).unwrap();
send_sigusr1();
let mut recieved_signals = signals.wait();
send_sigusr2();
assert_signals!(recieved_signals, SIGUSR1, SIGUSR2);
// The pipe still contains the byte from the second
// signal and so wait won't block but won't return
// a signal.
recieved_signals = signals.wait();
assert_no_signals!(recieved_signals);
}
#[cfg(feature = "iterator")]#[test]
#[serial]
fn is_closed_initially_returns_false() {
let (_, controller) = setup_for_sigusr2();
assert!(!controller.is_closed());
}
#[cfg(feature = "iterator")]#[test]
#[serial]
fn is_closed_returns_true_when_closed() {
let (_, controller) = setup_for_sigusr2();
controller.close();
assert!(controller.is_closed());
}
|