1use gpui::{AppContext as _, UpdateGlobal, px, size};
2use indoc::indoc;
3use settings::SettingsStore;
4use std::{
5 ops::{Deref, DerefMut},
6 panic, thread,
7};
8
9use language::language_settings::{AllLanguageSettings, SoftWrap};
10use util::test::marked_text_offsets;
11
12use super::{VimTestContext, neovim_connection::NeovimConnection};
13use crate::state::{Mode, VimGlobals};
14
15pub struct NeovimBackedTestContext {
16 pub(crate) cx: VimTestContext,
17 pub(crate) neovim: NeovimConnection,
18
19 last_set_state: Option<String>,
20 recent_keystrokes: Vec<String>,
21}
22
23#[derive(Default)]
24pub struct SharedState {
25 neovim: String,
26 editor: String,
27 initial: String,
28 neovim_mode: Mode,
29 editor_mode: Mode,
30 recent_keystrokes: String,
31}
32
33impl SharedState {
34 #[track_caller]
35 pub fn assert_matches(&self) {
36 if self.neovim != self.editor || self.neovim_mode != self.editor_mode {
37 panic!(
38 indoc! {"Test failed (zed does not match nvim behavior)
39 # initial state:
40 {}
41 # keystrokes:
42 {}
43 # neovim ({}):
44 {}
45 # zed ({}):
46 {}"},
47 self.initial,
48 self.recent_keystrokes,
49 self.neovim_mode,
50 self.neovim,
51 self.editor_mode,
52 self.editor,
53 )
54 }
55 }
56
57 #[track_caller]
58 pub fn assert_eq(&mut self, marked_text: &str) {
59 let marked_text = marked_text.replace('•', " ");
60 if self.neovim == marked_text
61 && self.neovim == self.editor
62 && self.neovim_mode == self.editor_mode
63 {
64 return;
65 }
66
67 let message = if self.neovim != marked_text {
68 "Test is incorrect (currently expected != neovim_state)"
69 } else {
70 "Editor does not match nvim behavior"
71 };
72 panic!(
73 indoc! {"{}
74 # initial state:
75 {}
76 # keystrokes:
77 {}
78 # currently expected:
79 {}
80 # neovim ({}):
81 {}
82 # zed ({}):
83 {}"},
84 message,
85 self.initial,
86 self.recent_keystrokes,
87 marked_text.replace(" \n", "•\n"),
88 self.neovim_mode,
89 self.neovim.replace(" \n", "•\n"),
90 self.editor_mode,
91 self.editor.replace(" \n", "•\n"),
92 )
93 }
94}
95
96pub struct SharedClipboard {
97 register: char,
98 neovim: String,
99 editor: String,
100 state: SharedState,
101}
102
103impl SharedClipboard {
104 #[track_caller]
105 pub fn assert_eq(&self, expected: &str) {
106 if expected == self.neovim && self.neovim == self.editor {
107 return;
108 }
109
110 let message = if expected != self.neovim {
111 "Test is incorrect (currently expected != neovim_state)"
112 } else {
113 "Editor does not match nvim behavior"
114 };
115
116 panic!(
117 indoc! {"{}
118 # initial state:
119 {}
120 # keystrokes:
121 {}
122 # currently expected: {:?}
123 # neovim register \"{}: {:?}
124 # zed register \"{}: {:?}"},
125 message,
126 self.state.initial,
127 self.state.recent_keystrokes,
128 expected,
129 self.register,
130 self.neovim,
131 self.register,
132 self.editor
133 )
134 }
135}
136
137impl NeovimBackedTestContext {
138 pub async fn new(cx: &mut gpui::TestAppContext) -> NeovimBackedTestContext {
139 #[cfg(feature = "neovim")]
140 cx.executor().allow_parking();
141 // rust stores the name of the test on the current thread.
142 // We use this to automatically name a file that will store
143 // the neovim connection's requests/responses so that we can
144 // run without neovim on CI.
145 let thread = thread::current();
146 let test_name = thread
147 .name()
148 .expect("thread is not named")
149 .split(':')
150 .next_back()
151 .unwrap()
152 .to_string();
153 Self {
154 cx: VimTestContext::new(cx, true).await,
155 neovim: NeovimConnection::new(test_name).await,
156
157 last_set_state: None,
158 recent_keystrokes: Default::default(),
159 }
160 }
161
162 pub async fn new_html(cx: &mut gpui::TestAppContext) -> NeovimBackedTestContext {
163 #[cfg(feature = "neovim")]
164 cx.executor().allow_parking();
165 // rust stores the name of the test on the current thread.
166 // We use this to automatically name a file that will store
167 // the neovim connection's requests/responses so that we can
168 // run without neovim on CI.
169 let thread = thread::current();
170 let test_name = thread
171 .name()
172 .expect("thread is not named")
173 .split(':')
174 .next_back()
175 .unwrap()
176 .to_string();
177 Self {
178 cx: VimTestContext::new_html(cx).await,
179 neovim: NeovimConnection::new(test_name).await,
180
181 last_set_state: None,
182 recent_keystrokes: Default::default(),
183 }
184 }
185
186 pub async fn new_typescript(cx: &mut gpui::TestAppContext) -> NeovimBackedTestContext {
187 #[cfg(feature = "neovim")]
188 cx.executor().allow_parking();
189 // rust stores the name of the test on the current thread.
190 // We use this to automatically name a file that will store
191 // the neovim connection's requests/responses so that we can
192 // run without neovim on CI.
193 let thread = thread::current();
194 let test_name = thread
195 .name()
196 .expect("thread is not named")
197 .split(':')
198 .next_back()
199 .unwrap()
200 .to_string();
201 Self {
202 cx: VimTestContext::new_typescript(cx).await,
203 neovim: NeovimConnection::new(test_name).await,
204
205 last_set_state: None,
206 recent_keystrokes: Default::default(),
207 }
208 }
209
210 pub async fn set_shared_state(&mut self, marked_text: &str) {
211 let mode = if marked_text.contains('»') {
212 Mode::Visual
213 } else {
214 Mode::Normal
215 };
216 self.set_state(marked_text, mode);
217 self.last_set_state = Some(marked_text.to_string());
218 self.recent_keystrokes = Vec::new();
219 self.neovim.set_state(marked_text).await;
220 }
221
222 pub async fn simulate_shared_keystrokes(&mut self, keystroke_texts: &str) {
223 for keystroke_text in keystroke_texts.split(' ') {
224 self.recent_keystrokes.push(keystroke_text.to_string());
225 self.neovim.send_keystroke(keystroke_text).await;
226 }
227 self.simulate_keystrokes(keystroke_texts);
228 }
229
230 #[must_use]
231 pub async fn simulate(&mut self, keystrokes: &str, initial_state: &str) -> SharedState {
232 self.set_shared_state(initial_state).await;
233 self.simulate_shared_keystrokes(keystrokes).await;
234 self.shared_state().await
235 }
236
237 pub async fn set_shared_wrap(&mut self, columns: u32) {
238 if columns < 12 {
239 panic!("nvim doesn't support columns < 12")
240 }
241 self.neovim.set_option("wrap").await;
242 self.neovim
243 .set_option(&format!("columns={}", columns))
244 .await;
245
246 self.update(|_, cx| {
247 SettingsStore::update_global(cx, |settings, cx| {
248 settings.update_user_settings::<AllLanguageSettings>(cx, |settings| {
249 settings.defaults.soft_wrap = Some(SoftWrap::PreferredLineLength);
250 settings.defaults.preferred_line_length = Some(columns);
251 });
252 })
253 })
254 }
255
256 pub async fn set_scroll_height(&mut self, rows: u32) {
257 // match Zed's scrolling behavior
258 self.neovim.set_option(&format!("scrolloff={}", 3)).await;
259 // +2 to account for the vim command UI at the bottom.
260 self.neovim.set_option(&format!("lines={}", rows + 2)).await;
261 let (line_height, visible_line_count) = self.editor(|editor, window, _cx| {
262 (
263 editor
264 .style()
265 .unwrap()
266 .text
267 .line_height_in_pixels(window.rem_size()),
268 editor.visible_line_count().unwrap(),
269 )
270 });
271
272 let window = self.window;
273 let margin = self
274 .update_window(window, |_, window, _cx| {
275 window.viewport_size().height - line_height * visible_line_count
276 })
277 .unwrap();
278
279 self.simulate_window_resize(
280 self.window,
281 size(px(1000.), margin + (rows as f32) * line_height),
282 );
283 }
284
285 pub async fn set_neovim_option(&mut self, option: &str) {
286 self.neovim.set_option(option).await;
287 }
288
289 #[must_use]
290 pub async fn shared_clipboard(&mut self) -> SharedClipboard {
291 SharedClipboard {
292 register: '"',
293 state: self.shared_state().await,
294 neovim: self.neovim.read_register('"').await,
295 editor: self.read_from_clipboard().unwrap().text().unwrap(),
296 }
297 }
298
299 #[must_use]
300 pub async fn shared_register(&mut self, register: char) -> SharedClipboard {
301 SharedClipboard {
302 register,
303 state: self.shared_state().await,
304 neovim: self.neovim.read_register(register).await,
305 editor: self.update(|_, cx| {
306 cx.global::<VimGlobals>()
307 .registers
308 .get(®ister)
309 .cloned()
310 .unwrap_or_default()
311 .text
312 .into()
313 }),
314 }
315 }
316
317 #[must_use]
318 pub async fn shared_state(&mut self) -> SharedState {
319 let (mode, marked_text) = self.neovim.state().await;
320 SharedState {
321 neovim: marked_text,
322 neovim_mode: mode,
323 editor: self.editor_state(),
324 editor_mode: self.mode(),
325 initial: self
326 .last_set_state
327 .as_ref()
328 .cloned()
329 .unwrap_or("N/A".to_string()),
330 recent_keystrokes: self.recent_keystrokes.join(" "),
331 }
332 }
333
334 #[must_use]
335 pub async fn simulate_at_each_offset(
336 &mut self,
337 keystrokes: &str,
338 marked_positions: &str,
339 ) -> SharedState {
340 let (unmarked_text, cursor_offsets) = marked_text_offsets(marked_positions);
341
342 for cursor_offset in cursor_offsets.iter() {
343 let mut marked_text = unmarked_text.clone();
344 marked_text.insert(*cursor_offset, 'ˇ');
345
346 let state = self.simulate(keystrokes, &marked_text).await;
347 if state.neovim != state.editor || state.neovim_mode != state.editor_mode {
348 return state;
349 }
350 }
351
352 SharedState::default()
353 }
354}
355
356impl Deref for NeovimBackedTestContext {
357 type Target = VimTestContext;
358
359 fn deref(&self) -> &Self::Target {
360 &self.cx
361 }
362}
363
364impl DerefMut for NeovimBackedTestContext {
365 fn deref_mut(&mut self) -> &mut Self::Target {
366 &mut self.cx
367 }
368}
369
370#[cfg(test)]
371mod test {
372 use crate::test::NeovimBackedTestContext;
373 use gpui::TestAppContext;
374
375 #[gpui::test]
376 async fn neovim_backed_test_context_works(cx: &mut TestAppContext) {
377 let mut cx = NeovimBackedTestContext::new(cx).await;
378 cx.shared_state().await.assert_matches();
379 cx.set_shared_state("This is a tesˇt").await;
380 cx.shared_state().await.assert_matches();
381 }
382}