Merge pull request #231 from theseus-rs/add-unix-socket-support

feat: add unix socket support

Author: brianheineman

Cargo.lock

@@ -23,13 +23,14 @@ In either case, PostgreSQL will run in a separate process space.
 
 - installing and running PostgreSQL
 - running PostgreSQL on ephemeral ports
+- Unix socket support
 - async and blocking API
 - bundling the PostgreSQL archive in an executable
 - semantic version resolution
-- support for custom PostgreSQL archives / binaries
 - ability to configure PostgreSQL startup options
+- settings builder for fluent configuration
 - URL based configuration
-- choice of native-tls vs rustls
+- choice of native-tls or rustls
 - support for installing PostgreSQL extensions
 
 ## Getting Started

README.md

@@ -0,0 +1,11 @@
+[package]
+edition.workspace = true
+name = "unix_socket"
+publish = false
+license.workspace = true
+version.workspace = true
+
+[dependencies]
+postgresql_embedded = { path = "../../postgresql_embedded" }
+tempfile = { workspace = true }
+tokio = { workspace = true, features = ["full"] }

examples/unix_socket/Cargo.toml

@@ -0,0 +1,50 @@
+use postgresql_embedded::{PostgreSQL, Result, SettingsBuilder};
+
+#[cfg(unix)]
+#[tokio::main]
+async fn main() -> Result<()> {
+    let socket_dir = tempfile::tempdir().expect("failed to create temp dir for socket");
+
+    let settings = SettingsBuilder::new()
+        .socket_dir(socket_dir.path().to_path_buf())
+        .build();
+
+    let mut postgresql = PostgreSQL::new(settings);
+    postgresql.setup().await?;
+    postgresql.start().await?;
+
+    let port = postgresql.settings().port;
+    let socket_file = socket_dir.path().join(format!(".s.PGSQL.{port}"));
+    println!("PostgreSQL is listening on Unix socket: {socket_file:?}");
+
+    let database_name = "test";
+    postgresql.create_database(database_name).await?;
+    println!("Created database '{database_name}'");
+
+    let exists = postgresql.database_exists(database_name).await?;
+    println!("Database '{database_name}' exists: {exists}");
+
+    postgresql.drop_database(database_name).await?;
+    println!("Dropped database '{database_name}'");
+
+    postgresql.stop().await?;
+    println!("PostgreSQL stopped");
+
+    Ok(())
+}
+
+#[cfg(not(unix))]
+fn main() {
+    eprintln!("Unix socket support is only available on Unix platforms");
+}
+
+#[cfg(test)]
+#[cfg(unix)]
+mod test {
+    use super::*;
+
+    #[test]
+    fn test_unix_socket_main() -> Result<()> {
+        main()
+    }
+}

examples/unix_socket/src/main.rs

@@ -8,7 +8,7 @@ use crate::hasher::md5;
 use crate::hasher::sha1;
 #[cfg(feature = "sha2")]
 use crate::hasher::sha2_256;
-#[cfg(feature = "sha2")]
+#[cfg(all(feature = "sha2", feature = "maven"))]
 use crate::hasher::sha2_512;
 #[cfg(feature = "maven")]
 use crate::repository::maven;

postgresql_archive/src/hasher/registry.rs

