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

     1  // Copyright 2021 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 aip0162
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestRollbackResponseMessageName(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name         string
    26  		Method       string
    27  		ResponseType string
    28  		problems     testutils.Problems
    29  	}{
    30  		{"Valid", "RollbackBook", "Book", nil},
    31  		{"Invalid", "RollbackBook", "RollbackBookResponse", testutils.Problems{{Suggestion: "Book"}}},
    32  		{"Irrelevant", "AcquireBook", "PurgeBooksResponse", nil},
    33  	} {
    34  		t.Run(test.name, func(t *testing.T) {
    35  			f := testutils.ParseProto3Tmpl(t, `
    36  				import "google/longrunning/operations.proto";
    37  				service Library {
    38  					rpc {{.Method}}(RollbackBookRequest) returns ({{.ResponseType}});
    39  				}
    40  				message RollbackBookRequest {}
    41  				message {{.ResponseType}} {}
    42  			`, test)
    43  			m := f.GetServices()[0].GetMethods()[0]
    44  			if diff := test.problems.SetDescriptor(m).Diff(rollbackResponseMessageName.Lint(f)); diff != "" {
    45  				t.Errorf(diff)
    46  			}
    47  		})
    48  	}
    49  }
    50  
    51  func TestRollbackOperationResponse(t *testing.T) {
    52  	for _, test := range []struct {
    53  		name         string
    54  		Method       string
    55  		ResponseType string
    56  		problems     testutils.Problems
    57  	}{
    58  		{"Valid", "RollbackBook", "Book", nil},
    59  		{"Invalid", "RollbackBook", "RollbackBookResponse", testutils.Problems{{Suggestion: "Book"}}},
    60  		{"Irrelevant", "AcquireBook", "PurgeBooksResponse", nil},
    61  	} {
    62  		t.Run(test.name, func(t *testing.T) {
    63  			f := testutils.ParseProto3Tmpl(t, `
    64  				import "google/longrunning/operations.proto";
    65  				service Library {
    66  					rpc {{.Method}}(RollbackBookRequest) returns (google.longrunning.Operation) {
    67  						option (google.longrunning.operation_info) = {
    68  							response_type: "{{.ResponseType}}"
    69  							metadata_type: "OperationMetadata"
    70  						};
    71  					}
    72  				}
    73  				message RollbackBookRequest {}
    74  				message OperationMetadata {}
    75  				message {{.ResponseType}} {}
    76  			`, test)
    77  			m := f.GetServices()[0].GetMethods()[0]
    78  			if diff := test.problems.SetDescriptor(m).Diff(rollbackResponseMessageName.Lint(f)); diff != "" {
    79  				t.Errorf(diff)
    80  			}
    81  		})
    82  	}
    83  }