caddytest: Update Caddyfile tests for formatting, HTTP-only blocks

Previous commit improved the Caddyfile adapter so it doesn't unnecessarily add names to "skip" in "auto_https" when the server is already HTTP-only.

This commit updates the tests to reflect that change, while also fixing the Caddyfile formatting in many of the tests.

We also print the line number of the divergence between input and formatted version in Caddyfile adapt warnings - very useful for finding initial formatting problems.

caddyconfig/caddyfile/adapter.go

@@ -53,13 +53,9 @@ func (a Adapter) Adapt(body []byte, options map[string]interface{}) ([]byte, []c
 	}
 
 	// lint check: see if input was properly formatted; sometimes messy files files parse
-	// successfully but result in logical errors because the Caddyfile is a bad format
+	// successfully but result in logical errors (the Caddyfile is a bad format, I'm sorry)
-	// TODO: also perform this check on imported files
+	if warning, different := formattingDifference(filename, body); different {
-	if !bytes.Equal(Format(body), body) {
+		warnings = append(warnings, warning)
-		warnings = append(warnings, caddyconfig.Warning{
-			File:    filename,
-			Message: "file is not formatted with 'caddy fmt'",
-		})
 	}
 
 	result, err := json.Marshal(cfg)
@@ -67,6 +63,32 @@ func (a Adapter) Adapt(body []byte, options map[string]interface{}) ([]byte, []c
 	return result, warnings, err
 }
 
+// formattingDifference returns a warning and true if the formatted version
+// is any different from the input; empty warning and false otherwise.
+// TODO: also perform this check on imported files
+func formattingDifference(filename string, body []byte) (caddyconfig.Warning, bool) {
+	formatted := Format(body)
+	if bytes.Equal(formatted, body) {
+		return caddyconfig.Warning{}, false
+	}
+
+	// find where the difference is
+	line := 1
+	for i, ch := range body {
+		if i >= len(formatted) || ch != formatted[i] {
+			break
+		}
+		if ch == '\n' {
+			line++
+		}
+	}
+	return caddyconfig.Warning{
+		File:    filename,
+		Line:    line,
+		Message: "input is not formatted with 'caddy fmt'",
+	}, true
+}
+
 // Unmarshaler is a type that can unmarshal
 // Caddyfile tokens to set itself up for a
 // JSON encoding. The goal of an unmarshaler

caddytest/caddytest.go

@@ -327,7 +327,7 @@ func (tc *Tester) AssertRedirect(requestURI string, expectedToLocation string, e
 }
 
 // CompareAdapt adapts a config and then compares it against an expected result
-func CompareAdapt(t *testing.T, rawConfig string, adapterName string, expectedResponse string) bool {
+func CompareAdapt(t *testing.T, filename, rawConfig string, adapterName string, expectedResponse string) bool {
 
 	cfgAdapter := caddyconfig.GetAdapter(adapterName)
 	if cfgAdapter == nil {
@@ -353,7 +353,7 @@ func CompareAdapt(t *testing.T, rawConfig string, adapterName string, expectedRe
 
 	if len(warnings) > 0 {
 		for _, w := range warnings {
-			t.Logf("warning: directive: %s : %s", w.Directive, w.Message)
+			t.Logf("warning: %s:%d: %s: %s", filename, w.Line, w.Directive, w.Message)
 		}
 	}
 
@@ -388,7 +388,7 @@ func CompareAdapt(t *testing.T, rawConfig string, adapterName string, expectedRe
 
 // AssertAdapt adapts a config and then tests it against an expected result
 func AssertAdapt(t *testing.T, rawConfig string, adapterName string, expectedResponse string) {
-	ok := CompareAdapt(t, rawConfig, adapterName, expectedResponse)
+	ok := CompareAdapt(t, "Caddyfile", rawConfig, adapterName, expectedResponse)
 	if !ok {
 		t.Fail()
 	}

caddytest/integration/caddyfile_adapt/global_options_acme.txt

@@ -9,7 +9,7 @@
 	}
 	acme_ca https://example.com
 	acme_eab {
-		key_id  4K2scIVbBpNd-78scadB2g
+		key_id 4K2scIVbBpNd-78scadB2g
 		mac_key abcdefghijklmnopqrstuvwx-abcdefghijklnopqrstuvwxyz12ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefgh
 	}
 	acme_ca_root /path/to/ca.crt

caddytest/integration/caddyfile_adapt/global_server_options_multi.txt

@@ -64,12 +64,7 @@ http://bar.com {
 							],
 							"terminal": true
 						}
-					],
+					]
-					"automatic_https": {
-						"skip": [
-							"bar.com"
-						]
-					}
 				},
 				"srv2": {
 					"listen": [

caddytest/integration/caddyfile_adapt/header.txt

@@ -4,7 +4,7 @@
 	header ?John "von Neumann"
 	header -Wolfram
 	header {
-		Grace: "Hopper"  # some users habitually suffix field names with a colon
+		Grace: "Hopper" # some users habitually suffix field names with a colon
 		+Ray "Solomonoff"
 		?Tim "Berners-Lee"
 		defer

caddytest/integration/caddyfile_adapt/http_only_on_domain.txt

@@ -46,12 +46,7 @@ http://a.caddy.localhost {
 							],
 							"terminal": true
 						}
-					],
+					]
-					"automatic_https": {
-						"skip": [
-							"a.caddy.localhost"
-						]
-					}
 				}
 			}
 		}

