temp-postgres 0.1.0

temporary postgres instance meant for unit tests
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

use std::path::PathBuf;

/// An error that can occur when creating or cleaning a postgres instance.
pub struct Error {
	/// The actual error.
	inner: ErrorInner,
}

#[derive(Debug)]
pub enum ErrorInner {
	/// Failed to create the temporary directory.
	MakeTempDir(std::io::Error),

	/// Failed to run a command.
	RunCommand(String, std::io::Error),

	/// Command was run but reported failure.
	CommandFailed(String, std::process::Output),

	/// Failed to spawn the server.
	SpawnServer(String, std::io::Error),

	/// Failed to create a file.
	Create(PathBuf, std::io::Error),

	/// Failed to duplicate a file descriptor.
	Duplicate(PathBuf, std::io::Error),

	/// Failed to open a file for reading.
	Open(PathBuf, std::io::Error),

	/// Failed to read from a file.
	Read(PathBuf, std::io::Error),

	/// The server did not become ready on time.
	ServerReadyTimeout,

	/// Failed to kill the server.
	KillServer(std::io::Error),

	/// Failed to clean up the temporary directory.
	CleanDir(PathBuf, std::io::Error),

	/// Failed to connect to the server.
	Connect(String, tokio_postgres::Error),
}

impl std::error::Error for Error {}

impl std::fmt::Debug for Error {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		std::fmt::Debug::fmt(&self.inner, f)
	}
}

impl std::fmt::Display for Error {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		std::fmt::Display::fmt(&self.inner, f)
	}
}

impl std::fmt::Display for ErrorInner {
	fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
		match self {
			Self::MakeTempDir(e) => write!(f, "Failed to create temporary directory: {e}"),
			Self::RunCommand(name, e) => write!(f, "Failed run command `{name}`: {e}"),
			Self::CommandFailed(name, output) => report_exit_reason(f, name, output),
			Self::SpawnServer(name, e) => write!(f, "Failed to run server command: {name}: {e}"),
			Self::Create(path, e) => write!(f, "Failed to create {}: {e}", path.display()),
			Self::Duplicate(path, e) => write!(f, "Failed to duplicate file descriptor of {}: {e}", path.display()),
			Self::Open(path, e) => write!(f, "Failed to open {} for reading: {e}", path.display()),
			Self::Read(path, e) => write!(f, "Failed to read from {}: {e}", path.display()),
			Self::ServerReadyTimeout => write!(f, "Server did not become ready within the timeout"),
			Self::KillServer(e) => write!(f, "Failed to terminate spanwed server: {e}"),
			Self::CleanDir(path, e) => write!(f, "Failed to clean up temporary state directory {}: {e}", path.display()),
			Self::Connect(address, e) => write!(f, "Failed to connect to server at {address}: {e}"),
		}
	}
}

fn report_exit_reason(f: &mut std::fmt::Formatter, name: &str, output: &std::process::Output) -> std::fmt::Result {
	#[cfg(unix)]
	{
		use std::os::unix::process::ExitStatusExt;
		if let Some(signal) = output.status.signal() {
			return write!(f, "Command `{name}` was killed by signal {signal}");
		}
	}
	if let Some(code) = output.status.code() {
		write!(f, "Command `{name}` exitted with status {code}")?;
		if let Ok(error) = std::str::from_utf8(&output.stderr) {
			let error = error.trim();
			if !error.is_empty() {
				write!(f, "Error: \n{error}")?;
			}
		}
		Ok(())
	} else {
		write!(f, "Command `{name}` failed with unknown termination reason")
	}
}

impl From<ErrorInner> for Error {
	fn from(inner: ErrorInner) -> Self {
		Self { inner }
	}
}