Dark-Alex-17/managarr
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: CLI support for deleting an album from Lidarr

Browse Source
This commit is contained in:
Alex Clarke
2026-01-09 16:33:32 -07:00
parent b2814371f0
commit 09bee7473f
14 changed files with 402 additions and 212 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/network/lidarr_network/library/albums/lidarr_albums_network_tests.rs
+112 -87
View File
@@ -1,106 +1,131 @@
#[cfg(test)]
mod tests {
use mockito::Matcher;
use pretty_assertions::assert_eq;
use serde_json::{json, Value};
use crate::models::lidarr_models::{Album, LidarrSerdeable};
use crate::network::lidarr_network::lidarr_network_test_utils::test_utils::{ALBUM_JSON};
use crate::network::lidarr_network::LidarrEvent;
use crate::network::network_tests::test_utils::{test_network, MockServarrApi};
use crate::models::lidarr_models::{Album, DeleteParams, LidarrSerdeable};
use crate::network::lidarr_network::LidarrEvent;
use crate::network::lidarr_network::lidarr_network_test_utils::test_utils::ALBUM_JSON;
use crate::network::network_tests::test_utils::{MockServarrApi, test_network};
use mockito::Matcher;
use pretty_assertions::assert_eq;
use serde_json::{Value, json};
#[tokio::test]
async fn test_handle_get_albums_event() {
let albums_json = json!([{
#[tokio::test]
async fn test_handle_get_albums_event() {
let albums_json = json!([{
"id": 1,
"title": "Test Album",
"foreignAlbumId": "test-foreign-album-id",
"monitored": true,
"anyReleaseOk": true,
"profileId": 1,
"duration": 180,
"albumType": "Album",
"genres": ["Classical"],
"ratings": {"votes": 15, "value": 8.4},
"releaseDate": "2023-01-01T00:00:00Z",
"statistics": {
"trackFileCount": 10,
"trackCount": 10,
"totalTrackCount": 10,
"sizeOnDisk": 1024,
"percentOfTracks": 99.9
}
"foreignAlbumId": "test-foreign-album-id",
"monitored": true,
"anyReleaseOk": true,
"profileId": 1,
"duration": 180,
"albumType": "Album",
"genres": ["Classical"],
"ratings": {"votes": 15, "value": 8.4},
"releaseDate": "2023-01-01T00:00:00Z",
"statistics": {
"trackFileCount": 10,
"trackCount": 10,
"totalTrackCount": 10,
"sizeOnDisk": 1024,
"percentOfTracks": 99.9
}
}]);
let response: Vec<Album> = serde_json::from_value(albums_json.clone()).unwrap();
let (mock, app, _server) = MockServarrApi::get()
.returns(albums_json)
.query("artistId=1")
.build_for(LidarrEvent::GetAlbums(1))
.await;
app.lock().await.server_tabs.set_index(2);
let mut network = test_network(&app);
let response: Vec<Album> = serde_json::from_value(albums_json.clone()).unwrap();
let (mock, app, _server) = MockServarrApi::get()
.returns(albums_json)
.query("artistId=1")
.build_for(LidarrEvent::GetAlbums(1))
.await;
app.lock().await.server_tabs.set_index(2);
let mut network = test_network(&app);
let result = network.handle_lidarr_event(LidarrEvent::GetAlbums(1)).await;
let result = network.handle_lidarr_event(LidarrEvent::GetAlbums(1)).await;
mock.assert_async().await;
mock.assert_async().await;
let LidarrSerdeable::Albums(albums) = result.unwrap() else {
panic!("Expected Albums");
};
let LidarrSerdeable::Albums(albums) = result.unwrap() else {
panic!("Expected Albums");
};
assert_eq!(albums, response);
assert!(!app.lock().await.data.lidarr_data.albums.is_empty());
}
assert_eq!(albums, response);
assert!(!app.lock().await.data.lidarr_data.albums.is_empty());
}
#[tokio::test]
async fn test_handle_toggle_album_monitoring_event() {
let mut expected_body: Value = serde_json::from_str(ALBUM_JSON).unwrap();
*expected_body.get_mut("monitored").unwrap() = json!(false);
let (get_mock, app, mut server) = MockServarrApi::get()
.returns(serde_json::from_str(ALBUM_JSON).unwrap())
.path("/1")
.build_for(LidarrEvent::GetAlbums(1))
.await;
let put_mock = server
.mock("PUT", "/api/v1/album/1")
.match_body(Matcher::Json(expected_body))
.match_header("X-Api-Key", "test1234")
.with_status(202)
.create_async()
.await;
app.lock().await.server_tabs.set_index(2);
let mut network = test_network(&app);
#[tokio::test]
async fn test_handle_delete_album_event() {
let delete_album_params = DeleteParams {
id: 1,
delete_files: true,
add_import_list_exclusion: true,
};
let (async_server, app, _server) = MockServarrApi::delete()
.path("/1")
.query("deleteFiles=true&addImportListExclusion=true")
.build_for(LidarrEvent::DeleteAlbum(delete_album_params.clone()))
.await;
app.lock().await.server_tabs.set_index(2);
let mut network = test_network(&app);
assert_ok!(
network
.handle_lidarr_event(LidarrEvent::ToggleAlbumMonitoring(1))
.await
);
assert!(
network
.handle_lidarr_event(LidarrEvent::DeleteAlbum(delete_album_params))
.await
.is_ok()
);
get_mock.assert_async().await;
put_mock.assert_async().await;
}
async_server.assert_async().await;
}
#[tokio::test]
async fn test_handle_get_album_details_event() {
let expected_album: Album = serde_json::from_str(ALBUM_JSON).unwrap();
let (mock, app, _server) = MockServarrApi::get()
.returns(serde_json::from_str(ALBUM_JSON).unwrap())
.path("/1")
.build_for(LidarrEvent::GetAlbumDetails(1))
.await;
app.lock().await.server_tabs.set_index(2);
let mut network = test_network(&app);
#[tokio::test]
async fn test_handle_toggle_album_monitoring_event() {
let mut expected_body: Value = serde_json::from_str(ALBUM_JSON).unwrap();
*expected_body.get_mut("monitored").unwrap() = json!(false);
let (get_mock, app, mut server) = MockServarrApi::get()
.returns(serde_json::from_str(ALBUM_JSON).unwrap())
.path("/1")
.build_for(LidarrEvent::GetAlbums(1))
.await;
let put_mock = server
.mock("PUT", "/api/v1/album/1")
.match_body(Matcher::Json(expected_body))
.match_header("X-Api-Key", "test1234")
.with_status(202)
.create_async()
.await;
app.lock().await.server_tabs.set_index(2);
let mut network = test_network(&app);
let result = network
.handle_lidarr_event(LidarrEvent::GetAlbumDetails(1))
.await;
assert_ok!(
network
.handle_lidarr_event(LidarrEvent::ToggleAlbumMonitoring(1))
.await
);
mock.assert_async().await;
get_mock.assert_async().await;
put_mock.assert_async().await;
}
let LidarrSerdeable::Album(album) = result.unwrap() else {
panic!("Expected Album");
};
#[tokio::test]
async fn test_handle_get_album_details_event() {
let expected_album: Album = serde_json::from_str(ALBUM_JSON).unwrap();
let (mock, app, _server) = MockServarrApi::get()
.returns(serde_json::from_str(ALBUM_JSON).unwrap())
.path("/1")
.build_for(LidarrEvent::GetAlbumDetails(1))
.await;
app.lock().await.server_tabs.set_index(2);
let mut network = test_network(&app);
assert_eq!(album, expected_album);
}
let result = network
.handle_lidarr_event(LidarrEvent::GetAlbumDetails(1))
.await;
mock.assert_async().await;
let LidarrSerdeable::Album(album) = result.unwrap() else {
panic!("Expected Album");
};
assert_eq!(album, expected_album);
}
}
src/network/lidarr_network/library/albums/mod.rs
+33 -1
View File
@@ -1,4 +1,4 @@
use crate::models::lidarr_models::{Album};
use crate::models::lidarr_models::{Album, DeleteParams};
use crate::network::lidarr_network::LidarrEvent;
use crate::network::{Network, RequestMethod};
use anyhow::Result;
@@ -57,6 +57,38 @@ impl Network<'_, '_> {
.await
}
pub(in crate::network::lidarr_network) async fn delete_album(
&mut self,
delete_album_params: DeleteParams,
) -> Result<()> {
let event = LidarrEvent::DeleteAlbum(DeleteParams::default());
let DeleteParams {
id,
delete_files,
add_import_list_exclusion,
} = delete_album_params;
info!(
"Deleting Lidarr album 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::lidarr_network) async fn toggle_album_monitoring(
&mut self,
album_id: i64,
src/network/lidarr_network/library/artists/lidarr_artists_network_tests.rs
+3 -3
View File
@@ -1,8 +1,8 @@
#[cfg(test)]
mod tests {
use crate::models::lidarr_models::{
AddArtistBody, AddArtistOptions, AddArtistSearchResult, Artist, DeleteArtistParams,
EditArtistParams, LidarrSerdeable, MonitorType, NewItemMonitorType,
AddArtistBody, AddArtistOptions, AddArtistSearchResult, Artist, DeleteParams, EditArtistParams,
LidarrSerdeable, MonitorType, NewItemMonitorType,
};
use crate::models::servarr_data::lidarr::lidarr_data::ActiveLidarrBlock;
use crate::network::NetworkResource;
@@ -54,7 +54,7 @@ mod tests {
#[tokio::test]
async fn test_handle_delete_artist_event() {
let delete_artist_params = DeleteArtistParams {
let delete_artist_params = DeleteParams {
id: 1,
delete_files: true,
add_import_list_exclusion: true,
src/network/lidarr_network/library/artists/mod.rs
+4 -5
View File
@@ -4,8 +4,7 @@ use serde_json::{Value, json};
use crate::models::Route;
use crate::models::lidarr_models::{
AddArtistBody, AddArtistSearchResult, Artist, DeleteArtistParams, EditArtistParams,
LidarrCommandBody,
AddArtistBody, AddArtistSearchResult, Artist, DeleteParams, EditArtistParams, LidarrCommandBody,
};
use crate::models::servarr_data::lidarr::lidarr_data::ActiveLidarrBlock;
use crate::models::stateful_table::StatefulTable;
@@ -20,10 +19,10 @@ mod lidarr_artists_network_tests;
impl Network<'_, '_> {
pub(in crate::network::lidarr_network) async fn delete_artist(
&mut self,
delete_artist_params: DeleteArtistParams,
delete_artist_params: DeleteParams,
) -> Result<()> {
let event = LidarrEvent::DeleteArtist(DeleteArtistParams::default());
let DeleteArtistParams {
let event = LidarrEvent::DeleteArtist(DeleteParams::default());
let DeleteParams {
id,
delete_files,
add_import_list_exclusion,
src/network/lidarr_network/lidarr_network_test_utils.rs
+1 -1
View File
@@ -50,7 +50,7 @@ pub mod test_utils {
"percentOfTracks": 99.9
}
}"#;
pub const ALBUM_JSON: &str = r#"{
"id": 1,
"title": "Test Album",
src/network/lidarr_network/lidarr_network_tests.rs
+14 -4
View File
@@ -1,7 +1,9 @@
#[cfg(test)]
mod tests {
use crate::app::App;
use crate::models::lidarr_models::{AddArtistBody, LidarrSerdeable, MetadataProfile};
use crate::models::lidarr_models::{
AddArtistBody, DeleteParams, EditArtistParams, LidarrSerdeable, MetadataProfile,
};
use crate::models::servarr_data::lidarr::modals::EditArtistModal;
use crate::models::servarr_models::{QualityProfile, Tag};
use crate::network::network_tests::test_utils::{MockServarrApi, test_network};
@@ -19,7 +21,9 @@ mod tests {
LidarrEvent::GetArtistDetails(0),
LidarrEvent::ListArtists,
LidarrEvent::AddArtist(AddArtistBody::default()),
LidarrEvent::ToggleArtistMonitoring(0)
LidarrEvent::ToggleArtistMonitoring(0),
LidarrEvent::DeleteArtist(DeleteParams::default()),
LidarrEvent::EditArtist(EditArtistParams::default())
)]
event: LidarrEvent,
) {
@@ -58,8 +62,14 @@ mod tests {
}
#[rstest]
fn test_resource_albums(
#[values(LidarrEvent::GetAlbums(0), LidarrEvent::ToggleAlbumMonitoring(0), LidarrEvent::GetAlbumDetails(0))] event: LidarrEvent,
fn test_resource_album(
#[values(
LidarrEvent::GetAlbums(0),
LidarrEvent::ToggleAlbumMonitoring(0),
LidarrEvent::GetAlbumDetails(0),
LidarrEvent::DeleteAlbum(DeleteParams::default())
)]
event: LidarrEvent,
) {
assert_str_eq!(event.resource(), "/album");
}
src/network/lidarr_network/mod.rs
+14 -4
View File
@@ -3,7 +3,7 @@ use log::info;
use super::{NetworkEvent, NetworkResource};
use crate::models::lidarr_models::{
AddArtistBody, DeleteArtistParams, EditArtistParams, LidarrSerdeable, MetadataProfile,
AddArtistBody, DeleteParams, EditArtistParams, LidarrSerdeable, MetadataProfile,
};
use crate::models::servarr_models::{QualityProfile, Tag};
use crate::network::{Network, RequestMethod};
@@ -25,7 +25,8 @@ pub mod lidarr_network_test_utils;
pub enum LidarrEvent {
AddArtist(AddArtistBody),
AddTag(String),
DeleteArtist(DeleteArtistParams),
DeleteAlbum(DeleteParams),
DeleteArtist(DeleteParams),
DeleteTag(i64),
EditArtist(EditArtistParams),
GetAlbums(i64),
@@ -60,7 +61,10 @@ impl NetworkResource for LidarrEvent {
| LidarrEvent::ListArtists
| LidarrEvent::AddArtist(_)
| LidarrEvent::ToggleArtistMonitoring(_) => "/artist",
LidarrEvent::GetAlbums(_) | LidarrEvent::ToggleAlbumMonitoring(_) | LidarrEvent::GetAlbumDetails(_) => "/album",
LidarrEvent::GetAlbums(_)
| LidarrEvent::ToggleAlbumMonitoring(_)
| LidarrEvent::GetAlbumDetails(_)
| LidarrEvent::DeleteAlbum(_) => "/album",
LidarrEvent::GetDiskSpace => "/diskspace",
LidarrEvent::GetDownloads(_) => "/queue",
LidarrEvent::GetHostConfig | LidarrEvent::GetSecurityConfig => "/config/host",
@@ -90,6 +94,9 @@ impl Network<'_, '_> {
) -> Result<LidarrSerdeable> {
match lidarr_event {
LidarrEvent::AddTag(tag) => self.add_lidarr_tag(tag).await.map(LidarrSerdeable::from),
LidarrEvent::DeleteAlbum(params) => {
self.delete_album(params).await.map(LidarrSerdeable::from)
}
LidarrEvent::DeleteArtist(params) => {
self.delete_artist(params).await.map(LidarrSerdeable::from)
}
@@ -104,7 +111,10 @@ impl Network<'_, '_> {
.get_artist_details(artist_id)
.await
.map(LidarrSerdeable::from),
LidarrEvent::GetAlbumDetails(album_id) => self.get_album_details(album_id).await.map(LidarrSerdeable::from),
LidarrEvent::GetAlbumDetails(album_id) => self
.get_album_details(album_id)
.await
.map(LidarrSerdeable::from),
LidarrEvent::GetDiskSpace => self.get_lidarr_diskspace().await.map(LidarrSerdeable::from),
LidarrEvent::GetDownloads(count) => self
.get_lidarr_downloads(count)