INFRA-304

qschoemaker · qschoemaker · commit 3d9407654860 · 2025-04-10T10:14:30.000+02:00
Small code improvements for better readability and error handling
diff --git a/config.go b/config.go
@@ -177,7 +177,7 @@ func configProbes(probesConfig YamlProbeConfig, fileName string) {
 			log.Fatalf("Config failure probe with name '%s' already exists (%s)", probe.Name, fileName)
 		}
 
-		var argumentOrder []string = make([]string, len(probe.Arguments))
+		var argumentOrder = make([]string, len(probe.Arguments))
 
 		var labelNames []string
 		var labelValues []string
@@ -201,7 +201,7 @@ func configProbes(probesConfig YamlProbeConfig, fileName string) {
 
 		i := 0
 		for key, argument := range probe.Arguments {
-			var argName string = fmt.Sprint(key)
+			var argName = fmt.Sprint(key)
 
 			if argument.Param != nil {
 				if _, exists := config.probes[probe.Name].arguments[*argument.Param]; exists {
diff --git a/main.go b/main.go
@@ -30,7 +30,7 @@ func main() {
 
 	r := http.NewServeMux()
 
-	r.HandleFunc("/", landingpage)
+	r.HandleFunc("/", landingPage)
 	r.Handle("/metrics", promhttp.Handler())
 	r.HandleFunc("/probe", probe)
 
diff --git a/pages.go b/pages.go
@@ -5,7 +5,7 @@ import (
 	"net/http"
 )
 
-func landingpage(w http.ResponseWriter, r *http.Request) {
+func landingPage(w http.ResponseWriter, r *http.Request) {
 	if r.URL.Path != "/" {
 		http.NotFound(w, r)
 		return
@@ -24,7 +24,7 @@ func landingpage(w http.ResponseWriter, r *http.Request) {
 		)
 	}
 
-	fmt.Fprintf(
+	_, err := fmt.Fprintf(
 		w,
 		`<html>
             <head><title>%s</title></head>
@@ -38,12 +38,15 @@ func landingpage(w http.ResponseWriter, r *http.Request) {
 		title,
 		probesString,
 	)
+	if err != nil {
+		return
+	}
 }
 
 func debugProbe(w http.ResponseWriter, probeName string, result runResult) {
 	title := "Debug Probe " + probeName
 
-	fmt.Fprintf(
+	_, err := fmt.Fprintf(
 		w,
 		`<html>
             <head><title>%s</title></head>
@@ -81,4 +84,7 @@ func debugProbe(w http.ResponseWriter, probeName string, result runResult) {
 		result.stdout,
 		result.stderr,
 	)
+	if err != nil {
+		return
+	}
 }
diff --git a/probe.go b/probe.go
@@ -50,9 +50,9 @@ func probe(w http.ResponseWriter, r *http.Request) {
 
 func run(cmd *exec.Cmd) runResult {
 	var result runResult
-	var outbuf, errbuf bytes.Buffer
-	cmd.Stdout = &outbuf
-	cmd.Stderr = &errbuf
+	var outBuf, errBuf bytes.Buffer
+	cmd.Stdout = &outBuf
+	cmd.Stderr = &errBuf
 
 	log.Debug("[Run] Start cmd", cmd)
 	start := time.Now()
@@ -62,8 +62,8 @@ func run(cmd *exec.Cmd) runResult {
 	result.duration = time.Since(start)
 	log.Debug("[Run] End cmd duration: ", result.duration)
 
-	result.stdout = outbuf.String()
-	result.stderr = errbuf.String()
+	result.stdout = outBuf.String()
+	result.stderr = errBuf.String()
 
 	result.exitCode = 0
 	if err != nil {
diff --git a/probe_test.go b/probe_test.go
@@ -23,24 +23,24 @@ var commandTests = []struct {
 
 func TestRun(t *testing.T) {
 	for _, tt := range commandTests {
-		assert := assert.New(t)
+		newAssert := assert.New(t)
 
 		result := run(tt.program)
 
-		assert.Equalf(tt.expectedExitCode, result.exitCode, "Exit code incorrect for `%s`", tt.program)
-		assert.Equalf(tt.expectedStdOut, result.stdout, "StdOut has content check failed for `%s`", tt.program)
-		assert.Equalf(tt.expectedStdErr, result.stderr, "StdErr has content check failed for `%s`", tt.program)
+		newAssert.Equalf(tt.expectedExitCode, result.exitCode, "Exit code incorrect for `%s`", tt.program)
+		newAssert.Equalf(tt.expectedStdOut, result.stdout, "StdOut has content check failed for `%s`", tt.program)
+		newAssert.Equalf(tt.expectedStdErr, result.stderr, "StdErr has content check failed for `%s`", tt.program)
 	}
 }
 
 func TestRunDuration(t *testing.T) {
-	assert := assert.New(t)
+	newAssert := assert.New(t)
 
 	duration := 2.0
 	program := exec.Command("test/resources/sleeping.py", fmt.Sprintf("%f", duration))
 	result := run(program)
 
-	assert.Equal(0, result.exitCode, "Exit code incorrect for `%s`", program)
-	assert.GreaterOrEqual(result.duration.Seconds(), duration, "Duration incorrect `%s`", program)
-	assert.LessOrEqual(result.duration.Seconds(), duration+1, "Duration incorrect `%s`", program)
+	newAssert.Equal(0, result.exitCode, "Exit code incorrect for `%s`", program)
+	newAssert.GreaterOrEqual(result.duration.Seconds(), duration, "Duration incorrect `%s`", program)
+	newAssert.LessOrEqual(result.duration.Seconds(), duration+1, "Duration incorrect `%s`", program)
 }

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`	`"net/http"`
`6`	`6`	`)`
`7`	`7`
`8`		`-func landingpage(w http.ResponseWriter, r *http.Request) {`
	`8`	`+func landingPage(w http.ResponseWriter, r *http.Request) {`
`9`	`9`	`if r.URL.Path != "/" {`
`10`	`10`	`http.NotFound(w, r)`
`11`	`11`	`return`
`@@ -24,7 +24,7 @@ func landingpage(w http.ResponseWriter, r *http.Request) {`
`24`	`24`	`)`
`25`	`25`	`}`
`26`	`26`
`27`		`- fmt.Fprintf(`
	`27`	`+ _, err := fmt.Fprintf(`
`28`	`28`	`w,`
`29`	`29`	`<html>
`30`	`30`	`<head><title>%s</title></head>`
`@@ -38,12 +38,15 @@ func landingpage(w http.ResponseWriter, r *http.Request) {`
`38`	`38`	`title,`
`39`	`39`	`probesString,`
`40`	`40`	`)`
	`41`	`+ if err != nil {`
	`42`	`+ return`
	`43`	`+ }`
`41`	`44`	`}`
`42`	`45`
`43`	`46`	`func debugProbe(w http.ResponseWriter, probeName string, result runResult) {`
`44`	`47`	`title := "Debug Probe " + probeName`
`45`	`48`
`46`		`- fmt.Fprintf(`
	`49`	`+ _, err := fmt.Fprintf(`
`47`	`50`	`w,`
`48`	`51`	`<html>
`49`	`52`	`<head><title>%s</title></head>`
`@@ -81,4 +84,7 @@ func debugProbe(w http.ResponseWriter, probeName string, result runResult) {`
`81`	`84`	`result.stdout,`
`82`	`85`	`result.stderr,`
`83`	`86`	`)`
	`87`	`+ if err != nil {`
	`88`	`+ return`
	`89`	`+ }`
`84`	`90`	`}`