shithub: hugo

Download patch

ref: a52e508d4628da4c976f4fe3f55eab2293686ee6
parent: 2b91b480d01cfcd4b13922effb25d83bc5dd3fb2
author: bep <[email protected]>
date: Sun Apr 5 17:03:16 EDT 2015 

Update test logs for uniformity and consistency

Many minor fixes to make test logs more consistent and correct a
mispelling.

Standardize on "[%i] got X but expected Y" for log messages. Using
a consistent layout makes it easier to read the test results. This
was mostly changing "Got" to "got". Swapped the order of values on
several calls to bring them in line with the convention.

A few log messages had a sequence number added to identify the
exact scenario that failed. Otherwise, there would be no way to
ascertain which failed When there are many scenarios.

Correct spelling of "expected."

Fixes #1028
Merged be2097e1ad789eca5d893805a059d94defbe5c48

[close #1040]


--- a/helpers/general_test.go
+++ b/helpers/general_test.go
@@ -28,7 +28,7 @@
 	} {
 		result := GuessType(this.in)
 		if result != this.expect {
-			t.Errorf("[%d] GuessType guessed wrong, expected %s, got %s", i, this.expect, result)
+			t.Errorf("[%d] got %s but expected %s", i, result, this.expect)
 		}
 	}
 }
@@ -109,7 +109,7 @@
 	for i, this := range append(containsBenchTestData, containsAdditionalTestData...) {
 		result := ReaderContains(StringToReader(this.v1), this.v2)
 		if result != this.expect {
-			t.Errorf("[%d] Got %t but expected %t", i, result, this.expect)
+			t.Errorf("[%d] got %t but expected %t", i, result, this.expect)
 		}
 	}
 
@@ -123,7 +123,7 @@
 		for i, this := range containsBenchTestData {
 			result := ReaderContains(StringToReader(this.v1), this.v2)
 			if result != this.expect {
-				b.Errorf("[%d] Got %t but expected %t", i, result, this.expect)
+				b.Errorf("[%d] got %t but expected %t", i, result, this.expect)
 			}
 		}
 	}
@@ -140,7 +140,7 @@
 			}
 			result := bytes.Contains(bs, this.v2)
 			if result != this.expect {
-				b.Errorf("[%d] Got %t but expected %t", i, result, this.expect)
+				b.Errorf("[%d] got %t but expected %t", i, result, this.expect)
 			}
 		}
 	}
@@ -167,10 +167,10 @@
 		{"Albert", true},
 		{"ALBERT", false},
 	}
-	for _, in := range data {
+	for i, in := range data {
 		output := InStringArray(array, in.input)
 		if output != in.expected {
-			t.Errorf("TestInStringArrayCase failed. Expected %t. Got %t.", in.expected, output)
+			t.Errorf("[%d] got %t but expected %t", i, output, in.expected)
 		}
 	}
 }
--- a/hugolib/pagination_test.go
+++ b/hugolib/pagination_test.go
@@ -301,7 +301,7 @@
 		result := probablyEqualPageLists(this.v1, this.v2)
 
 		if result != this.expect {
-			t.Errorf("[%d] Got %t but expected %t", i, result, this.expect)
+			t.Errorf("[%d] got %t but expected %t", i, result, this.expect)
 
 		}
 	}
--- a/hugolib/path_separators_test.go
+++ b/hugolib/path_separators_test.go
@@ -34,13 +34,13 @@
 		{filepath.Join("content", "dub", "sub", "foobar.html"), "dub", L("dub/single.html", "_default/single.html")},
 	}
 
-	for _, el := range toCheck {
+	for i, el := range toCheck {
 		p, err := NewPageFrom(strings.NewReader(SIMPLE_PAGE_YAML), el.input)
 		if err != nil {
-			t.Errorf("Reading from SIMPLE_PAGE_YAML resulted in an error: %s", err)
+			t.Errorf("[%d] Reading from SIMPLE_PAGE_YAML resulted in an error: %s", i, err)
 		}
 		if p.Section() != el.section {
-			t.Errorf("Section not set to %s for page %s. Got: %s", el.section, el.input, p.Section())
+			t.Errorf("[%d] Section incorrect page %s. got %s but expected %s", i, el.input, p.Section(), el.section)
 		}
 
 		for _, y := range el.layout {
@@ -48,7 +48,7 @@
 		}
 
 		if !listEqual(p.Layout(), el.layout) {
-			t.Errorf("Layout incorrect. Expected: '%s', Got: '%s'", el.layout, p.Layout())
+			t.Errorf("[%d] Layout incorrect. got '%s' but expected '%s'", i, p.Layout(), el.layout)
 		}
 	}
 }
