1use crate::{
2 db::{self, NewUserParams, UserId},
3 rpc::{CLEANUP_TIMEOUT, RECONNECT_TIMEOUT},
4 tests::{TestClient, TestServer},
5};
6use anyhow::{anyhow, Result};
7use call::ActiveCall;
8use client::RECEIVE_TIMEOUT;
9use collections::BTreeMap;
10use editor::Bias;
11use fs::{repository::GitFileStatus, FakeFs, Fs as _};
12use futures::StreamExt as _;
13use gpui::{executor::Deterministic, ModelHandle, Task, TestAppContext};
14use language::{range_to_lsp, FakeLspAdapter, Language, LanguageConfig, PointUtf16};
15use lsp::FakeLanguageServer;
16use parking_lot::Mutex;
17use pretty_assertions::assert_eq;
18use project::{search::SearchQuery, Project, ProjectPath};
19use rand::{
20 distributions::{Alphanumeric, DistString},
21 prelude::*,
22};
23use serde::{Deserialize, Serialize};
24use settings::SettingsStore;
25use std::{
26 env,
27 ops::Range,
28 path::{Path, PathBuf},
29 rc::Rc,
30 sync::{
31 atomic::{AtomicBool, Ordering::SeqCst},
32 Arc,
33 },
34};
35use util::ResultExt;
36
37lazy_static::lazy_static! {
38 static ref PLAN_LOAD_PATH: Option<PathBuf> = path_env_var("LOAD_PLAN");
39 static ref PLAN_SAVE_PATH: Option<PathBuf> = path_env_var("SAVE_PLAN");
40 static ref LOADED_PLAN_JSON: Mutex<Option<Vec<u8>>> = Default::default();
41 static ref PLAN: Mutex<Option<Arc<Mutex<TestPlan>>>> = Default::default();
42}
43
44#[gpui::test(iterations = 100, on_failure = "on_failure")]
45async fn test_random_collaboration(
46 cx: &mut TestAppContext,
47 deterministic: Arc<Deterministic>,
48 rng: StdRng,
49) {
50 deterministic.forbid_parking();
51
52 let max_peers = env::var("MAX_PEERS")
53 .map(|i| i.parse().expect("invalid `MAX_PEERS` variable"))
54 .unwrap_or(3);
55 let max_operations = env::var("OPERATIONS")
56 .map(|i| i.parse().expect("invalid `OPERATIONS` variable"))
57 .unwrap_or(10);
58
59 let mut server = TestServer::start(&deterministic).await;
60 let db = server.app_state.db.clone();
61
62 let mut users = Vec::new();
63 for ix in 0..max_peers {
64 let username = format!("user-{}", ix + 1);
65 let user_id = db
66 .create_user(
67 &format!("{username}@example.com"),
68 false,
69 NewUserParams {
70 github_login: username.clone(),
71 github_user_id: (ix + 1) as i32,
72 invite_count: 0,
73 },
74 )
75 .await
76 .unwrap()
77 .user_id;
78 users.push(UserTestPlan {
79 user_id,
80 username,
81 online: false,
82 next_root_id: 0,
83 operation_ix: 0,
84 });
85 }
86
87 for (ix, user_a) in users.iter().enumerate() {
88 for user_b in &users[ix + 1..] {
89 server
90 .app_state
91 .db
92 .send_contact_request(user_a.user_id, user_b.user_id)
93 .await
94 .unwrap();
95 server
96 .app_state
97 .db
98 .respond_to_contact_request(user_b.user_id, user_a.user_id, true)
99 .await
100 .unwrap();
101 }
102 }
103
104 let plan = Arc::new(Mutex::new(TestPlan::new(rng, users, max_operations)));
105
106 if let Some(path) = &*PLAN_LOAD_PATH {
107 let json = LOADED_PLAN_JSON
108 .lock()
109 .get_or_insert_with(|| {
110 eprintln!("loaded test plan from path {:?}", path);
111 std::fs::read(path).unwrap()
112 })
113 .clone();
114 plan.lock().deserialize(json);
115 }
116
117 PLAN.lock().replace(plan.clone());
118
119 let mut clients = Vec::new();
120 let mut client_tasks = Vec::new();
121 let mut operation_channels = Vec::new();
122
123 loop {
124 let Some((next_operation, applied)) = plan.lock().next_server_operation(&clients) else { break };
125 applied.store(true, SeqCst);
126 let did_apply = apply_server_operation(
127 deterministic.clone(),
128 &mut server,
129 &mut clients,
130 &mut client_tasks,
131 &mut operation_channels,
132 plan.clone(),
133 next_operation,
134 cx,
135 )
136 .await;
137 if !did_apply {
138 applied.store(false, SeqCst);
139 }
140 }
141
142 drop(operation_channels);
143 deterministic.start_waiting();
144 futures::future::join_all(client_tasks).await;
145 deterministic.finish_waiting();
146 deterministic.run_until_parked();
147
148 check_consistency_between_clients(&clients);
149
150 for (client, mut cx) in clients {
151 cx.update(|cx| {
152 let store = cx.remove_global::<SettingsStore>();
153 cx.clear_globals();
154 cx.set_global(store);
155 drop(client);
156 });
157 }
158
159 deterministic.run_until_parked();
160}
161
162fn on_failure() {
163 if let Some(plan) = PLAN.lock().clone() {
164 if let Some(path) = &*PLAN_SAVE_PATH {
165 eprintln!("saved test plan to path {:?}", path);
166 std::fs::write(path, plan.lock().serialize()).unwrap();
167 }
168 }
169}
170
171async fn apply_server_operation(
172 deterministic: Arc<Deterministic>,
173 server: &mut TestServer,
174 clients: &mut Vec<(Rc<TestClient>, TestAppContext)>,
175 client_tasks: &mut Vec<Task<()>>,
176 operation_channels: &mut Vec<futures::channel::mpsc::UnboundedSender<usize>>,
177 plan: Arc<Mutex<TestPlan>>,
178 operation: Operation,
179 cx: &mut TestAppContext,
180) -> bool {
181 match operation {
182 Operation::AddConnection { user_id } => {
183 let username;
184 {
185 let mut plan = plan.lock();
186 let mut user = plan.user(user_id);
187 if user.online {
188 return false;
189 }
190 user.online = true;
191 username = user.username.clone();
192 };
193 log::info!("Adding new connection for {}", username);
194 let next_entity_id = (user_id.0 * 10_000) as usize;
195 let mut client_cx = TestAppContext::new(
196 cx.foreground_platform(),
197 cx.platform(),
198 deterministic.build_foreground(user_id.0 as usize),
199 deterministic.build_background(),
200 cx.font_cache(),
201 cx.leak_detector(),
202 next_entity_id,
203 cx.function_name.clone(),
204 );
205
206 let (operation_tx, operation_rx) = futures::channel::mpsc::unbounded();
207 let client = Rc::new(server.create_client(&mut client_cx, &username).await);
208 operation_channels.push(operation_tx);
209 clients.push((client.clone(), client_cx.clone()));
210 client_tasks.push(client_cx.foreground().spawn(simulate_client(
211 client,
212 operation_rx,
213 plan.clone(),
214 client_cx,
215 )));
216
217 log::info!("Added connection for {}", username);
218 }
219
220 Operation::RemoveConnection {
221 user_id: removed_user_id,
222 } => {
223 log::info!("Simulating full disconnection of user {}", removed_user_id);
224 let client_ix = clients
225 .iter()
226 .position(|(client, cx)| client.current_user_id(cx) == removed_user_id);
227 let Some(client_ix) = client_ix else { return false };
228 let user_connection_ids = server
229 .connection_pool
230 .lock()
231 .user_connection_ids(removed_user_id)
232 .collect::<Vec<_>>();
233 assert_eq!(user_connection_ids.len(), 1);
234 let removed_peer_id = user_connection_ids[0].into();
235 let (client, mut client_cx) = clients.remove(client_ix);
236 let client_task = client_tasks.remove(client_ix);
237 operation_channels.remove(client_ix);
238 server.forbid_connections();
239 server.disconnect_client(removed_peer_id);
240 deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
241 deterministic.start_waiting();
242 log::info!("Waiting for user {} to exit...", removed_user_id);
243 client_task.await;
244 deterministic.finish_waiting();
245 server.allow_connections();
246
247 for project in client.remote_projects().iter() {
248 project.read_with(&client_cx, |project, _| {
249 assert!(
250 project.is_read_only(),
251 "project {:?} should be read only",
252 project.remote_id()
253 )
254 });
255 }
256
257 for (client, cx) in clients {
258 let contacts = server
259 .app_state
260 .db
261 .get_contacts(client.current_user_id(cx))
262 .await
263 .unwrap();
264 let pool = server.connection_pool.lock();
265 for contact in contacts {
266 if let db::Contact::Accepted { user_id, busy, .. } = contact {
267 if user_id == removed_user_id {
268 assert!(!pool.is_user_online(user_id));
269 assert!(!busy);
270 }
271 }
272 }
273 }
274
275 log::info!("{} removed", client.username);
276 plan.lock().user(removed_user_id).online = false;
277 client_cx.update(|cx| {
278 cx.clear_globals();
279 drop(client);
280 });
281 }
282
283 Operation::BounceConnection { user_id } => {
284 log::info!("Simulating temporary disconnection of user {}", user_id);
285 let user_connection_ids = server
286 .connection_pool
287 .lock()
288 .user_connection_ids(user_id)
289 .collect::<Vec<_>>();
290 if user_connection_ids.is_empty() {
291 return false;
292 }
293 assert_eq!(user_connection_ids.len(), 1);
294 let peer_id = user_connection_ids[0].into();
295 server.disconnect_client(peer_id);
296 deterministic.advance_clock(RECEIVE_TIMEOUT + RECONNECT_TIMEOUT);
297 }
298
299 Operation::RestartServer => {
300 log::info!("Simulating server restart");
301 server.reset().await;
302 deterministic.advance_clock(RECEIVE_TIMEOUT);
303 server.start().await.unwrap();
304 deterministic.advance_clock(CLEANUP_TIMEOUT);
305 let environment = &server.app_state.config.zed_environment;
306 let stale_room_ids = server
307 .app_state
308 .db
309 .stale_room_ids(environment, server.id())
310 .await
311 .unwrap();
312 assert_eq!(stale_room_ids, vec![]);
313 }
314
315 Operation::MutateClients {
316 user_ids,
317 batch_id,
318 quiesce,
319 } => {
320 let mut applied = false;
321 for user_id in user_ids {
322 let client_ix = clients
323 .iter()
324 .position(|(client, cx)| client.current_user_id(cx) == user_id);
325 let Some(client_ix) = client_ix else { continue };
326 applied = true;
327 if let Err(err) = operation_channels[client_ix].unbounded_send(batch_id) {
328 log::error!("error signaling user {user_id}: {err}");
329 }
330 }
331
332 if quiesce && applied {
333 deterministic.run_until_parked();
334 check_consistency_between_clients(&clients);
335 }
336
337 return applied;
338 }
339 }
340 true
341}
342
343async fn apply_client_operation(
344 client: &TestClient,
345 operation: ClientOperation,
346 cx: &mut TestAppContext,
347) -> Result<(), TestError> {
348 match operation {
349 ClientOperation::AcceptIncomingCall => {
350 let active_call = cx.read(ActiveCall::global);
351 if active_call.read_with(cx, |call, _| call.incoming().borrow().is_none()) {
352 Err(TestError::Inapplicable)?;
353 }
354
355 log::info!("{}: accepting incoming call", client.username);
356 active_call
357 .update(cx, |call, cx| call.accept_incoming(cx))
358 .await?;
359 }
360
361 ClientOperation::RejectIncomingCall => {
362 let active_call = cx.read(ActiveCall::global);
363 if active_call.read_with(cx, |call, _| call.incoming().borrow().is_none()) {
364 Err(TestError::Inapplicable)?;
365 }
366
367 log::info!("{}: declining incoming call", client.username);
368 active_call.update(cx, |call, _| call.decline_incoming())?;
369 }
370
371 ClientOperation::LeaveCall => {
372 let active_call = cx.read(ActiveCall::global);
373 if active_call.read_with(cx, |call, _| call.room().is_none()) {
374 Err(TestError::Inapplicable)?;
375 }
376
377 log::info!("{}: hanging up", client.username);
378 active_call.update(cx, |call, cx| call.hang_up(cx)).await?;
379 }
380
381 ClientOperation::InviteContactToCall { user_id } => {
382 let active_call = cx.read(ActiveCall::global);
383
384 log::info!("{}: inviting {}", client.username, user_id,);
385 active_call
386 .update(cx, |call, cx| call.invite(user_id.to_proto(), None, cx))
387 .await
388 .log_err();
389 }
390
391 ClientOperation::OpenLocalProject { first_root_name } => {
392 log::info!(
393 "{}: opening local project at {:?}",
394 client.username,
395 first_root_name
396 );
397
398 let root_path = Path::new("/").join(&first_root_name);
399 client.fs.create_dir(&root_path).await.unwrap();
400 client
401 .fs
402 .create_file(&root_path.join("main.rs"), Default::default())
403 .await
404 .unwrap();
405 let project = client.build_local_project(root_path, cx).await.0;
406 ensure_project_shared(&project, client, cx).await;
407 client.local_projects_mut().push(project.clone());
408 }
409
410 ClientOperation::AddWorktreeToProject {
411 project_root_name,
412 new_root_path,
413 } => {
414 let project = project_for_root_name(client, &project_root_name, cx)
415 .ok_or(TestError::Inapplicable)?;
416
417 log::info!(
418 "{}: finding/creating local worktree at {:?} to project with root path {}",
419 client.username,
420 new_root_path,
421 project_root_name
422 );
423
424 ensure_project_shared(&project, client, cx).await;
425 if !client.fs.paths().contains(&new_root_path) {
426 client.fs.create_dir(&new_root_path).await.unwrap();
427 }
428 project
429 .update(cx, |project, cx| {
430 project.find_or_create_local_worktree(&new_root_path, true, cx)
431 })
432 .await
433 .unwrap();
434 }
435
436 ClientOperation::CloseRemoteProject { project_root_name } => {
437 let project = project_for_root_name(client, &project_root_name, cx)
438 .ok_or(TestError::Inapplicable)?;
439
440 log::info!(
441 "{}: closing remote project with root path {}",
442 client.username,
443 project_root_name,
444 );
445
446 let ix = client
447 .remote_projects()
448 .iter()
449 .position(|p| p == &project)
450 .unwrap();
451 cx.update(|_| {
452 client.remote_projects_mut().remove(ix);
453 client.buffers().retain(|p, _| *p != project);
454 drop(project);
455 });
456 }
457
458 ClientOperation::OpenRemoteProject {
459 host_id,
460 first_root_name,
461 } => {
462 let active_call = cx.read(ActiveCall::global);
463 let project = active_call
464 .update(cx, |call, cx| {
465 let room = call.room().cloned()?;
466 let participant = room
467 .read(cx)
468 .remote_participants()
469 .get(&host_id.to_proto())?;
470 let project_id = participant
471 .projects
472 .iter()
473 .find(|project| project.worktree_root_names[0] == first_root_name)?
474 .id;
475 Some(room.update(cx, |room, cx| {
476 room.join_project(
477 project_id,
478 client.language_registry.clone(),
479 FakeFs::new(cx.background().clone()),
480 cx,
481 )
482 }))
483 })
484 .ok_or(TestError::Inapplicable)?;
485
486 log::info!(
487 "{}: joining remote project of user {}, root name {}",
488 client.username,
489 host_id,
490 first_root_name,
491 );
492
493 let project = project.await?;
494 client.remote_projects_mut().push(project.clone());
495 }
496
497 ClientOperation::CreateWorktreeEntry {
498 project_root_name,
499 is_local,
500 full_path,
501 is_dir,
502 } => {
503 let project = project_for_root_name(client, &project_root_name, cx)
504 .ok_or(TestError::Inapplicable)?;
505 let project_path = project_path_for_full_path(&project, &full_path, cx)
506 .ok_or(TestError::Inapplicable)?;
507
508 log::info!(
509 "{}: creating {} at path {:?} in {} project {}",
510 client.username,
511 if is_dir { "dir" } else { "file" },
512 full_path,
513 if is_local { "local" } else { "remote" },
514 project_root_name,
515 );
516
517 ensure_project_shared(&project, client, cx).await;
518 project
519 .update(cx, |p, cx| p.create_entry(project_path, is_dir, cx))
520 .unwrap()
521 .await?;
522 }
523
524 ClientOperation::OpenBuffer {
525 project_root_name,
526 is_local,
527 full_path,
528 } => {
529 let project = project_for_root_name(client, &project_root_name, cx)
530 .ok_or(TestError::Inapplicable)?;
531 let project_path = project_path_for_full_path(&project, &full_path, cx)
532 .ok_or(TestError::Inapplicable)?;
533
534 log::info!(
535 "{}: opening buffer {:?} in {} project {}",
536 client.username,
537 full_path,
538 if is_local { "local" } else { "remote" },
539 project_root_name,
540 );
541
542 ensure_project_shared(&project, client, cx).await;
543 let buffer = project
544 .update(cx, |project, cx| project.open_buffer(project_path, cx))
545 .await?;
546 client.buffers_for_project(&project).insert(buffer);
547 }
548
549 ClientOperation::EditBuffer {
550 project_root_name,
551 is_local,
552 full_path,
553 edits,
554 } => {
555 let project = project_for_root_name(client, &project_root_name, cx)
556 .ok_or(TestError::Inapplicable)?;
557 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
558 .ok_or(TestError::Inapplicable)?;
559
560 log::info!(
561 "{}: editing buffer {:?} in {} project {} with {:?}",
562 client.username,
563 full_path,
564 if is_local { "local" } else { "remote" },
565 project_root_name,
566 edits
567 );
568
569 ensure_project_shared(&project, client, cx).await;
570 buffer.update(cx, |buffer, cx| {
571 let snapshot = buffer.snapshot();
572 buffer.edit(
573 edits.into_iter().map(|(range, text)| {
574 let start = snapshot.clip_offset(range.start, Bias::Left);
575 let end = snapshot.clip_offset(range.end, Bias::Right);
576 (start..end, text)
577 }),
578 None,
579 cx,
580 );
581 });
582 }
583
584 ClientOperation::CloseBuffer {
585 project_root_name,
586 is_local,
587 full_path,
588 } => {
589 let project = project_for_root_name(client, &project_root_name, cx)
590 .ok_or(TestError::Inapplicable)?;
591 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
592 .ok_or(TestError::Inapplicable)?;
593
594 log::info!(
595 "{}: closing buffer {:?} in {} project {}",
596 client.username,
597 full_path,
598 if is_local { "local" } else { "remote" },
599 project_root_name
600 );
601
602 ensure_project_shared(&project, client, cx).await;
603 cx.update(|_| {
604 client.buffers_for_project(&project).remove(&buffer);
605 drop(buffer);
606 });
607 }
608
609 ClientOperation::SaveBuffer {
610 project_root_name,
611 is_local,
612 full_path,
613 detach,
614 } => {
615 let project = project_for_root_name(client, &project_root_name, cx)
616 .ok_or(TestError::Inapplicable)?;
617 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
618 .ok_or(TestError::Inapplicable)?;
619
620 log::info!(
621 "{}: saving buffer {:?} in {} project {}, {}",
622 client.username,
623 full_path,
624 if is_local { "local" } else { "remote" },
625 project_root_name,
626 if detach { "detaching" } else { "awaiting" }
627 );
628
629 ensure_project_shared(&project, client, cx).await;
630 let requested_version = buffer.read_with(cx, |buffer, _| buffer.version());
631 let save = project.update(cx, |project, cx| project.save_buffer(buffer, cx));
632 let save = cx.background().spawn(async move {
633 let (saved_version, _, _) = save
634 .await
635 .map_err(|err| anyhow!("save request failed: {:?}", err))?;
636 assert!(saved_version.observed_all(&requested_version));
637 anyhow::Ok(())
638 });
639 if detach {
640 cx.update(|cx| save.detach_and_log_err(cx));
641 } else {
642 save.await?;
643 }
644 }
645
646 ClientOperation::RequestLspDataInBuffer {
647 project_root_name,
648 is_local,
649 full_path,
650 offset,
651 kind,
652 detach,
653 } => {
654 let project = project_for_root_name(client, &project_root_name, cx)
655 .ok_or(TestError::Inapplicable)?;
656 let buffer = buffer_for_full_path(client, &project, &full_path, cx)
657 .ok_or(TestError::Inapplicable)?;
658
659 log::info!(
660 "{}: request LSP {:?} for buffer {:?} in {} project {}, {}",
661 client.username,
662 kind,
663 full_path,
664 if is_local { "local" } else { "remote" },
665 project_root_name,
666 if detach { "detaching" } else { "awaiting" }
667 );
668
669 use futures::{FutureExt as _, TryFutureExt as _};
670 let offset = buffer.read_with(cx, |b, _| b.clip_offset(offset, Bias::Left));
671 let request = cx.foreground().spawn(project.update(cx, |project, cx| {
672 match kind {
673 LspRequestKind::Rename => project
674 .prepare_rename(buffer, offset, cx)
675 .map_ok(|_| ())
676 .boxed(),
677 LspRequestKind::Completion => project
678 .completions(&buffer, offset, cx)
679 .map_ok(|_| ())
680 .boxed(),
681 LspRequestKind::CodeAction => project
682 .code_actions(&buffer, offset..offset, cx)
683 .map_ok(|_| ())
684 .boxed(),
685 LspRequestKind::Definition => project
686 .definition(&buffer, offset, cx)
687 .map_ok(|_| ())
688 .boxed(),
689 LspRequestKind::Highlights => project
690 .document_highlights(&buffer, offset, cx)
691 .map_ok(|_| ())
692 .boxed(),
693 }
694 }));
695 if detach {
696 request.detach();
697 } else {
698 request.await?;
699 }
700 }
701
702 ClientOperation::SearchProject {
703 project_root_name,
704 is_local,
705 query,
706 detach,
707 } => {
708 let project = project_for_root_name(client, &project_root_name, cx)
709 .ok_or(TestError::Inapplicable)?;
710
711 log::info!(
712 "{}: search {} project {} for {:?}, {}",
713 client.username,
714 if is_local { "local" } else { "remote" },
715 project_root_name,
716 query,
717 if detach { "detaching" } else { "awaiting" }
718 );
719
720 let search = project.update(cx, |project, cx| {
721 project.search(
722 SearchQuery::text(query, false, false, Vec::new(), Vec::new()),
723 cx,
724 )
725 });
726 drop(project);
727 let search = cx.background().spawn(async move {
728 search
729 .await
730 .map_err(|err| anyhow!("search request failed: {:?}", err))
731 });
732 if detach {
733 cx.update(|cx| search.detach_and_log_err(cx));
734 } else {
735 search.await?;
736 }
737 }
738
739 ClientOperation::WriteFsEntry {
740 path,
741 is_dir,
742 content,
743 } => {
744 if !client
745 .fs
746 .directories()
747 .contains(&path.parent().unwrap().to_owned())
748 {
749 return Err(TestError::Inapplicable);
750 }
751
752 if is_dir {
753 log::info!("{}: creating dir at {:?}", client.username, path);
754 client.fs.create_dir(&path).await.unwrap();
755 } else {
756 let exists = client.fs.metadata(&path).await?.is_some();
757 let verb = if exists { "updating" } else { "creating" };
758 log::info!("{}: {} file at {:?}", verb, client.username, path);
759
760 client
761 .fs
762 .save(&path, &content.as_str().into(), fs::LineEnding::Unix)
763 .await
764 .unwrap();
765 }
766 }
767
768 ClientOperation::GitOperation { operation } => match operation {
769 GitOperation::WriteGitIndex {
770 repo_path,
771 contents,
772 } => {
773 if !client.fs.directories().contains(&repo_path) {
774 return Err(TestError::Inapplicable);
775 }
776
777 log::info!(
778 "{}: writing git index for repo {:?}: {:?}",
779 client.username,
780 repo_path,
781 contents
782 );
783
784 let dot_git_dir = repo_path.join(".git");
785 let contents = contents
786 .iter()
787 .map(|(path, contents)| (path.as_path(), contents.clone()))
788 .collect::<Vec<_>>();
789 if client.fs.metadata(&dot_git_dir).await?.is_none() {
790 client.fs.create_dir(&dot_git_dir).await?;
791 }
792 client.fs.set_index_for_repo(&dot_git_dir, &contents).await;
793 }
794 GitOperation::WriteGitBranch {
795 repo_path,
796 new_branch,
797 } => {
798 if !client.fs.directories().contains(&repo_path) {
799 return Err(TestError::Inapplicable);
800 }
801
802 log::info!(
803 "{}: writing git branch for repo {:?}: {:?}",
804 client.username,
805 repo_path,
806 new_branch
807 );
808
809 let dot_git_dir = repo_path.join(".git");
810 if client.fs.metadata(&dot_git_dir).await?.is_none() {
811 client.fs.create_dir(&dot_git_dir).await?;
812 }
813 client.fs.set_branch_name(&dot_git_dir, new_branch).await;
814 }
815 GitOperation::WriteGitStatuses {
816 repo_path,
817 statuses,
818 } => {
819 if !client.fs.directories().contains(&repo_path) {
820 return Err(TestError::Inapplicable);
821 }
822
823 log::info!(
824 "{}: writing git statuses for repo {:?}: {:?}",
825 client.username,
826 repo_path,
827 statuses
828 );
829
830 let dot_git_dir = repo_path.join(".git");
831
832 let statuses = statuses
833 .iter()
834 .map(|(path, val)| (path.as_path(), val.clone()))
835 .collect::<Vec<_>>();
836
837 if client.fs.metadata(&dot_git_dir).await?.is_none() {
838 client.fs.create_dir(&dot_git_dir).await?;
839 }
840
841 client
842 .fs
843 .set_status_for_repo(&dot_git_dir, statuses.as_slice())
844 .await;
845 }
846 },
847 }
848 Ok(())
849}
850
851fn check_consistency_between_clients(clients: &[(Rc<TestClient>, TestAppContext)]) {
852 for (client, client_cx) in clients {
853 for guest_project in client.remote_projects().iter() {
854 guest_project.read_with(client_cx, |guest_project, cx| {
855 let host_project = clients.iter().find_map(|(client, cx)| {
856 let project = client
857 .local_projects()
858 .iter()
859 .find(|host_project| {
860 host_project.read_with(cx, |host_project, _| {
861 host_project.remote_id() == guest_project.remote_id()
862 })
863 })?
864 .clone();
865 Some((project, cx))
866 });
867
868 if !guest_project.is_read_only() {
869 if let Some((host_project, host_cx)) = host_project {
870 let host_worktree_snapshots =
871 host_project.read_with(host_cx, |host_project, cx| {
872 host_project
873 .worktrees(cx)
874 .map(|worktree| {
875 let worktree = worktree.read(cx);
876 (worktree.id(), worktree.snapshot())
877 })
878 .collect::<BTreeMap<_, _>>()
879 });
880 let guest_worktree_snapshots = guest_project
881 .worktrees(cx)
882 .map(|worktree| {
883 let worktree = worktree.read(cx);
884 (worktree.id(), worktree.snapshot())
885 })
886 .collect::<BTreeMap<_, _>>();
887
888 assert_eq!(
889 guest_worktree_snapshots.values().map(|w| w.abs_path()).collect::<Vec<_>>(),
890 host_worktree_snapshots.values().map(|w| w.abs_path()).collect::<Vec<_>>(),
891 "{} has different worktrees than the host for project {:?}",
892 client.username, guest_project.remote_id(),
893 );
894
895 for (id, host_snapshot) in &host_worktree_snapshots {
896 let guest_snapshot = &guest_worktree_snapshots[id];
897 assert_eq!(
898 guest_snapshot.root_name(),
899 host_snapshot.root_name(),
900 "{} has different root name than the host for worktree {}, project {:?}",
901 client.username,
902 id,
903 guest_project.remote_id(),
904 );
905 assert_eq!(
906 guest_snapshot.abs_path(),
907 host_snapshot.abs_path(),
908 "{} has different abs path than the host for worktree {}, project: {:?}",
909 client.username,
910 id,
911 guest_project.remote_id(),
912 );
913 assert_eq!(
914 guest_snapshot.entries(false).collect::<Vec<_>>(),
915 host_snapshot.entries(false).collect::<Vec<_>>(),
916 "{} has different snapshot than the host for worktree {:?} and project {:?}",
917 client.username,
918 host_snapshot.abs_path(),
919 guest_project.remote_id(),
920 );
921 assert_eq!(guest_snapshot.repositories().collect::<Vec<_>>(), host_snapshot.repositories().collect::<Vec<_>>(),
922 "{} has different repositories than the host for worktree {:?} and project {:?}",
923 client.username,
924 host_snapshot.abs_path(),
925 guest_project.remote_id(),
926 );
927 assert_eq!(guest_snapshot.scan_id(), host_snapshot.scan_id(),
928 "{} has different scan id than the host for worktree {:?} and project {:?}",
929 client.username,
930 host_snapshot.abs_path(),
931 guest_project.remote_id(),
932 );
933 }
934 }
935 }
936
937 for buffer in guest_project.opened_buffers(cx) {
938 let buffer = buffer.read(cx);
939 assert_eq!(
940 buffer.deferred_ops_len(),
941 0,
942 "{} has deferred operations for buffer {:?} in project {:?}",
943 client.username,
944 buffer.file().unwrap().full_path(cx),
945 guest_project.remote_id(),
946 );
947 }
948 });
949 }
950
951 let buffers = client.buffers().clone();
952 for (guest_project, guest_buffers) in &buffers {
953 let project_id = if guest_project.read_with(client_cx, |project, _| {
954 project.is_local() || project.is_read_only()
955 }) {
956 continue;
957 } else {
958 guest_project
959 .read_with(client_cx, |project, _| project.remote_id())
960 .unwrap()
961 };
962 let guest_user_id = client.user_id().unwrap();
963
964 let host_project = clients.iter().find_map(|(client, cx)| {
965 let project = client
966 .local_projects()
967 .iter()
968 .find(|host_project| {
969 host_project.read_with(cx, |host_project, _| {
970 host_project.remote_id() == Some(project_id)
971 })
972 })?
973 .clone();
974 Some((client.user_id().unwrap(), project, cx))
975 });
976
977 let (host_user_id, host_project, host_cx) =
978 if let Some((host_user_id, host_project, host_cx)) = host_project {
979 (host_user_id, host_project, host_cx)
980 } else {
981 continue;
982 };
983
984 for guest_buffer in guest_buffers {
985 let buffer_id = guest_buffer.read_with(client_cx, |buffer, _| buffer.remote_id());
986 let host_buffer = host_project.read_with(host_cx, |project, cx| {
987 project.buffer_for_id(buffer_id, cx).unwrap_or_else(|| {
988 panic!(
989 "host does not have buffer for guest:{}, peer:{:?}, id:{}",
990 client.username,
991 client.peer_id(),
992 buffer_id
993 )
994 })
995 });
996 let path = host_buffer
997 .read_with(host_cx, |buffer, cx| buffer.file().unwrap().full_path(cx));
998
999 assert_eq!(
1000 guest_buffer.read_with(client_cx, |buffer, _| buffer.deferred_ops_len()),
1001 0,
1002 "{}, buffer {}, path {:?} has deferred operations",
1003 client.username,
1004 buffer_id,
1005 path,
1006 );
1007 assert_eq!(
1008 guest_buffer.read_with(client_cx, |buffer, _| buffer.text()),
1009 host_buffer.read_with(host_cx, |buffer, _| buffer.text()),
1010 "{}, buffer {}, path {:?}, differs from the host's buffer",
1011 client.username,
1012 buffer_id,
1013 path
1014 );
1015
1016 let host_file = host_buffer.read_with(host_cx, |b, _| b.file().cloned());
1017 let guest_file = guest_buffer.read_with(client_cx, |b, _| b.file().cloned());
1018 match (host_file, guest_file) {
1019 (Some(host_file), Some(guest_file)) => {
1020 assert_eq!(guest_file.path(), host_file.path());
1021 assert_eq!(guest_file.is_deleted(), host_file.is_deleted());
1022 assert_eq!(
1023 guest_file.mtime(),
1024 host_file.mtime(),
1025 "guest {} mtime does not match host {} for path {:?} in project {}",
1026 guest_user_id,
1027 host_user_id,
1028 guest_file.path(),
1029 project_id,
1030 );
1031 }
1032 (None, None) => {}
1033 (None, _) => panic!("host's file is None, guest's isn't"),
1034 (_, None) => panic!("guest's file is None, hosts's isn't"),
1035 }
1036
1037 let host_diff_base =
1038 host_buffer.read_with(host_cx, |b, _| b.diff_base().map(ToString::to_string));
1039 let guest_diff_base = guest_buffer
1040 .read_with(client_cx, |b, _| b.diff_base().map(ToString::to_string));
1041 assert_eq!(
1042 guest_diff_base, host_diff_base,
1043 "guest {} diff base does not match host's for path {path:?} in project {project_id}",
1044 client.username
1045 );
1046
1047 let host_saved_version =
1048 host_buffer.read_with(host_cx, |b, _| b.saved_version().clone());
1049 let guest_saved_version =
1050 guest_buffer.read_with(client_cx, |b, _| b.saved_version().clone());
1051 assert_eq!(
1052 guest_saved_version, host_saved_version,
1053 "guest {} saved version does not match host's for path {path:?} in project {project_id}",
1054 client.username
1055 );
1056
1057 let host_saved_version_fingerprint =
1058 host_buffer.read_with(host_cx, |b, _| b.saved_version_fingerprint());
1059 let guest_saved_version_fingerprint =
1060 guest_buffer.read_with(client_cx, |b, _| b.saved_version_fingerprint());
1061 assert_eq!(
1062 guest_saved_version_fingerprint, host_saved_version_fingerprint,
1063 "guest {} saved fingerprint does not match host's for path {path:?} in project {project_id}",
1064 client.username
1065 );
1066
1067 let host_saved_mtime = host_buffer.read_with(host_cx, |b, _| b.saved_mtime());
1068 let guest_saved_mtime = guest_buffer.read_with(client_cx, |b, _| b.saved_mtime());
1069 assert_eq!(
1070 guest_saved_mtime, host_saved_mtime,
1071 "guest {} saved mtime does not match host's for path {path:?} in project {project_id}",
1072 client.username
1073 );
1074
1075 let host_is_dirty = host_buffer.read_with(host_cx, |b, _| b.is_dirty());
1076 let guest_is_dirty = guest_buffer.read_with(client_cx, |b, _| b.is_dirty());
1077 assert_eq!(guest_is_dirty, host_is_dirty,
1078 "guest {} dirty status does not match host's for path {path:?} in project {project_id}",
1079 client.username
1080 );
1081
1082 let host_has_conflict = host_buffer.read_with(host_cx, |b, _| b.has_conflict());
1083 let guest_has_conflict = guest_buffer.read_with(client_cx, |b, _| b.has_conflict());
1084 assert_eq!(guest_has_conflict, host_has_conflict,
1085 "guest {} conflict status does not match host's for path {path:?} in project {project_id}",
1086 client.username
1087 );
1088 }
1089 }
1090 }
1091}
1092
1093struct TestPlan {
1094 rng: StdRng,
1095 replay: bool,
1096 stored_operations: Vec<(StoredOperation, Arc<AtomicBool>)>,
1097 max_operations: usize,
1098 operation_ix: usize,
1099 users: Vec<UserTestPlan>,
1100 next_batch_id: usize,
1101 allow_server_restarts: bool,
1102 allow_client_reconnection: bool,
1103 allow_client_disconnection: bool,
1104}
1105
1106struct UserTestPlan {
1107 user_id: UserId,
1108 username: String,
1109 next_root_id: usize,
1110 operation_ix: usize,
1111 online: bool,
1112}
1113
1114#[derive(Clone, Debug, Serialize, Deserialize)]
1115#[serde(untagged)]
1116enum StoredOperation {
1117 Server(Operation),
1118 Client {
1119 user_id: UserId,
1120 batch_id: usize,
1121 operation: ClientOperation,
1122 },
1123}
1124
1125#[derive(Clone, Debug, Serialize, Deserialize)]
1126enum Operation {
1127 AddConnection {
1128 user_id: UserId,
1129 },
1130 RemoveConnection {
1131 user_id: UserId,
1132 },
1133 BounceConnection {
1134 user_id: UserId,
1135 },
1136 RestartServer,
1137 MutateClients {
1138 batch_id: usize,
1139 #[serde(skip_serializing)]
1140 #[serde(skip_deserializing)]
1141 user_ids: Vec<UserId>,
1142 quiesce: bool,
1143 },
1144}
1145
1146#[derive(Clone, Debug, Serialize, Deserialize)]
1147enum ClientOperation {
1148 AcceptIncomingCall,
1149 RejectIncomingCall,
1150 LeaveCall,
1151 InviteContactToCall {
1152 user_id: UserId,
1153 },
1154 OpenLocalProject {
1155 first_root_name: String,
1156 },
1157 OpenRemoteProject {
1158 host_id: UserId,
1159 first_root_name: String,
1160 },
1161 AddWorktreeToProject {
1162 project_root_name: String,
1163 new_root_path: PathBuf,
1164 },
1165 CloseRemoteProject {
1166 project_root_name: String,
1167 },
1168 OpenBuffer {
1169 project_root_name: String,
1170 is_local: bool,
1171 full_path: PathBuf,
1172 },
1173 SearchProject {
1174 project_root_name: String,
1175 is_local: bool,
1176 query: String,
1177 detach: bool,
1178 },
1179 EditBuffer {
1180 project_root_name: String,
1181 is_local: bool,
1182 full_path: PathBuf,
1183 edits: Vec<(Range<usize>, Arc<str>)>,
1184 },
1185 CloseBuffer {
1186 project_root_name: String,
1187 is_local: bool,
1188 full_path: PathBuf,
1189 },
1190 SaveBuffer {
1191 project_root_name: String,
1192 is_local: bool,
1193 full_path: PathBuf,
1194 detach: bool,
1195 },
1196 RequestLspDataInBuffer {
1197 project_root_name: String,
1198 is_local: bool,
1199 full_path: PathBuf,
1200 offset: usize,
1201 kind: LspRequestKind,
1202 detach: bool,
1203 },
1204 CreateWorktreeEntry {
1205 project_root_name: String,
1206 is_local: bool,
1207 full_path: PathBuf,
1208 is_dir: bool,
1209 },
1210 WriteFsEntry {
1211 path: PathBuf,
1212 is_dir: bool,
1213 content: String,
1214 },
1215 GitOperation {
1216 operation: GitOperation,
1217 },
1218}
1219
1220#[derive(Clone, Debug, Serialize, Deserialize)]
1221enum GitOperation {
1222 WriteGitIndex {
1223 repo_path: PathBuf,
1224 contents: Vec<(PathBuf, String)>,
1225 },
1226 WriteGitBranch {
1227 repo_path: PathBuf,
1228 new_branch: Option<String>,
1229 },
1230 WriteGitStatuses {
1231 repo_path: PathBuf,
1232 statuses: Vec<(PathBuf, GitFileStatus)>,
1233 },
1234}
1235
1236#[derive(Clone, Debug, Serialize, Deserialize)]
1237enum LspRequestKind {
1238 Rename,
1239 Completion,
1240 CodeAction,
1241 Definition,
1242 Highlights,
1243}
1244
1245enum TestError {
1246 Inapplicable,
1247 Other(anyhow::Error),
1248}
1249
1250impl From<anyhow::Error> for TestError {
1251 fn from(value: anyhow::Error) -> Self {
1252 Self::Other(value)
1253 }
1254}
1255
1256impl TestPlan {
1257 fn new(mut rng: StdRng, users: Vec<UserTestPlan>, max_operations: usize) -> Self {
1258 Self {
1259 replay: false,
1260 allow_server_restarts: rng.gen_bool(0.7),
1261 allow_client_reconnection: rng.gen_bool(0.7),
1262 allow_client_disconnection: rng.gen_bool(0.1),
1263 stored_operations: Vec::new(),
1264 operation_ix: 0,
1265 next_batch_id: 0,
1266 max_operations,
1267 users,
1268 rng,
1269 }
1270 }
1271
1272 fn deserialize(&mut self, json: Vec<u8>) {
1273 let stored_operations: Vec<StoredOperation> = serde_json::from_slice(&json).unwrap();
1274 self.replay = true;
1275 self.stored_operations = stored_operations
1276 .iter()
1277 .cloned()
1278 .enumerate()
1279 .map(|(i, mut operation)| {
1280 if let StoredOperation::Server(Operation::MutateClients {
1281 batch_id: current_batch_id,
1282 user_ids,
1283 ..
1284 }) = &mut operation
1285 {
1286 assert!(user_ids.is_empty());
1287 user_ids.extend(stored_operations[i + 1..].iter().filter_map(|operation| {
1288 if let StoredOperation::Client {
1289 user_id, batch_id, ..
1290 } = operation
1291 {
1292 if batch_id == current_batch_id {
1293 return Some(user_id);
1294 }
1295 }
1296 None
1297 }));
1298 user_ids.sort_unstable();
1299 }
1300 (operation, Arc::new(AtomicBool::new(false)))
1301 })
1302 .collect()
1303 }
1304
1305 fn serialize(&mut self) -> Vec<u8> {
1306 // Format each operation as one line
1307 let mut json = Vec::new();
1308 json.push(b'[');
1309 for (operation, applied) in &self.stored_operations {
1310 if !applied.load(SeqCst) {
1311 continue;
1312 }
1313 if json.len() > 1 {
1314 json.push(b',');
1315 }
1316 json.extend_from_slice(b"\n ");
1317 serde_json::to_writer(&mut json, operation).unwrap();
1318 }
1319 json.extend_from_slice(b"\n]\n");
1320 json
1321 }
1322
1323 fn next_server_operation(
1324 &mut self,
1325 clients: &[(Rc<TestClient>, TestAppContext)],
1326 ) -> Option<(Operation, Arc<AtomicBool>)> {
1327 if self.replay {
1328 while let Some(stored_operation) = self.stored_operations.get(self.operation_ix) {
1329 self.operation_ix += 1;
1330 if let (StoredOperation::Server(operation), applied) = stored_operation {
1331 return Some((operation.clone(), applied.clone()));
1332 }
1333 }
1334 None
1335 } else {
1336 let operation = self.generate_server_operation(clients)?;
1337 let applied = Arc::new(AtomicBool::new(false));
1338 self.stored_operations
1339 .push((StoredOperation::Server(operation.clone()), applied.clone()));
1340 Some((operation, applied))
1341 }
1342 }
1343
1344 fn next_client_operation(
1345 &mut self,
1346 client: &TestClient,
1347 current_batch_id: usize,
1348 cx: &TestAppContext,
1349 ) -> Option<(ClientOperation, Arc<AtomicBool>)> {
1350 let current_user_id = client.current_user_id(cx);
1351 let user_ix = self
1352 .users
1353 .iter()
1354 .position(|user| user.user_id == current_user_id)
1355 .unwrap();
1356 let user_plan = &mut self.users[user_ix];
1357
1358 if self.replay {
1359 while let Some(stored_operation) = self.stored_operations.get(user_plan.operation_ix) {
1360 user_plan.operation_ix += 1;
1361 if let (
1362 StoredOperation::Client {
1363 user_id, operation, ..
1364 },
1365 applied,
1366 ) = stored_operation
1367 {
1368 if user_id == ¤t_user_id {
1369 return Some((operation.clone(), applied.clone()));
1370 }
1371 }
1372 }
1373 None
1374 } else {
1375 let operation = self.generate_client_operation(current_user_id, client, cx)?;
1376 let applied = Arc::new(AtomicBool::new(false));
1377 self.stored_operations.push((
1378 StoredOperation::Client {
1379 user_id: current_user_id,
1380 batch_id: current_batch_id,
1381 operation: operation.clone(),
1382 },
1383 applied.clone(),
1384 ));
1385 Some((operation, applied))
1386 }
1387 }
1388
1389 fn generate_server_operation(
1390 &mut self,
1391 clients: &[(Rc<TestClient>, TestAppContext)],
1392 ) -> Option<Operation> {
1393 if self.operation_ix == self.max_operations {
1394 return None;
1395 }
1396
1397 Some(loop {
1398 break match self.rng.gen_range(0..100) {
1399 0..=29 if clients.len() < self.users.len() => {
1400 let user = self
1401 .users
1402 .iter()
1403 .filter(|u| !u.online)
1404 .choose(&mut self.rng)
1405 .unwrap();
1406 self.operation_ix += 1;
1407 Operation::AddConnection {
1408 user_id: user.user_id,
1409 }
1410 }
1411 30..=34 if clients.len() > 1 && self.allow_client_disconnection => {
1412 let (client, cx) = &clients[self.rng.gen_range(0..clients.len())];
1413 let user_id = client.current_user_id(cx);
1414 self.operation_ix += 1;
1415 Operation::RemoveConnection { user_id }
1416 }
1417 35..=39 if clients.len() > 1 && self.allow_client_reconnection => {
1418 let (client, cx) = &clients[self.rng.gen_range(0..clients.len())];
1419 let user_id = client.current_user_id(cx);
1420 self.operation_ix += 1;
1421 Operation::BounceConnection { user_id }
1422 }
1423 40..=44 if self.allow_server_restarts && clients.len() > 1 => {
1424 self.operation_ix += 1;
1425 Operation::RestartServer
1426 }
1427 _ if !clients.is_empty() => {
1428 let count = self
1429 .rng
1430 .gen_range(1..10)
1431 .min(self.max_operations - self.operation_ix);
1432 let batch_id = util::post_inc(&mut self.next_batch_id);
1433 let mut user_ids = (0..count)
1434 .map(|_| {
1435 let ix = self.rng.gen_range(0..clients.len());
1436 let (client, cx) = &clients[ix];
1437 client.current_user_id(cx)
1438 })
1439 .collect::<Vec<_>>();
1440 user_ids.sort_unstable();
1441 Operation::MutateClients {
1442 user_ids,
1443 batch_id,
1444 quiesce: self.rng.gen_bool(0.7),
1445 }
1446 }
1447 _ => continue,
1448 };
1449 })
1450 }
1451
1452 fn generate_client_operation(
1453 &mut self,
1454 user_id: UserId,
1455 client: &TestClient,
1456 cx: &TestAppContext,
1457 ) -> Option<ClientOperation> {
1458 if self.operation_ix == self.max_operations {
1459 return None;
1460 }
1461
1462 self.operation_ix += 1;
1463 let call = cx.read(ActiveCall::global);
1464 Some(loop {
1465 match self.rng.gen_range(0..100_u32) {
1466 // Mutate the call
1467 0..=29 => {
1468 // Respond to an incoming call
1469 if call.read_with(cx, |call, _| call.incoming().borrow().is_some()) {
1470 break if self.rng.gen_bool(0.7) {
1471 ClientOperation::AcceptIncomingCall
1472 } else {
1473 ClientOperation::RejectIncomingCall
1474 };
1475 }
1476
1477 match self.rng.gen_range(0..100_u32) {
1478 // Invite a contact to the current call
1479 0..=70 => {
1480 let available_contacts =
1481 client.user_store.read_with(cx, |user_store, _| {
1482 user_store
1483 .contacts()
1484 .iter()
1485 .filter(|contact| contact.online && !contact.busy)
1486 .cloned()
1487 .collect::<Vec<_>>()
1488 });
1489 if !available_contacts.is_empty() {
1490 let contact = available_contacts.choose(&mut self.rng).unwrap();
1491 break ClientOperation::InviteContactToCall {
1492 user_id: UserId(contact.user.id as i32),
1493 };
1494 }
1495 }
1496
1497 // Leave the current call
1498 71.. => {
1499 if self.allow_client_disconnection
1500 && call.read_with(cx, |call, _| call.room().is_some())
1501 {
1502 break ClientOperation::LeaveCall;
1503 }
1504 }
1505 }
1506 }
1507
1508 // Mutate projects
1509 30..=59 => match self.rng.gen_range(0..100_u32) {
1510 // Open a new project
1511 0..=70 => {
1512 // Open a remote project
1513 if let Some(room) = call.read_with(cx, |call, _| call.room().cloned()) {
1514 let existing_remote_project_ids = cx.read(|cx| {
1515 client
1516 .remote_projects()
1517 .iter()
1518 .map(|p| p.read(cx).remote_id().unwrap())
1519 .collect::<Vec<_>>()
1520 });
1521 let new_remote_projects = room.read_with(cx, |room, _| {
1522 room.remote_participants()
1523 .values()
1524 .flat_map(|participant| {
1525 participant.projects.iter().filter_map(|project| {
1526 if existing_remote_project_ids.contains(&project.id) {
1527 None
1528 } else {
1529 Some((
1530 UserId::from_proto(participant.user.id),
1531 project.worktree_root_names[0].clone(),
1532 ))
1533 }
1534 })
1535 })
1536 .collect::<Vec<_>>()
1537 });
1538 if !new_remote_projects.is_empty() {
1539 let (host_id, first_root_name) =
1540 new_remote_projects.choose(&mut self.rng).unwrap().clone();
1541 break ClientOperation::OpenRemoteProject {
1542 host_id,
1543 first_root_name,
1544 };
1545 }
1546 }
1547 // Open a local project
1548 else {
1549 let first_root_name = self.next_root_dir_name(user_id);
1550 break ClientOperation::OpenLocalProject { first_root_name };
1551 }
1552 }
1553
1554 // Close a remote project
1555 71..=80 => {
1556 if !client.remote_projects().is_empty() {
1557 let project = client
1558 .remote_projects()
1559 .choose(&mut self.rng)
1560 .unwrap()
1561 .clone();
1562 let first_root_name = root_name_for_project(&project, cx);
1563 break ClientOperation::CloseRemoteProject {
1564 project_root_name: first_root_name,
1565 };
1566 }
1567 }
1568
1569 // Mutate project worktrees
1570 81.. => match self.rng.gen_range(0..100_u32) {
1571 // Add a worktree to a local project
1572 0..=50 => {
1573 let Some(project) = client
1574 .local_projects()
1575 .choose(&mut self.rng)
1576 .cloned() else { continue };
1577 let project_root_name = root_name_for_project(&project, cx);
1578 let mut paths = client.fs.paths();
1579 paths.remove(0);
1580 let new_root_path = if paths.is_empty() || self.rng.gen() {
1581 Path::new("/").join(&self.next_root_dir_name(user_id))
1582 } else {
1583 paths.choose(&mut self.rng).unwrap().clone()
1584 };
1585 break ClientOperation::AddWorktreeToProject {
1586 project_root_name,
1587 new_root_path,
1588 };
1589 }
1590
1591 // Add an entry to a worktree
1592 _ => {
1593 let Some(project) = choose_random_project(client, &mut self.rng) else { continue };
1594 let project_root_name = root_name_for_project(&project, cx);
1595 let is_local = project.read_with(cx, |project, _| project.is_local());
1596 let worktree = project.read_with(cx, |project, cx| {
1597 project
1598 .worktrees(cx)
1599 .filter(|worktree| {
1600 let worktree = worktree.read(cx);
1601 worktree.is_visible()
1602 && worktree.entries(false).any(|e| e.is_file())
1603 && worktree.root_entry().map_or(false, |e| e.is_dir())
1604 })
1605 .choose(&mut self.rng)
1606 });
1607 let Some(worktree) = worktree else { continue };
1608 let is_dir = self.rng.gen::<bool>();
1609 let mut full_path =
1610 worktree.read_with(cx, |w, _| PathBuf::from(w.root_name()));
1611 full_path.push(gen_file_name(&mut self.rng));
1612 if !is_dir {
1613 full_path.set_extension("rs");
1614 }
1615 break ClientOperation::CreateWorktreeEntry {
1616 project_root_name,
1617 is_local,
1618 full_path,
1619 is_dir,
1620 };
1621 }
1622 },
1623 },
1624
1625 // Query and mutate buffers
1626 60..=90 => {
1627 let Some(project) = choose_random_project(client, &mut self.rng) else { continue };
1628 let project_root_name = root_name_for_project(&project, cx);
1629 let is_local = project.read_with(cx, |project, _| project.is_local());
1630
1631 match self.rng.gen_range(0..100_u32) {
1632 // Manipulate an existing buffer
1633 0..=70 => {
1634 let Some(buffer) = client
1635 .buffers_for_project(&project)
1636 .iter()
1637 .choose(&mut self.rng)
1638 .cloned() else { continue };
1639
1640 let full_path = buffer
1641 .read_with(cx, |buffer, cx| buffer.file().unwrap().full_path(cx));
1642
1643 match self.rng.gen_range(0..100_u32) {
1644 // Close the buffer
1645 0..=15 => {
1646 break ClientOperation::CloseBuffer {
1647 project_root_name,
1648 is_local,
1649 full_path,
1650 };
1651 }
1652 // Save the buffer
1653 16..=29 if buffer.read_with(cx, |b, _| b.is_dirty()) => {
1654 let detach = self.rng.gen_bool(0.3);
1655 break ClientOperation::SaveBuffer {
1656 project_root_name,
1657 is_local,
1658 full_path,
1659 detach,
1660 };
1661 }
1662 // Edit the buffer
1663 30..=69 => {
1664 let edits = buffer.read_with(cx, |buffer, _| {
1665 buffer.get_random_edits(&mut self.rng, 3)
1666 });
1667 break ClientOperation::EditBuffer {
1668 project_root_name,
1669 is_local,
1670 full_path,
1671 edits,
1672 };
1673 }
1674 // Make an LSP request
1675 _ => {
1676 let offset = buffer.read_with(cx, |buffer, _| {
1677 buffer.clip_offset(
1678 self.rng.gen_range(0..=buffer.len()),
1679 language::Bias::Left,
1680 )
1681 });
1682 let detach = self.rng.gen();
1683 break ClientOperation::RequestLspDataInBuffer {
1684 project_root_name,
1685 full_path,
1686 offset,
1687 is_local,
1688 kind: match self.rng.gen_range(0..5_u32) {
1689 0 => LspRequestKind::Rename,
1690 1 => LspRequestKind::Highlights,
1691 2 => LspRequestKind::Definition,
1692 3 => LspRequestKind::CodeAction,
1693 4.. => LspRequestKind::Completion,
1694 },
1695 detach,
1696 };
1697 }
1698 }
1699 }
1700
1701 71..=80 => {
1702 let query = self.rng.gen_range('a'..='z').to_string();
1703 let detach = self.rng.gen_bool(0.3);
1704 break ClientOperation::SearchProject {
1705 project_root_name,
1706 is_local,
1707 query,
1708 detach,
1709 };
1710 }
1711
1712 // Open a buffer
1713 81.. => {
1714 let worktree = project.read_with(cx, |project, cx| {
1715 project
1716 .worktrees(cx)
1717 .filter(|worktree| {
1718 let worktree = worktree.read(cx);
1719 worktree.is_visible()
1720 && worktree.entries(false).any(|e| e.is_file())
1721 })
1722 .choose(&mut self.rng)
1723 });
1724 let Some(worktree) = worktree else { continue };
1725 let full_path = worktree.read_with(cx, |worktree, _| {
1726 let entry = worktree
1727 .entries(false)
1728 .filter(|e| e.is_file())
1729 .choose(&mut self.rng)
1730 .unwrap();
1731 if entry.path.as_ref() == Path::new("") {
1732 Path::new(worktree.root_name()).into()
1733 } else {
1734 Path::new(worktree.root_name()).join(&entry.path)
1735 }
1736 });
1737 break ClientOperation::OpenBuffer {
1738 project_root_name,
1739 is_local,
1740 full_path,
1741 };
1742 }
1743 }
1744 }
1745
1746 // Update a git related action
1747 91..=95 => {
1748 break ClientOperation::GitOperation {
1749 operation: self.generate_git_operation(client),
1750 };
1751 }
1752
1753 // Create or update a file or directory
1754 96.. => {
1755 let is_dir = self.rng.gen::<bool>();
1756 let content;
1757 let mut path;
1758 let dir_paths = client.fs.directories();
1759
1760 if is_dir {
1761 content = String::new();
1762 path = dir_paths.choose(&mut self.rng).unwrap().clone();
1763 path.push(gen_file_name(&mut self.rng));
1764 } else {
1765 content = Alphanumeric.sample_string(&mut self.rng, 16);
1766
1767 // Create a new file or overwrite an existing file
1768 let file_paths = client.fs.files();
1769 if file_paths.is_empty() || self.rng.gen_bool(0.5) {
1770 path = dir_paths.choose(&mut self.rng).unwrap().clone();
1771 path.push(gen_file_name(&mut self.rng));
1772 path.set_extension("rs");
1773 } else {
1774 path = file_paths.choose(&mut self.rng).unwrap().clone()
1775 };
1776 }
1777 break ClientOperation::WriteFsEntry {
1778 path,
1779 is_dir,
1780 content,
1781 };
1782 }
1783 }
1784 })
1785 }
1786
1787 fn generate_git_operation(&mut self, client: &TestClient) -> GitOperation {
1788 fn generate_file_paths(
1789 repo_path: &Path,
1790 rng: &mut StdRng,
1791 client: &TestClient,
1792 ) -> Vec<PathBuf> {
1793 let mut paths = client
1794 .fs
1795 .files()
1796 .into_iter()
1797 .filter(|path| path.starts_with(repo_path))
1798 .collect::<Vec<_>>();
1799
1800 let count = rng.gen_range(0..=paths.len());
1801 paths.shuffle(rng);
1802 paths.truncate(count);
1803
1804 paths
1805 .iter()
1806 .map(|path| path.strip_prefix(repo_path).unwrap().to_path_buf())
1807 .collect::<Vec<_>>()
1808 }
1809
1810 let repo_path = client
1811 .fs
1812 .directories()
1813 .choose(&mut self.rng)
1814 .unwrap()
1815 .clone();
1816
1817 match self.rng.gen_range(0..100_u32) {
1818 0..=25 => {
1819 let file_paths = generate_file_paths(&repo_path, &mut self.rng, client);
1820
1821 let contents = file_paths
1822 .into_iter()
1823 .map(|path| (path, Alphanumeric.sample_string(&mut self.rng, 16)))
1824 .collect();
1825
1826 GitOperation::WriteGitIndex {
1827 repo_path,
1828 contents,
1829 }
1830 }
1831 26..=63 => {
1832 let new_branch = (self.rng.gen_range(0..10) > 3)
1833 .then(|| Alphanumeric.sample_string(&mut self.rng, 8));
1834
1835 GitOperation::WriteGitBranch {
1836 repo_path,
1837 new_branch,
1838 }
1839 }
1840 64..=100 => {
1841 let file_paths = generate_file_paths(&repo_path, &mut self.rng, client);
1842
1843 let statuses = file_paths
1844 .into_iter()
1845 .map(|paths| {
1846 (
1847 paths,
1848 match self.rng.gen_range(0..3_u32) {
1849 0 => GitFileStatus::Added,
1850 1 => GitFileStatus::Modified,
1851 2 => GitFileStatus::Conflict,
1852 _ => unreachable!(),
1853 },
1854 )
1855 })
1856 .collect::<Vec<_>>();
1857
1858 GitOperation::WriteGitStatuses {
1859 repo_path,
1860 statuses,
1861 }
1862 }
1863 _ => unreachable!(),
1864 }
1865 }
1866
1867 fn next_root_dir_name(&mut self, user_id: UserId) -> String {
1868 let user_ix = self
1869 .users
1870 .iter()
1871 .position(|user| user.user_id == user_id)
1872 .unwrap();
1873 let root_id = util::post_inc(&mut self.users[user_ix].next_root_id);
1874 format!("dir-{user_id}-{root_id}")
1875 }
1876
1877 fn user(&mut self, user_id: UserId) -> &mut UserTestPlan {
1878 let ix = self
1879 .users
1880 .iter()
1881 .position(|user| user.user_id == user_id)
1882 .unwrap();
1883 &mut self.users[ix]
1884 }
1885}
1886
1887async fn simulate_client(
1888 client: Rc<TestClient>,
1889 mut operation_rx: futures::channel::mpsc::UnboundedReceiver<usize>,
1890 plan: Arc<Mutex<TestPlan>>,
1891 mut cx: TestAppContext,
1892) {
1893 // Setup language server
1894 let mut language = Language::new(
1895 LanguageConfig {
1896 name: "Rust".into(),
1897 path_suffixes: vec!["rs".to_string()],
1898 ..Default::default()
1899 },
1900 None,
1901 );
1902 let _fake_language_servers = language
1903 .set_fake_lsp_adapter(Arc::new(FakeLspAdapter {
1904 name: "the-fake-language-server",
1905 capabilities: lsp::LanguageServer::full_capabilities(),
1906 initializer: Some(Box::new({
1907 let fs = client.fs.clone();
1908 move |fake_server: &mut FakeLanguageServer| {
1909 fake_server.handle_request::<lsp::request::Completion, _, _>(
1910 |_, _| async move {
1911 Ok(Some(lsp::CompletionResponse::Array(vec![
1912 lsp::CompletionItem {
1913 text_edit: Some(lsp::CompletionTextEdit::Edit(lsp::TextEdit {
1914 range: lsp::Range::new(
1915 lsp::Position::new(0, 0),
1916 lsp::Position::new(0, 0),
1917 ),
1918 new_text: "the-new-text".to_string(),
1919 })),
1920 ..Default::default()
1921 },
1922 ])))
1923 },
1924 );
1925
1926 fake_server.handle_request::<lsp::request::CodeActionRequest, _, _>(
1927 |_, _| async move {
1928 Ok(Some(vec![lsp::CodeActionOrCommand::CodeAction(
1929 lsp::CodeAction {
1930 title: "the-code-action".to_string(),
1931 ..Default::default()
1932 },
1933 )]))
1934 },
1935 );
1936
1937 fake_server.handle_request::<lsp::request::PrepareRenameRequest, _, _>(
1938 |params, _| async move {
1939 Ok(Some(lsp::PrepareRenameResponse::Range(lsp::Range::new(
1940 params.position,
1941 params.position,
1942 ))))
1943 },
1944 );
1945
1946 fake_server.handle_request::<lsp::request::GotoDefinition, _, _>({
1947 let fs = fs.clone();
1948 move |_, cx| {
1949 let background = cx.background();
1950 let mut rng = background.rng();
1951 let count = rng.gen_range::<usize, _>(1..3);
1952 let files = fs.files();
1953 let files = (0..count)
1954 .map(|_| files.choose(&mut *rng).unwrap().clone())
1955 .collect::<Vec<_>>();
1956 async move {
1957 log::info!("LSP: Returning definitions in files {:?}", &files);
1958 Ok(Some(lsp::GotoDefinitionResponse::Array(
1959 files
1960 .into_iter()
1961 .map(|file| lsp::Location {
1962 uri: lsp::Url::from_file_path(file).unwrap(),
1963 range: Default::default(),
1964 })
1965 .collect(),
1966 )))
1967 }
1968 }
1969 });
1970
1971 fake_server.handle_request::<lsp::request::DocumentHighlightRequest, _, _>(
1972 move |_, cx| {
1973 let mut highlights = Vec::new();
1974 let background = cx.background();
1975 let mut rng = background.rng();
1976
1977 let highlight_count = rng.gen_range(1..=5);
1978 for _ in 0..highlight_count {
1979 let start_row = rng.gen_range(0..100);
1980 let start_column = rng.gen_range(0..100);
1981 let end_row = rng.gen_range(0..100);
1982 let end_column = rng.gen_range(0..100);
1983 let start = PointUtf16::new(start_row, start_column);
1984 let end = PointUtf16::new(end_row, end_column);
1985 let range = if start > end { end..start } else { start..end };
1986 highlights.push(lsp::DocumentHighlight {
1987 range: range_to_lsp(range.clone()),
1988 kind: Some(lsp::DocumentHighlightKind::READ),
1989 });
1990 }
1991 highlights.sort_unstable_by_key(|highlight| {
1992 (highlight.range.start, highlight.range.end)
1993 });
1994 async move { Ok(Some(highlights)) }
1995 },
1996 );
1997 }
1998 })),
1999 ..Default::default()
2000 }))
2001 .await;
2002 client.language_registry.add(Arc::new(language));
2003
2004 while let Some(batch_id) = operation_rx.next().await {
2005 let Some((operation, applied)) = plan.lock().next_client_operation(&client, batch_id, &cx) else { break };
2006 applied.store(true, SeqCst);
2007 match apply_client_operation(&client, operation, &mut cx).await {
2008 Ok(()) => {}
2009 Err(TestError::Inapplicable) => {
2010 applied.store(false, SeqCst);
2011 log::info!("skipped operation");
2012 }
2013 Err(TestError::Other(error)) => {
2014 log::error!("{} error: {}", client.username, error);
2015 }
2016 }
2017 cx.background().simulate_random_delay().await;
2018 }
2019 log::info!("{}: done", client.username);
2020}
2021
2022fn buffer_for_full_path(
2023 client: &TestClient,
2024 project: &ModelHandle<Project>,
2025 full_path: &PathBuf,
2026 cx: &TestAppContext,
2027) -> Option<ModelHandle<language::Buffer>> {
2028 client
2029 .buffers_for_project(project)
2030 .iter()
2031 .find(|buffer| {
2032 buffer.read_with(cx, |buffer, cx| {
2033 buffer.file().unwrap().full_path(cx) == *full_path
2034 })
2035 })
2036 .cloned()
2037}
2038
2039fn project_for_root_name(
2040 client: &TestClient,
2041 root_name: &str,
2042 cx: &TestAppContext,
2043) -> Option<ModelHandle<Project>> {
2044 if let Some(ix) = project_ix_for_root_name(&*client.local_projects(), root_name, cx) {
2045 return Some(client.local_projects()[ix].clone());
2046 }
2047 if let Some(ix) = project_ix_for_root_name(&*client.remote_projects(), root_name, cx) {
2048 return Some(client.remote_projects()[ix].clone());
2049 }
2050 None
2051}
2052
2053fn project_ix_for_root_name(
2054 projects: &[ModelHandle<Project>],
2055 root_name: &str,
2056 cx: &TestAppContext,
2057) -> Option<usize> {
2058 projects.iter().position(|project| {
2059 project.read_with(cx, |project, cx| {
2060 let worktree = project.visible_worktrees(cx).next().unwrap();
2061 worktree.read(cx).root_name() == root_name
2062 })
2063 })
2064}
2065
2066fn root_name_for_project(project: &ModelHandle<Project>, cx: &TestAppContext) -> String {
2067 project.read_with(cx, |project, cx| {
2068 project
2069 .visible_worktrees(cx)
2070 .next()
2071 .unwrap()
2072 .read(cx)
2073 .root_name()
2074 .to_string()
2075 })
2076}
2077
2078fn project_path_for_full_path(
2079 project: &ModelHandle<Project>,
2080 full_path: &Path,
2081 cx: &TestAppContext,
2082) -> Option<ProjectPath> {
2083 let mut components = full_path.components();
2084 let root_name = components.next().unwrap().as_os_str().to_str().unwrap();
2085 let path = components.as_path().into();
2086 let worktree_id = project.read_with(cx, |project, cx| {
2087 project.worktrees(cx).find_map(|worktree| {
2088 let worktree = worktree.read(cx);
2089 if worktree.root_name() == root_name {
2090 Some(worktree.id())
2091 } else {
2092 None
2093 }
2094 })
2095 })?;
2096 Some(ProjectPath { worktree_id, path })
2097}
2098
2099async fn ensure_project_shared(
2100 project: &ModelHandle<Project>,
2101 client: &TestClient,
2102 cx: &mut TestAppContext,
2103) {
2104 let first_root_name = root_name_for_project(project, cx);
2105 let active_call = cx.read(ActiveCall::global);
2106 if active_call.read_with(cx, |call, _| call.room().is_some())
2107 && project.read_with(cx, |project, _| project.is_local() && !project.is_shared())
2108 {
2109 match active_call
2110 .update(cx, |call, cx| call.share_project(project.clone(), cx))
2111 .await
2112 {
2113 Ok(project_id) => {
2114 log::info!(
2115 "{}: shared project {} with id {}",
2116 client.username,
2117 first_root_name,
2118 project_id
2119 );
2120 }
2121 Err(error) => {
2122 log::error!(
2123 "{}: error sharing project {}: {:?}",
2124 client.username,
2125 first_root_name,
2126 error
2127 );
2128 }
2129 }
2130 }
2131}
2132
2133fn choose_random_project(client: &TestClient, rng: &mut StdRng) -> Option<ModelHandle<Project>> {
2134 client
2135 .local_projects()
2136 .iter()
2137 .chain(client.remote_projects().iter())
2138 .choose(rng)
2139 .cloned()
2140}
2141
2142fn gen_file_name(rng: &mut StdRng) -> String {
2143 let mut name = String::new();
2144 for _ in 0..10 {
2145 let letter = rng.gen_range('a'..='z');
2146 name.push(letter);
2147 }
2148 name
2149}
2150
2151fn path_env_var(name: &str) -> Option<PathBuf> {
2152 let value = env::var(name).ok()?;
2153 let mut path = PathBuf::from(value);
2154 if path.is_relative() {
2155 let mut abs_path = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
2156 abs_path.pop();
2157 abs_path.pop();
2158 abs_path.push(path);
2159 path = abs_path
2160 }
2161 Some(path)
2162}