github.com/googleapis/api-linter@v1.65.2/rules/aip0131/method_signature_test.go (about)

     1  // Copyright 2019 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     https://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package aip0131
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestMethodSignature(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name       string
    26  		MethodName string
    27  		Signature  string
    28  		problems   testutils.Problems
    29  	}{
    30  		{"Valid", "GetBook", `option (google.api.method_signature) = "name";`, testutils.Problems{}},
    31  		{"Missing", "GetBook", "", testutils.Problems{{Message: `(google.api.method_signature) = "name"`}}},
    32  		{
    33  			"Wrong",
    34  			"GetBook",
    35  			`option (google.api.method_signature) = "book";`,
    36  			testutils.Problems{{Suggestion: `option (google.api.method_signature) = "name";`}},
    37  		},
    38  		{"Irrelevant", "ReadBook", "", testutils.Problems{}},
    39  	} {
    40  		t.Run(test.name, func(t *testing.T) {
    41  			f := testutils.ParseProto3Tmpl(t, `
    42  				import "google/api/client.proto";
    43  				service Library {
    44  					rpc {{.MethodName}}({{.MethodName}}Request) returns (Book) {
    45  						{{.Signature}}
    46  					}
    47  				}
    48  				message {{.MethodName}}Request {}
    49  				message Book {}
    50  			`, test)
    51  			m := f.GetServices()[0].GetMethods()[0]
    52  			if diff := test.problems.SetDescriptor(m).Diff(methodSignature.Lint(f)); diff != "" {
    53  				t.Errorf(diff)
    54  			}
    55  		})
    56  	}
    57  }