github.com/googleapis/api-linter@v1.65.2/rules/aip0234/plural_method_name_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 aip0234
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestMethodPluralResourceName(t *testing.T) {
    24  	// Set up the testing permutations.
    25  	tests := []struct {
    26  		testName   string
    27  		MethodName string
    28  		URISuffix  string
    29  		problems   testutils.Problems
    30  	}{
    31  		{
    32  			testName:   "Valid-BatchUpdateBooks",
    33  			MethodName: "BatchUpdateBooks",
    34  			URISuffix:  "books:batchUpdate",
    35  			problems:   testutils.Problems{},
    36  		},
    37  		{
    38  			testName:   "Valid-BatchUpdateMen",
    39  			MethodName: "BatchUpdateMen",
    40  			URISuffix:  "men:batchUpdate",
    41  			problems:   testutils.Problems{},
    42  		},
    43  		{
    44  			testName:   "Invalid-SingularBus",
    45  			MethodName: "BatchUpdateBus",
    46  			URISuffix:  "bus:batchUpdate",
    47  			problems: testutils.Problems{{
    48  				Suggestion: "BatchUpdateBuses",
    49  			}},
    50  		},
    51  		{
    52  			testName:   "Invalid-SingularCorpPerson",
    53  			MethodName: "BatchUpdateCorpPerson",
    54  			URISuffix:  "corpPerson:batchUpdate",
    55  			problems: testutils.Problems{{
    56  				Suggestion: "BatchUpdateCorpPeople",
    57  			}},
    58  		},
    59  		{
    60  			testName:   "Invalid-Irrelevant",
    61  			MethodName: "AcquireBook",
    62  			URISuffix:  "book",
    63  			problems:   testutils.Problems{},
    64  		},
    65  	}
    66  
    67  	// Run each test individually.
    68  	for _, test := range tests {
    69  		t.Run(test.testName, func(t *testing.T) {
    70  			file := testutils.ParseProto3Tmpl(t, `
    71  				import "google/api/annotations.proto";
    72  
    73  				service BookService {
    74  					rpc {{.MethodName}}({{.MethodName}}Request) returns ({{.MethodName}}Response) {
    75  						option (google.api.http) = {
    76  							post: "/v1/{parent=publishers/*}/{{.URISuffix}}"
    77  							body: "*"
    78  						};
    79  					}
    80  				}
    81  
    82  				message {{.MethodName}}Request {}
    83  
    84  				message {{.MethodName}}Response{}
    85  				`, test)
    86  
    87  			m := file.GetServices()[0].GetMethods()[0]
    88  
    89  			problems := pluralMethodName.Lint(file)
    90  			if diff := test.problems.SetDescriptor(m).Diff(problems); diff != "" {
    91  				t.Errorf(diff)
    92  			}
    93  		})
    94  	}
    95  }