feat(readarr): test an indexer and expose the command on the CLI
Fetch the indexer's full details, then post them back verbatim to the test endpoint. The payload round-trips through serde_json::Value so the fields Indexer does not model, such as infoLink and the per-field label and type metadata, survive the round trip intact. A successful test returns an empty JSON object and clears indexer_test_errors; a failure returns an array whose first entry carries the error message. The test endpoint reports failures with a non-2xx status, so the request ignores the status code and parses the body either way.
This commit is contained in:
6 files changed
+267
No files matched your search
@@ -110,6 +110,13 @@ pub enum ReadarrCommand {
|
|||||||
)]
|
)]
|
||||||
task_name: ReadarrTaskName,
|
task_name: ReadarrTaskName,
|
||||||
},
|
},
|
||||||
|
#[command(
|
||||||
|
about = "Test the indexer with the given ID. Note that a successful test returns an empty JSON body; i.e. '{}'"
|
||||||
|
)]
|
||||||
|
TestIndexer {
|
||||||
|
#[arg(long, help = "The ID of the indexer to test", required = true)]
|
||||||
|
indexer_id: i64,
|
||||||
|
},
|
||||||
#[command(
|
#[command(
|
||||||
about = "Toggle monitoring for the specified author corresponding to the given author ID"
|
about = "Toggle monitoring for the specified author corresponding to the given author ID"
|
||||||
)]
|
)]
|
||||||
@@ -240,6 +247,13 @@ impl<'a, 'b> CliCommandHandler<'a, 'b, ReadarrCommand> for ReadarrCliHandler<'a,
|
|||||||
.await?;
|
.await?;
|
||||||
serde_json::to_string_pretty(&resp)?
|
serde_json::to_string_pretty(&resp)?
|
||||||
}
|
}
|
||||||
|
ReadarrCommand::TestIndexer { indexer_id } => {
|
||||||
|
let resp = self
|
||||||
|
.network
|
||||||
|
.handle_network_event(ReadarrEvent::TestIndexer(indexer_id).into())
|
||||||
|
.await?;
|
||||||
|
serde_json::to_string_pretty(&resp)?
|
||||||
|
}
|
||||||
ReadarrCommand::ToggleAuthorMonitoring { author_id } => {
|
ReadarrCommand::ToggleAuthorMonitoring { author_id } => {
|
||||||
let resp = self
|
let resp = self
|
||||||
.network
|
.network
|
||||||
|
|||||||
@@ -151,6 +151,30 @@ mod tests {
|
|||||||
assert_ok!(&result);
|
assert_ok!(&result);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_test_indexer_requires_indexer_id() {
|
||||||
|
let result = Cli::command().try_get_matches_from(["managarr", "readarr", "test-indexer"]);
|
||||||
|
|
||||||
|
assert_err!(&result);
|
||||||
|
assert_eq!(
|
||||||
|
result.unwrap_err().kind(),
|
||||||
|
ErrorKind::MissingRequiredArgument
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_test_indexer_requirements_satisfied() {
|
||||||
|
let result = Cli::command().try_get_matches_from([
|
||||||
|
"managarr",
|
||||||
|
"readarr",
|
||||||
|
"test-indexer",
|
||||||
|
"--indexer-id",
|
||||||
|
"8",
|
||||||
|
]);
|
||||||
|
|
||||||
|
assert_ok!(&result);
|
||||||
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn test_toggle_author_monitoring_requires_author_id() {
|
fn test_toggle_author_monitoring_requires_author_id() {
|
||||||
let result =
|
let result =
|
||||||
@@ -346,6 +370,31 @@ mod tests {
|
|||||||
assert_ok!(&result);
|
assert_ok!(&result);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_test_indexer_command() {
|
||||||
|
let expected_indexer_id = 8;
|
||||||
|
let mut mock_network = MockNetworkTrait::new();
|
||||||
|
mock_network
|
||||||
|
.expect_handle_network_event()
|
||||||
|
.with(eq::<NetworkEvent>(
|
||||||
|
ReadarrEvent::TestIndexer(expected_indexer_id).into(),
|
||||||
|
))
|
||||||
|
.times(1)
|
||||||
|
.returning(|_| {
|
||||||
|
Ok(Serdeable::Readarr(ReadarrSerdeable::Value(
|
||||||
|
json!({"testResponse": "response"}),
|
||||||
|
)))
|
||||||
|
});
|
||||||
|
let app_arc = Arc::new(Mutex::new(App::test_default()));
|
||||||
|
let test_indexer_command = ReadarrCommand::TestIndexer { indexer_id: 8 };
|
||||||
|
|
||||||
|
let result = ReadarrCliHandler::with(&app_arc, test_indexer_command, &mut mock_network)
|
||||||
|
.handle()
|
||||||
|
.await;
|
||||||
|
|
||||||
|
assert_ok!(&result);
|
||||||
|
}
|
||||||
|
|
||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn test_toggle_author_monitoring_command() {
|
async fn test_toggle_author_monitoring_command() {
|
||||||
let mut mock_network = MockNetworkTrait::new();
|
let mut mock_network = MockNetworkTrait::new();
|
||||||
|
|||||||
@@ -263,4 +263,56 @@ impl Network<'_, '_> {
|
|||||||
})
|
})
|
||||||
.await
|
.await
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub(in crate::network::readarr_network) async fn test_readarr_indexer(
|
||||||
|
&mut self,
|
||||||
|
indexer_id: i64,
|
||||||
|
) -> Result<Value> {
|
||||||
|
let detail_event = ReadarrEvent::GetIndexers;
|
||||||
|
let event = ReadarrEvent::TestIndexer(indexer_id);
|
||||||
|
info!("Testing Readarr indexer with ID: {indexer_id}");
|
||||||
|
|
||||||
|
info!("Fetching indexer details for indexer with ID: {indexer_id}");
|
||||||
|
|
||||||
|
let request_props = self
|
||||||
|
.request_props_from(
|
||||||
|
detail_event,
|
||||||
|
RequestMethod::Get,
|
||||||
|
None::<()>,
|
||||||
|
Some(format!("/{indexer_id}")),
|
||||||
|
None,
|
||||||
|
)
|
||||||
|
.await;
|
||||||
|
|
||||||
|
let mut test_body: Value = Value::default();
|
||||||
|
|
||||||
|
self
|
||||||
|
.handle_request::<(), Value>(request_props, |detailed_indexer_body, _| {
|
||||||
|
test_body = detailed_indexer_body;
|
||||||
|
})
|
||||||
|
.await?;
|
||||||
|
|
||||||
|
info!("Testing indexer");
|
||||||
|
|
||||||
|
let mut request_props = self
|
||||||
|
.request_props_from(event, RequestMethod::Post, Some(test_body), None, None)
|
||||||
|
.await;
|
||||||
|
request_props.ignore_status_code = true;
|
||||||
|
|
||||||
|
self
|
||||||
|
.handle_request::<Value, Value>(request_props, |test_results, mut app| {
|
||||||
|
if test_results.as_object().is_none() {
|
||||||
|
let error_message = test_results
|
||||||
|
.as_array()
|
||||||
|
.and_then(|arr| arr.first())
|
||||||
|
.and_then(|item| item.get("errorMessage"))
|
||||||
|
.map(|msg| msg.to_string())
|
||||||
|
.unwrap_or_else(|| "Unknown indexer test error".to_string());
|
||||||
|
app.data.readarr_data.indexer_test_errors = Some(error_message);
|
||||||
|
} else {
|
||||||
|
app.data.readarr_data.indexer_test_errors = Some(String::new());
|
||||||
|
};
|
||||||
|
})
|
||||||
|
.await
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -425,4 +425,149 @@ mod tests {
|
|||||||
async_edit_server.assert_async().await;
|
async_edit_server.assert_async().await;
|
||||||
assert_err!(result);
|
assert_err!(result);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_handle_test_readarr_indexer_event() {
|
||||||
|
let expected_body: Value = serde_json::from_str(INDEXER_JSON).unwrap();
|
||||||
|
let (async_details_server, app, mut server) = MockServarrApi::get()
|
||||||
|
.returns(serde_json::from_str(INDEXER_JSON).unwrap())
|
||||||
|
.path("/8")
|
||||||
|
.build_for(ReadarrEvent::GetIndexers)
|
||||||
|
.await;
|
||||||
|
let async_test_server = server
|
||||||
|
.mock(
|
||||||
|
"POST",
|
||||||
|
format!("/api/v1{}", ReadarrEvent::TestIndexer(8).resource()).as_str(),
|
||||||
|
)
|
||||||
|
.with_status(200)
|
||||||
|
.match_header("X-Api-Key", "test1234")
|
||||||
|
.match_body(Matcher::Json(expected_body))
|
||||||
|
.with_body("{}")
|
||||||
|
.create_async()
|
||||||
|
.await;
|
||||||
|
{
|
||||||
|
let mut app = app.lock().await;
|
||||||
|
app.server_tabs.set_index(3);
|
||||||
|
app.data.readarr_data.indexer_test_errors = Some("stale error".to_owned());
|
||||||
|
}
|
||||||
|
let mut network = test_network(&app);
|
||||||
|
|
||||||
|
let result = network
|
||||||
|
.handle_readarr_event(ReadarrEvent::TestIndexer(8))
|
||||||
|
.await;
|
||||||
|
|
||||||
|
async_details_server.assert_async().await;
|
||||||
|
async_test_server.assert_async().await;
|
||||||
|
assert_ok!(&result);
|
||||||
|
let app = app.lock().await;
|
||||||
|
assert_some_eq_x!(&app.data.readarr_data.indexer_test_errors, &String::new());
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_handle_test_readarr_indexer_event_captures_validation_errors() {
|
||||||
|
let expected_body: Value = serde_json::from_str(INDEXER_JSON).unwrap();
|
||||||
|
let (async_details_server, app, mut server) = MockServarrApi::get()
|
||||||
|
.returns(serde_json::from_str(INDEXER_JSON).unwrap())
|
||||||
|
.path("/8")
|
||||||
|
.build_for(ReadarrEvent::GetIndexers)
|
||||||
|
.await;
|
||||||
|
let async_test_server = server
|
||||||
|
.mock(
|
||||||
|
"POST",
|
||||||
|
format!("/api/v1{}", ReadarrEvent::TestIndexer(8).resource()).as_str(),
|
||||||
|
)
|
||||||
|
.with_status(400)
|
||||||
|
.match_header("X-Api-Key", "test1234")
|
||||||
|
.match_body(Matcher::Json(expected_body))
|
||||||
|
.with_body(json!([{ "errorMessage": "Unable to connect to indexer" }]).to_string())
|
||||||
|
.create_async()
|
||||||
|
.await;
|
||||||
|
{
|
||||||
|
let mut app = app.lock().await;
|
||||||
|
app.server_tabs.set_index(3);
|
||||||
|
app.data.readarr_data.indexer_test_errors = Some("stale error".to_owned());
|
||||||
|
}
|
||||||
|
let mut network = test_network(&app);
|
||||||
|
|
||||||
|
let result = network
|
||||||
|
.handle_readarr_event(ReadarrEvent::TestIndexer(8))
|
||||||
|
.await;
|
||||||
|
|
||||||
|
async_details_server.assert_async().await;
|
||||||
|
async_test_server.assert_async().await;
|
||||||
|
assert_ok!(&result);
|
||||||
|
let app = app.lock().await;
|
||||||
|
assert_some_eq_x!(
|
||||||
|
&app.data.readarr_data.indexer_test_errors,
|
||||||
|
&"\"Unable to connect to indexer\"".to_owned()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_handle_test_readarr_indexer_event_falls_back_to_a_generic_error_message() {
|
||||||
|
let expected_body: Value = serde_json::from_str(INDEXER_JSON).unwrap();
|
||||||
|
let (async_details_server, app, mut server) = MockServarrApi::get()
|
||||||
|
.returns(serde_json::from_str(INDEXER_JSON).unwrap())
|
||||||
|
.path("/8")
|
||||||
|
.build_for(ReadarrEvent::GetIndexers)
|
||||||
|
.await;
|
||||||
|
let async_test_server = server
|
||||||
|
.mock(
|
||||||
|
"POST",
|
||||||
|
format!("/api/v1{}", ReadarrEvent::TestIndexer(8).resource()).as_str(),
|
||||||
|
)
|
||||||
|
.with_status(400)
|
||||||
|
.match_header("X-Api-Key", "test1234")
|
||||||
|
.match_body(Matcher::Json(expected_body))
|
||||||
|
.with_body("[]")
|
||||||
|
.create_async()
|
||||||
|
.await;
|
||||||
|
{
|
||||||
|
let mut app = app.lock().await;
|
||||||
|
app.server_tabs.set_index(3);
|
||||||
|
app.data.readarr_data.indexer_test_errors = Some("stale error".to_owned());
|
||||||
|
}
|
||||||
|
let mut network = test_network(&app);
|
||||||
|
|
||||||
|
let result = network
|
||||||
|
.handle_readarr_event(ReadarrEvent::TestIndexer(8))
|
||||||
|
.await;
|
||||||
|
|
||||||
|
async_details_server.assert_async().await;
|
||||||
|
async_test_server.assert_async().await;
|
||||||
|
assert_ok!(&result);
|
||||||
|
let app = app.lock().await;
|
||||||
|
assert_some_eq_x!(
|
||||||
|
&app.data.readarr_data.indexer_test_errors,
|
||||||
|
&"Unknown indexer test error".to_owned()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn test_handle_test_readarr_indexer_event_failure() {
|
||||||
|
let (async_details_server, app, _server) = MockServarrApi::get()
|
||||||
|
.returns(serde_json::from_str(INDEXER_JSON).unwrap())
|
||||||
|
.path("/8")
|
||||||
|
.status(500)
|
||||||
|
.build_for(ReadarrEvent::GetIndexers)
|
||||||
|
.await;
|
||||||
|
{
|
||||||
|
let mut app = app.lock().await;
|
||||||
|
app.server_tabs.set_index(3);
|
||||||
|
app.data.readarr_data.indexer_test_errors = Some("stale error".to_owned());
|
||||||
|
}
|
||||||
|
let mut network = test_network(&app);
|
||||||
|
|
||||||
|
let result = network
|
||||||
|
.handle_readarr_event(ReadarrEvent::TestIndexer(8))
|
||||||
|
.await;
|
||||||
|
|
||||||
|
async_details_server.assert_async().await;
|
||||||
|
assert_err!(result);
|
||||||
|
let app = app.lock().await;
|
||||||
|
assert_some_eq_x!(
|
||||||
|
&app.data.readarr_data.indexer_test_errors,
|
||||||
|
&"stale error".to_owned()
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
@@ -75,6 +75,7 @@ pub enum ReadarrEvent {
|
|||||||
MarkHistoryItemAsFailed(i64),
|
MarkHistoryItemAsFailed(i64),
|
||||||
SearchNewAuthor(String),
|
SearchNewAuthor(String),
|
||||||
StartTask(ReadarrTaskName),
|
StartTask(ReadarrTaskName),
|
||||||
|
TestIndexer(i64),
|
||||||
ToggleAuthorMonitoring(i64),
|
ToggleAuthorMonitoring(i64),
|
||||||
ToggleBookMonitoring(i64),
|
ToggleBookMonitoring(i64),
|
||||||
TriggerAutomaticAuthorSearch(i64),
|
TriggerAutomaticAuthorSearch(i64),
|
||||||
@@ -119,6 +120,7 @@ impl NetworkResource for ReadarrEvent {
|
|||||||
ReadarrEvent::DeleteIndexer(_) | ReadarrEvent::EditIndexer(_) | ReadarrEvent::GetIndexers => {
|
ReadarrEvent::DeleteIndexer(_) | ReadarrEvent::EditIndexer(_) | ReadarrEvent::GetIndexers => {
|
||||||
"/indexer"
|
"/indexer"
|
||||||
}
|
}
|
||||||
|
ReadarrEvent::TestIndexer(_) => "/indexer/test",
|
||||||
ReadarrEvent::GetLogs(_) => "/log",
|
ReadarrEvent::GetLogs(_) => "/log",
|
||||||
ReadarrEvent::GetMetadataProfiles => "/metadataprofile",
|
ReadarrEvent::GetMetadataProfiles => "/metadataprofile",
|
||||||
ReadarrEvent::GetQualityProfiles => "/qualityprofile",
|
ReadarrEvent::GetQualityProfiles => "/qualityprofile",
|
||||||
@@ -306,6 +308,10 @@ impl Network<'_, '_> {
|
|||||||
.start_readarr_task(task_name)
|
.start_readarr_task(task_name)
|
||||||
.await
|
.await
|
||||||
.map(ReadarrSerdeable::from),
|
.map(ReadarrSerdeable::from),
|
||||||
|
ReadarrEvent::TestIndexer(indexer_id) => self
|
||||||
|
.test_readarr_indexer(indexer_id)
|
||||||
|
.await
|
||||||
|
.map(ReadarrSerdeable::from),
|
||||||
ReadarrEvent::ToggleAuthorMonitoring(author_id) => self
|
ReadarrEvent::ToggleAuthorMonitoring(author_id) => self
|
||||||
.toggle_author_monitoring(author_id)
|
.toggle_author_monitoring(author_id)
|
||||||
.await
|
.await
|
||||||
|
|||||||
@@ -52,6 +52,7 @@ mod tests {
|
|||||||
#[case(ReadarrEvent::DeleteIndexer(1), "/indexer")]
|
#[case(ReadarrEvent::DeleteIndexer(1), "/indexer")]
|
||||||
#[case(ReadarrEvent::EditIndexer(EditIndexerParams::default()), "/indexer")]
|
#[case(ReadarrEvent::EditIndexer(EditIndexerParams::default()), "/indexer")]
|
||||||
#[case(ReadarrEvent::GetIndexers, "/indexer")]
|
#[case(ReadarrEvent::GetIndexers, "/indexer")]
|
||||||
|
#[case(ReadarrEvent::TestIndexer(8), "/indexer/test")]
|
||||||
#[case(ReadarrEvent::GetLogs(500), "/log")]
|
#[case(ReadarrEvent::GetLogs(500), "/log")]
|
||||||
#[case(ReadarrEvent::GetMetadataProfiles, "/metadataprofile")]
|
#[case(ReadarrEvent::GetMetadataProfiles, "/metadataprofile")]
|
||||||
#[case(ReadarrEvent::GetQualityProfiles, "/qualityprofile")]
|
#[case(ReadarrEvent::GetQualityProfiles, "/qualityprofile")]
|
||||||
|
|||||||
Reference in new issue
Block a user