feat(readarr): fetch Readarr logs and expose them on the CLI

Adds ReadarrEvent::GetLogs backed by get_readarr_logs, which formats each
record into the Readarr logs list, and surfaces it as
'readarr list logs --events N'.

The --output-in-log-format branch reads the Readarr log lines, and is
covered by a test that pins that source so it cannot silently drift to
another servarr's data.
This commit is contained in:
Dark-Alex-17 committed 2026-08-20 21:33:57 -06:00
1 parent c6d729162a
commit 690a17e152
6 files changed
+276 -9

No files matched your search

+30 -3
View File
@@ -19,6 +19,16 @@ mod list_command_handler_tests;
pub enum ReadarrListCommand {
#[command(about = "List disk space details for all provisioned root folders in Readarr")]
DiskSpace,
#[command(about = "Fetch Readarr logs")]
Logs {
#[arg(long, help = "How many log events to fetch", default_value_t = 500)]
events: u64,
#[arg(
long,
help = "Output the logs in the same format as they appear in the log files"
)]
output_in_log_format: bool,
},
#[command(about = "List all Readarr updates")]
Updates,
}
@@ -30,19 +40,19 @@ impl From<ReadarrListCommand> for Command {
}
pub(super) struct ReadarrListCommandHandler<'a, 'b> {
_app: &'a Arc<Mutex<App<'b>>>,
app: &'a Arc<Mutex<App<'b>>>,
command: ReadarrListCommand,
network: &'a mut dyn NetworkTrait,
}
impl<'a, 'b> CliCommandHandler<'a, 'b, ReadarrListCommand> for ReadarrListCommandHandler<'a, 'b> {
fn with(
_app: &'a Arc<Mutex<App<'b>>>,
app: &'a Arc<Mutex<App<'b>>>,
command: ReadarrListCommand,
network: &'a mut dyn NetworkTrait,
) -> Self {
ReadarrListCommandHandler {
_app,
app,
command,
network,
}
@@ -57,6 +67,23 @@ impl<'a, 'b> CliCommandHandler<'a, 'b, ReadarrListCommand> for ReadarrListComman
.await?;
serde_json::to_string_pretty(&resp)?
}
ReadarrListCommand::Logs {
events,
output_in_log_format,
} => {
let logs = self
.network
.handle_network_event(ReadarrEvent::GetLogs(events).into())
.await?;
if output_in_log_format {
let log_lines = &self.app.lock().await.data.readarr_data.logs.items;
serde_json::to_string_pretty(log_lines)?
} else {
serde_json::to_string_pretty(&logs)?
}
}
ReadarrListCommand::Updates => {
let resp = self
.network
+92 -3
View File
@@ -18,9 +18,10 @@ mod tests {
}
mod cli {
use rstest::rstest;
use super::*;
use clap::{Parser, error::ErrorKind};
use pretty_assertions::assert_eq;
use rstest::rstest;
#[rstest]
fn test_list_commands_have_no_arg_requirements(
@@ -30,12 +31,39 @@ mod tests {
assert_ok!(&result);
}
#[test]
fn test_list_logs_events_flag_requires_arguments() {
let result =
Cli::command().try_get_matches_from(["managarr", "readarr", "list", "logs", "--events"]);
assert_err!(&result);
assert_eq!(result.unwrap_err().kind(), ErrorKind::InvalidValue);
}
#[test]
fn test_list_logs_default_values() {
let expected_args = ReadarrListCommand::Logs {
events: 500,
output_in_log_format: false,
};
let result = Cli::try_parse_from(["managarr", "readarr", "list", "logs"]);
assert_ok!(&result);
let Some(Command::Readarr(ReadarrCommand::List(logs_command))) = result.unwrap().command
else {
panic!("Unexpected command type");
};
assert_eq!(logs_command, expected_args);
}
}
mod handler {
use std::sync::Arc;
use mockall::predicate::eq;
use pretty_assertions::assert_str_eq;
use serde_json::json;
use tokio::sync::Mutex;
@@ -45,7 +73,7 @@ mod tests {
CliCommandHandler,
readarr::list_command_handler::{ReadarrListCommand, ReadarrListCommandHandler},
},
models::{Serdeable, readarr_models::ReadarrSerdeable},
models::{HorizontallyScrollableText, Serdeable, readarr_models::ReadarrSerdeable},
network::{MockNetworkTrait, NetworkEvent, readarr_network::ReadarrEvent},
};
@@ -72,6 +100,67 @@ mod tests {
assert_ok!(&result);
}
#[tokio::test]
async fn test_handle_list_logs_command() {
let expected_events = 1000;
let mut mock_network = MockNetworkTrait::new();
mock_network
.expect_handle_network_event()
.with(eq::<NetworkEvent>(
ReadarrEvent::GetLogs(expected_events).into(),
))
.times(1)
.returning(|_| {
Ok(Serdeable::Readarr(ReadarrSerdeable::Value(
json!({"testResponse": "response"}),
)))
});
let app_arc = Arc::new(Mutex::new(App::test_default()));
let list_logs_command = ReadarrListCommand::Logs {
events: 1000,
output_in_log_format: false,
};
let result = ReadarrListCommandHandler::with(&app_arc, list_logs_command, &mut mock_network)
.handle()
.await;
assert_ok!(&result);
}
#[tokio::test]
async fn test_handle_list_logs_command_output_in_log_format() {
let mut mock_network = MockNetworkTrait::new();
mock_network
.expect_handle_network_event()
.with(eq::<NetworkEvent>(ReadarrEvent::GetLogs(1000).into()))
.times(1)
.returning(|_| {
Ok(Serdeable::Readarr(ReadarrSerdeable::Value(
json!({"testResponse": "response"}),
)))
});
let app_arc = Arc::new(Mutex::new(App::test_default()));
app_arc
.lock()
.await
.data
.readarr_data
.logs
.set_items(vec![HorizontallyScrollableText::from("readarr log line")]);
let list_logs_command = ReadarrListCommand::Logs {
events: 1000,
output_in_log_format: true,
};
let result = ReadarrListCommandHandler::with(&app_arc, list_logs_command, &mut mock_network)
.handle()
.await;
assert_ok!(&result);
assert_str_eq!(result.unwrap(), "[\n \"readarr log line\"\n]");
}
#[tokio::test]
async fn test_handle_list_updates_command() {
let mut mock_network = MockNetworkTrait::new();