mirror of
https://github.com/gohugoio/hugo.git
synced 2024-06-30 18:53:44 +00:00
1ad117cbe2
Will check for an OS environment variable named `HUGO_FILE_LOG_FORMAT`. The tokens available are `:file` (absolute filename), `:line` (line number) and `:col` (column number). The default format is: \":file::line::col\"` How to set OS environment variables is OS specific, but an example on Unix setting an alternative format when running Hugo: ```bash env HUGO_FILE_LOG_FORMAT="\":file::line\"" hugo ``` The above will include filename and line number quoted. Fixes #5352
141 lines
3.4 KiB
Go
141 lines
3.4 KiB
Go
// Copyright 2018 The Hugo Authors. All rights reserved.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
// Package errors contains common Hugo errors and error related utilities.
|
|
package herrors
|
|
|
|
import (
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func TestCreateFileLogFormatter(t *testing.T) {
|
|
assert := require.New(t)
|
|
|
|
ctx := ErrorContext{Filename: "/my/file.txt", LineNumber: 12, ColumnNumber: 13}
|
|
|
|
assert.Equal("/my/file.txt|13|12", createFileLogFormatter(":file|:col|:line")(ctx))
|
|
assert.Equal("13|/my/file.txt|12", createFileLogFormatter(":col|:file|:line")(ctx))
|
|
assert.Equal("好:13", createFileLogFormatter("好::col")(ctx))
|
|
assert.Equal("\"/my/file.txt:12:13\"", createFileLogFormatter("")(ctx))
|
|
|
|
}
|
|
|
|
func TestErrorLocator(t *testing.T) {
|
|
assert := require.New(t)
|
|
|
|
lineMatcher := func(m LineMatcher) bool {
|
|
return strings.Contains(m.Line, "THEONE")
|
|
}
|
|
|
|
lines := `LINE 1
|
|
LINE 2
|
|
LINE 3
|
|
LINE 4
|
|
This is THEONE
|
|
LINE 6
|
|
LINE 7
|
|
LINE 8
|
|
`
|
|
|
|
location := locateErrorInString(lines, lineMatcher)
|
|
assert.Equal([]string{"LINE 3", "LINE 4", "This is THEONE", "LINE 6", "LINE 7"}, location.Lines)
|
|
|
|
assert.Equal(5, location.LineNumber)
|
|
assert.Equal(2, location.Pos)
|
|
|
|
assert.Equal([]string{"This is THEONE"}, locateErrorInString(`This is THEONE`, lineMatcher).Lines)
|
|
|
|
location = locateErrorInString(`L1
|
|
This is THEONE
|
|
L2
|
|
`, lineMatcher)
|
|
assert.Equal(2, location.LineNumber)
|
|
assert.Equal(1, location.Pos)
|
|
assert.Equal([]string{"L1", "This is THEONE", "L2", ""}, location.Lines)
|
|
|
|
location = locateErrorInString(`This is THEONE
|
|
L2
|
|
`, lineMatcher)
|
|
assert.Equal(0, location.Pos)
|
|
assert.Equal([]string{"This is THEONE", "L2", ""}, location.Lines)
|
|
|
|
location = locateErrorInString(`L1
|
|
This THEONE
|
|
`, lineMatcher)
|
|
assert.Equal([]string{"L1", "This THEONE", ""}, location.Lines)
|
|
assert.Equal(1, location.Pos)
|
|
|
|
location = locateErrorInString(`L1
|
|
L2
|
|
This THEONE
|
|
`, lineMatcher)
|
|
assert.Equal([]string{"L1", "L2", "This THEONE", ""}, location.Lines)
|
|
assert.Equal(2, location.Pos)
|
|
|
|
location = locateErrorInString("NO MATCH", lineMatcher)
|
|
assert.Equal(-1, location.LineNumber)
|
|
assert.Equal(-1, location.Pos)
|
|
assert.Equal(0, len(location.Lines))
|
|
|
|
lineMatcher = func(m LineMatcher) bool {
|
|
return m.LineNumber == 6
|
|
}
|
|
|
|
location = locateErrorInString(`A
|
|
B
|
|
C
|
|
D
|
|
E
|
|
F
|
|
G
|
|
H
|
|
I
|
|
J`, lineMatcher)
|
|
|
|
assert.Equal([]string{"D", "E", "F", "G", "H"}, location.Lines)
|
|
assert.Equal(6, location.LineNumber)
|
|
assert.Equal(2, location.Pos)
|
|
|
|
// Test match EOF
|
|
lineMatcher = func(m LineMatcher) bool {
|
|
return m.LineNumber == 4
|
|
}
|
|
|
|
location = locateErrorInString(`A
|
|
B
|
|
C
|
|
`, lineMatcher)
|
|
|
|
assert.Equal([]string{"B", "C", ""}, location.Lines)
|
|
assert.Equal(4, location.LineNumber)
|
|
assert.Equal(2, location.Pos)
|
|
|
|
offsetMatcher := func(m LineMatcher) bool {
|
|
return m.Offset == 1
|
|
}
|
|
|
|
location = locateErrorInString(`A
|
|
B
|
|
C
|
|
D
|
|
E`, offsetMatcher)
|
|
|
|
assert.Equal([]string{"A", "B", "C", "D"}, location.Lines)
|
|
assert.Equal(2, location.LineNumber)
|
|
assert.Equal(1, location.Pos)
|
|
|
|
}
|