go/imports/imports_test.go

package imports

import (
	"context"
	"strings"
	"testing"

	assert "github.com/stretchr/testify/require"
	"go.skia.org/infra/go/testutils/unittest"
	"go.skia.org/infra/go/util"
)

func TestNoPackageImportsTesting(t *testing.T) {
	unittest.LargeTest(t)

	// Assert that no package imports "testing".
	importers, err := FindImporters(context.Background(), "testing")
	assert.NoError(t, err)
	assert.Emptyf(t, importers, "No non-test packages should import \"testing\" but the following do:\n%s", strings.Join(importers, "\n"))
}

// Any package named testutil(s) and the packages in the
// following list are allowed to import testify
var testifyExceptions = []string{
	"go.skia.org/infra/go/deepequal",
	"go.skia.org/infra/go/mockhttpclient",
	"go.skia.org/infra/golden/go/mocks",
}

var unwantedTestifyPackages = []string{
	"github.com/stretchr/testify/require",
	"github.com/stretchr/testify/assert",
}

// TODO(kjlubick): this list should be empty.
// items should not be added to this list, only removed.
var legacyTestifyPackages = []string{
	"go.skia.org/infra/task_driver/go/db",
	"go.skia.org/infra/task_driver/go/td",
	"go.skia.org/infra/task_scheduler/go/db",
	"go.skia.org/infra/task_scheduler/go/isolate_cache",
	"go.skia.org/infra/task_scheduler/go/tryjobs",
}

func TestNoPackageImportsTestify(t *testing.T) {
	unittest.LargeTest(t)

	for _, p := range unwantedTestifyPackages {

		// Assert that no package has this import
		importers, err := FindImporters(context.Background(), p)
		assert.NoError(t, err)
		badImports := []string{}
		for _, i := range importers {
			if !strings.HasSuffix(i, "testutil") && !strings.HasSuffix(i, "testutils") && !util.In(i, testifyExceptions) && !util.In(i, legacyTestifyPackages) {
				badImports = append(badImports, i)
			}
		}
		assert.Emptyf(t, badImports, "Only test or testutil packages should import %q. Violators:\n%s", p, strings.Join(badImports, "\n"))
	}
}