Skip to content

Commit

Permalink
Fix Erroridf/Warnidf mixed case issue
Browse files Browse the repository at this point in the history
Fixes #12617
  • Loading branch information
bep committed Jun 22, 2024
1 parent 3b72446 commit 8731d88
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 23 deletions.
2 changes: 2 additions & 0 deletions common/loggers/logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -323,11 +323,13 @@ func (l *logAdapter) Errors() string {
}

func (l *logAdapter) Erroridf(id, format string, v ...any) {
id = strings.ToLower(id)
format += l.idfInfoStatement("error", id, format)
l.errorl.WithField(FieldNameStatementID, id).Logf(format, v...)
}

func (l *logAdapter) Warnidf(id, format string, v ...any) {
id = strings.ToLower(id)
format += l.idfInfoStatement("warning", id, format)
l.warnl.WithField(FieldNameStatementID, id).Logf(format, v...)
}
Expand Down
6 changes: 5 additions & 1 deletion config/allconfig/allconfig.go
Original file line number Diff line number Diff line change
Expand Up @@ -315,9 +315,13 @@ func (c *Config) CompileConfig(logger loggers.Logger) error {
}
}

for i, s := range c.IgnoreLogs {
c.IgnoreLogs[i] = strings.ToLower(s)
}

ignoredLogIDs := make(map[string]bool)
for _, err := range c.IgnoreLogs {
ignoredLogIDs[strings.ToLower(err)] = true
ignoredLogIDs[err] = true
}

baseURL, err := urls.NewBaseURLFromString(c.BaseURL)
Expand Down
4 changes: 2 additions & 2 deletions hugolib/cascade_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -779,7 +779,7 @@ title: "Post 1"
{{ .Title }}|{{ .Params.foo }}$
`
b := Test(t, files)
b.AssertLogNotContains(`looks like a path with an extension`)
b.AssertLogContains(`! looks like a path with an extension`)
}

func TestCascadConfigExtensionInPath(t *testing.T) {
Expand Down Expand Up @@ -813,7 +813,7 @@ foo = 'bar'
path = '/p1.md'
`
b := Test(t, files)
b.AssertLogNotContains(`looks like a path with an extension`)
b.AssertLogContains(`! looks like a path with an extension`)
}

