use std::{ cell::{Cell, RefCell}, fs, path::{Path, PathBuf}, sync::Once, time::Duration, }; use crossbeam_channel::{after, select, Receiver}; use lsp_server::{Connection, Message, Notification, Request}; use lsp_types::{notification::Exit, request::Shutdown, TextDocumentIdentifier, Url}; use project_model::ProjectManifest; use rust_analyzer::{config::Config, lsp_ext, main_loop}; use serde::Serialize; use serde_json::{json, to_string_pretty, Value}; use test_utils::{find_mismatch, Fixture}; use vfs::AbsPathBuf; use crate::testdir::TestDir; pub(crate) struct Project<'a> { fixture: &'a str, with_sysroot: bool, tmp_dir: Option, roots: Vec, config: serde_json::Value, } impl<'a> Project<'a> { pub(crate) fn with_fixture(fixture: &str) -> Project { Project { fixture, tmp_dir: None, roots: vec![], with_sysroot: false, config: serde_json::Value::Null, } } pub(crate) fn tmp_dir(mut self, tmp_dir: TestDir) -> Project<'a> { self.tmp_dir = Some(tmp_dir); self } pub(crate) fn root(mut self, path: &str) -> Project<'a> { self.roots.push(path.into()); self } pub(crate) fn with_sysroot(mut self, yes: bool) -> Project<'a> { self.with_sysroot = yes; self } pub(crate) fn with_config(mut self, config: serde_json::Value) -> Project<'a> { self.config = config; self } pub(crate) fn server(self) -> Server { let tmp_dir = self.tmp_dir.unwrap_or_else(|| TestDir::new()); static INIT: Once = Once::new(); INIT.call_once(|| { env_logger::builder().is_test(true).parse_env("RA_LOG").try_init().unwrap(); profile::init_from(crate::PROFILE); }); for entry in Fixture::parse(self.fixture) { let path = tmp_dir.path().join(&entry.path['/'.len_utf8()..]); fs::create_dir_all(path.parent().unwrap()).unwrap(); fs::write(path.as_path(), entry.text.as_bytes()).unwrap(); } let tmp_dir_path = AbsPathBuf::assert(tmp_dir.path().to_path_buf()); let mut roots = self.roots.into_iter().map(|root| tmp_dir_path.join(root)).collect::>(); if roots.is_empty() { roots.push(tmp_dir_path.clone()); } let discovered_projects = roots .into_iter() .map(|it| ProjectManifest::discover_single(&it).unwrap()) .collect::>(); let mut config = Config::new( tmp_dir_path, lsp_types::ClientCapabilities { text_document: Some(lsp_types::TextDocumentClientCapabilities { definition: Some(lsp_types::GotoCapability { link_support: Some(true), ..Default::default() }), code_action: Some(lsp_types::CodeActionClientCapabilities { code_action_literal_support: Some( lsp_types::CodeActionLiteralSupport::default(), ), ..Default::default() }), hover: Some(lsp_types::HoverClientCapabilities { content_format: Some(vec![lsp_types::MarkupKind::Markdown]), ..Default::default() }), ..Default::default() }), window: Some(lsp_types::WindowClientCapabilities { work_done_progress: Some(false), ..Default::default() }), experimental: Some(json!({ "statusNotification": true, })), ..Default::default() }, ); config.discovered_projects = Some(discovered_projects); config.update(self.config); Server::new(tmp_dir, config) } } pub(crate) fn project(fixture: &str) -> Server { Project::with_fixture(fixture).server() } pub(crate) struct Server { req_id: Cell, messages: RefCell>, _thread: jod_thread::JoinHandle<()>, client: Connection, /// XXX: remove the tempdir last dir: TestDir, } impl Server { fn new(dir: TestDir, config: Config) -> Server { let (connection, client) = Connection::memory(); let _thread = jod_thread::Builder::new() .name("test server".to_string()) .spawn(move || main_loop(config, connection).unwrap()) .expect("failed to spawn a thread"); Server { req_id: Cell::new(1), dir, messages: Default::default(), client, _thread } } pub(crate) fn doc_id(&self, rel_path: &str) -> TextDocumentIdentifier { let path = self.dir.path().join(rel_path); TextDocumentIdentifier { uri: Url::from_file_path(path).unwrap() } } pub(crate) fn notification(&self, params: N::Params) where N: lsp_types::notification::Notification, N::Params: Serialize, { let r = Notification::new(N::METHOD.to_string(), params); self.send_notification(r) } pub(crate) fn request(&self, params: R::Params, expected_resp: Value) where R: lsp_types::request::Request, R::Params: Serialize, { let actual = self.send_request::(params); if let Some((expected_part, actual_part)) = find_mismatch(&expected_resp, &actual) { panic!( "JSON mismatch\nExpected:\n{}\nWas:\n{}\nExpected part:\n{}\nActual part:\n{}\n", to_string_pretty(&expected_resp).unwrap(), to_string_pretty(&actual).unwrap(), to_string_pretty(expected_part).unwrap(), to_string_pretty(actual_part).unwrap(), ); } } pub(crate) fn send_request(&self, params: R::Params) -> Value where R: lsp_types::request::Request, R::Params: Serialize, { let id = self.req_id.get(); self.req_id.set(id.wrapping_add(1)); let r = Request::new(id.into(), R::METHOD.to_string(), params); self.send_request_(r) } fn send_request_(&self, r: Request) -> Value { let id = r.id.clone(); self.client.sender.send(r.clone().into()).unwrap(); while let Some(msg) = self.recv().unwrap_or_else(|Timeout| panic!("timeout: {:?}", r)) { match msg { Message::Request(req) => { if req.method == "client/registerCapability" { let params = req.params.to_string(); if ["workspace/didChangeWatchedFiles", "textDocument/didSave"] .iter() .any(|&it| params.contains(it)) { continue; } } panic!("unexpected request: {:?}", req) } Message::Notification(_) => (), Message::Response(res) => { assert_eq!(res.id, id); if let Some(err) = res.error { panic!("error response: {:#?}", err); } return res.result.unwrap(); } } } panic!("no response for {:?}", r); } pub(crate) fn wait_until_workspace_is_loaded(self) -> Server { self.wait_for_message_cond(1, &|msg: &Message| match msg { Message::Notification(n) if n.method == "rust-analyzer/status" => { let status = n .clone() .extract::("rust-analyzer/status") .unwrap() .status; matches!(status, lsp_ext::Status::Ready) } _ => false, }) .unwrap_or_else(|Timeout| panic!("timeout while waiting for ws to load")); self } fn wait_for_message_cond( &self, n: usize, cond: &dyn Fn(&Message) -> bool, ) -> Result<(), Timeout> { let mut total = 0; for msg in self.messages.borrow().iter() { if cond(msg) { total += 1 } } while total < n { let msg = self.recv()?.expect("no response"); if cond(&msg) { total += 1; } } Ok(()) } fn recv(&self) -> Result, Timeout> { let msg = recv_timeout(&self.client.receiver)?; let msg = msg.map(|msg| { self.messages.borrow_mut().push(msg.clone()); msg }); Ok(msg) } fn send_notification(&self, not: Notification) { self.client.sender.send(Message::Notification(not)).unwrap(); } pub(crate) fn path(&self) -> &Path { self.dir.path() } } impl Drop for Server { fn drop(&mut self) { self.request::((), Value::Null); self.notification::(()); } } struct Timeout; fn recv_timeout(receiver: &Receiver) -> Result, Timeout> { let timeout = if cfg!(target_os = "macos") { Duration::from_secs(300) } else { Duration::from_secs(120) }; select! { recv(receiver) -> msg => Ok(msg.ok()), recv(after(timeout)) -> _ => Err(Timeout), } }