github.com/googleapis/api-linter@v1.65.2/rules/aip0233/request_message_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 aip0233
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestRequestMessageName(t *testing.T) {
    24  	// Set up the testing permutations.
    25  	tests := []struct {
    26  		testName   string
    27  		MethodName string
    28  		Request    string
    29  		problems   testutils.Problems
    30  	}{
    31  		{
    32  			testName:   "Valid-BatchCreateBooksRequest",
    33  			MethodName: "BatchCreateBooks",
    34  			Request:    "BatchCreateBooksRequest",
    35  			problems:   testutils.Problems{},
    36  		},
    37  		{
    38  			testName:   "Invalid-MissMatchingMethodName",
    39  			MethodName: "BatchCreateBooks",
    40  			Request:    "BatchCreateBookRequest",
    41  			problems: testutils.Problems{{
    42  				Suggestion: "BatchCreateBooksRequest",
    43  			}},
    44  		},
    45  		{
    46  			testName:   "Irrelevant",
    47  			MethodName: "AcquireBook",
    48  			Request:    "AcquireBookRequest",
    49  			problems:   testutils.Problems{},
    50  		},
    51  	}
    52  
    53  	// Run each test individually.
    54  	for _, test := range tests {
    55  		t.Run(test.testName, func(t *testing.T) {
    56  			file := testutils.ParseProto3Tmpl(t, `
    57  				import "google/api/annotations.proto";
    58  				
    59  				service BookService {
    60  					rpc {{.MethodName}}({{.Request}}) returns ({{.MethodName}}Response) {
    61  						option (google.api.http) = {
    62  							post: "/v1/{parent=publishers/*}/"
    63  							body: "*"
    64  						};
    65  					}
    66  				}
    67  				
    68  				message {{.Request}}{}
    69  				
    70  				message {{.MethodName}}Response{}
    71  				`, test)
    72  
    73  			m := file.GetServices()[0].GetMethods()[0]
    74  
    75  			problems := requestMessageName.Lint(file)
    76  			if diff := test.problems.SetDescriptor(m).Diff(problems); diff != "" {
    77  				t.Errorf(diff)
    78  			}
    79  		})
    80  	}
    81  }