github.com/nikron/prototool@v1.3.0/internal/lint/check_request_response_names_match_rpc.go (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package lint
    22  
    23  import (
    24  	"github.com/emicklei/proto"
    25  	"github.com/uber/prototool/internal/text"
    26  )
    27  
    28  var requestResponseNamesMatchRPCLinter = NewLinter(
    29  	"REQUEST_RESPONSE_NAMES_MATCH_RPC",
    30  	"Verifies that all request names are RpcNameRequest and all response names are RpcNameResponse.",
    31  	checkRequestResponseNamesMatchRPC,
    32  )
    33  
    34  func checkRequestResponseNamesMatchRPC(add func(*text.Failure), dirPath string, descriptors []*proto.Proto) error {
    35  	return runVisitor(requestResponseNamesMatchRPCVisitor{baseAddVisitor: newBaseAddVisitor(add)}, descriptors)
    36  }
    37  
    38  type requestResponseNamesMatchRPCVisitor struct {
    39  	baseAddVisitor
    40  }
    41  
    42  func (v requestResponseNamesMatchRPCVisitor) VisitService(service *proto.Service) {
    43  	for _, child := range service.Elements {
    44  		child.Accept(v)
    45  	}
    46  }
    47  
    48  func (v requestResponseNamesMatchRPCVisitor) VisitRPC(rpc *proto.RPC) {
    49  	// TODO: toCamelCase for rpc.Name
    50  	if rpc.RequestType != rpc.Name+"Request" {
    51  		v.AddFailuref(rpc.Position, "Name of request type %q should be %q.", rpc.RequestType, rpc.Name+"Request")
    52  	}
    53  	if rpc.ReturnsType != rpc.Name+"Response" {
    54  		v.AddFailuref(rpc.Position, "Name of response type %q should be %q.", rpc.ReturnsType, rpc.Name+"Response")
    55  	}
    56  }