245 строк · 12 КиБ
code/crates/chl-tray/tests/на_своей_шине.rs
| 1 | //! Проверка приёмника живьём, на своей шине. |
| 2 | //! |
| 3 | //! Юнит-тесты в самом крейте проверяют чистые функции — разбор `service`, |
| 4 | //! выбор картинки, уборку по ушедшей шине. Про протокол они не говорят |
| 5 | //! ничего: имя можно занять неверными флагами, свойства прочитать не тем |
| 6 | //! путём, сигнал испустить не с тем именем — и все восемь тестов останутся |
| 7 | //! зелёными. Поэтому здесь поднимается **отдельный `dbus-daemon`**, на нём |
| 8 | //! запускается настоящий приёмник, и с ним разговаривает настоящий значок. |
| 9 | //! |
| 10 | //! Своя шина, а не сеансовая, по двум причинам. На сеансовой уже есть |
| 11 | //! наблюдатель рабочего стола (в Plasma — `kded6`), и приёмник правильно |
| 12 | //! откажется занимать имя — проверять станет нечего. И наоборот: занять |
| 13 | //! имя в живом сеансе значило бы отобрать значки у рабочего стола на время |
| 14 | //! прогона тестов. |
| 15 | //! |
| 16 | //! Если `dbus-daemon` в системе нет, тесты не притворяются пройденными, а |
| 17 | //! честно помечаются пропущенными сообщением в вывод. |
| 18 | |
| 19 | use std::process::{Child, Command, Stdio}; |
| 20 | use std::sync::mpsc::RecvTimeoutError; |
| 21 | use std::time::Duration; |
| 22 | |
| 23 | use chl_tray::watcher::{Event, WATCHER_NAME, WATCHER_PATH, start_on_address}; |
| 24 | use zbus::blocking::Connection; |
| 25 | |
| 26 | /// Своя шина на время проверки. |
| 27 | struct Шина { |
| 28 | процесс: Child, |
| 29 | адрес: String, |
| 30 | } |
| 31 | |
| 32 | impl Шина { |
| 33 | fn поднять() -> Option<Self> { |
| 34 | let out = Command::new("dbus-daemon") |
| 35 | .args(["--session", "--print-address", "--nofork", "--nopidfile"]) |
| 36 | .stdout(Stdio::piped()) |
| 37 | .stderr(Stdio::null()) |
| 38 | .spawn() |
| 39 | .ok()?; |
| 40 | let mut процесс = out; |
| 41 | let stdout = процесс.stdout.take()?; |
| 42 | let адрес = { |
| 43 | use std::io::{BufRead, BufReader}; |
| 44 | BufReader::new(stdout).lines().next()?.ok()? |
| 45 | }; |
| 46 | match адрес.trim().is_empty() { |
| 47 | true => None, |
| 48 | false => Some(Шина { процесс, адрес: адрес.trim().to_owned() }), |
| 49 | } |
| 50 | } |
| 51 | |
| 52 | /// Соединение для подопытных — значка и проверочных запросов. |
| 53 | /// |
| 54 | /// Рантайм нужен по той же причине, что и внутри крейта: вариант zbus |
| 55 | /// здесь токийный, и блокирующие вызовы без рантайма падают. Тест |
| 56 | /// держит свой, чтобы проверять приёмник снаружи, его собственным |
| 57 | /// рантаймом не пользуясь. |
| 58 | fn соединиться(&self) -> zbus::Result<Connection> { |
| 59 | zbus::blocking::connection::Builder::address(self.адрес.as_str())?.build() |
| 60 | } |
| 61 | } |
| 62 | |
| 63 | impl Drop for Шина { |
| 64 | fn drop(&mut self) { |
| 65 | let _ = self.процесс.kill(); |
| 66 | let _ = self.процесс.wait(); |
| 67 | } |
| 68 | } |
| 69 | |
| 70 | /// Значок-подопытный: ровно то, что отдаёт живая программа. |
| 71 | struct Значок; |
| 72 | |
| 73 | #[zbus::interface(name = "org.kde.StatusNotifierItem")] |
| 74 | impl Значок { |
| 75 | #[zbus(property)] |
| 76 | fn id(&self) -> String { |
| 77 | "подопытный".into() |
| 78 | } |
| 79 | #[zbus(property)] |
| 80 | fn title(&self) -> String { |
| 81 | "Подопытный значок".into() |
| 82 | } |
| 83 | #[zbus(property)] |
| 84 | fn status(&self) -> String { |
| 85 | "Active".into() |
| 86 | } |
| 87 | #[zbus(property)] |
| 88 | fn icon_name(&self) -> String { |
| 89 | String::new() |
| 90 | } |
| 91 | /// Две картинки разного размера — приёмник обязан взять большую. |
| 92 | #[zbus(property)] |
| 93 | fn icon_pixmap(&self) -> Vec<chl_tray::item::PixmapTuple> { |
| 94 | vec![(16, 16, vec![7u8; 16 * 16 * 4]), (32, 32, vec![9u8; 32 * 32 * 4])] |
| 95 | } |
| 96 | #[zbus(property)] |
| 97 | fn tool_tip(&self) -> chl_tray::item::ToolTipTuple { |
| 98 | (String::new(), vec![], "Заголовок".into(), "Описание".into()) |
| 99 | } |
| 100 | } |
| 101 | |
| 102 | /// Рантайм для подопытных соединений теста. |
| 103 | fn рантайм_теста() -> tokio::runtime::Runtime { |
| 104 | tokio::runtime::Builder::new_multi_thread() |
| 105 | .worker_threads(1) |
| 106 | .enable_all() |
| 107 | .build() |
| 108 | .expect("рантайм теста") |
| 109 | } |
| 110 | |
| 111 | /// Дождаться события, подходящего под условие, не дольше срока. |
| 112 | fn дождаться( |
| 113 | events: &std::sync::mpsc::Receiver<Event>, |
| 114 | срок: Duration, |
| 115 | годится: impl Fn(&Event) -> bool, |
| 116 | ) -> Option<Event> { |
| 117 | let край = std::time::Instant::now() + срок; |
| 118 | loop { |
| 119 | let осталось = край.saturating_duration_since(std::time::Instant::now()); |
| 120 | match events.recv_timeout(осталось) { |
| 121 | Ok(e) if годится(&e) => return Some(e), |
| 122 | Ok(_) => continue, |
| 123 | Err(RecvTimeoutError::Timeout) => return None, |
| 124 | Err(RecvTimeoutError::Disconnected) => return None, |
| 125 | } |
| 126 | } |
| 127 | } |
| 128 | |
| 129 | #[test] |
| 130 | fn имя_занимается_значок_доходит_и_уход_программы_его_убирает() { |
| 131 | let Some(шина) = Шина::поднять() else { |
| 132 | eprintln!("пропущено: в системе нет dbus-daemon, поднять свою шину нечем"); |
| 133 | return; |
| 134 | }; |
| 135 | let rt = рантайм_теста(); |
| 136 | // Вход на всё тело: блокирующие вызовы zbus здесь есть в каждом шаге. |
| 137 | let _вход = rt.enter(); |
| 138 | |
| 139 | let приёмник = start_on_address(&шина.адрес).expect("приёмник запускается"); |
| 140 | |
| 141 | // 1. На пустой шине имя обязано стать нашим. |
| 142 | assert_eq!( |
| 143 | дождаться(&приёмник.events, Duration::from_secs(5), |e| matches!(e, Event::Took)), |
| 144 | Some(Event::Took), |
| 145 | "на шине без наблюдателя имя должно достаться нам" |
| 146 | ); |
| 147 | |
| 148 | // 2. Имя действительно занято — спрашиваем у самой шины, а не у себя. |
| 149 | let проверочное = шина.соединиться().expect("второе соединение"); |
| 150 | let dbus = zbus::blocking::fdo::DBusProxy::new(&проверочное).expect("сервис шины"); |
| 151 | let имена = dbus.list_names().expect("список имён"); |
| 152 | assert!( |
| 153 | имена.iter().any(|n| n.as_str() == WATCHER_NAME), |
| 154 | "имя {WATCHER_NAME} должно быть на шине, а имён там: {имена:?}" |
| 155 | ); |
| 156 | |
| 157 | // 3. Появляется значок и регистрируется, как это делает Wine. |
| 158 | let значок = шина.соединиться().expect("соединение значка"); |
| 159 | значок |
| 160 | .object_server() |
| 161 | .at("/StatusNotifierItem", Значок) |
| 162 | .expect("значок выставляется на шину"); |
| 163 | let шина_значка = значок.unique_name().expect("уникальное имя значка").to_string(); |
| 164 | |
| 165 | let вызов = зарегистрировать(&значок, "/StatusNotifierItem"); |
| 166 | assert!(вызов.is_ok(), "регистрация значка должна пройти: {вызов:?}"); |
| 167 | |
| 168 | let Some(Event::Added(icon)) = |
| 169 | дождаться(&приёмник.events, Duration::from_secs(5), |e| matches!(e, Event::Added(_))) |
| 170 | else { |
| 171 | panic!("значок зарегистрировался, но приёмник о нём не сообщил"); |
| 172 | }; |
| 173 | |
| 174 | // Свойства прочитаны настоящим вызовом по шине, а не придуманы. |
| 175 | assert_eq!(icon.id, "подопытный"); |
| 176 | assert_eq!(icon.title, "Подопытный значок"); |
| 177 | assert_eq!(icon.status, "Active"); |
| 178 | assert_eq!(icon.tooltip, "Заголовок\nОписание"); |
| 179 | let pixmap = icon.pixmap.expect("картинка должна быть прочитана"); |
| 180 | assert_eq!( |
| 181 | (pixmap.width, pixmap.height), |
| 182 | (32, 32), |
| 183 | "из двух предложенных картинок берётся большая" |
| 184 | ); |
| 185 | assert_eq!(pixmap.argb.len(), 32 * 32 * 4); |
| 186 | assert_eq!(icon.bus, шина_значка, "значок должен числиться за своим именем на шине"); |
| 187 | |
| 188 | // 4. Программа закрылась — значок обязан убраться сам, без подсказок. |
| 189 | drop(значок); |
| 190 | let убрался = дождаться(&приёмник.events, Duration::from_secs(5), |e| { |
| 191 | matches!(e, Event::Removed { .. }) |
| 192 | }); |
| 193 | assert!( |
| 194 | matches!(&убрался, Some(Event::Removed { key }) if key == &icon.key), |
| 195 | "после ухода программы должен прийти Removed с тем же ключом, пришло: {убрался:?}" |
| 196 | ); |
| 197 | } |
| 198 | |
| 199 | #[test] |
| 200 | fn при_занятом_имени_приёмник_не_лезет() { |
| 201 | let Some(шина) = Шина::поднять() else { |
| 202 | eprintln!("пропущено: в системе нет dbus-daemon"); |
| 203 | return; |
| 204 | }; |
| 205 | let rt = рантайм_теста(); |
| 206 | // Вход на всё тело: блокирующие вызовы zbus здесь есть в каждом шаге. |
| 207 | let _вход = rt.enter(); |
| 208 | |
| 209 | // Чужой наблюдатель занял имя первым — как это делает рабочий стол. |
| 210 | let чужой = шина.соединиться().expect("соединение чужого наблюдателя"); |
| 211 | чужой.request_name(WATCHER_NAME).expect("чужой занимает имя"); |
| 212 | |
| 213 | let приёмник = start_on_address(&шина.адрес).expect("приёмник запускается"); |
| 214 | |
| 215 | // Ключевое: `Took` приходить НЕ должен. Проверяется ожиданием с |
| 216 | // таймаутом — то есть отсутствием события, а не его наличием. |
| 217 | assert_eq!( |
| 218 | дождаться(&приёмник.events, Duration::from_millis(1500), |e| matches!(e, Event::Took)), |
| 219 | None, |
| 220 | "имя занято рабочим столом — приёмник не должен объявлять его своим" |
| 221 | ); |
| 222 | |
| 223 | // И имя по-прежнему у чужого владельца, а не отобрано. |
| 224 | let dbus = zbus::blocking::fdo::DBusProxy::new(&чужой).expect("сервис шины"); |
| 225 | let владелец = dbus.get_name_owner(WATCHER_NAME.try_into().unwrap()).expect("владелец имени"); |
| 226 | assert_eq!( |
| 227 | владелец.as_str(), |
| 228 | чужой.unique_name().unwrap().as_str(), |
| 229 | "имя должно остаться у того, кто занял его первым" |
| 230 | ); |
| 231 | } |
| 232 | |
| 233 | /// Позвать `RegisterStatusNotifierItem` у приёмника — ровно так, как это |
| 234 | /// делает программа: методом на шине, а не через внутренности крейта. |
| 235 | fn зарегистрировать(conn: &Connection, путь: &str) -> zbus::Result<()> { |
| 236 | conn.call_method( |
| 237 | Some(WATCHER_NAME), |
| 238 | WATCHER_PATH, |
| 239 | Some("org.kde.StatusNotifierWatcher"), |
| 240 | "RegisterStatusNotifierItem", |
| 241 | &(путь,), |
| 242 | ) |
| 243 | .map(|_| ()) |
| 244 | } |
| 245 |