.github/workflows/test.yml

@@ -2,7 +2,7 @@ name: test
 on:
   push:
     branches:
-      - master
+      - "main"
   pull_request:
     branches:
       - "*"

Cargo.toml

@@ -1,12 +1,8 @@
 [package]
 name = "gandi-live-dns"
-description = "Automatically updates your IP address in Gandi's Live DNS. Makes it possible to use Gandi as a dynamic DNS system."
+version = "1.4.0"
-version = "1.5.0"
 edition = "2021"
 authors = ["Kaan Barmore-Genç <kaan@bgenc.net>"]
-license = "MIT"
-readme = "Readme.md"
-repository = "https://github.com/SeriousBug/gandi-live-dns-rust"
 
 [profile.release]
 strip = "symbols"
@@ -21,7 +17,7 @@ toml = "0.5"
 json = "0.12"
 serde = { version = "1.0", features = ["derive"] }
 directories = "4.0"
-clap = { version = "4.0", features = [
+clap = { version = "3.2", features = [
   "derive",
   "cargo",
   "unicode",
@@ -30,14 +26,11 @@ clap = { version = "4.0", features = [
 tokio = { version = "1.20", features = ["full"] }
 futures = "0.3"
 anyhow = "1.0"
-governor = "0.5"
+governor = "0.4"
 async-trait = "0.1"
-die-exit-2 = "0.4"
+# TODO: Relies on a yet-unreleased interface. Switch to an actual crate release once available
+die-exit = { git = "https://github.com/Xavientois/die.git", rev = "31d3801f4e21654b0b28430987b1e21fc7728676" }
 
 [dev-dependencies]
 httpmock = "0.6"
 regex = "1.6"
-
-[dev-dependencies.die-exit-2]
-version = "0.4"
-features = ["test"]

Readme.md

@@ -1,6 +1,6 @@
 ## gandi-live-dns-rust
 
-[![tests](https://img.shields.io/github/workflow/status/SeriousBug/gandi-live-dns-rust/test?label=tests)](https://github.com/SeriousBug/gandi-live-dns-rust/actions/workflows/test.yml) [![Test coverage report](https://img.shields.io/codecov/c/github/SeriousBug/gandi-live-dns-rust)](https://codecov.io/gh/SeriousBug/gandi-live-dns-rust) [![lint checks](https://img.shields.io/github/workflow/status/SeriousBug/gandi-live-dns-rust/lint%20checks?label=lints)](https://github.com/SeriousBug/gandi-live-dns-rust/actions/workflows/lint.yml) [![Releases](https://img.shields.io/github/v/release/SeriousBug/gandi-live-dns-rust?include_prereleases)](https://github.com/SeriousBug/gandi-live-dns-rust/releases) [![Docker Image Size](https://img.shields.io/docker/image-size/seriousbug/gandi-live-dns-rust)](https://hub.docker.com/r/seriousbug/gandi-live-dns-rust) [![MIT license](https://img.shields.io/github/license/SeriousBug/gandi-live-dns-rust)](https://github.com/SeriousBug/gandi-live-dns-rust/blob/master/LICENSE.txt)
+[![tests](https://img.shields.io/github/workflow/status/SeriousBug/gandi-live-dns-rust/test?label=tests)](https://github.com/SeriousBug/gandi-live-dns-rust/actions/workflows/test.yml) [![lint checks](https://img.shields.io/github/workflow/status/SeriousBug/gandi-live-dns-rust/lint%20checks?label=lints)](https://github.com/SeriousBug/gandi-live-dns-rust/actions/workflows/lint.yml) [![Releases](https://img.shields.io/github/v/release/SeriousBug/gandi-live-dns-rust?include_prereleases)](https://github.com/SeriousBug/gandi-live-dns-rust/releases) [![Docker Image Size](https://img.shields.io/docker/image-size/seriousbug/gandi-live-dns-rust)](https://hub.docker.com/r/seriousbug/gandi-live-dns-rust) [![MIT license](https://img.shields.io/github/license/SeriousBug/gandi-live-dns-rust)](https://github.com/SeriousBug/gandi-live-dns-rust/blob/master/LICENSE.txt)
 
 A program that can set the IP addresses for configured DNS entries in
 [Gandi](https://gandi.net)'s domain configuration. Thanks to Gandi's
@@ -59,12 +59,6 @@ arm64, armv6, and armv7 platforms. Follow the steps below to use these images.
 > has a full path to the config file (`$(pwd)/gandi.toml` part). Otherwise
 > Docker will create a directory.
 
-### From source
-
-This package is also published on `crates.io` as
-[gandi-live-dns](https://crates.io/crates/gandi-live-dns). If you would like to
-build it from source and you have a working rust install, you can use `cargo install gandi-live-dns` to build and install it.
-
 ## Automation
 
 The `Packaging` folder contains a Systemd service and timer, which you can use
@@ -74,7 +68,7 @@ up, but avoid unnecessarily overloading Gandi's servers.
 
 - Place `gandi-live-dns.timer` and `gandi-live-dns.service` into `/etc/systemd/system`
 - Put `gandi-live-dns` binary into `/usr/bin/`
-  - You can also place it in `/usr/local/bin` or some other directory, just make sure to update the path in the service file
+    - You can also place it in `/usr/local/bin` or some other directory, just make sure to update the path in the service file
 - Create the folder `/etc/gandi-live-dns`, and place your `gandi.toml` into it
 - Create a user for the service: `useradd --system gandi-live-dns --home-dir /etc/gandi-live-dns`
 - Make sure only the service can access the config file: `chown gandi-live-dns: /etc/gandi-live-dns/gandi.toml && chmod 600 /etc/gandi-live-dns/gandi.toml`
@@ -93,13 +87,13 @@ To make a release, first set up `cross` and `docker`. Make sure you log into
 Docker with `docker login`. Then follow these steps:
 
 - bump up the version in `Cargo.toml` according to [semver](https://semver.org/)
-  - commit and push the changes
+    - commit and push the changes
 - run `./make-release.sh`
-  > This will build binaries, then package them into archives, as well as
+    > This will build binaries, then package them into archives, as well as
-  > build and upload docker images.
+    > build and upload docker images.
 - Create a release on Github
-  - Make sure to create a tag for the release version on `master`
+    - Make sure to create a tag for the release version on `master`
-  - Upload the binary archives to the Github release
+    - Upload the binary archives to the Github release
 - Update the AUR version manually
 
 ## Alternatives

make-release.sh

@@ -44,24 +44,25 @@ declare -A DOCKER_TARGETS=(
 )
 
 # Get the version number
-VERSION=$(sed -nr 's/^version *= *"([0-9.]+)"/\1/p' Cargo.toml | head --lines=1)
+VERSION=$(sed -nr 's/^version *= *"([0-9.]+)"/\1/p' Cargo.toml)
 
 # Make the builds
 for target in "${!TARGETS[@]}"; do
   echo Building "${target}"
   cross build -j $(($(nproc) / 2)) --release --target "${target}"
-  if [[ "${target}" =~ .*"windows".* ]]; then
+  if [[ "${target}" =~ .*"windows".* ]] ; then
     zip -j "gandi-live-dns.${VERSION}.${TARGETS[${target}]}.zip" target/"${target}"/release/gandi-live-dns.exe 1>/dev/null
   else
     tar -acf "gandi-live-dns.${VERSION}.${TARGETS[${target}]}.tar.xz" -C "target/${target}/release/" "gandi-live-dns"
   fi
 done
 
-if [[ "$#" -ge 2 && "$1" = "--no-docker" ]]; then
+if [[ "$#" -ge 2 && "$1" = "--no-docker" ]] ; then
   echo "Exiting without releasing to docker"
   exit 0
 fi
 
+
 # Copy files into place so Docker can get them easily
 cd Docker
 echo Building Docker images

src/config.rs

@@ -5,15 +5,10 @@ use serde::Deserialize;
 use std::fs;
 use std::path::PathBuf;
 
-fn default_types() -> Vec<String> {
-    DEFAULT_TYPES.iter().map(|v| v.to_string()).collect()
-}
-
 #[derive(Deserialize, Debug)]
 pub struct Entry {
     pub name: String,
-    #[serde(default = "default_types")]
+    types: Option<Vec<String>>,
-    types: Vec<String>,
     fqdn: Option<String>,
     ttl: Option<u32>,
 }
@@ -59,7 +54,11 @@ impl Config {
     }
 
     pub fn types<'e>(entry: &'e Entry) -> Vec<&'e str> {
-        entry.types.iter().map(|t| t.as_str()).collect()
+        entry
+            .types
+            .as_ref()
+            .and_then(|ts| Some(ts.iter().map(|t| t.as_str()).collect()))
+            .unwrap_or_else(|| DEFAULT_TYPES.to_vec())
     }
 }
 
@@ -69,7 +68,7 @@ fn load_config_from<P: std::convert::AsRef<std::path::Path>>(path: P) -> anyhow:
 }
 
 pub fn load_config(opts: &opts::Opts) -> anyhow::Result<Config> {
-    let mut config = match &opts.config {
+    match &opts.config {
         Some(config_path) => load_config_from(&config_path),
         None => {
             let confpath = ProjectDirs::from("me", "kaangenc", "gandi-dynamic-dns")
@@ -86,23 +85,7 @@ pub fn load_config(opts: &opts::Opts) -> anyhow::Result<Config> {
                     load_config_from(path)
                 })
         }
-    }?;
-    // Filter out any types skipped in CLI opts
-    if opts.skip_ipv4 || opts.skip_ipv6 {
-        config.entry = config
-            .entry
-            .into_iter()
-            .map(|mut entry| {
-                entry.types = entry
-                    .types
-                    .into_iter()
-                    .filter(|v| (v == "A" && !opts.skip_ipv4) || (v == "AAAA" && !opts.skip_ipv6))
-                    .collect();
-                entry
-            })
-            .collect();
     }
-    Ok(config)
 }
 
 pub fn validate_config(config: &Config) -> anyhow::Result<()> {
@@ -134,9 +117,6 @@ fqdn = "example.com"
 api_key = "xxx"
 ttl = 300
 
-[[entry]]
-name = "www"
-
 [[entry]]
 name = "@"
 "#,
@@ -145,18 +125,14 @@ name = "@"
 
         let opts = Opts {
             config: Some(temp.to_string_lossy().to_string()),
-            ..Opts::default()
         };
         let conf = load_config(&opts).expect("Failed to load config file");
 
         assert_eq!(conf.fqdn, "example.com");
         assert_eq!(conf.api_key, "xxx");
         assert_eq!(conf.ttl, 300);
-        assert_eq!(conf.entry.len(), 2);
+        assert_eq!(conf.entry.len(), 1);
-        assert_eq!(conf.entry[0].name, "www");
+        assert_eq!(conf.entry[0].name, "@");
-        assert_eq!(conf.entry[0].types, vec!["A".to_string()]);
-        assert_eq!(conf.entry[1].name, "@");
-        assert_eq!(conf.entry[1].types, vec!["A".to_string()]);
         // default
         assert_eq!(conf.ip_source, IPSourceName::Ipify);
     }
@@ -185,7 +161,6 @@ name = "@"
 
         let opts = Opts {
             config: Some(temp.to_string_lossy().to_string()),
-            ..Opts::default()
         };
         let conf = load_config(&opts).expect("Failed to load config file");
 
@@ -197,80 +172,4 @@ name = "@"
         assert_eq!(conf.entry[1].name, "@");
         assert_eq!(conf.ip_source, IPSourceName::Icanhazip);
     }
-
-    #[test]
-    fn load_config_skip_ipv4_with_opts() {
-        let mut temp = temp_dir().join("gandi-live-dns-test");
-        fs::create_dir_all(&temp).expect("Failed to create test dir");
-        temp.push("test-3.toml");
-        fs::write(
-            &temp,
-            r#"
-fqdn = "example.com"
-api_key = "yyy"
-
-[[entry]]
-name = "www"
-types = ["A", "AAAA"]
-
-[[entry]]
-name = "@"
-types = ["A", "AAAA"]
-"#,
-        )
-        .expect("Failed to write test config file");
-
-        let opts = Opts {
-            config: Some(temp.to_string_lossy().to_string()),
-            skip_ipv4: true,
-            ..Opts::default()
-        };
-        let conf = load_config(&opts).expect("Failed to load config file");
-
-        assert_eq!(conf.fqdn, "example.com");
-        assert_eq!(conf.api_key, "yyy");
-        assert_eq!(conf.entry.len(), 2);
-        assert_eq!(conf.entry[0].name, "www");
-        assert_eq!(conf.entry[0].types, vec!["AAAA".to_string()]);
-        assert_eq!(conf.entry[1].name, "@");
-        assert_eq!(conf.entry[1].types, vec!["AAAA".to_string()]);
-    }
-
-    #[test]
-    fn load_config_skip_ipv6_with_opts() {
-        let mut temp = temp_dir().join("gandi-live-dns-test");
-        fs::create_dir_all(&temp).expect("Failed to create test dir");
-        temp.push("test-4.toml");
-        fs::write(
-            &temp,
-            r#"
-fqdn = "example.com"
-api_key = "yyy"
-
-[[entry]]
-name = "www"
-types = ["A", "AAAA"]
-
-[[entry]]
-name = "@"
-types = ["A", "AAAA"]
-"#,
-        )
-        .expect("Failed to write test config file");
-
-        let opts = Opts {
-            config: Some(temp.to_string_lossy().to_string()),
-            skip_ipv6: true,
-            ..Opts::default()
-        };
-        let conf = load_config(&opts).expect("Failed to load config file");
-
-        assert_eq!(conf.fqdn, "example.com");
-        assert_eq!(conf.api_key, "yyy");
-        assert_eq!(conf.entry.len(), 2);
-        assert_eq!(conf.entry[0].name, "www");
-        assert_eq!(conf.entry[0].types, vec!["A".to_string()]);
-        assert_eq!(conf.entry[1].name, "@");
-        assert_eq!(conf.entry[1].types, vec!["A".to_string()]);
-    }
 }

src/main.rs

@@ -14,7 +14,7 @@ mod config;
 mod gandi;
 mod ip_source;
 mod opts;
-use die_exit_2::*;
+use die_exit::*;
 use governor;
 
 /// 30 requests per minute, see https://api.gandi.net/docs/reference/
@@ -179,7 +179,6 @@ mod tests {
 
         let opts = Opts {
             config: Some(temp.to_string_lossy().to_string()),
-            ..Opts::default()
         };
         let conf = config::load_config(&opts).expect("Failed to load config");
         run::<IPSourceMock>(server.base_url().as_str(), conf)

src/opts.rs

@@ -1,20 +1,10 @@
 use clap::Parser;
 
 /// A tool to automatically update DNS entries on Gandi, using it as a dynamic DNS system.
-#[derive(Parser, Debug, Default)]
+#[derive(Parser, Debug)]
 #[clap(author, version, about, long_about = None, name = "gandi-live-dns")]
 pub struct Opts {
     /// The path to the configuration file.
     #[clap(long)]
     pub config: Option<String>,
-    /// Skip IPv4 updates.
-    ///
-    /// If enabled, any IPv4 (A) records in the configuration file are ignored.
-    #[clap(action, long)]
-    pub skip_ipv4: bool,
-    /// Skip IPv4 updates.
-    ///
-    /// If enabled, any IPv6 (AAAA) records in the configuration file are ignored.
-    #[clap(action, long)]
-    pub skip_ipv6: bool,
 }