--- a/hugolib/path_separators_windows_test.go
+++ b/hugolib/path_separators_windows_test.go
@@ -13,6 +13,6 @@
 func TestTemplatePathSeparator(t *testing.T) {
 	tmpl := new(tpl.GoHTMLTemplate)
 	if name := tmpl.GenerateTemplateNameFrom(win_base, win_path); name != "sub1/index.html" {
-		t.Fatalf("Template name incorrect.  Expected: %s, Got: %s", "sub1/index.html", name)
+		t.Fatalf("Template name incorrect. got %s but expected %s", name, "sub1/index.html")
 	}
 }
--- a/hugolib/shortcode_test.go
+++ b/hugolib/shortcode_test.go
@@ -27,7 +27,7 @@
 	}
 
 	if output != expected {
-		t.Fatalf("Shortcode render didn't match. Expected: %q, Got: %q", expected, output)
+		t.Fatalf("Shortcode render didn't match. got %q but exxpected %q", output, expected)
 	}
 }
 
@@ -260,8 +260,8 @@
 			} else {
 				r, _ := regexp.Compile(this.expectErrorMsg)
 				if !r.MatchString(err.Error()) {
-					t.Fatalf("[%d] %s: ExtractShortcodes didn't return an expected error message, expected %s got %s",
-						i, this.name, this.expectErrorMsg, err.Error())
+					t.Fatalf("[%d] %s: ExtractShortcodes didn't return an expected error message, got %s but expected %s",
+						i, this.name, err.Error(), this.expectErrorMsg)
 				}
 			}
 			continue
@@ -289,7 +289,7 @@
 		}
 
 		if !r.MatchString(content) {
-			t.Fatalf("[%d] %s: Shortcode extract didn't match. Expected: %q, Got: %q", i, this.name, expected, content)
+			t.Fatalf("[%d] %s: Shortcode extract didn't match. got %q but expected %q", i, this.name, content, expected)
 		}
 
 		for placeHolder, sc := range shortCodes {
@@ -305,7 +305,7 @@
 		if this.expectShortCodes != "" {
 			shortCodesAsStr := fmt.Sprintf("map%q", collectAndSortShortcodes(shortCodes))
 			if !strings.Contains(shortCodesAsStr, this.expectShortCodes) {
-				t.Fatalf("[%d] %s: Short codes not as expected, got %s - expected to contain %s", i, this.name, shortCodesAsStr, this.expectShortCodes)
+				t.Fatalf("[%d] %s: Short codes not as expected, got %s but expected %s", i, this.name, shortCodesAsStr, this.expectShortCodes)
 			}
 		}
 	}
--- a/parser/frontmatter_test.go
+++ b/parser/frontmatter_test.go
@@ -19,7 +19,7 @@
 		result := FormatToLeadRune(this.kind)
 
 		if result != this.expect {
-			t.Errorf("[%d] Got %q but expected %q", i, result, this.expect)
+			t.Errorf("[%d] got %q but expected %q", i, result, this.expect)
 		}
 	}
 }
--- a/tpl/template_funcs_test.go
+++ b/tpl/template_funcs_test.go
@@ -271,7 +271,7 @@
 		result := In(this.v1, this.v2)
 
 		if result != this.expect {
-			t.Errorf("[%d] Got %v but expected %v", i, result, this.expect)
+			t.Errorf("[%d] got %v but expected %v", i, result, this.expect)
 		}
 	}
 }
@@ -310,7 +310,7 @@
 				continue
 			}
 			if !reflect.DeepEqual(result, this.expect) {
-				t.Errorf("[%d] Got %s but expected %s", i, result, this.expect)
+				t.Errorf("[%d] got %s but expected %s", i, result, this.expect)
 			}
 		}
 	}
@@ -350,7 +350,7 @@
 				continue
 			}
 			if !reflect.DeepEqual(result, this.expect) {
-				t.Errorf("[%d] Got %s but expected %s", i, result, this.expect)
+				t.Errorf("[%d] got %s but expected %s", i, result, this.expect)
 			}
 		}
 	}
@@ -380,7 +380,7 @@
 				continue
 			}
 			if !reflect.DeepEqual(result, this.expect) {
-				t.Errorf("[%d] Got %s but expected %s", i, result, this.expect)
+				t.Errorf("[%d] got %s but expected %s", i, result, this.expect)
 			}
 		}
 	}
@@ -413,7 +413,7 @@
 			continue
 		}
 		if !reflect.DeepEqual(results, this.expect) {
-			t.Errorf("[%d] Got %v but expected %v", i, results, this.expect)
+			t.Errorf("[%d] got %v but expected %v", i, results, this.expect)
 		}
 	}
 
@@ -420,13 +420,13 @@
 	_, err1 := Intersect("not an array or slice", []string{"a"})
 
 	if err1 == nil {
-		t.Error("Excpected error for non array as first arg")
+		t.Error("Expected error for non array as first arg")
 	}
 
 	_, err2 := Intersect([]string{"a"}, "not an array or slice")
 
 	if err2 == nil {
-		t.Error("Excpected error for non array as second arg")
+		t.Error("Expected error for non array as second arg")
 	}
 }
 
@@ -1225,3 +1225,4 @@
 		}
 	}
 }
+