Skip to content

Commit

Permalink
Log the server / cluster logfile on error.
Browse files Browse the repository at this point in the history 
This allows us to find errors that aren't visible
in stdout/stderr.
  • Loading branch information
@nihohit @barshaul
nihohit authored and barshaul committed Jun 26, 2024
1 parent 1fcdc75 commit 4b18e25
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 23 deletions.
20 changes: 18 additions & 2 deletions redis/tests/support/cluster.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

use std::convert::identity;
use std::env;
use std::io::Read;
use std::process;
use std::thread::sleep;
use std::time::Duration;
Expand Down Expand Up @@ -207,10 +208,24 @@ impl RedisCluster {
let mut process = cmd.spawn().unwrap();
sleep(Duration::from_millis(100));

let log_file_index = cmd.get_args().position(|arg|arg == "--logfile").unwrap() + 1;
let log_file_path = cmd.get_args().nth(log_file_index).unwrap();
match process.try_wait() {
Ok(Some(status)) => {
let stdout = process.stdout.map_or(String::new(), |mut out|{
let mut str = String::new();
out.read_to_string(&mut str).unwrap();
str
});
let stderr = process.stderr.map_or(String::new(), |mut out|{
let mut str = String::new();
out.read_to_string(&mut str).unwrap();
str
});

let log_file_contents = std::fs::read_to_string(log_file_path).unwrap();
let err =
format!("redis server creation failed with status {status:?}");
format!("redis server creation failed with status {status:?}.\nstdout: `{stdout}`.\nstderr: `{stderr}`\nlog file: {log_file_contents}");
if cur_attempts == max_attempts {
panic!("{err}");
}
Expand All @@ -222,7 +237,8 @@ impl RedisCluster {
let mut cur_attempts = 0;
loop {
if cur_attempts == max_attempts {
panic!("redis server creation failed: Port {port} closed")
let log_file_contents = std::fs::read_to_string(log_file_path).unwrap();
panic!("redis server creation failed: Port {port} closed. {log_file_contents}")
}
if port_in_use(&addr) {
return process;
Expand Down
74 changes: 53 additions & 21 deletions redis/tests/support/mod.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,8 @@ pub enum Module {

pub struct RedisServer {
pub process: process::Child,
pub(crate) tempdir: tempfile::TempDir,
tempdir: tempfile::TempDir,
log_file: PathBuf,
pub(crate) addr: redis::ConnectionAddr,
pub(crate) tls_paths: Option<TlsFilePaths>,
}
Expand Down Expand Up @@ -176,6 +177,10 @@ impl RedisServer {
RedisServer::with_modules(&[], true)
}

pub fn log_file_contents(&self) -> String {
std::fs::read_to_string(self.log_file.clone()).unwrap()
}

pub fn get_addr(port: u16) -> ConnectionAddr {
let server_type = ServerType::get_intended();
match server_type {
Expand Down Expand Up @@ -279,7 +284,8 @@ impl RedisServer {
.prefix("redis")
.tempdir()
.expect("failed to create tempdir");
redis_cmd.arg("--logfile").arg(Self::log_file(&tempdir));
let log_file = Self::log_file(&tempdir);
redis_cmd.arg("--logfile").arg(log_file.clone());
match addr {
redis::ConnectionAddr::Tcp(ref bind, server_port) => {
redis_cmd
Expand All @@ -290,6 +296,7 @@ impl RedisServer {

RedisServer {
process: spawner(&mut redis_cmd),
log_file,
tempdir,
addr,
tls_paths: None,
Expand Down Expand Up @@ -329,6 +336,7 @@ impl RedisServer {

RedisServer {
process: spawner(&mut redis_cmd),
log_file,
tempdir,
addr,
tls_paths: Some(tls_paths),
Expand All @@ -342,6 +350,7 @@ impl RedisServer {
.arg(path);
RedisServer {
process: spawner(&mut redis_cmd),
log_file,
tempdir,
addr,
tls_paths: None,
Expand Down Expand Up @@ -446,15 +455,27 @@ impl TestContext {
}

pub fn with_tls(tls_files: TlsFilePaths, mtls_enabled: bool) -> TestContext {
Self::with_modules_and_tls(&[], mtls_enabled, Some(tls_files))
}

pub fn with_modules(modules: &[Module], mtls_enabled: bool) -> TestContext {
Self::with_modules_and_tls(modules, mtls_enabled, None)
}

fn with_modules_and_tls(
modules: &[Module],
mtls_enabled: bool,
tls_files: Option<TlsFilePaths>,
) -> Self {
let redis_port = get_random_available_port();
let addr: ConnectionAddr = RedisServer::get_addr(redis_port);

let server = RedisServer::new_with_addr_tls_modules_and_spawner(
addr,
None,
Some(tls_files),
tls_files,
mtls_enabled,
&[],
modules,
|cmd| {
cmd.spawn()
.unwrap_or_else(|err| panic!("Failed to run {cmd:?}: {err}"))
Expand All @@ -467,25 +488,36 @@ impl TestContext {
#[cfg(not(feature = "tls-rustls"))]
let client = redis::Client::open(server.connection_info()).unwrap();

Self::connect_with_retries(&client);
let mut con;

TestContext {
server,
client,
protocol: use_protocol(),
let millisecond = Duration::from_millis(1);
let mut retries = 0;
loop {
match client.get_connection() {
Err(err) => {
if err.is_connection_refusal() {
sleep(millisecond);
retries += 1;
if retries > 100000 {
panic!(
"Tried to connect too many times, last error: {err}, logfile: {}",
server.log_file_contents()
);
}
} else {
panic!(
"Could not connect: {err}, logfile: {}",
server.log_file_contents()
);
}
}
Ok(x) => {
con = x;
break;
}
}
}
}

pub fn with_modules(modules: &[Module], mtls_enabled: bool) -> TestContext {
let server = RedisServer::with_modules(modules, mtls_enabled);

#[cfg(feature = "tls-rustls")]
let client =
build_single_client(server.connection_info(), &server.tls_paths, mtls_enabled).unwrap();
#[cfg(not(feature = "tls-rustls"))]
let client = redis::Client::open(server.connection_info()).unwrap();

Self::connect_with_retries(&client);
redis::cmd("FLUSHDB").execute(&mut con);

TestContext {
server,
Expand Down

0 comments on commit 4b18e25

Please sign in to comment.