Upload to ghcr.io, document the fact that it's there

Update to 1.8.0
Update deps (#95 )
2024-05-18 03:09:04 -05:00 · 2023-03-16 00:10:45 -04:00 · 2023-02-13 01:04:05 -05:00 · 2023-02-13 01:03:34 -05:00 · 2023-02-13 00:58:23 -05:00 · 2023-02-10 22:08:54 -05:00
14 changed files with 434 additions and 148 deletions
--- a/.clippy.toml
+++ b/.clippy.toml
@ -0,0 +1,3 @@
+# assert_eq!(..., true) or false is a lot clearer when testing functions that
+# return booleans.
+bool_assert_comparison = false
--- a/.codecov.yml
+++ b/.codecov.yml
@ -0,0 +1,4 @@
+ignore:
+  # These are tested, but the tests hit external services which is not
+  # necessarily smart to do in CI, so they get skipped.
+  - "src/ip_source"
--- a/Cargo.lock
+++ b/Cargo.lock
@ -13,9 +13,9 @@ dependencies = [

 [[package]]
 name = "anyhow"
-version = "1.0.68"
+version = "1.0.69"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2cb2f989d18dd141ab8ae82f64d1a8cdd37e0840f73a406896cf5e99502fab61"
+checksum = "224afbd727c3d6e4b90103ece64b8d1b67fbb1973b1046c2281eed3f3803f800"

 [[package]]
 name = "ascii-canvas"
@ -93,7 +93,7 @@ dependencies = [
 "slab",
 "socket2",
 "waker-fn",
- "windows-sys",
+ "windows-sys 0.42.0",
 ]

 [[package]]
@ -130,7 +130,7 @@ dependencies = [
 "futures-lite",
 "libc",
 "signal-hook",
- "windows-sys",
+ "windows-sys 0.42.0",
 ]

 [[package]]
@ -266,9 +266,9 @@ checksum = "0d261e256854913907f67ed06efbc3338dfe6179796deefc1ff763fc1aee5535"

 [[package]]
 name = "bytes"
-version = "1.3.0"
+version = "1.4.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dfb24e866b15a1af2a1b663f10c6b6b8f397a84aadb828f12e5b289ec23a3a3c"
+checksum = "89b2fd2a0dcf38d7971e2194b6b6eebab45ae01067456a7fd93d5547a61b70be"

 [[package]]
 name = "castaway"
@ -476,9 +476,9 @@ dependencies = [

 [[package]]
 name = "encoding_rs"
-version = "0.8.31"
+version = "0.8.32"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9852635589dc9f9ea1b6fe9f05b50ef208c85c834a562f0c6abb1c475736ec2b"
+checksum = "071a31f4ee85403370b58aca746f01041ede6f0da2730960ad001edc2b71b394"
 dependencies = [
 "cfg-if",
 ]
@ -652,7 +652,7 @@ dependencies = [

 [[package]]
 name = "gandi-live-dns"
-version = "1.7.0"
+version = "1.8.0"
 dependencies = [
 "anyhow",
 "async-trait",
@ -663,9 +663,11 @@ dependencies = [
 "governor",
 "httpmock",
 "json",
+ "lazy_static",
 "regex",
 "reqwest",
 "serde",
+ "thiserror",
 "tokio",
 "toml",
 ]
@ -738,9 +740,9 @@ checksum = "8a9ee70c43aaf417c914396645a0fa852624801b24ebb7ae78fe8272889ac888"

 [[package]]
 name = "heck"
-version = "0.4.0"
+version = "0.4.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2540771e65fc8cb83cd6e8a237f70c319bd5c29f78ed1084ba5d50eeac86f7f9"
+checksum = "95505c38b4572b2d910cecb0281560f54b440a19336cbbcb27bf6ce6adc6f5a8"

 [[package]]
 name = "hermit-abi"
@ -760,6 +762,12 @@ dependencies = [
 "libc",
 ]

+[[package]]
+name = "hermit-abi"
+version = "0.3.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "fed44880c466736ef9a5c5b5facefb5ed0785676d0c02d612db14e54f0d84286"
+
 [[package]]
 name = "http"
 version = "0.2.8"
@ -824,9 +832,9 @@ dependencies = [

 [[package]]
 name = "hyper"
-version = "0.14.23"
+version = "0.14.24"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "034711faac9d2166cb1baf1a2fb0b60b1f277f8492fd72176c17f3515e1abd3c"
+checksum = "5e011372fa0b68db8350aa7a248930ecc7839bf46d8485577d69f117a75f164c"
 dependencies = [
 "bytes",
 "futures-channel",
@ -890,12 +898,12 @@ dependencies = [

 [[package]]
 name = "io-lifetimes"
-version = "1.0.4"
+version = "1.0.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e7d6c6f8c91b4b9ed43484ad1a938e393caf35960fce7f82a040497207bd8e9e"
+checksum = "1abeb7a0dd0f8181267ff8adc397075586500b81b28a73e8a0208b00fc170fb3"
 dependencies = [
 "libc",
- "windows-sys",
+ "windows-sys 0.45.0",
 ]

 [[package]]
@ -906,14 +914,14 @@ checksum = "30e22bd8629359895450b59ea7a776c850561b96a3b1d31321c1949d9e6c9146"

 [[package]]
 name = "is-terminal"
-version = "0.4.2"
+version = "0.4.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "28dfb6c8100ccc63462345b67d1bbc3679177c75ee4bf59bf29c8b1d110b8189"
+checksum = "22e18b0a45d56fe973d6db23972bf5bc46f988a4a2385deac9cc29572f09daef"
 dependencies = [
- "hermit-abi 0.2.6",
+ "hermit-abi 0.3.1",
 "io-lifetimes",
 "rustix",
- "windows-sys",
+ "windows-sys 0.45.0",
 ]

 [[package]]
@ -960,9 +968,9 @@ checksum = "fad582f4b9e86b6caa621cabeb0963332d92eea04729ab12892c2533951e6440"

 [[package]]
 name = "js-sys"
-version = "0.3.60"
+version = "0.3.61"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "49409df3e3bf0856b916e2ceaca09ee28e6871cf7d9ce97a692cacfdb2a25a47"
+checksum = "445dde2150c55e483f3d8416706b97ec8e8237c307e5b7b4b8dd15e6af2a0730"
 dependencies = [
 "wasm-bindgen",
 ]
@ -1110,7 +1118,7 @@ dependencies = [
 "libc",
 "log",
 "wasi 0.11.0+wasi-snapshot-preview1",
- "windows-sys",
+ "windows-sys 0.42.0",
 ]

 [[package]]
@ -1199,15 +1207,15 @@ dependencies = [

 [[package]]
 name = "parking_lot_core"
-version = "0.9.6"
+version = "0.9.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ba1ef8814b5c993410bb3adfad7a5ed269563e4a2f90c41f5d85be7fb47133bf"
+checksum = "9069cbb9f99e3a5083476ccb29ceb1de18b9118cafa53e90c9551235de2b9521"
 dependencies = [
 "cfg-if",
 "libc",
 "redox_syscall",
 "smallvec",
- "windows-sys",
+ "windows-sys 0.45.0",
 ]

 [[package]]
@ -1218,9 +1226,9 @@ checksum = "478c572c3d73181ff3c2539045f6eb99e5491218eae919370993b890cdbdd98e"

 [[package]]
 name = "petgraph"
-version = "0.6.2"
+version = "0.6.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e6d5014253a1331579ce62aa67443b4a658c5e7dd03d4bc6d302b94474888143"
+checksum = "4dd7d28ee937e54fe3080c91faa1c3a46c06de6252988a7f4592ba2310ef22a4"
 dependencies = [
 "fixedbitset",
 "indexmap",
@ -1290,7 +1298,7 @@ dependencies = [
 "libc",
 "log",
 "wepoll-ffi",
- "windows-sys",
+ "windows-sys 0.42.0",
 ]

 [[package]]
@ -1331,9 +1339,9 @@ dependencies = [

 [[package]]
 name = "proc-macro2"
-version = "1.0.50"
+version = "1.0.51"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "6ef7d57beacfaf2d8aee5937dab7b7f28de3cb8b1828479bb5de2a7106f2bae2"
+checksum = "5d727cae5b39d21da60fa540906919ad737832fe0b1c165da3a34d6548c849d6"
 dependencies = [
 "unicode-ident",
 ]
@ -1395,9 +1403,9 @@ dependencies = [

 [[package]]
 name = "raw-cpuid"
-version = "10.6.0"
+version = "10.6.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a6823ea29436221176fe662da99998ad3b4db2c7f31e7b6f5fe43adccd6320bb"
+checksum = "c307f7aacdbab3f0adee67d52739a1d71112cc068d6fab169ddeb18e48877fad"
 dependencies = [
 "bitflags",
 ]
@ -1495,16 +1503,16 @@ dependencies = [

 [[package]]
 name = "rustix"
-version = "0.36.7"
+version = "0.36.8"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "d4fdebc4b395b7fbb9ab11e462e20ed9051e7b16e42d24042c776eca0ac81b03"
+checksum = "f43abb88211988493c1abb44a70efa56ff0ce98f233b7b276146f1f3f7ba9644"
 dependencies = [
 "bitflags",
 "errno",
 "io-lifetimes",
 "libc",
 "linux-raw-sys",
- "windows-sys",
+ "windows-sys 0.45.0",
 ]

 [[package]]
@ -1546,7 +1554,7 @@ version = "0.1.21"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "713cfb06c7059f3588fb8044c0fad1d09e3c01d225e25b9220dbfdcf16dbb1b3"
 dependencies = [
- "windows-sys",
+ "windows-sys 0.42.0",
 ]

 [[package]]
@ -1587,9 +1595,9 @@ dependencies = [

 [[package]]
 name = "serde_json"
-version = "1.0.91"
+version = "1.0.93"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "877c235533714907a8c2464236f5c4b2a17262ef1bd71f38f35ea592c8da6883"
+checksum = "cad406b69c91885b5107daf2c29572f6c8cdb3c66826821e286c533490c0bc76"
 dependencies = [
 "itoa",
 "ryu",
@ -1629,9 +1637,9 @@ dependencies = [

 [[package]]
 name = "signal-hook"
-version = "0.3.14"
+version = "0.3.15"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a253b5e89e2698464fc26b545c9edceb338e18a89effeeecfea192c3025be29d"
+checksum = "732768f1176d21d09e076c23a93123d40bba92d50c4058da34d45c8de8e682b9"
 dependencies = [
 "libc",
 "signal-hook-registry",
@ -1639,9 +1647,9 @@ dependencies = [

 [[package]]
 name = "signal-hook-registry"
-version = "1.4.0"
+version = "1.4.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e51e73328dc4ac0c7ccbda3a494dfa03df1de2f46018127f60c693f2648455b0"
+checksum = "d8229b473baa5980ac72ef434c4415e70c4b5e71b423043adb4ba059f89c99a1"
 dependencies = [
 "libc",
 ]
@ -1757,7 +1765,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "cb20089a8ba2b69debd491f8d2d023761cbf196e999218c591fa1e7e15a21907"
 dependencies = [
 "rustix",
- "windows-sys",
+ "windows-sys 0.42.0",
 ]

 [[package]]
@ -1800,9 +1808,9 @@ dependencies = [

 [[package]]
 name = "tinyvec_macros"
-version = "0.1.0"
+version = "0.1.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "cda74da7e1a664f795bb1f8a87ec406fb89a02522cf6e50620d016add6dbbf5c"
+checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20"

 [[package]]
 name = "tokio"
@ -1821,7 +1829,7 @@ dependencies = [
 "signal-hook-registry",
 "socket2",
 "tokio-macros",
- "windows-sys",
+ "windows-sys 0.42.0",
 ]

 [[package]]
@ -1848,9 +1856,9 @@ dependencies = [

 [[package]]
 name = "tokio-util"
-version = "0.7.4"
+version = "0.7.7"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "0bb2e075f03b3d66d8d8785356224ba688d2906a371015e225beeb65ca92c740"
+checksum = "5427d89453009325de0d8f342c9490009f76e999cb7672d77e46267448f7e6b2"
 dependencies = [
 "bytes",
 "futures-core",
@ -1862,9 +1870,9 @@ dependencies = [

 [[package]]
 name = "toml"
-version = "0.7.1"
+version = "0.7.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "772c1426ab886e7362aedf4abc9c0d1348a979517efedfc25862944d10137af0"
+checksum = "f7afcae9e3f0fe2c370fd4657108972cbb2fa9db1b9f84849cefd80741b01cb6"
 dependencies = [
 "serde",
 "serde_spanned",
@ -1883,9 +1891,9 @@ dependencies = [

 [[package]]
 name = "toml_edit"
-version = "0.19.1"
+version = "0.19.3"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "90a238ee2e6ede22fb95350acc78e21dc40da00bb66c0334bde83de4ed89424e"
+checksum = "5e6a7712b49e1775fb9a7b998de6635b299237f48b404dde71704f2e0e7f37e5"
 dependencies = [
 "indexmap",
 "nom8",
@ -2060,9 +2068,9 @@ checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"

 [[package]]
 name = "wasm-bindgen"
-version = "0.2.83"
+version = "0.2.84"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "eaf9f5aceeec8be17c128b2e93e031fb8a4d469bb9c4ae2d7dc1888b26887268"
+checksum = "31f8dcbc21f30d9b8f2ea926ecb58f6b91192c17e9d33594b3df58b2007ca53b"
 dependencies = [
 "cfg-if",
 "wasm-bindgen-macro",
@ -2070,9 +2078,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-backend"
-version = "0.2.83"
+version = "0.2.84"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "4c8ffb332579b0557b52d268b91feab8df3615f265d5270fec2a8c95b17c1142"
+checksum = "95ce90fd5bcc06af55a641a86428ee4229e44e07033963a2290a8e241607ccb9"
 dependencies = [
 "bumpalo",
 "log",
@ -2085,9 +2093,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-futures"
-version = "0.4.33"
+version = "0.4.34"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "23639446165ca5a5de86ae1d8896b737ae80319560fbaa4c2887b7da6e7ebd7d"
+checksum = "f219e0d211ba40266969f6dbdd90636da12f75bee4fc9d6c23d1260dadb51454"
 dependencies = [
 "cfg-if",
 "js-sys",
@ -2097,9 +2105,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-macro"
-version = "0.2.83"
+version = "0.2.84"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "052be0f94026e6cbc75cdefc9bae13fd6052cdcaf532fa6c45e7ae33a1e6c810"
+checksum = "4c21f77c0bedc37fd5dc21f897894a5ca01e7bb159884559461862ae90c0b4c5"
 dependencies = [
 "quote",
 "wasm-bindgen-macro-support",
@ -2107,9 +2115,9 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-macro-support"
-version = "0.2.83"
+version = "0.2.84"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "07bc0c051dc5f23e307b13285f9d75df86bfdf816c5721e573dec1f9b8aa193c"
+checksum = "2aff81306fcac3c7515ad4e177f521b5c9a15f2b08f4e32d823066102f35a5f6"
 dependencies = [
 "proc-macro2",
 "quote",
@ -2120,15 +2128,15 @@ dependencies = [

 [[package]]
 name = "wasm-bindgen-shared"
-version = "0.2.83"
+version = "0.2.84"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "1c38c045535d93ec4f0b4defec448e4291638ee608530863b1e2ba115d4fff7f"
+checksum = "0046fef7e28c3804e5e38bfa31ea2a0f73905319b677e57ebe37e49358989b5d"

 [[package]]
 name = "web-sys"
-version = "0.3.60"
+version = "0.3.61"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bcda906d8be16e728fd5adc5b729afad4e444e106ab28cd1c7256e54fa61510f"
+checksum = "e33b99f4b23ba3eec1a53ac264e35a755f00e966e0065077d6027c0f575b0b97"
 dependencies = [
 "js-sys",
 "wasm-bindgen",
@ -2208,6 +2216,30 @@ dependencies = [
 "windows_x86_64_msvc",
 ]

+[[package]]
+name = "windows-sys"
+version = "0.45.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "75283be5efb2831d37ea142365f009c02ec203cd29a3ebecbc093d52315b66d0"
+dependencies = [
+ "windows-targets",
+]
+
+[[package]]
+name = "windows-targets"
+version = "0.42.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "8e2522491fbfcd58cc84d47aeb2958948c4b8982e9a2d8a2a35bbaed431390e7"
+dependencies = [
+ "windows_aarch64_gnullvm",
+ "windows_aarch64_msvc",
+ "windows_i686_gnu",
+ "windows_i686_msvc",
+ "windows_x86_64_gnu",
+ "windows_x86_64_gnullvm",
+ "windows_x86_64_msvc",
+]
+
 [[package]]
 name = "windows_aarch64_gnullvm"
 version = "0.42.1"
--- a/Cargo.toml
+++ b/Cargo.toml
@ -1,11 +1,11 @@
 [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.7.0"
+version = "1.8.0"
 edition = "2021"
 authors = ["Kaan Barmore-Genç <kaan@bgenc.net>"]
 license = "MIT"
-readme = "Readme.md"
+readme = "README.md"
 repository = "https://github.com/SeriousBug/gandi-live-dns-rust"

 [profile.release]
@ -33,10 +33,12 @@ anyhow = "1.0"
 governor = "0.5"
 async-trait = "0.1"
 die-exit = "0.4"
+thiserror = "1.0.38"

 [dev-dependencies]
 httpmock = "0.6"
 regex = "1.6"
+lazy_static = "1.4.0"

 [dev-dependencies.die-exit]
 version = "0.4"
--- a/README.md
+++ b/README.md
@ -69,8 +69,14 @@ Download the latest version from the releases page, extract it from the archive,

 ### With docker

-Use the [seriousbug/gandi-live-dns-rust](https://hub.docker.com/r/seriousbug/gandi-live-dns-rust) Docker images, which are available for x86_64,
-arm64, armv6, and armv7 platforms. Follow the steps below to use these images.
+Container images are available on both Github Packages and Docker Hub.
+- [ghcr.io/seriousbug/gandi-live-dns-rust](https://github.com/users/seriousbug/packages/container/package/gandi-live-dns-rust)
+- [docker.io/seriousbug/gandi-live-dns-rust](https://hub.docker.com/r/seriousbug/gandi-live-dns-rust)
+
+The container images are built multi-arch, with support for x86_64, arm64,
+armv7, and armv6 platforms. Follow the steps below to use them. You can use
+`seriousbug/gandi-live-dns-rust` directly which will default to Docker Hub,
+otherwise add `ghcr.io` in the examples below to use Github Packages.

 - Create a file `gandi.toml`, then copy and paste the contents of [`example.toml`](https://raw.githubusercontent.com/SeriousBug/gandi-live-dns-rust/master/example.toml)
 - Follow the instructions in the example config to get your API key and put it in the config
@ -161,7 +167,8 @@ Docker with `docker login`. Then follow these steps:
 - Create a release on Github
  - Make sure to create a tag for the release version on `master`
  - Upload the binary archives to the Github release
- Update the AUR version manually
+- Update the AUR version
+- Run `cargo publish` to update the crates.io version

 ## Alternatives

--- a/make-release.sh
+++ b/make-release.sh
@ -3,9 +3,7 @@
 # Make sure `cross` is installed.
 # You'll also need `sed`, a relatively recent version of `tar`, and `7z`.
 #
-# This script runs does `sudo docker` to build and push the release to docker.
-# If you have rootless docker set up, remove sudo from this variable.
-DOCKER="sudo docker"
+DOCKER="docker"
 #
 shopt -s extglob
 # Trap errors and interrupts
@ -49,6 +47,9 @@ VERSION=$(sed -nr 's/^version *= *"([0-9.]+)"/\1/p' Cargo.toml | head --lines=1)
 # Make the builds
 for target in "${!TARGETS[@]}"; do
  echo Building "${target}"
+  # Keeping the cached builds seem to be breaking things when going between targets
+  # This wouldn't be a problem if these were running in a matrix on the CI...
+  rm -rf target/release/
  cross build -j $(($(nproc) / 2)) --release --target "${target}"
  if [[ "${target}" =~ .*"windows".* ]]; then
    zip -j "gandi-live-dns.${VERSION}.${TARGETS[${target}]}.zip" target/"${target}"/release/gandi-live-dns.exe 1>/dev/null
@ -76,4 +77,6 @@ ${DOCKER} buildx build . \
  --file "Dockerfile" \
  --tag "seriousbug/gandi-live-dns-rust:latest" \
  --tag "seriousbug/gandi-live-dns-rust:${VERSION}" \
+  --tag "ghcr.io/seriousbug/gandi-live-dns-rust:latest" \
+  --tag "ghcr.io/seriousbug/gandi-live-dns-rust:${VERSION}" \
  --push
--- a/src/config.rs
+++ b/src/config.rs
@ -1,13 +1,26 @@
 use crate::opts;
 use directories::ProjectDirs;
 use serde::Deserialize;
-use std::fs;
 use std::path::PathBuf;
+use std::{fs, io};
+use thiserror::Error;

 fn default_types() -> Vec<String> {
    DEFAULT_TYPES.iter().map(|v| v.to_string()).collect()
 }

+#[derive(Error, Debug)]
+pub enum ConfigError {
+    #[error("Failed to read config file: {0} ")]
+    Io(#[from] io::Error),
+    #[error("Failed to parse config file: {0}")]
+    Parse(#[from] toml::de::Error),
+    #[error("Entry '{0}' has invalid type '{1}'")]
+    Validation(String, String),
+    #[error("Can't find config directory")]
+    ConfigNotFound(),
+}
+
 #[derive(Deserialize, Debug)]
 pub struct Entry {
    pub name: String,
@ -65,18 +78,20 @@ impl Config {
    }
 }

-fn load_config_from<P: std::convert::AsRef<std::path::Path>>(path: P) -> anyhow::Result<Config> {
+fn load_config_from<P: std::convert::AsRef<std::path::Path>>(
+    path: P,
+) -> Result<Config, ConfigError> {
    let contents = fs::read_to_string(path)?;
    Ok(toml::from_str(&contents)?)
 }

-pub fn load_config(opts: &opts::Opts) -> anyhow::Result<Config> {
+pub fn load_config(opts: &opts::Opts) -> Result<Config, ConfigError> {
    let mut config = match &opts.config {
        Some(config_path) => load_config_from(config_path),
        None => {
            let confpath = ProjectDirs::from("me", "kaangenc", "gandi-dynamic-dns")
                .map(|dir| PathBuf::from(dir.config_dir()).join("config.toml"))
-                .ok_or_else(|| anyhow::anyhow!("Can't find config directory"));
+                .ok_or(ConfigError::ConfigNotFound());
            confpath
                .and_then(|path| {
                    println!("Checking for config: {}", path.to_string_lossy());
@ -105,11 +120,14 @@ pub fn load_config(opts: &opts::Opts) -> anyhow::Result<Config> {
    Ok(config)
 }

-pub fn validate_config(config: &Config) -> anyhow::Result<()> {
+pub fn validate_config(config: &Config) -> Result<(), ConfigError> {
    for entry in &config.entry {
        for entry_type in Config::types(entry) {
            if entry_type != "A" && entry_type != "AAAA" {
-                anyhow::bail!("Entry {} has invalid type {}", entry.name, entry_type);
+                return Err(ConfigError::Validation(
+                    entry.name.clone(),
+                    entry_type.to_string(),
+                ));
            }
        }
    }
--- a/src/ip_source/common.rs
+++ b/src/ip_source/common.rs
@ -0,0 +1,9 @@
+use async_trait::async_trait;
+
+use crate::ClientError;
+
+#[async_trait]
+pub trait IPSource {
+    async fn get_ipv4(&self) -> Result<String, ClientError>;
+    async fn get_ipv6(&self) -> Result<String, ClientError>;
+}
--- a/src/ip_source/icanhazip.rs
+++ b/src/ip_source/icanhazip.rs
@ -1,10 +1,12 @@
 use async_trait::async_trait;

-use super::ip_source::IPSource;
+use crate::ClientError;
+
+use super::common::IPSource;

 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 text = response.text().await?;
    Ok(text)
@ -12,14 +14,14 @@ async fn get_ip(api_url: &str) -> anyhow::Result<String> {

 #[async_trait]
 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")
            .await?
            // icanazip puts a newline at the end
            .trim()
            .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")
            .await?
            // icanazip puts a newline at the end
@ -32,7 +34,7 @@ impl IPSource for IPSourceIcanhazip {
 mod tests {
    use regex::Regex;

-    use crate::ip_source::ip_source::IPSource;
+    use crate::ip_source::common::IPSource;

    use super::IPSourceIcanhazip;

--- a/src/ip_source/ip_source.rs
+++ b/src/ip_source/ip_source.rs
@ -1,7 +0,0 @@
-use async_trait::async_trait;
-
-#[async_trait]
-pub trait IPSource {
-    async fn get_ipv4(&self) -> anyhow::Result<String>;
-    async fn get_ipv6(&self) -> anyhow::Result<String>;
-}
--- a/src/ip_source/ipify.rs
+++ b/src/ip_source/ipify.rs
@ -1,10 +1,12 @@
 use async_trait::async_trait;

-use super::ip_source::IPSource;
+use crate::ClientError;
+
+use super::common::IPSource;

 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 text = response.text().await?;
    Ok(text)
@ -12,10 +14,10 @@ async fn get_ip(api_url: &str) -> anyhow::Result<String> {

 #[async_trait]
 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
    }
-    async fn get_ipv6(&self) -> anyhow::Result<String> {
+    async fn get_ipv6(&self) -> Result<String, ClientError> {
        get_ip("https://api6.ipify.org").await
    }
 }
--- a/src/ip_source/mod.rs
+++ b/src/ip_source/mod.rs
@ -1,4 +1,4 @@
+pub(crate) mod common;
 pub(crate) mod icanhazip;
-pub(crate) mod ip_source;
 pub(crate) mod ipify;
 pub(crate) mod seeip;
--- a/src/ip_source/seeip.rs
+++ b/src/ip_source/seeip.rs
@ -1,10 +1,12 @@
 use async_trait::async_trait;

-use super::ip_source::IPSource;
+use crate::ClientError;
+
+use super::common::IPSource;

 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 text = response.text().await?;
    Ok(text)
@ -12,10 +14,10 @@ async fn get_ip(api_url: &str) -> anyhow::Result<String> {

 #[async_trait]
 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
    }
-    async fn get_ipv6(&self) -> anyhow::Result<String> {
+    async fn get_ipv6(&self) -> Result<String, ClientError> {
        get_ip("https://ip6.seeip.org").await
    }
 }
--- a/src/main.rs
+++ b/src/main.rs
@ -1,13 +1,14 @@
 use crate::config::Config;
 use crate::gandi::GandiAPI;
-use crate::ip_source::{ip_source::IPSource, ipify::IPSourceIpify};
+use crate::ip_source::{common::IPSource, ipify::IPSourceIpify};
 use clap::Parser;
-use config::IPSourceName;
+use config::{ConfigError, IPSourceName};
 use ip_source::icanhazip::IPSourceIcanhazip;
 use ip_source::seeip::IPSourceSeeIP;
 use opts::Opts;
+use reqwest::header::InvalidHeaderValue;
 use reqwest::{header, Client, ClientBuilder, StatusCode};
-use serde::Serialize;
+use serde::{Deserialize, Serialize};
 use std::{num::NonZeroU32, sync::Arc, time::Duration};
 use tokio::join;
 use tokio::{self, task::JoinHandle, time::sleep};
@ -16,16 +17,47 @@ mod gandi;
 mod ip_source;
 mod opts;
 use die_exit::*;
+use thiserror::Error;

 /// 30 requests per minute, see https://api.gandi.net/docs/reference/
 const GANDI_RATE_LIMIT: u32 = 30;
 /// If we hit the rate limit, wait up to this many seconds before next attempt
 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 key = format!("Apikey {}", api_key);
+    let key = format!("Apikey {api_key}");
    let mut auth_value = header::HeaderValue::from_str(&key)?;
    let mut headers = header::HeaderMap::new();
    auth_value.set_sensitive(true);
@ -42,12 +74,30 @@ pub struct APIPayload {
    pub rrset_ttl: u32,
 }

+#[derive(Debug)]
+struct ResponseFeedback {
+    entry_name: String,
+    entry_type: String,
+    response: Result<String, ApiError>,
+}
+
+#[derive(Deserialize)]
+// Allowing dead code because this is the API response we get from Gandi.
+// We don't necessarily need all the fields, but we get them anyway.
+#[allow(dead_code)]
+struct ApiResponse {
+    message: String,
+    cause: Option<String>,
+    code: Option<i32>,
+    object: Option<String>,
+}
+
 async fn run(
    base_url: &str,
    ip_source: &Box<dyn IPSource>,
    conf: &Config,
    opts: &Opts,
-) -> anyhow::Result<()> {
+) -> Result<(), ClientError> {
    let mut last_ipv4: Option<String> = None;
    let mut last_ipv6: Option<String> = None;

@ -58,12 +108,12 @@ async fn run(
        let ipv6 = ipv6_result.as_ref();
        println!("Found these:");
        match ipv4 {
-            Ok(ip) => println!("\tIPv4: {}", ip),
-            Err(err) => eprintln!("\tIPv4 failed: {}", err),
+            Ok(ip) => println!("\tIPv4: {ip}"),
+            Err(err) => eprintln!("\tIPv4 failed: {err}"),
        }
        match ipv6 {
-            Ok(ip) => println!("\tIPv6: {}", ip),
-            Err(err) => eprintln!("\tIPv6 failed: {}", err),
+            Ok(ip) => println!("\tIPv6: {ip}"),
+            Err(err) => eprintln!("\tIPv6 failed: {err}"),
        }

        let ipv4_same = last_ipv4
@ -75,12 +125,9 @@ async fn run(
            .map(|p| ipv6.map(|q| p == q).unwrap_or(false))
            .unwrap_or(false);

-        last_ipv4 = ipv4.ok().map(|v| v.to_string());
-        last_ipv6 = ipv6.ok().map(|v| v.to_string());
-
        if !ipv4_same || !ipv6_same || conf.always_update {
            let client = api_client(&conf.api_key)?;
-            let mut tasks: Vec<JoinHandle<(StatusCode, String)>> = Vec::new();
+            let mut tasks: Vec<JoinHandle<Result<ResponseFeedback, ClientError>>> = Vec::new();
            println!("Attempting to update DNS entries now");

            let governor = Arc::new(governor::RateLimiter::direct(governor::Quota::per_minute(
@ -100,10 +147,22 @@ async fn run(
                    }
                    .url();
                    let ip = match entry_type {
-                        "A" => ipv4.die_with(|error| format!("Needed IPv4 for {fqdn}: {error}")),
-                        "AAAA" => ipv6.die_with(|error| format!("Needed IPv6 for {fqdn}: {error}")),
-                        bad_entry_type => die!("Unexpected type in config: {}", bad_entry_type),
-                    };
+                        "A" => match ipv4 {
+                            Ok(ref value) => Ok(value),
+                            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 {
                        rrset_values: vec![ip.to_string()],
                        rrset_ttl: Config::ttl(entry, conf),
@ -111,28 +170,94 @@ async fn run(
                    let req = client.put(url).json(&payload);
                    let task_governor = governor.clone();
                    let entry_type = entry_type.to_string();
-                    let task = tokio::task::spawn(async move {
-                        task_governor.until_ready_with_jitter(retry_jitter).await;
-                        println!("Updating {} record for {}", entry_type, &fqdn);
-                        match req.send().await {
-                            Ok(response) => (
-                                response.status(),
-                                response
-                                    .text()
-                                    .await
-                                    .unwrap_or_else(|error| error.to_string()),
-                            ),
-                            Err(error) => (StatusCode::IM_A_TEAPOT, error.to_string()),
-                        }
-                    });
+                    let entry_name = entry.name.to_string();
+
+                    let task: JoinHandle<Result<ResponseFeedback, ClientError>> =
+                        tokio::task::spawn(async move {
+                            task_governor.until_ready_with_jitter(retry_jitter).await;
+                            println!("Updating {} record for {}", entry_type, &fqdn);
+
+                            let resp = req.send().await?;
+
+                            let response_feedback = match resp.status() {
+                                StatusCode::CREATED => {
+                                    let body: ApiResponse = resp.json().await?;
+                                    ResponseFeedback {
+                                        entry_name,
+                                        entry_type,
+                                        response: Ok(body.message),
+                                    }
+                                }
+                                StatusCode::UNAUTHORIZED => ResponseFeedback {
+                                    entry_name,
+                                    entry_type,
+                                    response: Err(ApiError::Unauthorized()),
+                                },
+                                StatusCode::FORBIDDEN => {
+                                    let body: ApiResponse = resp.json().await?;
+                                    ResponseFeedback {
+                                        entry_name: entry_name.clone(),
+                                        entry_type,
+                                        response: Err(ApiError::Forbidden {
+                                            message: body.message,
+                                        }),
+                                    }
+                                }
+                                _ => {
+                                    let status = resp.status();
+                                    let body: ApiResponse = resp.json().await?;
+                                    ResponseFeedback {
+                                        entry_name,
+                                        entry_type,
+                                        response: Err(ApiError::Unknown(status, body.message)),
+                                    }
+                                }
+                            };
+                            Ok(response_feedback)
+                        });
                    tasks.push(task);
                }
            }

            let results = futures::future::try_join_all(tasks).await?;
-            println!("Updates done for {} entries", results.len());
-            for (status, body) in results {
-                println!("{} - {}", status, body);
+            // Only count successfull requests
+            println!(
+                "Updates done for {} entries",
+                results
+                    .iter()
+                    .filter_map(|item| item.as_ref().ok())
+                    .filter(|item| item.response.is_ok())
+                    .count()
+            );
+            for item in &results {
+                match item {
+                    Ok(value) => println!(
+                        "{}",
+                        match &value.response {
+                            Ok(val) => format!(
+                                "Record '{}' ({}): {}",
+                                value.entry_name, value.entry_type, val
+                            ),
+                            Err(err) => format!(
+                                "Record '{}' ({}): {}",
+                                value.entry_name, value.entry_type, err
+                            ),
+                        }
+                    ),
+                    Err(err) => println!("{err}"),
+                }
+            }
+            if results
+                .iter()
+                // all tasks finished OK, and all responses were OK as well
+                .all(|result| result.as_ref().map(|v| v.response.is_ok()).unwrap_or(false))
+            {
+                // Only then we update the last seen IP, because we want to
+                // retry updates in case the last update just happened to fail
+                last_ipv4 = ipv4.ok().map(|v| v.to_string());
+                last_ipv6 = ipv6.ok().map(|v| v.to_string());
+            } else if opts.repeat.is_some() {
+                println!("Some operations failed. They will be retried during the next repeat.")
            }
        } else {
            println!("IP address has not changed since last update");
@ -153,36 +278,39 @@ async fn run(
 #[tokio::main(flavor = "current_thread")]
 async fn main() -> anyhow::Result<()> {
    let opts = opts::Opts::parse();
-    let conf = config::load_config(&opts)
-        .die_with(|error| format!("Failed to read config file: {}", error));
+    let conf = config::load_config(&opts)?;

    let ip_source: Box<dyn IPSource> = match conf.ip_source {
        IPSourceName::Ipify => Box::new(IPSourceIpify),
        IPSourceName::Icanhazip => Box::new(IPSourceIcanhazip),
        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?;
    Ok(())
 }

 #[cfg(test)]
 mod tests {
-    use std::{env::temp_dir, time::Duration};
-
-    use crate::{config, ip_source::ip_source::IPSource, opts::Opts, run};
+    use crate::{config, ip_source::common::IPSource, opts::Opts, run, ClientError};
    use async_trait::async_trait;
    use httpmock::MockServer;
+    use lazy_static::lazy_static;
+    use std::{
+        env::temp_dir,
+        sync::atomic::{AtomicBool, Ordering::SeqCst},
+        time::Duration,
+    };
    use tokio::{fs, task::LocalSet, time::sleep};

    struct IPSourceMock;

    #[async_trait]
    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())
        }
-        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())
        }
    }
@ -210,7 +338,8 @@ mod tests {
                    "/v5/livedns/domains/{fqdn}/records/{rname}/{rtype}"
                ))
                .body_contains("192.168.0.0");
-            then.status(200);
+            then.status(201)
+                .body("{\"cause\":\"\", \"code\":201, \"message\":\"\", \"object\":\"\"}");
        });

        let opts = Opts {
@ -257,7 +386,8 @@ mod tests {
                        "/v5/livedns/domains/{fqdn}/records/{rname}/{rtype}"
                    ))
                    .body_contains("192.168.0.0");
-                then.status(200);
+                then.status(201)
+                    .body("{\"cause\":\"\", \"code\":201, \"message\":\"\", \"object\":\"\"}");
            });

            let server_url = server.base_url();
@ -282,6 +412,85 @@ mod tests {
        });
    }

+    #[test]
+    fn repeat_with_failure() {
+        let runtime = tokio::runtime::Builder::new_current_thread()
+            .enable_all()
+            .build()
+            .unwrap();
+
+        LocalSet::new().block_on(&runtime, async {
+            let mut temp = temp_dir().join("gandi-live-dns-test");
+            fs::create_dir_all(&temp)
+                .await
+                .expect("Failed to create test dir");
+            temp.push("test.toml");
+            fs::write(
+                &temp,
+                "fqdn = \"example.com\"\napi_key = \"xxx\"\nttl = 300\n[[entry]]\nname =\"@\"\n",
+            )
+            .await
+            .expect("Failed to write test config file");
+
+            let fqdn = "example.com";
+            let rname = "@";
+            let rtype = "A";
+            let server = MockServer::start();
+            let mock = server.mock(|when, then| {
+                when.method("PUT")
+                    .path(format!(
+                        "/v5/livedns/domains/{fqdn}/records/{rname}/{rtype}"
+                    ))
+                    .body_contains("192.168.0.0")
+                    .matches(|_| {
+                        // Don't match during the first call, but do during the second call
+                        lazy_static! {
+                            static ref FIRST_CALL: AtomicBool = AtomicBool::new(true);
+                        }
+                        if FIRST_CALL.load(SeqCst) {
+                            FIRST_CALL.store(false, SeqCst);
+                            return true;
+                        }
+                        false
+                    });
+                then.status(500)
+                    .body("{\"cause\":\"\", \"code\":500, \"message\":\"Something went wrong\", \"object\":\"\"}");
+            });
+            let mock_fail = server.mock(|when, then| {
+                when.method("PUT")
+                    .path(format!(
+                        "/v5/livedns/domains/{fqdn}/records/{rname}/{rtype}"
+                    ))
+                    .body_contains("192.168.0.0");
+                then.status(201)
+                    .body("{\"cause\":\"\", \"code\":201, \"message\":\"\", \"object\":\"\"}");
+            });
+
+            let server_url = server.base_url();
+            let handle = tokio::task::spawn_local(async move {
+                let opts = Opts {
+                    config: Some(temp.to_string_lossy().to_string()),
+                    repeat: Some(1),
+                    ..Opts::default()
+                };
+                let conf = config::load_config(&opts).expect("Failed to load config");
+                let ip_source: Box<dyn IPSource> = Box::new(IPSourceMock);
+                run(&server_url, &ip_source, &conf, &opts)
+                    .await
+                    .expect("Failed when running the update");
+            });
+
+            sleep(Duration::from_secs(4)).await;
+            handle.abort();
+
+            // The first call failed
+            mock_fail.assert();
+            // We then retried since the first call failed. The retry succeeds
+            // so we don't retry again.
+            mock.assert();
+        });
+    }
+
    #[test]
    fn repeat_always_update() {
        let runtime = tokio::runtime::Builder::new_current_thread()
@ -312,7 +521,7 @@ mod tests {
                        "/v5/livedns/domains/{fqdn}/records/{rname}/{rtype}"
                    ))
                    .body_contains("192.168.0.0");
-                then.status(200);
+                then.status(201).body("{\"cause\":\"\", \"code\":201, \"message\":\"\", \"object\":\"\"}");
            });

            let server_url = server.base_url();
Author	SHA1	Message	Date
Kaan Barmore-Genç	847b6eb1c5	Upload to ghcr.io, document the fact that it's there	2023-03-16 00:10:45 -04:00
Kaan Barmore-Genç	706251c4d8	Update to 1.8.0	2023-02-13 01:04:05 -05:00
Kaan Barmore-Genç	d4dffb19e9	Update deps (#95 )	2023-02-13 01:03:34 -05:00
Kaan Barmore-Genç	5c6b38f7b0	Do retry update after a failure & fix tests (#94 ) * Do retry update after a failure & fix tests * Fix formatting * Fix clippy errors * Add codecov ignore for ip_source files	2023-02-13 00:58:23 -05:00
jannikac	8413555d2f	Implement thiserror and improve output formatting (#91 ) * implemented an error struct with all possible errors using thiserror * Replaced die_with with ClientError enum derived with thiserror. This enables prettier and more structured error handling than anyhow * Added proper parsing of Gandi API Responses. This also makes it possible to output prettier logs. * improved error message * anyhow is better for main fn because it outputs anyhow errors correctly	2023-02-10 22:08:54 -05:00
Kaan Barmore-Genç	5cdd7b9e83	Update readme file name	2023-02-01 23:58:47 -05:00
Kaan Barmore-Genç	1bb4c7af1c	update build script	2023-02-01 23:57:01 -05:00