github.com/googleapis/api-linter@v1.65.2/rules/aip0156/forbidden_methods_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 aip0156
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestForbiddenMethods(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name       string
    26  		MethodName string
    27  		Suffix     string
    28  		problems   testutils.Problems
    29  	}{
    30  		{"ValidGet", "GetPublisherSettings", "/settings", testutils.Problems{}},
    31  		{"ValidUpdate", "UpdatePublisherSettings", "/settings", testutils.Problems{}},
    32  		{"ValidList", "ListPublisherSettings", "/settings", testutils.Problems{}},
    33  		{"InvalidCreate", "CreatePublisherSettings", "/settings", testutils.Problems{{Message: "Create"}}},
    34  		{"InvalidDelete", "DeletePublisherSettings", "/settings", testutils.Problems{{Message: "Delete"}}},
    35  		{"Irrelevant", "CreatePublisher", "", testutils.Problems{}},
    36  	} {
    37  		f := testutils.ParseProto3Tmpl(t, `
    38  			import "google/api/annotations.proto";
    39  			service Library {
    40  				rpc {{.MethodName}}({{.MethodName}}Request) returns (Settings) {
    41  					option (google.api.http) = {
    42  						post: "/v1/{name=publishers/*{{.Suffix}}}"
    43  						body: "settings"
    44  					};
    45  				}
    46  			}
    47  			message {{.MethodName}}Request {}
    48  			message Settings{}
    49  		`, test)
    50  		method := f.GetServices()[0].GetMethods()[0]
    51  		problems := forbiddenMethods.Lint(f)
    52  		if diff := test.problems.SetDescriptor(method).Diff(problems); diff != "" {
    53  			t.Errorf(diff)
    54  		}
    55  	}
    56  }