[ty] Move server tests as integration tests (#19522)

## Summary

Reference:
#19391 (comment)

Author: dhruvmanila

Cargo.lock

@@ -38,11 +38,16 @@ tracing = { workspace = true }
 tracing-subscriber = { workspace = true, features = ["chrono"] }
 
 [dev-dependencies]
+ty_server = { workspace = true, features = ["testing"] }
+
 dunce = { workspace = true }
 insta = { workspace = true, features = ["filters", "json"] }
 regex = { workspace = true }
 tempfile = { workspace = true }
 
+[features]
+testing = []
+
 [target.'cfg(target_vendor = "apple")'.dependencies]
 libc = { workspace = true }
 

crates/ty_server/Cargo.toml

@@ -4,7 +4,9 @@ use anyhow::Context;
 use lsp_server::Connection;
 use ruff_db::system::{OsSystem, SystemPathBuf};
 
-use crate::server::Server;
+pub use crate::logging::{LogLevel, init_logging};
+pub use crate::server::Server;
+pub use crate::session::ClientOptions;
 pub use document::{NotebookDocument, PositionEncoding, TextDocument};
 pub(crate) use session::{DocumentQuery, Session};
 
@@ -14,9 +16,6 @@ mod server;
 mod session;
 mod system;
 
-#[cfg(test)]
-pub mod test;
-
 pub(crate) const SERVER_NAME: &str = "ty";
 pub(crate) const DIAGNOSTIC_NAME: &str = "ty";
 

crates/ty_server/src/lib.rs

@@ -14,7 +14,7 @@ use tracing_subscriber::fmt::time::ChronoLocal;
 use tracing_subscriber::fmt::writer::BoxMakeWriter;
 use tracing_subscriber::layer::SubscriberExt;
 
-pub(crate) fn init_logging(log_level: LogLevel, log_file: Option<&SystemPath>) {
+pub fn init_logging(log_level: LogLevel, log_file: Option<&SystemPath>) {
     let log_file = log_file
         .map(|path| {
             // this expands `logFile` so that tildes and environment variables
@@ -66,7 +66,7 @@ pub(crate) fn init_logging(log_level: LogLevel, log_file: Option<&SystemPath>) {
 /// The default log level is `info`.
 #[derive(Clone, Copy, Debug, Deserialize, Default, PartialEq, Eq, PartialOrd, Ord)]
 #[serde(rename_all = "lowercase")]
-pub(crate) enum LogLevel {
+pub enum LogLevel {
     Error,
     Warn,
     #[default]

crates/ty_server/src/logging.rs

@@ -26,7 +26,7 @@ pub(crate) use api::publish_settings_diagnostics;
 pub(crate) use main_loop::{Action, ConnectionSender, Event, MainLoopReceiver, MainLoopSender};
 pub(crate) type Result<T> = std::result::Result<T, api::Error>;
 
-pub(crate) struct Server {
+pub struct Server {
     connection: Connection,
     client_capabilities: ClientCapabilities,
     worker_threads: NonZeroUsize,
@@ -36,7 +36,7 @@ pub(crate) struct Server {
 }
 
 impl Server {
-    pub(crate) fn new(
+    pub fn new(
         worker_threads: NonZeroUsize,
         connection: Connection,
         native_system: Arc<dyn System + 'static + Send + Sync + RefUnwindSafe>,
@@ -161,7 +161,7 @@ impl Server {
         })
     }
 
-    pub(crate) fn run(mut self) -> crate::Result<()> {
+    pub fn run(mut self) -> crate::Result<()> {
         let client = Client::new(
             self.main_loop_sender.clone(),
             self.connection.sender.clone(),
@@ -302,89 +302,3 @@ impl Drop for ServerPanicHookHandler {
         }
     }
 }
-
-#[cfg(test)]
-mod tests {
-    use anyhow::Result;
-    use lsp_types::notification::PublishDiagnostics;
-    use ruff_db::system::SystemPath;
-
-    use crate::session::ClientOptions;
-    use crate::test::TestServerBuilder;
-
-    #[test]
-    fn initialization() -> Result<()> {
-        let server = TestServerBuilder::new()?
-            .build()?
-            .wait_until_workspaces_are_initialized()?;
-
-        let initialization_result = server.initialization_result().unwrap();
-
-        insta::assert_json_snapshot!("initialization", initialization_result);
-
-        Ok(())
-    }
-
-    #[test]
-    fn initialization_with_workspace() -> Result<()> {
-        let workspace_root = SystemPath::new("foo");
-        let server = TestServerBuilder::new()?
-            .with_workspace(workspace_root, ClientOptions::default())?
-            .build()?
-            .wait_until_workspaces_are_initialized()?;
-
-        let initialization_result = server.initialization_result().unwrap();
-
-        insta::assert_json_snapshot!("initialization_with_workspace", initialization_result);
-
-        Ok(())
-    }
-
-    #[test]
-    fn publish_diagnostics_on_did_open() -> Result<()> {
-        let workspace_root = SystemPath::new("src");
-        let foo = SystemPath::new("src/foo.py");
-        let foo_content = "\
-def foo() -> str:
-    return 42
-";
-
-        let mut server = TestServerBuilder::new()?
-            .with_workspace(workspace_root, ClientOptions::default())?
-            .with_file(foo, foo_content)?
-            .enable_pull_diagnostics(false)
-            .build()?
-            .wait_until_workspaces_are_initialized()?;
-
-        server.open_text_document(foo, &foo_content, 1);
-        let diagnostics = server.await_notification::<PublishDiagnostics>()?;
-
-        insta::assert_debug_snapshot!(diagnostics);
-
-        Ok(())
-    }
-
-    #[test]
-    fn pull_diagnostics_on_did_open() -> Result<()> {
-        let workspace_root = SystemPath::new("src");
-        let foo = SystemPath::new("src/foo.py");
-        let foo_content = "\
-def foo() -> str:
-    return 42
-";
-
-        let mut server = TestServerBuilder::new()?
-            .with_workspace(workspace_root, ClientOptions::default())?
-            .with_file(foo, foo_content)?
-            .enable_pull_diagnostics(true)
-            .build()?
-            .wait_until_workspaces_are_initialized()?;
-
-        server.open_text_document(foo, &foo_content, 1);
-        let diagnostics = server.document_diagnostic_request(foo)?;
-
-        insta::assert_debug_snapshot!(diagnostics);
-
-        Ok(())
-    }
-}

crates/ty_server/src/server.rs

@@ -21,7 +21,8 @@ use ty_project::{ChangeResult, Db as _, ProjectDatabase, ProjectMetadata};
 
 pub(crate) use self::capabilities::ResolvedClientCapabilities;
 pub(crate) use self::index::DocumentQuery;
-pub(crate) use self::options::{AllOptions, ClientOptions, DiagnosticMode};
+pub use self::options::ClientOptions;
+pub(crate) use self::options::{AllOptions, DiagnosticMode};
 pub(crate) use self::settings::ClientSettings;
 use crate::document::{DocumentKey, DocumentVersion, NotebookDocument};
 use crate::server::publish_settings_diagnostics;

crates/ty_server/src/session.rs

@@ -49,9 +49,10 @@ struct WorkspaceOptions {
 
 /// This is a direct representation of the settings schema sent by the client.
 #[derive(Clone, Debug, Deserialize, Default)]
-#[cfg_attr(test, derive(serde::Serialize, PartialEq, Eq))]
+#[cfg_attr(test, derive(PartialEq, Eq))]
+#[cfg_attr(feature = "testing", derive(serde::Serialize))]
 #[serde(rename_all = "camelCase")]
-pub(crate) struct ClientOptions {
+pub struct ClientOptions {
     /// Settings under the `python.*` namespace in VS Code that are useful for the ty language
     /// server.
     python: Option<Python>,
@@ -63,7 +64,8 @@ pub(crate) struct ClientOptions {
 
 /// Diagnostic mode for the language server.
 #[derive(Clone, Copy, Debug, Default, Deserialize)]
-#[cfg_attr(test, derive(serde::Serialize, PartialEq, Eq))]
+#[cfg_attr(test, derive(PartialEq, Eq))]
+#[cfg_attr(feature = "testing", derive(serde::Serialize))]
 #[serde(rename_all = "camelCase")]
 pub(crate) enum DiagnosticMode {
     /// Check only currently open files.
@@ -147,21 +149,24 @@ impl ClientOptions {
 // all settings and not just the ones in "python.*".
 
 #[derive(Clone, Debug, Deserialize, Default)]
-#[cfg_attr(test, derive(serde::Serialize, PartialEq, Eq))]
+#[cfg_attr(test, derive(PartialEq, Eq))]
+#[cfg_attr(feature = "testing", derive(serde::Serialize))]
 #[serde(rename_all = "camelCase")]
 struct Python {
     ty: Option<Ty>,
 }
 
 #[derive(Clone, Debug, Deserialize, Default)]
-#[cfg_attr(test, derive(serde::Serialize, PartialEq, Eq))]
+#[cfg_attr(test, derive(PartialEq, Eq))]
+#[cfg_attr(feature = "testing", derive(serde::Serialize))]
 #[serde(rename_all = "camelCase")]
 struct PythonExtension {
     active_environment: Option<ActiveEnvironment>,
 }
 
 #[derive(Clone, Debug, Deserialize)]
-#[cfg_attr(test, derive(serde::Serialize, PartialEq, Eq))]
+#[cfg_attr(test, derive(PartialEq, Eq))]
+#[cfg_attr(feature = "testing", derive(serde::Serialize))]
 #[serde(rename_all = "camelCase")]
 pub(crate) struct ActiveEnvironment {
     pub(crate) executable: PythonExecutable,
@@ -170,7 +175,8 @@ pub(crate) struct ActiveEnvironment {
 }
 
 #[derive(Clone, Debug, Deserialize)]
-#[cfg_attr(test, derive(serde::Serialize, PartialEq, Eq))]
+#[cfg_attr(test, derive(PartialEq, Eq))]
+#[cfg_attr(feature = "testing", derive(serde::Serialize))]
 #[serde(rename_all = "camelCase")]
 pub(crate) struct EnvironmentVersion {
     pub(crate) major: i64,
@@ -182,7 +188,8 @@ pub(crate) struct EnvironmentVersion {
 }
 
 #[derive(Clone, Debug, Deserialize)]
-#[cfg_attr(test, derive(serde::Serialize, PartialEq, Eq))]
+#[cfg_attr(test, derive(PartialEq, Eq))]
+#[cfg_attr(feature = "testing", derive(serde::Serialize))]
 #[serde(rename_all = "camelCase")]
 pub(crate) struct PythonEnvironment {
     pub(crate) folder_uri: Url,
@@ -194,7 +201,8 @@ pub(crate) struct PythonEnvironment {
 }
 
 #[derive(Clone, Debug, Deserialize)]
-#[cfg_attr(test, derive(serde::Serialize, PartialEq, Eq))]
+#[cfg_attr(test, derive(PartialEq, Eq))]
+#[cfg_attr(feature = "testing", derive(serde::Serialize))]
 #[serde(rename_all = "camelCase")]
 pub(crate) struct PythonExecutable {
     #[allow(dead_code)]
@@ -203,7 +211,8 @@ pub(crate) struct PythonExecutable {
 }
 
 #[derive(Clone, Debug, Deserialize, Default)]
-#[cfg_attr(test, derive(serde::Serialize, PartialEq, Eq))]
+#[cfg_attr(test, derive(PartialEq, Eq))]
+#[cfg_attr(feature = "testing", derive(serde::Serialize))]
 #[serde(rename_all = "camelCase")]
 struct Ty {
     disable_language_services: Option<bool>,

crates/ty_server/src/session/options.rs

@@ -0,0 +1,33 @@
+use anyhow::Result;
+use ruff_db::system::SystemPath;
+use ty_server::ClientOptions;
+
+use crate::TestServerBuilder;
+
+#[test]
+fn empty_workspace_folders() -> Result<()> {
+    let server = TestServerBuilder::new()?
+        .build()?
+        .wait_until_workspaces_are_initialized()?;
+
+    let initialization_result = server.initialization_result().unwrap();
+
+    insta::assert_json_snapshot!("initialization", initialization_result);
+
+    Ok(())
+}
+
+#[test]
+fn single_workspace_folder() -> Result<()> {
+    let workspace_root = SystemPath::new("foo");
+    let server = TestServerBuilder::new()?
+        .with_workspace(workspace_root, ClientOptions::default())?
+        .build()?
+        .wait_until_workspaces_are_initialized()?;
+
+    let initialization_result = server.initialization_result().unwrap();
+
+    insta::assert_json_snapshot!("initialization_with_workspace", initialization_result);
+
+    Ok(())
+}