Skip to content

Log the cluster logfile on error. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Log the cluster logfile on error. #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7137565
Log the server / cluster logfile on error.
nihohit May 29, 2024
254332a
Wait for free port in legal range.
nihohit May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions redis/tests/support/cluster.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,8 @@ impl RedisCluster {
let mut process = cmd.spawn().unwrap();
sleep(Duration::from_millis(50));

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|{
Expand All @@ -216,8 +218,10 @@ impl RedisCluster {
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:?}.\nstdout: `{stdout}`.\nstderr: `{stderr}`");
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 @@ -230,7 +234,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
98 changes: 45 additions & 53 deletions redis/tests/support/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,7 @@ pub enum Module {
pub struct RedisServer {
pub process: process::Child,
tempdir: tempfile::TempDir,
log_file: PathBuf,
addr: redis::ConnectionAddr,
pub(crate) tls_paths: Option<TlsFilePaths>,
}
Expand Down Expand Up @@ -174,6 +175,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 @@ -270,7 +275,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 @@ -281,6 +287,7 @@ impl RedisServer {

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

RedisServer {
process: spawner(&mut redis_cmd),
log_file,
tempdir,
addr,
tls_paths: Some(tls_paths),
Expand All @@ -333,6 +341,7 @@ impl RedisServer {
.arg(path);
RedisServer {
process: spawner(&mut redis_cmd),
log_file,
tempdir,
addr,
tls_paths: None,
Expand Down Expand Up @@ -374,13 +383,19 @@ impl RedisServer {
/// process, so this must be used with care (since here we only use it for tests, it's
/// mostly okay).
pub fn get_random_available_port() -> u16 {
let addr = &"127.0.0.1:0".parse::<SocketAddr>().unwrap().into();
let socket = Socket::new(Domain::IPV4, Type::STREAM, None).unwrap();
socket.set_reuse_address(true).unwrap();
socket.bind(addr).unwrap();
socket.listen(1).unwrap();
let listener = TcpListener::from(socket);
listener.local_addr().unwrap().port()
for _ in 0..10000 {
let addr = &"127.0.0.1:0".parse::<SocketAddr>().unwrap().into();
let socket = Socket::new(Domain::IPV4, Type::STREAM, None).unwrap();
socket.set_reuse_address(true).unwrap();
socket.bind(addr).unwrap();
socket.listen(1).unwrap();
let listener = TcpListener::from(socket);
let port = listener.local_addr().unwrap().port();
if port < 55535 {
return port;
}
}
panic!("Couldn't get a valid port");
}

impl Drop for RedisServer {
Expand Down Expand Up @@ -410,15 +425,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 = 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 @@ -442,51 +469,16 @@ impl TestContext {
sleep(millisecond);
retries += 1;
if retries > 100000 {
panic!("Tried to connect too many times, last error: {err}");
}
} else {
panic!("Could not connect: {err}");
}
}
Ok(x) => {
con = x;
break;
}
}
}
redis::cmd("FLUSHDB").execute(&mut con);

TestContext {
server,
client,
protocol: use_protocol(),
}
}

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();

let mut con;

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}");
panic!(
"Tried to connect too many times, last error: {err}, logfile: {}",
server.log_file_contents()
);
}
} else {
panic!("Could not connect: {err}");
panic!(
"Could not connect: {err}, logfile: {}",
server.log_file_contents()
);
}
}
Ok(x) => {
Expand Down