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

feat: Support for custom headers to be added to every request to each server to support alternative authentication mechanisms [#47]

Browse Source
This commit is contained in:
Alex Clarke
2025-08-29 10:23:17 -06:00
parent 4ea39f74fe
commit 0b29351366
5 changed files with 235 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/network/mod.rs
+18 -4
View File
@@ -19,6 +19,7 @@ use crate::models::Serdeable;
use crate::network::radarr_network::RadarrEvent;
#[cfg(test)]
use mockall::automock;
use reqwest::header::HeaderMap;
pub mod radarr_network;
pub mod sonarr_network;
@@ -167,28 +168,36 @@ impl<'a, 'b> Network<'a, 'b> {
method,
body,
api_token,
custom_headers,
..
} = request_props;
debug!("Creating RequestBuilder for resource: {uri:?}");
debug!("Sending {method:?} request to {uri} with body {body:?}");
match method {
RequestMethod::Get => self.client.get(uri).header("X-Api-Key", api_token),
RequestMethod::Get => self
.client
.get(uri)
.header("X-Api-Key", api_token)
.headers(custom_headers),
RequestMethod::Post => self
.client
.post(uri)
.json(&body.unwrap_or_default())
.header("X-Api-Key", api_token),
.header("X-Api-Key", api_token)
.headers(custom_headers),
RequestMethod::Put => self
.client
.put(uri)
.json(&body.unwrap_or_default())
.header("X-Api-Key", api_token),
.header("X-Api-Key", api_token)
.headers(custom_headers),
RequestMethod::Delete => self
.client
.delete(uri)
.json(&body.unwrap_or_default())
.header("X-Api-Key", api_token),
.header("X-Api-Key", api_token)
.headers(custom_headers),
}
}
@@ -212,6 +221,7 @@ impl<'a, 'b> Network<'a, 'b> {
uri,
api_token,
ssl_cert_path,
custom_headers: custom_headers_option,
..
} = app
.server_tabs
@@ -245,12 +255,15 @@ impl<'a, 'b> Network<'a, 'b> {
uri = format!("{uri}?{params}");
}
let custom_headers = custom_headers_option.clone().unwrap_or_default();
RequestProps {
uri,
method,
body,
api_token: api_token.as_ref().expect("API token not found").clone(),
ignore_status_code: false,
custom_headers,
}
}
}
@@ -270,4 +283,5 @@ pub struct RequestProps<T: Serialize + Debug> {
pub body: Option<T>,
pub api_token: String,
pub ignore_status_code: bool,
pub custom_headers: HeaderMap,
}
src/network/network_tests.rs
+59
View File
@@ -6,6 +6,7 @@ mod tests {
use mockito::{Mock, Server, ServerGuard};
use pretty_assertions::assert_str_eq;
use reqwest::header::HeaderMap;
use reqwest::Client;
use rstest::rstest;
use serde::{Deserialize, Serialize};
@@ -81,6 +82,7 @@ mod tests {
}),
api_token: "test1234".to_owned(),
ignore_status_code: false,
custom_headers: HeaderMap::new(),
},
|_, _| (),
)
@@ -105,6 +107,7 @@ mod tests {
body: None,
api_token: "test1234".to_owned(),
ignore_status_code: false,
custom_headers: HeaderMap::new(),
},
|response, mut app| app.error = HorizontallyScrollableText::from(response.value),
)
@@ -138,6 +141,7 @@ mod tests {
body: None,
api_token: "test1234".to_owned(),
ignore_status_code: true,
custom_headers: HeaderMap::new(),
},
|response, _app| test_result = response.value,
)
@@ -176,6 +180,7 @@ mod tests {
body: None,
api_token: "test1234".to_owned(),
ignore_status_code: false,
custom_headers: HeaderMap::new(),
},
|_, _| (),
)
@@ -229,6 +234,7 @@ mod tests {
body: None,
api_token: "test1234".to_owned(),
ignore_status_code: false,
custom_headers: HeaderMap::new(),
},
|response, mut app| app.error = HorizontallyScrollableText::from(response.value),
)
@@ -261,6 +267,7 @@ mod tests {
body: None,
api_token: "test1234".to_owned(),
ignore_status_code: false,
custom_headers: HeaderMap::new(),
},
|response, mut app| app.error = HorizontallyScrollableText::from(response.value),
)
@@ -301,6 +308,7 @@ mod tests {
body: None,
api_token: "test1234".to_owned(),
ignore_status_code: false,
custom_headers: HeaderMap::new(),
},
|response, mut app| app.error = HorizontallyScrollableText::from(response.value),
)
@@ -331,6 +339,7 @@ mod tests {
body: None,
api_token: "test1234".to_owned(),
ignore_status_code: false,
custom_headers: HeaderMap::new(),
},
|response, mut app| app.error = HorizontallyScrollableText::from(response.value),
)
@@ -363,8 +372,11 @@ mod tests {
let mut async_server = server
.mock(&request_method.to_string().to_uppercase(), "/test")
.match_header("X-Api-Key", "test1234")
.match_header("X-Custom-Header", "CustomValue")
.with_status(200);
let mut body = None::<Test>;
let mut custom_headers = HeaderMap::new();
custom_headers.insert("X-Custom-Header", "CustomValue".parse().unwrap());
if request_method == RequestMethod::Post {
async_server = async_server.with_body(
@@ -388,6 +400,7 @@ mod tests {
body,
api_token: "test1234".to_owned(),
ignore_status_code: false,
custom_headers,
})
.await
.send()
@@ -440,6 +453,7 @@ mod tests {
assert_eq!(request_props.method, RequestMethod::Get);
assert_eq!(request_props.body, None);
assert!(request_props.api_token.is_empty());
assert!(request_props.custom_headers.is_empty());
}
#[rstest]
@@ -476,6 +490,47 @@ mod tests {
assert_eq!(request_props.method, RequestMethod::Get);
assert_eq!(request_props.body, None);
assert_str_eq!(request_props.api_token, api_token);
assert!(request_props.custom_headers.is_empty());
}
#[rstest]
#[tokio::test]
async fn test_request_props_from_custom_config_custom_headers(
#[values(RadarrEvent::GetMovies, SonarrEvent::ListSeries)] network_event: impl Into<NetworkEvent>
+ NetworkResource,
) {
let api_token = "testToken1234".to_owned();
let app_arc = Arc::new(Mutex::new(App::test_default()));
let resource = network_event.resource();
let mut header_map = HeaderMap::new();
header_map.insert("X-Custom-Header", "CustomValue".parse().unwrap());
let servarr_config = ServarrConfig {
host: Some("192.168.0.123".to_owned()),
port: Some(8080),
api_token: Some(api_token.clone()),
ssl_cert_path: Some("/test/cert.crt".to_owned()),
custom_headers: Some(header_map.clone()),
..ServarrConfig::default()
};
{
let mut app = app_arc.lock().await;
app.server_tabs.tabs[0].config = Some(servarr_config.clone());
app.server_tabs.tabs[1].config = Some(servarr_config);
}
let network = Network::new(&app_arc, CancellationToken::new(), Client::new());
let request_props = network
.request_props_from(network_event, RequestMethod::Get, None::<()>, None, None)
.await;
assert_str_eq!(
request_props.uri,
format!("https://192.168.0.123:8080/api/v3{resource}")
);
assert_eq!(request_props.method, RequestMethod::Get);
assert_eq!(request_props.body, None);
assert_str_eq!(request_props.api_token, api_token);
assert_eq!(request_props.custom_headers, header_map);
}
#[rstest]
@@ -510,6 +565,7 @@ mod tests {
assert_eq!(request_props.method, RequestMethod::Get);
assert_eq!(request_props.body, None);
assert_str_eq!(request_props.api_token, api_token);
assert!(request_props.custom_headers.is_empty());
}
#[rstest]
@@ -546,6 +602,7 @@ mod tests {
assert_eq!(request_props.method, RequestMethod::Get);
assert_eq!(request_props.body, None);
assert!(request_props.api_token.is_empty());
assert!(request_props.custom_headers.is_empty());
}
#[rstest]
@@ -588,6 +645,7 @@ mod tests {
assert_eq!(request_props.method, RequestMethod::Get);
assert_eq!(request_props.body, None);
assert_str_eq!(request_props.api_token, api_token);
assert!(request_props.custom_headers.is_empty());
}
#[rstest]
@@ -628,6 +686,7 @@ mod tests {
assert_eq!(request_props.method, RequestMethod::Get);
assert_eq!(request_props.body, None);
assert_str_eq!(request_props.api_token, api_token);
assert!(request_props.custom_headers.is_empty());
}
#[derive(Clone, Serialize, Deserialize, Debug, Default, PartialEq, Eq)]