github.com/googleapis/api-linter@v1.65.2/rules/aip0152/response_message_name_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 aip0152
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestResponseMessageName(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name         string
    26  		Method       string
    27  		ResponseType string
    28  		LROType      string
    29  		problems     testutils.Problems
    30  	}{
    31  		{"Valid", "RunWriteBookJob", "google.longrunning.Operation", "RunWriteBookJobResponse", nil},
    32  		{"InvalidNotLRO", "RunWriteBookJob", "RunWriteBookJobResponse", "", testutils.Problems{{Suggestion: "google.longrunning.Operation"}}},
    33  		{"InvalidLROType", "RunWriteBookJob", "google.longrunning.Operation", "RunWriteBookJobRequest", testutils.Problems{{Suggestion: "RunWriteBookJobResponse"}}},
    34  		{"Irrelevant", "AcquireBook", "RunWriteBookJobResponse", "", nil},
    35  	} {
    36  		t.Run(test.name, func(t *testing.T) {
    37  			f := testutils.ParseProto3Tmpl(t, `
    38  				import "google/longrunning/operations.proto";
    39  				service Library {
    40  					rpc {{.Method}}(RunWriteBookJobRequest) returns ({{.ResponseType}}) {
    41  						option (google.longrunning.operation_info) = {
    42  							response_type: "{{.LROType}}"
    43  						};
    44  					}
    45  				}
    46  				message RunWriteBookJobRequest {}
    47  				message RunWriteBookJobResponse {}
    48  			`, test)
    49  			m := f.GetServices()[0].GetMethods()[0]
    50  			if diff := test.problems.SetDescriptor(m).Diff(responseMessageName.Lint(f)); diff != "" {
    51  				t.Errorf(diff)
    52  			}
    53  		})
    54  	}
    55  }