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

     1  // Copyright 2020 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 aip0136
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestDeclarativeFriendly(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name       string
    26  		MethodName string
    27  		ImpOnly    string
    28  		problems   testutils.Problems
    29  	}{
    30  		{"ValidGet", "GetBook", "", nil},
    31  		{"ValidList", "ListBooks", "", nil},
    32  		{"ValidCreate", "CreateBook", "", nil},
    33  		{"ValidUpdate", "UpdateBook", "", nil},
    34  		{"ValidDelete", "DeleteBook", "", nil},
    35  		{"ValidUndelete", "UndeleteBook", "", nil},
    36  		{"ValidBatch", "BatchGetBooks", "", nil},
    37  		{"ValidCustomImperativeOnly", "FrobBook", "IMPERATIVE ONLY.", nil},
    38  		{"Invalid", "FrobBook", "", testutils.Problems{{Message: "avoid custom methods"}}},
    39  	} {
    40  		t.Run(test.name, func(t *testing.T) {
    41  			f := testutils.ParseProto3Tmpl(t, `
    42  				import "google/api/resource.proto";
    43  
    44  				service Library {
    45  					// The {{.MethodName}} method.
    46  					// (-- {{.ImpOnly}} --)
    47  					rpc {{.MethodName}}({{.MethodName}}Request) returns ({{.MethodName}}Response);
    48  				}
    49  
    50  				message {{.MethodName}}Request {}
    51  				message {{.MethodName}}Response {}
    52  
    53  				message Book {
    54  					option (google.api.resource) = {
    55  						type: "library.googleapis.com/Book"
    56  						pattern: "publishers/{publisher}/books/{book}"
    57  						style: DECLARATIVE_FRIENDLY
    58  					};
    59  				}
    60  			`, test)
    61  			m := f.GetServices()[0].GetMethods()[0]
    62  			if diff := test.problems.SetDescriptor(m).Diff(standardMethodsOnly.Lint(f)); diff != "" {
    63  				t.Errorf(diff)
    64  			}
    65  		})
    66  	}
    67  }