|
| 1 | +//! Test that our use of #[track_caller] is making the correct line number |
| 2 | +//! show up. |
| 3 | +use std::panic; |
| 4 | +use std::process::abort; |
| 5 | +use std::ptr; |
| 6 | +use std::sync::Mutex; |
| 7 | + |
| 8 | +use objc2::encode::Encode; |
| 9 | +use objc2::rc::{Allocated, Id, Shared, __RcTestObject}; |
| 10 | +use objc2::runtime::{NSObject, Object}; |
| 11 | +use objc2::{class, declare_class, msg_send, msg_send_id, ClassType}; |
| 12 | + |
| 13 | +static EXPECTED_MESSAGE: Mutex<String> = Mutex::new(String::new()); |
| 14 | +static EXPECTED_LINE: Mutex<u32> = Mutex::new(0); |
| 15 | + |
| 16 | +pub struct PanicChecker(()); |
| 17 | + |
| 18 | +impl PanicChecker { |
| 19 | + fn new() -> Self { |
| 20 | + panic::set_hook(Box::new(|info| { |
| 21 | + let expected_message = EXPECTED_MESSAGE.lock().unwrap(); |
| 22 | + let expected_line = EXPECTED_LINE.lock().unwrap(); |
| 23 | + |
| 24 | + let payload = info.payload(); |
| 25 | + let message = if let Some(payload) = payload.downcast_ref::<&'static str>() { |
| 26 | + payload.to_string() |
| 27 | + } else if let Some(payload) = payload.downcast_ref::<String>() { |
| 28 | + payload.clone() |
| 29 | + } else { |
| 30 | + format!("could not extract message: {payload:?}") |
| 31 | + }; |
| 32 | + let location = info.location().expect("location"); |
| 33 | + |
| 34 | + if !message.contains(&*expected_message) { |
| 35 | + eprintln!("expected {expected_message:?}, got: {message:?}"); |
| 36 | + abort(); |
| 37 | + } |
| 38 | + if location.file() != file!() { |
| 39 | + eprintln!("expected file {:?}, got: {:?}", file!(), location.file()); |
| 40 | + abort(); |
| 41 | + } |
| 42 | + if location.line() != *expected_line { |
| 43 | + eprintln!("expected line {expected_line}, got: {}", location.line()); |
| 44 | + abort(); |
| 45 | + } |
| 46 | + })); |
| 47 | + Self(()) |
| 48 | + } |
| 49 | + |
| 50 | + fn assert_panics(&self, message: &str, line: u32, f: impl FnOnce()) { |
| 51 | + *EXPECTED_MESSAGE.lock().unwrap() = message.to_string(); |
| 52 | + *EXPECTED_LINE.lock().unwrap() = line; |
| 53 | + |
| 54 | + let res = panic::catch_unwind(panic::AssertUnwindSafe(|| { |
| 55 | + f(); |
| 56 | + })); |
| 57 | + assert!(res.is_err()); |
| 58 | + |
| 59 | + *EXPECTED_MESSAGE.lock().unwrap() = "unknown".to_string(); |
| 60 | + *EXPECTED_LINE.lock().unwrap() = 0; |
| 61 | + } |
| 62 | +} |
| 63 | + |
| 64 | +impl Drop for PanicChecker { |
| 65 | + fn drop(&mut self) { |
| 66 | + let _ = panic::take_hook(); |
| 67 | + } |
| 68 | +} |
| 69 | + |
| 70 | +#[test] |
| 71 | +fn test_track_caller() { |
| 72 | + let checker = PanicChecker::new(); |
| 73 | + |
| 74 | + #[cfg(debug_assertions)] |
| 75 | + { |
| 76 | + test_nil(&checker); |
| 77 | + test_verify(&checker); |
| 78 | + test_error_methods(&checker); |
| 79 | + } |
| 80 | + |
| 81 | + test_id_unwrap(&checker); |
| 82 | + |
| 83 | + #[cfg(feature = "catch-all")] |
| 84 | + test_catch_all(&checker); |
| 85 | + |
| 86 | + test_unwind(&checker); |
| 87 | +} |
| 88 | + |
| 89 | +pub fn test_nil(checker: &PanicChecker) { |
| 90 | + let nil: *mut Object = ptr::null_mut(); |
| 91 | + |
| 92 | + let msg = "messsaging description to nil"; |
| 93 | + checker.assert_panics(msg, line!() + 1, || { |
| 94 | + let _: *mut Object = unsafe { msg_send![nil, description] }; |
| 95 | + }); |
| 96 | + checker.assert_panics(msg, line!() + 1, || { |
| 97 | + let _: *mut Object = unsafe { msg_send![super(nil, NSObject::class()), description] }; |
| 98 | + }); |
| 99 | + checker.assert_panics(msg, line!() + 1, || { |
| 100 | + let _: Option<Id<Object, Shared>> = unsafe { msg_send_id![nil, description] }; |
| 101 | + }); |
| 102 | +} |
| 103 | + |
| 104 | +pub fn test_verify(checker: &PanicChecker) { |
| 105 | + let obj = NSObject::new(); |
| 106 | + |
| 107 | + let msg = "invalid message send to -[NSObject description]: expected return to have type code '@', but found 'v'"; |
| 108 | + checker.assert_panics(msg, line!() + 1, || { |
| 109 | + let _: () = unsafe { msg_send![&obj, description] }; |
| 110 | + }); |
| 111 | + |
| 112 | + let msg = format!("invalid message send to -[NSObject hash]: expected return to have type code '{}', but found '@'", usize::ENCODING); |
| 113 | + checker.assert_panics(&msg, line!() + 1, || { |
| 114 | + let _: Option<Id<Object, Shared>> = unsafe { msg_send_id![&obj, hash] }; |
| 115 | + }); |
| 116 | +} |
| 117 | + |
| 118 | +pub fn test_error_methods(checker: &PanicChecker) { |
| 119 | + let nil: *mut Object = ptr::null_mut(); |
| 120 | + |
| 121 | + let msg = "messsaging someSelectorWithError: to nil"; |
| 122 | + checker.assert_panics(msg, line!() + 2, || { |
| 123 | + let _: Result<(), Id<NSObject, Shared>> = |
| 124 | + unsafe { msg_send![nil, someSelectorWithError: _] }; |
| 125 | + }); |
| 126 | + checker.assert_panics(msg, line!() + 2, || { |
| 127 | + let _: Result<(), Id<NSObject, Shared>> = |
| 128 | + unsafe { msg_send![super(nil, NSObject::class()), someSelectorWithError: _] }; |
| 129 | + }); |
| 130 | + checker.assert_panics(msg, line!() + 2, || { |
| 131 | + let _: Result<Id<Object, Shared>, Id<NSObject, Shared>> = |
| 132 | + unsafe { msg_send_id![nil, someSelectorWithError: _] }; |
| 133 | + }); |
| 134 | + |
| 135 | + let msg = "invalid message send to -[NSObject someSelectorWithError:]: method not found"; |
| 136 | + checker.assert_panics(msg, line!() + 3, || { |
| 137 | + let obj = __RcTestObject::new(); |
| 138 | + let _: Result<(), Id<NSObject, Shared>> = |
| 139 | + unsafe { msg_send![super(&obj), someSelectorWithError: _] }; |
| 140 | + }); |
| 141 | +} |
| 142 | + |
| 143 | +pub fn test_id_unwrap(checker: &PanicChecker) { |
| 144 | + let cls = __RcTestObject::class(); |
| 145 | + let obj = __RcTestObject::new(); |
| 146 | + |
| 147 | + let msg = "failed creating new instance using +[__RcTestObject newReturningNull]"; |
| 148 | + checker.assert_panics(msg, line!() + 1, || { |
| 149 | + let _obj: Id<__RcTestObject, Shared> = unsafe { msg_send_id![cls, newReturningNull] }; |
| 150 | + }); |
| 151 | + |
| 152 | + let msg = "failed allocating with +[__RcTestObject allocReturningNull]"; |
| 153 | + checker.assert_panics(msg, line!() + 1, || { |
| 154 | + let _obj: Allocated<__RcTestObject> = unsafe { msg_send_id![cls, allocReturningNull] }; |
| 155 | + }); |
| 156 | + |
| 157 | + let msg = "failed initializing object with -initReturningNull"; |
| 158 | + checker.assert_panics(msg, line!() + 2, || { |
| 159 | + let _obj: Id<__RcTestObject, Shared> = |
| 160 | + unsafe { msg_send_id![__RcTestObject::alloc(), initReturningNull] }; |
| 161 | + }); |
| 162 | + |
| 163 | + let msg = "failed copying object"; |
| 164 | + checker.assert_panics(msg, line!() + 1, || { |
| 165 | + let _obj: Id<__RcTestObject, Shared> = unsafe { msg_send_id![&obj, copyReturningNull] }; |
| 166 | + }); |
| 167 | + |
| 168 | + let msg = "unexpected NULL returned from -[__RcTestObject methodReturningNull]"; |
| 169 | + checker.assert_panics(msg, line!() + 1, || { |
| 170 | + let _obj: Id<__RcTestObject, Shared> = unsafe { msg_send_id![&obj, methodReturningNull] }; |
| 171 | + }); |
| 172 | +} |
| 173 | + |
| 174 | +pub fn test_catch_all(checker: &PanicChecker) { |
| 175 | + let obj: Id<NSObject, Shared> = unsafe { msg_send_id![class!(NSArray), new] }; |
| 176 | + |
| 177 | + let msg = "NSRangeException"; |
| 178 | + checker.assert_panics(msg, line!() + 1, || { |
| 179 | + let _: *mut Object = unsafe { msg_send![&obj, objectAtIndex: 0usize] }; |
| 180 | + }); |
| 181 | + |
| 182 | + let msg = "NSRangeException"; |
| 183 | + checker.assert_panics(msg, line!() + 1, || { |
| 184 | + let _: Id<Object, Shared> = unsafe { msg_send_id![&obj, objectAtIndex: 0usize] }; |
| 185 | + }); |
| 186 | +} |
| 187 | + |
| 188 | +declare_class!( |
| 189 | + struct PanickingClass; |
| 190 | + |
| 191 | + unsafe impl ClassType for PanickingClass { |
| 192 | + type Super = NSObject; |
| 193 | + const NAME: &'static str = "PanickingClass"; |
| 194 | + } |
| 195 | + |
| 196 | + unsafe impl PanickingClass { |
| 197 | + #[method(panic)] |
| 198 | + fn _panic() -> *mut Self { |
| 199 | + panic!("panic in PanickingClass") |
| 200 | + } |
| 201 | + } |
| 202 | +); |
| 203 | + |
| 204 | +pub fn test_unwind(checker: &PanicChecker) { |
| 205 | + let msg = "panic in PanickingClass"; |
| 206 | + let line = line!() - 7; |
| 207 | + checker.assert_panics(msg, line, || { |
| 208 | + let _: *mut Object = unsafe { msg_send![PanickingClass::class(), panic] }; |
| 209 | + }); |
| 210 | + checker.assert_panics(msg, line, || { |
| 211 | + let _: Id<Object, Shared> = unsafe { msg_send_id![PanickingClass::class(), panic] }; |
| 212 | + }); |
| 213 | +} |
0 commit comments