func TestCascadeIssue12172(t *testing.T) {
Expand Down
42 changes: 29 additions & 13 deletions hugolib/integrationtest_builder.go
Original file line number Diff line number Diff line change
Expand Up @@ -206,24 +206,34 @@ func (b *lockingBuffer) Write(p []byte) (n int, err error) {
return
}

// AssertLogContains asserts that the last build log contains the given strings.
// Each string can be negated with a "! " prefix.
func (s *IntegrationTestBuilder) AssertLogContains(els ...string) {
s.Helper()
for _, el := range els {
s.Assert(s.lastBuildLog, qt.Contains, el)
}
}

func (s *IntegrationTestBuilder) AssertLogNotContains(els ...string) {
s.Helper()
for _, el := range els {
s.Assert(s.lastBuildLog, qt.Not(qt.Contains), el)
var negate bool
el, negate = s.negate(el)
check := qt.Contains
if negate {
check = qt.Not(qt.Contains)
}
s.Assert(s.lastBuildLog, check, el)
}
}

// AssertLogNotContains asserts that the last build log does matches the given regular expressions.
// The regular expressions can be negated with a "! " prefix.
func (s *IntegrationTestBuilder) AssertLogMatches(expression string) {
s.Helper()
var negate bool
expression, negate = s.negate(expression)
re := regexp.MustCompile(expression)
s.Assert(re.MatchString(s.lastBuildLog), qt.IsTrue, qt.Commentf(s.lastBuildLog))
checker := qt.IsTrue
if negate {
checker = qt.IsFalse
}

s.Assert(re.MatchString(s.lastBuildLog), checker, qt.Commentf(s.lastBuildLog))
}

func (s *IntegrationTestBuilder) AssertBuildCountData(count int) {
Expand Down Expand Up @@ -258,6 +268,15 @@ func (s *IntegrationTestBuilder) AssertFileCount(dirname string, expected int) {
s.Assert(count, qt.Equals, expected)
}

func (s *IntegrationTestBuilder) negate(match string) (string, bool) {
var negate bool
if strings.HasPrefix(match, "! ") {
negate = true
match = strings.TrimPrefix(match, "! ")
}
return match, negate
}

func (s *IntegrationTestBuilder) AssertFileContent(filename string, matches ...string) {
s.Helper()
content := strings.TrimSpace(s.FileContent(filename))
Expand All @@ -270,10 +289,7 @@ func (s *IntegrationTestBuilder) AssertFileContent(filename string, matches ...s
continue
}
var negate bool
if strings.HasPrefix(match, "! ") {
negate = true
match = strings.TrimPrefix(match, "! ")
}
match, negate = s.negate(match)
if negate {
s.Assert(content, qt.Not(qt.Contains), match, cm)
continue
Expand Down
2 changes: 1 addition & 1 deletion hugolib/menu_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -674,7 +674,7 @@ menu: main

b.AssertFileContent("public/en/index.html", `<a href="/en/p1/">p1</a><a href="/en/p2/">p2</a>`)
b.AssertFileContent("public/fr/index.html", `<a href="/fr/p1/">p1</a>`)
b.AssertLogNotContains("WARN")
b.AssertLogContains("! WARN")
}

func TestSectionPagesIssue12399(t *testing.T) {
Expand Down
4 changes: 2 additions & 2 deletions hugolib/pagesfromdata/pagesfromgotmpl_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,7 @@ title: "p1"

b = hugolib.Test(t, files, hugolib.TestOptWarn())

b.AssertLogNotContains("WARN")
b.AssertLogContains("! WARN")
}

func TestPagesFromGoTmplPathWarningsPathResource(t *testing.T) {
Expand Down Expand Up @@ -597,7 +597,7 @@ value: data1

b = hugolib.Test(t, files, hugolib.TestOptWarn())

b.AssertLogNotContains("WARN")
b.AssertLogContains("! WARN")
}

func TestPagesFromGoTmplShortcodeNoPreceddingCharacterIssue12544(t *testing.T) {
Expand Down
16 changes: 12 additions & 4 deletions tpl/fmt/fmt_integration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,22 @@ func TestErroridf(t *testing.T) {
files := `
-- hugo.toml --
disableKinds = ['page','rss','section','sitemap','taxonomy','term']
ignoreErrors = ['error-b']
ignoreErrors = ['error-b','error-C']
-- layouts/index.html --
{{ erroridf "error-a" "%s" "a"}}
{{ erroridf "error-b" "%s" "b"}}
{{ erroridf "error-C" "%s" "C"}}
{{ erroridf "error-c" "%s" "c"}}
{{ erroridf "error-d" "%s" "D"}}
`

b, err := hugolib.TestE(t, files)

b.Assert(err, qt.IsNotNil)
b.AssertLogMatches(`^ERROR a\nYou can suppress this error by adding the following to your site configuration:\nignoreLogs = \['error-a'\]\n$`)
b.AssertLogMatches(`ERROR a\nYou can suppress this error by adding the following to your site configuration:\nignoreLogs = \['error-a'\]`)
b.AssertLogMatches(`ERROR D`)
b.AssertLogMatches(`! ERROR C`)
b.AssertLogMatches(`! ERROR c`)
}

func TestWarnidf(t *testing.T) {
Expand All @@ -45,13 +51,15 @@ func TestWarnidf(t *testing.T) {
files := `
-- hugo.toml --
disableKinds = ['page','rss','section','sitemap','taxonomy','term']
ignoreLogs = ['warning-b']
ignoreLogs = ['warning-b', 'WarniNg-C']
-- layouts/index.html --
{{ warnidf "warning-a" "%s" "a"}}
{{ warnidf "warning-b" "%s" "b"}}
{{ warnidf "warNing-C" "%s" "c"}}
`

b := hugolib.Test(t, files, hugolib.TestOptWarn())
b.AssertLogContains("WARN a", "You can suppress this warning", "ignoreLogs", "['warning-a']")
b.AssertLogNotContains("['warning-b']")
b.AssertLogContains("! ['warning-b']")
b.AssertLogContains("! ['warning-c']")
}

0 comments on commit 8731d88

Please sign in to comment.