Merge pull request #4 from axatol/feat/use-gonfig

Author: hans-m-song

.github/workflows/_build.yaml

@@ -25,7 +25,7 @@ on:
 
 jobs:
   build:
-    runs-on: self-hosted
+    runs-on: ${{ github.repository_owner }}
 
     steps:
       - name: Checkout
@@ -46,42 +46,37 @@ jobs:
         run: go vet ./...
 
       - name: Run tests
-        run: go test ./...
+        run: go test -v ./...
 
       - name: Setup golangci-lint
         uses: golangci/golangci-lint-action@v3
         with:
           version: latest
           args: --timeout 1m --verbose
+          skip-cache: true
 
-  publish:
-    needs: build
-    if: inputs.publish
-    runs-on: self-hosted
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          show-progress: false
+      - name: Build
+        run: make build-image IMAGE_TAG=${{ inputs.image-tag }}
 
-      - uses: axatol/actions/assume-aws-role@release
+      - name: Assume AWS role
+        uses: axatol/actions/assume-aws-role@release
+        if: inputs.publish
         with:
           aws-region: us-east-1
           role-to-assume: ${{ secrets.AWS_ECR_IMAGE_PUBLISHER_ROLE_ARN }}
 
       - name: Login to ECR
+        if: inputs.publish
         uses: aws-actions/amazon-ecr-login@v2
         with:
           mask-password: true
 
-      - name: Build
-        run: make build-image IMAGE_TAG=${{ inputs.image-tag }}
-
       - name: Publish
+        if: inputs.publish
         run: make publish-image IMAGE_TAG=${{ inputs.image-tag }}
 
       - name: Prune ECR
+        if: inputs.publish
         uses: axatol/actions/prune-ecr-repository@release
         with:
           repository-name: external-dns-cloudflare-tunnel-webhook

.gitignore

@@ -3,4 +3,4 @@ dist
 tmp
 
 # dev
-.env
+.env*

README.md

@@ -63,24 +63,27 @@ helm upgrade external-dns-cloudflare-tunnel external-dns/external-dns \
 
 ## Configuration
 
-| Environment variable    | Type            | Default            | Notes |
-| ----------------------- | --------------- | ------------------ | ----- |
-| `LOG_LEVEL`             | `string`        | `"info"`           |       |
-| `LOG_FORMAT`            | `string`        | `"json"`           |       |
-| `CLOUDFLARE_API_KEY`    | `string`        | `""`               | ^1    |
-| `CLOUDFLARE_API_EMAIL`  | `string`        | `""`               | ^1    |
-| `CLOUDFLARE_API_TOKEN`  | `string`        | `""`               | ^1    |
-| `CLOUDFLARE_ACCOUNT_ID` | `string`        |                    | ^2    |
-| `CLOUDFLARE_TUNNEL_ID`  | `string`        |                    | ^2    |
-| `CLOUDFLARE_SYNC_DNS`   | `bool`          | `"false"`          |       |
-| `PORT`                  | `int64`         | `"8888"`           |       |
-| `READ_TIMEOUT`          | `time.Duration` | `"5s"`             |       |
-| `WRITE_TIMEOUT`         | `time.Duration` | `"10s"`            |       |
-| `DRY_RUN`               | `bool`          | `"false"`          |       |
-| `DOMAIN_FILTER`         | `[]string`      | `"" delimiter:","` | ^3    |
+### Kubernetes annotations
+
+| Environment variable    | Flag                     | Type            | Default            | Notes |
+| ----------------------- | ------------------------ | --------------- | ------------------ | ----- |
+| `LOG_LEVEL`             | `-log-level`             | `enum`          | `"info"`           | ^4    |
+| `LOG_FORMAT`            | `-log-format`            | `enum`          | `"json"`           | ^5    |
+| `CLOUDFLARE_API_KEY`    | `-cloudflare-api-key`    | `string`        | `""`               | ^1    |
+| `CLOUDFLARE_API_EMAIL`  | `-cloudflare-api-email`  | `string`        | `""`               | ^1    |
+| `CLOUDFLARE_API_TOKEN`  | `-cloudflare-api-token`  | `string`        | `""`               | ^1    |
+| `CLOUDFLARE_ACCOUNT_ID` | `-cloudflare-account-id` | `string`        |                    | ^2    |
+| `CLOUDFLARE_TUNNEL_ID`  | `-cloudflare-tunnel-id`  | `string`        |                    | ^2    |
+| `PORT`                  | `-port`                  | `int64`         | `"8888"`           |       |
+| `READ_TIMEOUT`          | `-read-timeout`          | `time.Duration` | `"5s"`             |       |
+| `WRITE_TIMEOUT`         | `-write-timeout`         | `time.Duration` | `"10s"`            |       |
+| `DRY_RUN`               | `-dry-run`               | `bool`          | `"false"`          |       |
+| `DOMAIN_FILTER`         | `-domain-filter`         | `[]string`      | `"" delimiter:","` | ^3    |
 
 1. Must specify:
    - _both_ `CLOUDFLARE_API_KEY` and `CLOUDFLARE_API_EMAIL`
    - _or_ `CLOUDFLARE_API_TOKEN`
 2. Required field
 3. Specify multiple by delimiting with `,`
