hugo/common/herrors/error_locator_test.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 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)

	pos := location.Position()
	assert.Equal(5, pos.LineNumber)
	assert.Equal(2, location.LinesPos)

	assert.Equal([]string{"This is THEONE"}, locateErrorInString(`This is THEONE`, lineMatcher).Lines)

	location = locateErrorInString(`L1
This is THEONE
L2
`, lineMatcher)
	assert.Equal(2, location.Position().LineNumber)
	assert.Equal(1, location.LinesPos)
	assert.Equal([]string{"L1", "This is THEONE", "L2", ""}, location.Lines)

	location = locateErrorInString(`This is THEONE
L2
`, lineMatcher)
	assert.Equal(0, location.LinesPos)
	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.LinesPos)

	location = locateErrorInString(`L1
L2
This THEONE
`, lineMatcher)
	assert.Equal([]string{"L1", "L2", "This THEONE", ""}, location.Lines)
	assert.Equal(2, location.LinesPos)

	location = locateErrorInString("NO MATCH", lineMatcher)
	assert.Equal(-1, location.Position().LineNumber)
	assert.Equal(-1, location.LinesPos)
	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.Position().LineNumber)
	assert.Equal(2, location.LinesPos)

	// 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.Position().LineNumber)
	assert.Equal(2, location.LinesPos)

	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.Position().LineNumber)
	assert.Equal(1, location.LinesPos)

}