github.com/googleapis/api-linter@v1.65.2/rules/aip0135/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 aip0135
    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  		Etag       string
    29  		Force      string
    30  		problems   testutils.Problems
    31  	}{
    32  		{"Valid", "DeleteBook", `option (google.api.method_signature) = "name";`, "", "", testutils.Problems{}},
    33  		{"Missing", "DeleteBook", "", "", "", testutils.Problems{{Message: `(google.api.method_signature) = "name"`}}},
    34  		{
    35  			"Wrong",
    36  			"DeleteBook",
    37  			`option (google.api.method_signature) = "book";`,
    38  			"", "",
    39  			testutils.Problems{{Suggestion: `option (google.api.method_signature) = "name";`}},
    40  		},
    41  		{"Irrelevant", "RemoveBook", "", "", "", testutils.Problems{}},
    42  		{"WithEtag", "DeleteBook", `option (google.api.method_signature) = "name,etag";`, "string etag = 2;", "", testutils.Problems{}},
    43  		{"WithForce", "DeleteBook", `option (google.api.method_signature) = "name,force";`, "", "bool force = 3;", testutils.Problems{}},
    44  		{"WithBoth", "DeleteBook", `option (google.api.method_signature) = "name,etag,force";`, "string etag = 2;", "bool force = 3;", testutils.Problems{}},
    45  		{"MissingNameWithBoth", "DeleteBook", `option (google.api.method_signature) = "etag,force";`, "string etag = 2;", "bool force = 3;", testutils.Problems{{Suggestion: `option (google.api.method_signature) = "name,etag,force";`}}},
    46  	} {
    47  		t.Run(test.name, func(t *testing.T) {
    48  			f := testutils.ParseProto3Tmpl(t, `
    49  				import "google/api/client.proto";
    50  				import "google/protobuf/empty.proto";
    51  				service Library {
    52  					rpc {{.MethodName}}({{.MethodName}}Request) returns (google.protobuf.Empty) {
    53  						{{.Signature}}
    54  					}
    55  				}
    56  				message {{.MethodName}}Request {
    57  					{{.Etag}}
    58  					{{.Force}}
    59  				}
    60  			`, test)
    61  			m := f.GetServices()[0].GetMethods()[0]
    62  			if diff := test.problems.SetDescriptor(m).Diff(methodSignature.Lint(f)); diff != "" {
    63  				t.Errorf(diff)
    64  			}
    65  		})
    66  	}
    67  }