github.com/elek/golangci-lint@v1.42.2-0.20211208090441-c05b7fcb3a9a/pkg/result/processors/sort_results_test.go

package processors

import (
	"fmt"
	"go/token"
	"testing"

	"github.com/stretchr/testify/assert"

	"github.com/elek/golangci-lint/pkg/config"
	"github.com/elek/golangci-lint/pkg/result"
)

var issues = []result.Issue{
	{
		Pos: token.Position{
			Filename: "file_windows.go",
			Column:   80,
			Line:     10,
		},
	},
	{
		Pos: token.Position{
			Filename: "file_linux.go",
			Column:   70,
			Line:     11,
		},
	},
	{
		Pos: token.Position{
			Filename: "file_darwin.go",
			Line:     12,
		},
	},
	{
		Pos: token.Position{
			Filename: "file_darwin.go",
			Column:   60,
			Line:     10,
		},
	},
}

type compareTestCase struct {
	a, b     result.Issue
	expected compareResult
}

func testCompareValues(t *testing.T, cmp comparator, name string, tests []compareTestCase) {
	t.Parallel()

	for i := 0; i < len(tests); i++ {
		test := tests[i]
		t.Run(fmt.Sprintf("%s(%d)", name, i), func(t *testing.T) {
			res := cmp.Compare(&test.a, &test.b)
			assert.Equal(t, test.expected.String(), res.String())
		})
	}
}

func TestCompareByLine(t *testing.T) {
	testCompareValues(t, ByLine{}, "Compare By Line", []compareTestCase{
		{issues[0], issues[1], Less},    // 10 vs 11
		{issues[0], issues[0], Equal},   // 10 vs 10
		{issues[3], issues[3], Equal},   // 10 vs 10
		{issues[0], issues[3], Equal},   // 10 vs 10
		{issues[3], issues[2], Less},    // 10 vs 12
		{issues[1], issues[1], Equal},   // 11 vs 11
		{issues[1], issues[0], Greater}, // 11 vs 10
		{issues[1], issues[2], Less},    // 11 vs 12
		{issues[2], issues[3], Greater}, // 12 vs 10
		{issues[2], issues[1], Greater}, // 12 vs 11
		{issues[2], issues[2], Equal},   // 12 vs 12
	})
}

func TestCompareByName(t *testing.T) { //nolint:dupl
	testCompareValues(t, ByName{}, "Compare By Name", []compareTestCase{
		{issues[0], issues[1], Greater}, // file_windows.go vs file_linux.go
		{issues[1], issues[2], Greater}, // file_linux.go vs file_darwin.go
		{issues[2], issues[3], Equal},   // file_darwin.go vs file_darwin.go
		{issues[1], issues[1], Equal},   // file_linux.go vs file_linux.go
		{issues[1], issues[0], Less},    // file_linux.go vs file_windows.go
		{issues[3], issues[2], Equal},   // file_darwin.go vs file_darwin.go
		{issues[2], issues[1], Less},    // file_darwin.go vs file_linux.go
		{issues[0], issues[0], Equal},   // file_windows.go vs file_windows.go
		{issues[2], issues[2], Equal},   // file_darwin.go vs file_darwin.go
		{issues[3], issues[3], Equal},   // file_darwin.go vs file_darwin.go
	})
}

func TestCompareByColumn(t *testing.T) { //nolint:dupl
	testCompareValues(t, ByColumn{}, "Compare By Column", []compareTestCase{
		{issues[0], issues[1], Greater}, // 80 vs 70
		{issues[1], issues[2], None},    // 70 vs zero value
		{issues[3], issues[3], Equal},   // 60 vs 60
		{issues[2], issues[3], None},    // zero value vs 60
		{issues[2], issues[1], None},    // zero value vs 70
		{issues[1], issues[0], Less},    // 70 vs 80
		{issues[1], issues[1], Equal},   // 70 vs 70
		{issues[3], issues[2], None},    // vs zero value
		{issues[2], issues[2], Equal},   // zero value vs zero value
		{issues[1], issues[1], Equal},   // 70 vs 70
	})
}

func TestCompareNested(t *testing.T) {
	var cmp = ByName{
		next: ByLine{
			next: ByColumn{},
		},
	}

	testCompareValues(t, cmp, "Nested Comparing", []compareTestCase{
		{issues[1], issues[0], Less},    // file_linux.go vs file_windows.go
		{issues[2], issues[1], Less},    // file_darwin.go vs file_linux.go
		{issues[0], issues[1], Greater}, // file_windows.go vs file_linux.go
		{issues[1], issues[2], Greater}, // file_linux.go vs file_darwin.go
		{issues[3], issues[2], Less},    // file_darwin.go vs file_darwin.go, 10 vs 12
		{issues[0], issues[0], Equal},   // file_windows.go vs file_windows.go
		{issues[2], issues[3], Greater}, // file_darwin.go vs file_darwin.go, 12 vs 10
		{issues[1], issues[1], Equal},   // file_linux.go vs file_linux.go
		{issues[2], issues[2], Equal},   // file_darwin.go vs file_darwin.go
		{issues[3], issues[3], Equal},   // file_darwin.go vs file_darwin.go
	})
}

func TestNumericCompare(t *testing.T) {
	var tests = []struct {
		a, b     int
		expected compareResult
	}{
		{0, 0, Equal},
		{0, 1, None},
		{1, 0, None},
		{1, -1, None},
		{-1, 1, None},
		{1, 1, Equal},
		{1, 2, Less},
		{2, 1, Greater},
	}

	t.Parallel()

	for i := 0; i < len(tests); i++ {
		test := tests[i]
		t.Run(fmt.Sprintf("%s(%d)", "Numeric Compare", i), func(t *testing.T) {
			res := numericCompare(test.a, test.b)
			assert.Equal(t, test.expected.String(), res.String())
		})
	}
}

func TestNoSorting(t *testing.T) {
	var tests = make([]result.Issue, len(issues))
	copy(tests, issues)

	var sr = NewSortResults(&config.Config{})

	results, err := sr.Process(tests)
	assert.Equal(t, tests, results)
	assert.Nil(t, err, nil)
}

func TestSorting(t *testing.T) {
	var tests = make([]result.Issue, len(issues))
	copy(tests, issues)

	var expected = make([]result.Issue, len(issues))
	expected[0] = issues[3]
	expected[1] = issues[2]
	expected[2] = issues[1]
	expected[3] = issues[0]

	var cfg = config.Config{}
	cfg.Output.SortResults = true
	var sr = NewSortResults(&cfg)

	results, err := sr.Process(tests)
	assert.Equal(t, results, expected)
	assert.Nil(t, err, nil)
}