feat(readarr): delete Readarr authors and expose the command on the CLI

This commit is contained in:
Dark-Alex-17 committed 2026-08-27 09:54:38 -06:00
1 parent fcfc29894e
commit ac8a11233f
7 files changed
+249 -6

No files matched your search

+26
View File
@@ -8,6 +8,7 @@ use super::ReadarrCommand;
use crate::{
app::App,
cli::{CliCommandHandler, Command},
models::readarr_models::DeleteParams,
network::{NetworkTrait, readarr_network::ReadarrEvent},
};
@@ -17,6 +18,15 @@ mod delete_command_handler_tests;
#[derive(Debug, Clone, PartialEq, Eq, Subcommand)]
pub enum ReadarrDeleteCommand {
#[command(about = "Delete an author from your Readarr library")]
Author {
#[arg(long, help = "The ID of the author to delete", required = true)]
author_id: i64,
#[arg(long, help = "Delete the author files from disk as well")]
delete_files_from_disk: bool,
#[arg(long, help = "Add a list exclusion for this author")]
add_list_exclusion: bool,
},
#[command(about = "Delete the root folder with the given ID")]
RootFolder {
#[arg(long, help = "The ID of the root folder to delete", required = true)]
@@ -58,6 +68,22 @@ impl<'a, 'b> CliCommandHandler<'a, 'b, ReadarrDeleteCommand>
async fn handle(self) -> Result<String> {
let result = match self.command {
ReadarrDeleteCommand::Author {
author_id,
delete_files_from_disk,
add_list_exclusion,
} => {
let delete_author_params = DeleteParams {
id: author_id,
delete_files: delete_files_from_disk,
add_import_list_exclusion: add_list_exclusion,
};
let resp = self
.network
.handle_network_event(ReadarrEvent::DeleteAuthor(delete_author_params).into())
.await?;
serde_json::to_string_pretty(&resp)?
}
ReadarrDeleteCommand::RootFolder { root_folder_id } => {
let resp = self
.network
+115 -1
View File
@@ -24,6 +24,86 @@ mod tests {
use super::*;
use pretty_assertions::assert_eq;
#[test]
fn test_delete_author_requires_arguments() {
let result = Cli::command().try_get_matches_from(["managarr", "readarr", "delete", "author"]);
assert_err!(&result);
assert_eq!(
result.unwrap_err().kind(),
ErrorKind::MissingRequiredArgument
);
}
#[test]
fn test_delete_author_author_id_requires_a_number() {
let result = Cli::command().try_get_matches_from([
"managarr",
"readarr",
"delete",
"author",
"--author-id",
"not_a_number",
]);
assert_err!(&result);
assert_eq!(result.unwrap_err().kind(), ErrorKind::ValueValidation);
}
#[test]
fn test_delete_author_defaults() {
let expected_args = ReadarrDeleteCommand::Author {
author_id: 1,
delete_files_from_disk: false,
add_list_exclusion: false,
};
let result = Cli::try_parse_from([
"managarr",
"readarr",
"delete",
"author",
"--author-id",
"1",
]);
assert_ok!(&result);
let Some(Command::Readarr(ReadarrCommand::Delete(delete_command))) = result.unwrap().command
else {
panic!("Unexpected command type");
};
assert_eq!(delete_command, expected_args);
}
#[test]
fn test_delete_author_all_args_defined() {
let expected_args = ReadarrDeleteCommand::Author {
author_id: 1,
delete_files_from_disk: true,
add_list_exclusion: true,
};
let result = Cli::try_parse_from([
"managarr",
"readarr",
"delete",
"author",
"--author-id",
"1",
"--delete-files-from-disk",
"--add-list-exclusion",
]);
assert_ok!(&result);
let Some(Command::Readarr(ReadarrCommand::Delete(delete_command))) = result.unwrap().command
else {
panic!("Unexpected command type");
};
assert_eq!(delete_command, expected_args);
}
#[test]
fn test_delete_root_folder_requires_arguments() {
let result =
@@ -127,13 +207,47 @@ mod tests {
ReadarrDeleteCommand, ReadarrDeleteCommandHandler,
};
use crate::models::Serdeable;
use crate::models::readarr_models::ReadarrSerdeable;
use crate::models::readarr_models::{DeleteParams, ReadarrSerdeable};
use crate::network::readarr_network::ReadarrEvent;
use crate::{
app::App,
network::{MockNetworkTrait, NetworkEvent},
};
#[tokio::test]
async fn test_handle_delete_author_command() {
let expected_delete_author_params = DeleteParams {
id: 1,
delete_files: true,
add_import_list_exclusion: false,
};
let mut mock_network = MockNetworkTrait::new();
mock_network
.expect_handle_network_event()
.with(eq::<NetworkEvent>(
ReadarrEvent::DeleteAuthor(expected_delete_author_params).into(),
))
.times(1)
.returning(|_| {
Ok(Serdeable::Readarr(ReadarrSerdeable::Value(
json!({"testResponse": "response"}),
)))
});
let app_arc = Arc::new(Mutex::new(App::test_default()));
let delete_author_command = ReadarrDeleteCommand::Author {
author_id: 1,
delete_files_from_disk: true,
add_list_exclusion: false,
};
let result =
ReadarrDeleteCommandHandler::with(&app_arc, delete_author_command, &mut mock_network)
.handle()
.await;
assert_ok!(&result);
}
#[tokio::test]
async fn test_handle_delete_root_folder_command() {
let mut mock_network = MockNetworkTrait::new();
+8
View File
@@ -220,6 +220,14 @@ pub struct AddAuthorSearchResult {
pub ratings: Option<Ratings>,
}
#[derive(Serialize, Deserialize, Debug, Default, Clone, Eq, PartialEq)]
#[serde(rename_all = "lowercase")]
pub struct DeleteParams {
pub id: i64,
pub delete_files: bool,
pub add_import_list_exclusion: bool,
}
#[derive(Default, Clone, Serialize, Debug, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct AddAuthorBody {
@@ -4,7 +4,7 @@ use serde_json::{Value, json};
use crate::models::Route;
use crate::models::readarr_models::{
AddAuthorBody, AddAuthorSearchResult, Author, EditAuthorParams,
AddAuthorBody, AddAuthorSearchResult, Author, DeleteParams, EditAuthorParams,
};
use crate::models::servarr_data::readarr::readarr_data::ActiveReadarrBlock;
use crate::models::stateful_table::StatefulTable;
@@ -45,6 +45,38 @@ impl Network<'_, '_> {
.await
}
pub(in crate::network::readarr_network) async fn delete_author(
&mut self,
delete_author_params: DeleteParams,
) -> Result<()> {
let event = ReadarrEvent::DeleteAuthor(DeleteParams::default());
let DeleteParams {
id,
delete_files,
add_import_list_exclusion,
} = delete_author_params;
info!(
"Deleting Readarr author with ID: {id} with deleteFiles={delete_files} and addImportListExclusion={add_import_list_exclusion}"
);
let request_props = self
.request_props_from(
event,
RequestMethod::Delete,
None::<()>,
Some(format!("/{id}")),
Some(format!(
"deleteFiles={delete_files}&addImportListExclusion={add_import_list_exclusion}"
)),
)
.await;
self
.handle_request::<(), ()>(request_props, |_, _| ())
.await
}
pub(in crate::network::readarr_network) async fn edit_author(
&mut self,
mut edit_author_params: EditAuthorParams,
@@ -1,8 +1,8 @@
#[cfg(test)]
mod tests {
use crate::models::readarr_models::{
AddAuthorBody, AddAuthorSearchResult, Author, EditAuthorParams, NewItemMonitorType,
ReadarrSerdeable,
AddAuthorBody, AddAuthorSearchResult, Author, DeleteParams, EditAuthorParams,
NewItemMonitorType, ReadarrSerdeable,
};
use crate::models::servarr_data::readarr::readarr_data::ActiveReadarrBlock;
use crate::models::stateful_table::StatefulTable;
@@ -16,6 +16,7 @@ mod tests {
use bimap::BiMap;
use mockito::Matcher;
use pretty_assertions::assert_eq;
use rstest::rstest;
use serde_json::{Value, json};
#[tokio::test]
@@ -625,4 +626,58 @@ mod tests {
async_edit_server.assert_async().await;
assert_err!(result);
}
#[rstest]
#[case(true, false, "deleteFiles=true&addImportListExclusion=false")]
#[case(false, true, "deleteFiles=false&addImportListExclusion=true")]
#[tokio::test]
async fn test_handle_delete_author_event(
#[case] delete_files: bool,
#[case] add_import_list_exclusion: bool,
#[case] expected_query: &str,
) {
let delete_author_params = DeleteParams {
id: 1,
delete_files,
add_import_list_exclusion,
};
let (mock, app, _server) = MockServarrApi::delete()
.path("/1")
.query(expected_query)
.build_for(ReadarrEvent::DeleteAuthor(delete_author_params.clone()))
.await;
app.lock().await.server_tabs.set_index(3);
let mut network = test_network(&app);
let result = network
.handle_readarr_event(ReadarrEvent::DeleteAuthor(delete_author_params))
.await;
mock.assert_async().await;
assert_ok!(result);
}
#[tokio::test]
async fn test_handle_delete_author_event_failure() {
let delete_author_params = DeleteParams {
id: 1,
delete_files: true,
add_import_list_exclusion: false,
};
let (mock, app, _server) = MockServarrApi::delete()
.path("/1")
.query("deleteFiles=true&addImportListExclusion=false")
.status(500)
.build_for(ReadarrEvent::DeleteAuthor(delete_author_params.clone()))
.await;
app.lock().await.server_tabs.set_index(3);
let mut network = test_network(&app);
let result = network
.handle_readarr_event(ReadarrEvent::DeleteAuthor(delete_author_params))
.await;
mock.assert_async().await;
assert_err!(result);
}
}
+8 -1
View File
@@ -4,7 +4,8 @@ use serde_json::{Value, json};
use super::{NetworkEvent, NetworkResource};
use crate::models::readarr_models::{
AddAuthorBody, AddReadarrRootFolderBody, EditAuthorParams, ReadarrSerdeable, ReadarrTaskName,
AddAuthorBody, AddReadarrRootFolderBody, DeleteParams, EditAuthorParams, ReadarrSerdeable,
ReadarrTaskName,
};
use crate::models::servarr_models::{MetadataProfile, QualityProfile, Tag};
use crate::network::{Network, RequestMethod};
@@ -26,6 +27,7 @@ pub enum ReadarrEvent {
AddAuthor(AddAuthorBody),
AddRootFolder(AddReadarrRootFolderBody),
AddTag(String),
DeleteAuthor(DeleteParams),
DeleteRootFolder(i64),
DeleteTag(i64),
EditAuthor(EditAuthorParams),
@@ -52,6 +54,7 @@ impl NetworkResource for ReadarrEvent {
fn resource(&self) -> &'static str {
match &self {
ReadarrEvent::AddAuthor(_)
| ReadarrEvent::DeleteAuthor(_)
| ReadarrEvent::EditAuthor(_)
| ReadarrEvent::GetAuthorDetails(_)
| ReadarrEvent::ListAuthors => "/author",
@@ -92,6 +95,10 @@ impl Network<'_, '_> {
.await
.map(ReadarrSerdeable::from),
ReadarrEvent::AddTag(tag) => self.add_readarr_tag(tag).await.map(ReadarrSerdeable::from),
ReadarrEvent::DeleteAuthor(delete_author_params) => self
.delete_author(delete_author_params)
.await
.map(ReadarrSerdeable::from),
ReadarrEvent::DeleteRootFolder(root_folder_id) => self
.delete_readarr_root_folder(root_folder_id)
.await
@@ -2,7 +2,7 @@
mod tests {
use crate::app::App;
use crate::models::readarr_models::{
AddAuthorBody, AddReadarrRootFolderBody, EditAuthorParams, ReadarrSerdeable,
AddAuthorBody, AddReadarrRootFolderBody, DeleteParams, EditAuthorParams, ReadarrSerdeable,
};
use crate::models::servarr_models::{MetadataProfile, QualityProfile, Tag};
use crate::network::network_tests::test_utils::{MockServarrApi, test_network};
@@ -16,6 +16,7 @@ mod tests {
#[rstest]
#[case(ReadarrEvent::AddAuthor(AddAuthorBody::default()), "/author")]
#[case(ReadarrEvent::DeleteAuthor(DeleteParams::default()), "/author")]
#[case(ReadarrEvent::EditAuthor(EditAuthorParams::default()), "/author")]
#[case(ReadarrEvent::GetAuthorDetails(1), "/author")]
#[case(ReadarrEvent::ListAuthors, "/author")]