+4. One of `trace`, `debug`, `info`, `warn`, `error`, `fatal`
+5. One of `text`, `json`

go.mod

@@ -1,14 +1,14 @@
 module github.com/axatol/external-dns-cloudflare-tunnel-webhook
 
-go 1.21.5
+go 1.23.0
 
 require (
+	github.com/axatol/gonfig v0.0.1
 	github.com/cloudflare/cloudflare-go v0.87.0
-	github.com/codingconcepts/env v0.0.0-20200821220118-a8fbf8d84482
 	github.com/go-chi/chi/v5 v5.0.11
 	github.com/joho/godotenv v1.5.1
 	github.com/rs/zerolog v1.31.0
-	github.com/stretchr/testify v1.8.4
+	github.com/stretchr/testify v1.9.0
 	sigs.k8s.io/external-dns v0.14.0
 )
 
@@ -36,10 +36,9 @@ require (
 	github.com/pmezard/go-difflib v1.0.1-0.20181226105442-5d4384ee4fb2 // indirect
 	github.com/rogpeppe/go-internal v1.11.0 // indirect
 	github.com/sirupsen/logrus v1.9.3 // indirect
-	github.com/stretchr/objx v0.5.1 // indirect
-	golang.org/x/net v0.20.0 // indirect
-	golang.org/x/sys v0.16.0 // indirect
-	golang.org/x/text v0.14.0 // indirect
+	golang.org/x/net v0.30.0 // indirect
+	golang.org/x/sys v0.26.0 // indirect
+	golang.org/x/text v0.19.0 // indirect
 	golang.org/x/time v0.5.0 // indirect
 	gopkg.in/inf.v0 v0.9.1 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect

go.sum

@@ -1,9 +1,9 @@
 github.com/aws/aws-sdk-go v1.50.10 h1:H3NQvqRUKG+9oysCKTIyylpkqfPA7MiBtzTnu/cIGqE=
 github.com/aws/aws-sdk-go v1.50.10/go.mod h1:LF8svs817+Nz+DmiMQKTO3ubZ/6IaTpq3TjupRn3Eqk=
+github.com/axatol/gonfig v0.0.1 h1:0BuGUQOYbqsYJbSP8zps4wbbE6ggNLbVUYI5YpnJPoQ=
+github.com/axatol/gonfig v0.0.1/go.mod h1:F/jR7fBmZIoTLr3UNMHGpE99v8VhTjWOEZ4qN+B27N4=
 github.com/cloudflare/cloudflare-go v0.87.0 h1:hLuXnDneECNpen4YwfA4+kcjyv8gsj30kOJsHPyw9pI=
 github.com/cloudflare/cloudflare-go v0.87.0/go.mod h1:wYW/5UP02TUfBToa/yKbQHV+r6h1NnJ1Je7XjuGM4Jw=
-github.com/codingconcepts/env v0.0.0-20200821220118-a8fbf8d84482 h1:5/aEFreBh9hH/0G+33xtczJCvMaulqsm9nDuu2BZUEo=
-github.com/codingconcepts/env v0.0.0-20200821220118-a8fbf8d84482/go.mod h1:TM9ug+H/2cI3EjyIDr5xKCkFGyNE59URgH1wu5NyU8E=
 github.com/coreos/go-systemd/v22 v22.5.0/go.mod h1:Y58oyj3AT4RCenI/lSvhwexgC+NSVTIJ3seZv2GcEnc=
 github.com/creack/pty v1.1.9/go.mod h1:oKZEueFk5CKHvIhNR5MUki03XCEU+Q6VDXinZuGJ33E=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
@@ -82,19 +82,14 @@ github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVs
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
-github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
-github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
-github.com/stretchr/objx v0.5.1 h1:4VhoImhV/Bm0ToFkXFi8hXNXwpDRZ/ynw3amt82mzq0=
-github.com/stretchr/objx v0.5.1/go.mod h1:/iHQpkQwBD6DLUmQ4pE+s1TXdob1mORJ4/UFdrifcy0=
+github.com/stretchr/objx v0.5.2 h1:xuMeJ0Sdp5ZMRXx/aWO6RZxdr3beISkG5/G/aIRr3pY=
+github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/8L+MA=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
-github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.2/go.mod h1:R6va5+xMeoiuVRoj+gSkQ7d3FALtqAAGI1FQKckRals=
-github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
-github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
-github.com/stretchr/testify v1.8.4 h1:CcVxjf3Q8PM0mHUKJCdn+eZZtm5yQwehR5yeSVQQcUk=
-github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=
+github.com/stretchr/testify v1.9.0 h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=
+github.com/stretchr/testify v1.9.0/go.mod h1:r2ic/lqez/lEtzL7wO/rwa5dbSLXVDPFyf8C91i36aY=
 github.com/yuin/goldmark v1.1.27/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
@@ -106,8 +101,8 @@ golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20200226121028-0de0cce0169b/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
-golang.org/x/net v0.20.0 h1:aCL9BSgETF1k+blQaYUBx9hJ9LOGP3gAVemcZlf1Kpo=
-golang.org/x/net v0.20.0/go.mod h1:z8BVo6PvndSri0LbOE3hAn0apkU+1YvI6E70E9jsnvY=
+golang.org/x/net v0.30.0 h1:AcW1SDZMkb8IpzCdQUaIq2sP4sZ4zw+55h6ynffypl4=
+golang.org/x/net v0.30.0/go.mod h1:2wGyMJ5iFasEhkwi13ChkO/t1ECNC4X4eBKkVFyYFlU=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -123,12 +118,12 @@ golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.16.0 h1:xWw16ngr6ZMtmxDyKyIgsE93KNKz5HKmMa3b8ALHidU=
-golang.org/x/sys v0.16.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.26.0 h1:KHjCJyddX0LoSTb3J+vWpupP9p0oznkqVk/IfjymZbo=
+golang.org/x/sys v0.26.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
-golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
-golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
+golang.org/x/text v0.19.0 h1:kTxAhCbGbxhK0IwgSKiMO5awPoDQ0RpfiVYBfK860YM=
+golang.org/x/text v0.19.0/go.mod h1:BuEKDfySbSR4drPmRPG/7iBdf8hvFMuRexcpahXilzY=
 golang.org/x/time v0.5.0 h1:o7cqy6amK/52YcAKIPlM3a+Fpj35zvRj2TP+e1xFSfk=
 golang.org/x/time v0.5.0/go.mod h1:3BpzKBy/shNhVucY/MWOyx10tF3SFh9QdLuxbVysPQM=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=

main.go

@@ -44,7 +44,6 @@ func main() {
 		Str("cloudflare_api_token", strings.Repeat("*", len(config.Values.CloudflareAPIToken))).
 		Str("cloudflare_account_id", config.Values.CloudflareAccountID).
 		Str("cloudflare_tunnel_id", config.Values.CloudflareTunnelID).
-		Bool("cloudflare_sync_dns", config.Values.CloudflareSyncDNS).
 		Int64("port", config.Values.Port).
 		Dur("read_timeout", config.Values.ReadTimeout).
 		Dur("write_timeout", config.Values.WriteTimeout).
@@ -61,7 +60,6 @@ func main() {
 		Cloudflare:          client,
 		CloudflareAccountID: config.Values.CloudflareAccountID,
 		CloudflareTunnelID:  config.Values.CloudflareTunnelID,
-		CloudflareSyncDNS:   config.Values.CloudflareSyncDNS,
 		DryRun:              config.Values.DryRun,
 		DomainFilter:        config.Values.DomainFilter,
 	}

pkg/config/config.go

@@ -5,36 +5,35 @@ import (
 	"os"
 	"time"
 
-	"github.com/codingconcepts/env"
+	"github.com/axatol/gonfig"
 	"github.com/joho/godotenv"
 	"github.com/rs/zerolog"
 	"github.com/rs/zerolog/log"
 	"github.com/rs/zerolog/pkgerrors"
 )
 
 var Values = struct {
-	LogLevel  string `env:"LOG_LEVEL" default:"info"`
-	LogFormat string `env:"LOG_FORMAT" default:"json"`
-
-	CloudflareAPIKey    string `env:"CLOUDFLARE_API_KEY"`
-	CloudflareAPIEmail  string `env:"CLOUDFLARE_API_EMAIL"`
-	CloudflareAPIToken  string `env:"CLOUDFLARE_API_TOKEN"`
-	CloudflareAccountID string `env:"CLOUDFLARE_ACCOUNT_ID" required:"true"`
-	CloudflareTunnelID  string `env:"CLOUDFLARE_TUNNEL_ID" required:"true"`
-	CloudflareSyncDNS   bool   `env:"CLOUDFLARE_SYNC_DNS" default:"false"`
-
-	Port         int64         `env:"PORT" default:"8888"`
-	ReadTimeout  time.Duration `env:"READ_TIMEOUT" default:"5s"`
-	WriteTimeout time.Duration `env:"WRITE_TIMEOUT" default:"10s"`
-	DryRun       bool          `env:"DRY_RUN" default:"false"`
-	DomainFilter []string      `env:"DOMAIN_FILTER" delimiter:","`
+	LogLevel  string `env:"LOG_LEVEL"  flag:"log-level"  default:"info"`
+	LogFormat string `env:"LOG_FORMAT" flag:"log-format" default:"json"`
+
+	CloudflareAPIKey    string `env:"CLOUDFLARE_API_KEY"    flag:"cloudflare-api-key"`
+	CloudflareAPIEmail  string `env:"CLOUDFLARE_API_EMAIL"  flag:"cloudflare-api-email"`
+	CloudflareAPIToken  string `env:"CLOUDFLARE_API_TOKEN"  flag:"cloudflare-api-token"`
+	CloudflareAccountID string `env:"CLOUDFLARE_ACCOUNT_ID" flag:"cloudflare-account-id" required:"true"`
+	CloudflareTunnelID  string `env:"CLOUDFLARE_TUNNEL_ID"  flag:"cloudflare-tunnel-id"   required:"true"`
+
+	Port         int64         `env:"PORT"          flag:"port"          default:"8888"`
+	ReadTimeout  time.Duration `env:"READ_TIMEOUT"  flag:"read-timeout"  default:"5s"`
+	WriteTimeout time.Duration `env:"WRITE_TIMEOUT" flag:"write-timeout" default:"10s"`
+	DryRun       bool          `env:"DRY_RUN"       flag:"dry-run"       default:"false"`
+	DomainFilter []string      `env:"DOMAIN_FILTER" flag:"domain-filter" delimiter:","`
 }{}
 
 func Configure() error {
 	// ignore error if .env file does not exist
 	_ = godotenv.Load()
 
-	if err := env.Set(&Values); err != nil {
+	if err := gonfig.Load(&Values); err != nil {
 		return fmt.Errorf("failed to load config: %w", err)
 	}
 
@@ -50,7 +49,7 @@ func Configure() error {
 	case "json":
 		zerolog.TimeFieldFormat = zerolog.TimeFormatUnix
 	case "text":
-		log.Logger = zerolog.New(zerolog.ConsoleWriter{Out: os.Stdout})
+		log.Logger = zerolog.New(zerolog.ConsoleWriter{Out: os.Stdout}).With().Timestamp().Logger()
 	default:
 		return fmt.Errorf("invalid log format: %s", Values.LogFormat)
 	}

pkg/provider/provider.go

@@ -17,7 +17,6 @@ type CloudflareTunnelProvider struct {
 	Cloudflare          cf.Cloudflare
 	CloudflareAccountID string
 	CloudflareTunnelID  string
-	CloudflareSyncDNS   bool
 	DryRun              bool
 	DomainFilter        []string
 }
@@ -98,10 +97,8 @@ func (p CloudflareTunnelProvider) ApplyChanges(ctx context.Context, changes *pla
 		return fmt.Errorf("failed to update tunnel ingress rules: %w", err)
 	}
 
-	if p.CloudflareSyncDNS {
-		if err := BatchUpdateDNSRecords(ctx, p.Cloudflare, changeset); err != nil {
-			return fmt.Errorf("failed to update zone records: %w", err)
-		}
+	if err := BatchUpdateDNSRecords(ctx, p.Cloudflare, changeset); err != nil {
+		return fmt.Errorf("failed to update zone records: %w", err)
 	}
 
 	return nil