caddytest/integration/caddyfile_adapt/matchers_in_route.txt

@@ -1,10 +1,10 @@
 :80 {
-    route {
+	route {
-        # unused matchers should not panic
+		# unused matchers should not panic
-        # see https://github.com/caddyserver/caddy/issues/3745
+		# see https://github.com/caddyserver/caddy/issues/3745
-        @matcher1 path /path1
+		@matcher1 path /path1
-        @matcher2 path /path2
+		@matcher2 path /path2
-    }
+	}
 }
 ----------
 {

caddytest/integration/caddyfile_adapt/php_fastcgi_subdirectives.txt

@@ -1,15 +1,15 @@
 :8884
 
 php_fastcgi localhost:9000 {
-    # some php_fastcgi-specific subdirectives
+	# some php_fastcgi-specific subdirectives
-    split .php .php5
+	split .php .php5
-    env VAR1 value1
+	env VAR1 value1
-    env VAR2 value2
+	env VAR2 value2
-    root /var/www
+	root /var/www
-    index index.php5
+	index index.php5
 
-    # passed through to reverse_proxy (directive order doesn't matter!)
+	# passed through to reverse_proxy (directive order doesn't matter!)
-    lb_policy random
+	lb_policy random
 }
 ----------
 {

caddytest/integration/caddyfile_adapt/request_body.txt

@@ -1,6 +1,7 @@
 localhost
+
 request_body {
-  max_size 1MB
+	max_size 1MB
 }
 ----------
 {

caddytest/integration/caddyfile_adapt/reverse_proxy_empty_non_http_transport.txt

@@ -1,7 +1,7 @@
 :8884
 
 reverse_proxy 127.0.0.1:65535 {
-    transport fastcgi
+	transport fastcgi
 }
 ----------
 {

caddytest/integration/caddyfile_adapt/tls_automation_policies_2.txt

@@ -1,5 +1,4 @@
 # issue #3953
-
 {
 	cert_issuer zerossl api_key
 }
@@ -58,12 +57,7 @@ http://example.net {
 							],
 							"terminal": true
 						}
-					],
+					]
-					"automatic_https": {
-						"skip": [
-							"example.net"
-						]
-					}
 				}
 			}
 		},

caddytest/integration/caddyfile_adapt/tls_conn_policy_consolidate.txt

@@ -75,12 +75,7 @@ http://b.b https://b.b:8443 {
 							],
 							"terminal": true
 						}
-					],
+					]
-					"automatic_https": {
-						"skip": [
-							"b.b"
-						]
-					}
 				},
 				"srv2": {
 					"listen": [

caddytest/integration/caddyfile_adapt_test.go

@@ -32,14 +32,15 @@ func TestCaddyfileAdaptToJSON(t *testing.T) {
 		}
 
 		// split the Caddyfile (first) and JSON (second) parts
+		// (append newline to Caddyfile to match formatter expectations)
 		parts := strings.Split(string(data), "----------")
-		caddyfile, json := strings.TrimSpace(parts[0]), strings.TrimSpace(parts[1])
+		caddyfile, json := strings.TrimSpace(parts[0])+"\n", strings.TrimSpace(parts[1])
 
 		// replace windows newlines in the json with unix newlines
 		json = winNewlines.ReplaceAllString(json, "\n")
 
 		// run the test
-		ok := caddytest.CompareAdapt(t, caddyfile, "caddyfile", json)
+		ok := caddytest.CompareAdapt(t, filename, caddyfile, "caddyfile", json)
 		if !ok {
 			t.Errorf("failed to adapt %s", filename)
 		}

cmd/commandfuncs.go

@@ -529,6 +529,9 @@ func cmdAdaptConfig(fl Flags) (int, error) {
 		adaptedConfig = prettyBuf.Bytes()
 	}
 
+	// print result to stdout
+	fmt.Println(string(adaptedConfig))
+
 	// print warnings to stderr
 	for _, warn := range warnings {
 		msg := warn.Message
@@ -538,9 +541,6 @@ func cmdAdaptConfig(fl Flags) (int, error) {
 		fmt.Fprintf(os.Stderr, "[WARNING][%s] %s:%d: %s\n", adaptCmdAdapterFlag, warn.File, warn.Line, msg)
 	}
 
-	// print result to stdout
-	fmt.Println(string(adaptedConfig))
-
 	// validate output if requested
 	if adaptCmdValidateFlag {
 		var cfg *caddy.Config