mirror of
https://github.com/SeriousBug/gandi-live-dns-rust
synced 2024-05-18 11:19:03 -05:00
Replaced die_with with ClientError enum derived with thiserror.
This enables prettier and more structured error handling than anyhow
This commit is contained in:
parent
83f58371b0
commit
36f6f6600e
|
@ -1,10 +1,12 @@
|
||||||
use async_trait::async_trait;
|
use async_trait::async_trait;
|
||||||
|
|
||||||
|
use crate::ClientError;
|
||||||
|
|
||||||
use super::ip_source::IPSource;
|
use super::ip_source::IPSource;
|
||||||
|
|
||||||
pub(crate) struct IPSourceIcanhazip;
|
pub(crate) struct IPSourceIcanhazip;
|
||||||
|
|
||||||
async fn get_ip(api_url: &str) -> anyhow::Result<String> {
|
async fn get_ip(api_url: &str) -> Result<String, ClientError> {
|
||||||
let response = reqwest::get(api_url).await?;
|
let response = reqwest::get(api_url).await?;
|
||||||
let text = response.text().await?;
|
let text = response.text().await?;
|
||||||
Ok(text)
|
Ok(text)
|
||||||
|
@ -12,14 +14,14 @@ async fn get_ip(api_url: &str) -> anyhow::Result<String> {
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl IPSource for IPSourceIcanhazip {
|
impl IPSource for IPSourceIcanhazip {
|
||||||
async fn get_ipv4(&self) -> anyhow::Result<String> {
|
async fn get_ipv4(&self) -> Result<String, ClientError> {
|
||||||
Ok(get_ip("https://ipv4.icanhazip.com")
|
Ok(get_ip("https://ipv4.icanhazip.com")
|
||||||
.await?
|
.await?
|
||||||
// icanazip puts a newline at the end
|
// icanazip puts a newline at the end
|
||||||
.trim()
|
.trim()
|
||||||
.to_string())
|
.to_string())
|
||||||
}
|
}
|
||||||
async fn get_ipv6(&self) -> anyhow::Result<String> {
|
async fn get_ipv6(&self) -> Result<String, ClientError> {
|
||||||
Ok(get_ip("https://ipv6.icanhazip.com")
|
Ok(get_ip("https://ipv6.icanhazip.com")
|
||||||
.await?
|
.await?
|
||||||
// icanazip puts a newline at the end
|
// icanazip puts a newline at the end
|
||||||
|
|
|
@ -1,7 +1,9 @@
|
||||||
use async_trait::async_trait;
|
use async_trait::async_trait;
|
||||||
|
|
||||||
|
use crate::ClientError;
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
pub trait IPSource {
|
pub trait IPSource {
|
||||||
async fn get_ipv4(&self) -> anyhow::Result<String>;
|
async fn get_ipv4(&self) -> Result<String, ClientError>;
|
||||||
async fn get_ipv6(&self) -> anyhow::Result<String>;
|
async fn get_ipv6(&self) -> Result<String, ClientError>;
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
use async_trait::async_trait;
|
use async_trait::async_trait;
|
||||||
|
|
||||||
|
use crate::ClientError;
|
||||||
|
|
||||||
use super::ip_source::IPSource;
|
use super::ip_source::IPSource;
|
||||||
|
|
||||||
pub(crate) struct IPSourceIpify;
|
pub(crate) struct IPSourceIpify;
|
||||||
|
|
||||||
async fn get_ip(api_url: &str) -> anyhow::Result<String> {
|
async fn get_ip(api_url: &str) -> Result<String, ClientError> {
|
||||||
let response = reqwest::get(api_url).await?;
|
let response = reqwest::get(api_url).await?;
|
||||||
let text = response.text().await?;
|
let text = response.text().await?;
|
||||||
Ok(text)
|
Ok(text)
|
||||||
|
@ -12,10 +14,10 @@ async fn get_ip(api_url: &str) -> anyhow::Result<String> {
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl IPSource for IPSourceIpify {
|
impl IPSource for IPSourceIpify {
|
||||||
async fn get_ipv4(&self) -> anyhow::Result<String> {
|
async fn get_ipv4(&self) -> Result<String, ClientError> {
|
||||||
get_ip("https://api.ipify.org").await
|
get_ip("https://api.ipify.org").await
|
||||||
}
|
}
|
||||||
async fn get_ipv6(&self) -> anyhow::Result<String> {
|
async fn get_ipv6(&self) -> Result<String, ClientError> {
|
||||||
get_ip("https://api6.ipify.org").await
|
get_ip("https://api6.ipify.org").await
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
use async_trait::async_trait;
|
use async_trait::async_trait;
|
||||||
|
|
||||||
|
use crate::ClientError;
|
||||||
|
|
||||||
use super::ip_source::IPSource;
|
use super::ip_source::IPSource;
|
||||||
|
|
||||||
pub(crate) struct IPSourceSeeIP;
|
pub(crate) struct IPSourceSeeIP;
|
||||||
|
|
||||||
async fn get_ip(api_url: &str) -> anyhow::Result<String> {
|
async fn get_ip(api_url: &str) -> Result<String, ClientError> {
|
||||||
let response = reqwest::get(api_url).await?;
|
let response = reqwest::get(api_url).await?;
|
||||||
let text = response.text().await?;
|
let text = response.text().await?;
|
||||||
Ok(text)
|
Ok(text)
|
||||||
|
@ -12,10 +14,10 @@ async fn get_ip(api_url: &str) -> anyhow::Result<String> {
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl IPSource for IPSourceSeeIP {
|
impl IPSource for IPSourceSeeIP {
|
||||||
async fn get_ipv4(&self) -> anyhow::Result<String> {
|
async fn get_ipv4(&self) -> Result<String, ClientError> {
|
||||||
get_ip("https://ip4.seeip.org").await
|
get_ip("https://ip4.seeip.org").await
|
||||||
}
|
}
|
||||||
async fn get_ipv6(&self) -> anyhow::Result<String> {
|
async fn get_ipv6(&self) -> Result<String, ClientError> {
|
||||||
get_ip("https://ip6.seeip.org").await
|
get_ip("https://ip6.seeip.org").await
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
71
src/main.rs
71
src/main.rs
|
@ -2,10 +2,11 @@ use crate::config::Config;
|
||||||
use crate::gandi::GandiAPI;
|
use crate::gandi::GandiAPI;
|
||||||
use crate::ip_source::{ip_source::IPSource, ipify::IPSourceIpify};
|
use crate::ip_source::{ip_source::IPSource, ipify::IPSourceIpify};
|
||||||
use clap::Parser;
|
use clap::Parser;
|
||||||
use config::IPSourceName;
|
use config::{ConfigError, IPSourceName};
|
||||||
use ip_source::icanhazip::IPSourceIcanhazip;
|
use ip_source::icanhazip::IPSourceIcanhazip;
|
||||||
use ip_source::seeip::IPSourceSeeIP;
|
use ip_source::seeip::IPSourceSeeIP;
|
||||||
use opts::Opts;
|
use opts::Opts;
|
||||||
|
use reqwest::header::InvalidHeaderValue;
|
||||||
use reqwest::{header, Client, ClientBuilder, StatusCode};
|
use reqwest::{header, Client, ClientBuilder, StatusCode};
|
||||||
use serde::Serialize;
|
use serde::Serialize;
|
||||||
use std::{num::NonZeroU32, sync::Arc, time::Duration};
|
use std::{num::NonZeroU32, sync::Arc, time::Duration};
|
||||||
|
@ -16,13 +17,44 @@ mod gandi;
|
||||||
mod ip_source;
|
mod ip_source;
|
||||||
mod opts;
|
mod opts;
|
||||||
use die_exit::*;
|
use die_exit::*;
|
||||||
|
use thiserror::Error;
|
||||||
|
|
||||||
/// 30 requests per minute, see https://api.gandi.net/docs/reference/
|
/// 30 requests per minute, see https://api.gandi.net/docs/reference/
|
||||||
const GANDI_RATE_LIMIT: u32 = 30;
|
const GANDI_RATE_LIMIT: u32 = 30;
|
||||||
/// If we hit the rate limit, wait up to this many seconds before next attempt
|
/// If we hit the rate limit, wait up to this many seconds before next attempt
|
||||||
const GANDI_DELAY_JITTER: u64 = 20;
|
const GANDI_DELAY_JITTER: u64 = 20;
|
||||||
|
|
||||||
fn api_client(api_key: &str) -> anyhow::Result<Client> {
|
#[derive(Error, Debug)]
|
||||||
|
pub enum ClientError {
|
||||||
|
#[error("Error occured while reading config: {0}")]
|
||||||
|
Config(#[from] ConfigError),
|
||||||
|
#[error("Error while accessing the Gandi API: {0}")]
|
||||||
|
Api(#[from] ApiError),
|
||||||
|
#[error("Error while converting the API key to a header: {0}")]
|
||||||
|
InvalidHeader(#[from] InvalidHeaderValue),
|
||||||
|
#[error("Error while sending request: {0}")]
|
||||||
|
Request(#[from] reqwest::Error),
|
||||||
|
#[error("Error while joining async tasks: {0}")]
|
||||||
|
TaskJoin(#[from] tokio::task::JoinError),
|
||||||
|
#[error("Unexpected type in config: {0}")]
|
||||||
|
BadEntry(String),
|
||||||
|
#[error("Entry '{0}' includes type A which requires an IPv4 adress but no IPv4 adress could be determined because: {1}")]
|
||||||
|
Ipv4missing(String, String),
|
||||||
|
#[error("Entry '{0}' includes type AAAA which requires an IPv6 adress but no IPv6 adress could be determined because: {1}")]
|
||||||
|
Ipv6missing(String, String),
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Error, Debug)]
|
||||||
|
pub enum ApiError {
|
||||||
|
#[error("API returned 403 - Forbidden. Message: {message:?}")]
|
||||||
|
Forbidden { message: String },
|
||||||
|
#[error("API returned 403 - Unauthorized. Provided API key is possibly incorrect")]
|
||||||
|
Unauthorized(),
|
||||||
|
#[error("API returned {0} - {0}")]
|
||||||
|
Unknown(StatusCode, String),
|
||||||
|
}
|
||||||
|
|
||||||
|
fn api_client(api_key: &str) -> Result<Client, ClientError> {
|
||||||
let client_builder = ClientBuilder::new();
|
let client_builder = ClientBuilder::new();
|
||||||
|
|
||||||
let key = format!("Apikey {}", api_key);
|
let key = format!("Apikey {}", api_key);
|
||||||
|
@ -47,7 +79,7 @@ async fn run(
|
||||||
ip_source: &Box<dyn IPSource>,
|
ip_source: &Box<dyn IPSource>,
|
||||||
conf: &Config,
|
conf: &Config,
|
||||||
opts: &Opts,
|
opts: &Opts,
|
||||||
) -> anyhow::Result<()> {
|
) -> Result<(), ClientError> {
|
||||||
let mut last_ipv4: Option<String> = None;
|
let mut last_ipv4: Option<String> = None;
|
||||||
let mut last_ipv6: Option<String> = None;
|
let mut last_ipv6: Option<String> = None;
|
||||||
|
|
||||||
|
@ -100,10 +132,22 @@ async fn run(
|
||||||
}
|
}
|
||||||
.url();
|
.url();
|
||||||
let ip = match entry_type {
|
let ip = match entry_type {
|
||||||
"A" => ipv4.die_with(|error| format!("Needed IPv4 for {fqdn}: {error}")),
|
"A" => match ipv4 {
|
||||||
"AAAA" => ipv6.die_with(|error| format!("Needed IPv6 for {fqdn}: {error}")),
|
Ok(ref value) => Ok(value),
|
||||||
bad_entry_type => die!("Unexpected type in config: {}", bad_entry_type),
|
Err(ref err) => Err(ClientError::Ipv4missing(
|
||||||
};
|
entry.name.clone(),
|
||||||
|
err.to_string(),
|
||||||
|
)),
|
||||||
|
},
|
||||||
|
"AAAA" => match ipv6 {
|
||||||
|
Ok(ref value) => Ok(value),
|
||||||
|
Err(ref err) => Err(ClientError::Ipv6missing(
|
||||||
|
entry.name.clone(),
|
||||||
|
err.to_string(),
|
||||||
|
)),
|
||||||
|
},
|
||||||
|
&_ => Err(ClientError::BadEntry(entry_type.to_string())),
|
||||||
|
}?;
|
||||||
let payload = APIPayload {
|
let payload = APIPayload {
|
||||||
rrset_values: vec![ip.to_string()],
|
rrset_values: vec![ip.to_string()],
|
||||||
rrset_ttl: Config::ttl(entry, conf),
|
rrset_ttl: Config::ttl(entry, conf),
|
||||||
|
@ -151,17 +195,16 @@ async fn run(
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tokio::main(flavor = "current_thread")]
|
#[tokio::main(flavor = "current_thread")]
|
||||||
async fn main() -> anyhow::Result<()> {
|
async fn main() -> Result<(), ClientError> {
|
||||||
let opts = opts::Opts::parse();
|
let opts = opts::Opts::parse();
|
||||||
let conf = config::load_config(&opts)
|
let conf = config::load_config(&opts)?;
|
||||||
.die_with(|error| format!("Failed to read config file: {}", error));
|
|
||||||
|
|
||||||
let ip_source: Box<dyn IPSource> = match conf.ip_source {
|
let ip_source: Box<dyn IPSource> = match conf.ip_source {
|
||||||
IPSourceName::Ipify => Box::new(IPSourceIpify),
|
IPSourceName::Ipify => Box::new(IPSourceIpify),
|
||||||
IPSourceName::Icanhazip => Box::new(IPSourceIcanhazip),
|
IPSourceName::Icanhazip => Box::new(IPSourceIcanhazip),
|
||||||
IPSourceName::SeeIP => Box::new(IPSourceSeeIP),
|
IPSourceName::SeeIP => Box::new(IPSourceSeeIP),
|
||||||
};
|
};
|
||||||
config::validate_config(&conf).die_with(|error| format!("Invalid config: {}", error));
|
config::validate_config(&conf)?;
|
||||||
run("https://api.gandi.net", &ip_source, &conf, &opts).await?;
|
run("https://api.gandi.net", &ip_source, &conf, &opts).await?;
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
@ -170,7 +213,7 @@ async fn main() -> anyhow::Result<()> {
|
||||||
mod tests {
|
mod tests {
|
||||||
use std::{env::temp_dir, time::Duration};
|
use std::{env::temp_dir, time::Duration};
|
||||||
|
|
||||||
use crate::{config, ip_source::ip_source::IPSource, opts::Opts, run};
|
use crate::{config, ip_source::ip_source::IPSource, opts::Opts, run, ClientError};
|
||||||
use async_trait::async_trait;
|
use async_trait::async_trait;
|
||||||
use httpmock::MockServer;
|
use httpmock::MockServer;
|
||||||
use tokio::{fs, task::LocalSet, time::sleep};
|
use tokio::{fs, task::LocalSet, time::sleep};
|
||||||
|
@ -179,10 +222,10 @@ mod tests {
|
||||||
|
|
||||||
#[async_trait]
|
#[async_trait]
|
||||||
impl IPSource for IPSourceMock {
|
impl IPSource for IPSourceMock {
|
||||||
async fn get_ipv4(&self) -> anyhow::Result<String> {
|
async fn get_ipv4(&self) -> Result<String, ClientError> {
|
||||||
Ok("192.168.0.0".to_string())
|
Ok("192.168.0.0".to_string())
|
||||||
}
|
}
|
||||||
async fn get_ipv6(&self) -> anyhow::Result<String> {
|
async fn get_ipv6(&self) -> Result<String, ClientError> {
|
||||||
Ok("fe80:0000:0208:74ff:feda:625c".to_string())
|
Ok("fe80:0000:0208:74ff:feda:625c".to_string())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in a new issue