check_wkt_directly_imported.go

// Copyright (c) 2018 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package lint

import (
	"strings"

	"github.com/emicklei/proto"
	"github.com/uber/prototool/internal/text"
	"github.com/uber/prototool/internal/wkt"
)

// TODO: This will not detect things like "timestamp.proto" or "protobuf/timestamp.proto"
// A more robust solution might be needed

var (
	wktDirectlyImportedLinter = NewLinter(
		"WKT_DIRECTLY_IMPORTED",
		`Verifies that the Well-Known Types are directly imported using "google/protobuf/" as the base of the import.`,
		checkWKTDirectlyImported,
	)
)

func checkWKTDirectlyImported(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
	return runVisitor(&wktDirectlyImportedVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
}

type wktDirectlyImportedVisitor struct {
	baseAddVisitor
}

func (v wktDirectlyImportedVisitor) VisitImport(element *proto.Import) {
	for wktFilename := range wkt.Filenames {
		if strings.HasSuffix(element.Filename, wktFilename) && element.Filename != wktFilename {
			v.AddFailuref(element.Position, "Import %q is a Well-Known Type import but should be imported using google/protobuf as the base.", element.Filename)
		}
	}
}