Merge pull request #21 from sil-org/feature/refactor

Fix bugs in default handling and refactor code for less complexity

Author: jason-jackson

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @sil-org/go-devs

Dockerfile

@@ -1,5 +1,6 @@
-FROM golang:1-alpine3.7 as builder
+FROM golang:1-alpine3.22 AS builder
 WORKDIR /go/src/entrypoint
+COPY ./go.mod /go/src/entrypoint
 COPY ./entrypoint.go /go/src/entrypoint/
 RUN go build
 

Dockerfile-tests

@@ -1,7 +1,8 @@
-FROM golang:1-alpine3.7
+FROM golang:1-alpine3.22
 WORKDIR /go/src/entrypoint
+COPY ./go.mod /go/src/entrypoint
 COPY ./entrypoint.go /go/src/entrypoint/
 COPY ./entrypoint_test.go /go/src/entrypoint/
 COPY ./traefik.toml /go/src/entrypoint/
 COPY ./traefik_test.toml /go/src/entrypoint/
-CMD ["go", "test"]
+CMD ["go", "test"]

entrypoint.go

@@ -4,7 +4,7 @@ import (
 	"bufio"
 	"flag"
 	"fmt"
-	"io/ioutil"
+	"log"
 	"os"
 	"os/exec"
 	"regexp"
@@ -26,14 +26,12 @@ type EnvVar struct {
 }
 
 func main() {
-
 	var configFile string
 	flag.StringVar(&configFile, "c", "/etc/traefik/traefik.toml", "Traefik config file to use, default: /etc/traefik/traefik.toml")
 	flag.Parse()
 
 	if _, err := os.Stat(configFile); err != nil {
-		fmt.Println("Config file", configFile, "not found")
-		os.Exit(1)
+		log.Fatalln("Config file not found:", configFile)
 	}
 
 	if len(os.Args) <= 1 {
@@ -52,7 +50,6 @@ func main() {
 	handleError(err)
 
 	runCmd()
-	os.Exit(0)
 }
 
 // Run CMD specified in Dockerfile or runtime and send output to stdout
@@ -79,29 +76,23 @@ func runCmd() {
 
 func handleError(err error) {
 	if err != nil {
-		fmt.Println(err)
-		os.Exit(1)
+		log.Fatalln(err)
 	}
 }
 
 // ReadTraefikToml reads the Traefik config file from filesystem and returns as byte array
 func ReadTraefikToml(filename string) ([]byte, error) {
-	file, err := ioutil.ReadFile(filename)
+	file, err := os.ReadFile(filename)
 	if err != nil {
-		return []byte{}, fmt.Errorf("Unable to read config file at %s", filename)
+		return []byte{}, fmt.Errorf("unable to read config file at %s", filename)
 	}
 
 	return file, nil
 }
 
 // WriteTraefikToml writes updated Traefix config to filesystem
 func WriteTraefikToml(filename string, contents []byte) error {
-	err := ioutil.WriteFile(filename, contents, 0644)
-	if err != nil {
-		return err
-	}
-
-	return nil
+	return os.WriteFile(filename, contents, 0644)
 }
 
 // UpdateConfigContent replaces placeholders with values from environment variables
@@ -116,38 +107,43 @@ func UpdateConfigContent(config []byte, replacements []Replacement) []byte {
 
 // BuildReplacementsFromEnv Build []Replacement from env vars
 func BuildReplacementsFromEnv() ([]Replacement, error) {
+	letsEncryptURLs := map[string]string{
+		"staging":    "https://acme-staging.api.letsencrypt.org/directory",
+		"production": "https://acme-v01.api.letsencrypt.org/directory",
+	}
 
 	var configReplacements []Replacement
 
 	envVars := GetEnvVarModels()
 	for _, envvar := range envVars {
 		value := os.Getenv(envvar.Name)
-		if value == "" && envvar.Required {
-			return configReplacements, fmt.Errorf("Missing required env var: %s. Description: %s", envvar.Name, envvar.Desc)
-		}
+		if value == "" {
+			if envvar.Required {
+				return configReplacements, fmt.Errorf("missing required env var: %s. Description: %s", envvar.Name, envvar.Desc)
+			}
 
-		if value != "" {
-			if envvar.Name == "LETS_ENCRYPT_CA" {
-				if value == "staging" {
-					value = "https://acme-staging.api.letsencrypt.org/directory"
-				} else if value == "production" {
-					value = "https://acme-v01.api.letsencrypt.org/directory"
-				}
-			} else if envvar.Name == "SANS" {
-				sans := strings.Split(value, ",")
-				value = ""
-				for _, san := range sans {
-					value += "\"" + san + "\", "
-				}
-				value = strings.TrimRight(value, ", ")
+			if envvar.Default == "" {
+				continue
 			}
-			configReplacements = append(configReplacements, Replacement{
-				Key:   envvar.Name,
-				Value: value,
-			})
-		} else if value == "" && !envvar.Required {
+
 			value = envvar.Default
 		}
+
+		switch envvar.Name {
+		case "LETS_ENCRYPT_CA":
+			if v, ok := letsEncryptURLs[value]; ok {
+				value = v
+			}
+		case "SANS":
+			value = `"` + strings.ReplaceAll(value, ",", `", "`) + `"`
+		default:
+			// Do nothing
+		}
+
+		configReplacements = append(configReplacements, Replacement{
+			Key:   envvar.Name,
+			Value: value,
+		})
 	}
 
 	return configReplacements, nil

entrypoint_test.go

@@ -16,51 +16,45 @@ example val
 another green	
 `
 	replacements := []Replacement{
-		Replacement{
+		{
 			Key:   "TEST",
 			Value: "val",
 		},
-		Replacement{
+		{
 			Key:   "FIELD",
 			Value: "green",
 		},
 	}
 	results := UpdateConfigContent([]byte(original), replacements)
 
 	if string(results) != expected {
-		t.Error("Results to not match expected. Results:", results)
-		t.FailNow()
+		t.Fatal("Results to not match expected. Results:", results)
 	}
 }
 
 func TestBuildReplacementsFromEnv(t *testing.T) {
 	// Test failure for required env var
 	_, err := BuildReplacementsFromEnv()
 	if err == nil {
-		t.Error("BuildReplacementsFromEnv should have failed because no env vars have been set")
-		t.FailNow()
+		t.Fatal("BuildReplacementsFromEnv should have failed because no env vars have been set")
 	}
 
 	setRequiredEnvVars()
 
 	replacements, err := BuildReplacementsFromEnv()
 	if err != nil {
-		t.Error(err)
-		t.FailNow()
+		t.Fatal(err)
 	}
 
-	replacementsCount := len(replacements)
-	if replacementsCount != 6 {
-		t.Error("Replacements did not have enough entries, only found", replacementsCount, "but expected 6")
-		t.FailNow()
+	if want, got := 7, len(replacements); want != got {
+		t.Fatal("Replacements did not have enough entries: found", got, "but expected", want)
 	}
 }
 
 func TestReadUpdateWrite(t *testing.T) {
 	dir, err := os.Getwd()
 	if err != nil {
-		t.Error("Unable to get current working directory for TestReadUpdateWrite")
-		t.FailNow()
+		t.Fatal("Unable to get current working directory for TestReadUpdateWrite")
 	}
 	readFile := dir + "/traefik.toml"
 	writeFile := dir + "/traefik_test.toml"
@@ -72,8 +66,7 @@ func TestReadUpdateWrite(t *testing.T) {
 
 	configToml, err := ReadTraefikToml(readFile)
 	if err != nil {
-		t.Error(err)
-		t.FailNow()
+		t.Fatal(err)
 	}
 
 	// Make sure placeholders for env vars exist
@@ -82,17 +75,15 @@ func TestReadUpdateWrite(t *testing.T) {
 		search := regexp.MustCompile(envvar.Name)
 		found := search.Find(configToml)
 		if found == nil {
-			t.Error("Did not find key in configToml template for env var", envvar.Name)
-			t.FailNow()
+			t.Fatal("Did not find key in configToml template for env var", envvar.Name)
 		}
 	}
 
 	// Update config with required env var values
 	setRequiredEnvVars()
 	replacements, err := BuildReplacementsFromEnv()
 	if err != nil {
-		t.Error(err)
-		t.FailNow()
+		t.Fatal(err)
 	}
 	configToml = UpdateConfigContent(configToml, replacements)
 
@@ -102,19 +93,16 @@ func TestReadUpdateWrite(t *testing.T) {
 			search := regexp.MustCompile(envvar.Name)
 			found := search.Find(configToml)
 			if found != nil {
-				t.Error("Uh oh, placeholder for required env var still present after update for env var:", envvar.Name)
-				t.FailNow()
+				t.Fatal("Uh oh, placeholder for required env var still present after update for env var:", envvar.Name)
 			}
 		}
 	}
 
 	// Write out test file for manual reivew
 	err = WriteTraefikToml(writeFile, configToml)
 	if err != nil {
-		t.Error(err)
-		t.FailNow()
+		t.Fatal(err)
 	}
-
 }
 
 func setRequiredEnvVars() {

go.mod

@@ -0,0 +1,3 @@
+module github.com/sil-org/traefik-https-proxy
+
+go 1.18