@@ -35,12 +35,16 @@ impl ClusterDbBuilder {
 
     /// Create a new [`ClusterDbBuilder`] from [Settings]
     pub fn from(settings: &dyn Settings) -> Self {
-        Self::new()
+        let mut builder = Self::new()
             .program_dir(settings.get_binary_dir())
             .host(settings.get_host())
             .port(settings.get_port())
             .username(settings.get_username())
-            .pg_password(settings.get_password())
+            .pg_password(settings.get_password());
+        if let Some(socket_dir) = settings.get_socket_dir() {
+            builder = builder.host(socket_dir.to_string_lossy().to_string());
+        }
+        builder
     }
 
     /// Location of the program binary
@@ -259,6 +263,7 @@ impl CommandBuilder for ClusterDbBuilder {
 mod tests {
     use super::*;
     use crate::TestSettings;
+    use crate::TestSocketSettings;
     use crate::traits::CommandToString;
     use test_log::test;
 
@@ -319,4 +324,20 @@ mod tests {
             command.to_command_string()
         );
     }
+
+    #[test]
+    fn test_builder_from_socket() {
+        let command = ClusterDbBuilder::from(&TestSocketSettings).build();
+        #[cfg(not(target_os = "windows"))]
+        let command_prefix = r#"PGPASSWORD="password" "./clusterdb" "#;
+        #[cfg(target_os = "windows")]
+        let command_prefix = r#"".\\clusterdb" "#;
+
+        assert_eq!(
+            format!(
+                r#"{command_prefix}"--host" "/tmp/pg_socket" "--port" "5432" "--username" "postgres""#
+            ),
+            command.to_command_string()
+        );
+    }
 }

postgresql_commands/src/clusterdb.rs

@@ -43,12 +43,16 @@ impl CreateDbBuilder {
 
     /// Create a new [`CreateDbBuilder`] from [Settings]
     pub fn from(settings: &dyn Settings) -> Self {
-        Self::new()
+        let mut builder = Self::new()
             .program_dir(settings.get_binary_dir())
             .host(settings.get_host())
             .port(settings.get_port())
             .username(settings.get_username())
-            .pg_password(settings.get_password())
+            .pg_password(settings.get_password());
+        if let Some(socket_dir) = settings.get_socket_dir() {
+            builder = builder.host(socket_dir.to_string_lossy().to_string());
+        }
+        builder
     }
 
     /// Location of the program binary
@@ -364,6 +368,7 @@ impl CommandBuilder for CreateDbBuilder {
 mod tests {
     use super::*;
     use crate::TestSettings;
+    use crate::TestSocketSettings;
     use crate::traits::CommandToString;
     use test_log::test;
 
@@ -432,4 +437,20 @@ mod tests {
             command.to_command_string()
         );
     }
+
+    #[test]
+    fn test_builder_from_socket() {
+        let command = CreateDbBuilder::from(&TestSocketSettings).build();
+        #[cfg(not(target_os = "windows"))]
+        let command_prefix = r#"PGPASSWORD="password" "./createdb" "#;
+        #[cfg(target_os = "windows")]
+        let command_prefix = r#"".\\createdb" "#;
+
+        assert_eq!(
+            format!(
+                r#"{command_prefix}"--host" "/tmp/pg_socket" "--port" "5432" "--username" "postgres""#
+            ),
+            command.to_command_string()
+        );
+    }
 }

postgresql_commands/src/createdb.rs

@@ -50,12 +50,16 @@ impl CreateUserBuilder {
 
     /// Create a new [`CreateUserBuilder`] from [Settings]
     pub fn from(settings: &dyn Settings) -> Self {
-        Self::new()
+        let mut builder = Self::new()
             .program_dir(settings.get_binary_dir())
             .host(settings.get_host())
             .port(settings.get_port())
             .username(settings.get_username())
-            .pg_password(settings.get_password())
+            .pg_password(settings.get_password());
+        if let Some(socket_dir) = settings.get_socket_dir() {
+            builder = builder.host(socket_dir.to_string_lossy().to_string());
+        }
+        builder
     }
 
     /// Location of the program binary
@@ -441,6 +445,7 @@ impl CommandBuilder for CreateUserBuilder {
 mod tests {
     use super::*;
     use crate::TestSettings;
+    use crate::TestSocketSettings;
     use crate::traits::CommandToString;
     use test_log::test;
 
@@ -516,4 +521,20 @@ mod tests {
             command.to_command_string()
         );
     }
+
+    #[test]
+    fn test_builder_from_socket() {
+        let command = CreateUserBuilder::from(&TestSocketSettings).build();
+        #[cfg(not(target_os = "windows"))]
+        let command_prefix = r#"PGPASSWORD="password" "./createuser" "#;
+        #[cfg(target_os = "windows")]
+        let command_prefix = r#"".\\createuser" "#;
+
+        assert_eq!(
+            format!(
+                r#"{command_prefix}"--host" "/tmp/pg_socket" "--port" "5432" "--username" "postgres""#
+            ),
+            command.to_command_string()
+        );
+    }
 }

postgresql_commands/src/createuser.rs

@@ -33,12 +33,16 @@ impl DropDbBuilder {
 
     /// Create a new [`DropDbBuilder`] from [Settings]
     pub fn from(settings: &dyn Settings) -> Self {
-        Self::new()
+        let mut builder = Self::new()
             .program_dir(settings.get_binary_dir())
             .host(settings.get_host())
             .port(settings.get_port())
             .username(settings.get_username())
-            .pg_password(settings.get_password())
+            .pg_password(settings.get_password());
+        if let Some(socket_dir) = settings.get_socket_dir() {
+            builder = builder.host(socket_dir.to_string_lossy().to_string());
+        }
+        builder
     }
 
     /// Location of the program binary
@@ -244,6 +248,7 @@ impl CommandBuilder for DropDbBuilder {
 mod tests {
     use super::*;
     use crate::TestSettings;
+    use crate::TestSocketSettings;
     use crate::traits::CommandToString;
     use test_log::test;
 
@@ -303,4 +308,20 @@ mod tests {
             command.to_command_string()
         );
     }
+
+    #[test]
+    fn test_builder_from_socket() {
+        let command = DropDbBuilder::from(&TestSocketSettings).build();
+        #[cfg(not(target_os = "windows"))]
+        let command_prefix = r#"PGPASSWORD="password" "./dropdb" "#;
+        #[cfg(target_os = "windows")]
+        let command_prefix = r#"".\\dropdb" "#;
+
+        assert_eq!(
+            format!(
+                r#"{command_prefix}"--host" "/tmp/pg_socket" "--port" "5432" "--username" "postgres""#
+            ),
+            command.to_command_string()
+        );
+    }
 }

postgresql_commands/src/dropdb.rs

@@ -31,12 +31,16 @@ impl DropUserBuilder {
 
     /// Create a new [`DropUserBuilder`] from [Settings]
     pub fn from(settings: &dyn Settings) -> Self {
-        Self::new()
+        let mut builder = Self::new()
             .program_dir(settings.get_binary_dir())
             .host(settings.get_host())
             .port(settings.get_port())
             .username(settings.get_username())
-            .pg_password(settings.get_password())
+            .pg_password(settings.get_password());
+        if let Some(socket_dir) = settings.get_socket_dir() {
+            builder = builder.host(socket_dir.to_string_lossy().to_string());
+        }
+        builder
     }
 
     /// Location of the program binary
@@ -208,6 +212,7 @@ impl CommandBuilder for DropUserBuilder {
 mod tests {
     use super::*;
     use crate::TestSettings;
+    use crate::TestSocketSettings;
     use crate::traits::CommandToString;
     use test_log::test;
 
@@ -264,4 +269,20 @@ mod tests {
             command.to_command_string()
         );
     }
+
+    #[test]
+    fn test_builder_from_socket() {
+        let command = DropUserBuilder::from(&TestSocketSettings).build();
+        #[cfg(not(target_os = "windows"))]
+        let command_prefix = r#"PGPASSWORD="password" "./dropuser" "#;
+        #[cfg(target_os = "windows")]
+        let command_prefix = r#"".\\dropuser" "#;
+
+        assert_eq!(
+            format!(
+                r#"{command_prefix}"--host" "/tmp/pg_socket" "--port" "5432" "--username" "postgres""#
+            ),
+            command.to_command_string()
+        );
+    }
 }