github.com/googleapis/api-linter@v1.65.2/rules/aip0234/response_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 aip0234
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestResponseMessageName(t *testing.T) {
    24  	// Set up the testing permutations.
    25  	tests := []struct {
    26  		testName   string
    27  		MethodName string
    28  		Response   string
    29  		problems   testutils.Problems
    30  	}{
    31  		{
    32  			testName:   "Valid-BatchUpdateBooksResponse",
    33  			MethodName: "BatchUpdateBooks",
    34  			Response:   "BatchUpdateBooksResponse",
    35  			problems:   testutils.Problems{},
    36  		},
    37  		{
    38  			testName:   "Invalid-MissMatchingMethodName",
    39  			MethodName: "BatchUpdateBooks",
    40  			Response:   "BatchUpdateBookResponse",
    41  			problems: testutils.Problems{{
    42  				Suggestion: "BatchUpdateBooksResponse",
    43  			}},
    44  		},
    45  		{
    46  			testName:   "Irrelevant",
    47  			MethodName: "UpdateBook",
    48  			Response:   "Book",
    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}}({{.MethodName}}Request) returns ({{.Response}}) {
    61  						option (google.api.http) = {
    62  							post: "/v1/{parent=publishers/*}/"
    63  							body: "*"
    64  						};
    65  					}
    66  				}
    67  				message {{.MethodName}}Request {}
    68  				message {{.Response}}{}
    69  				`, test)
    70  
    71  			m := file.GetServices()[0].GetMethods()[0]
    72  
    73  			problems := responseMessageName.Lint(file)
    74  			if diff := test.problems.SetDescriptor(m).Diff(problems); diff != "" {
    75  				t.Errorf(diff)
    76  			}
    77  		})
    78  	}
    79  }
    80  
    81  // Other cases for long running response will be handled by AIP-0151
    82  func TestLongRunningResponse(t *testing.T) {
    83  	// Set up the testing permutations.
    84  	tests := []struct {
    85  		testName     string
    86  		ResponseType string
    87  		problems     testutils.Problems
    88  	}{
    89  		{
    90  			testName:     "Valid-LongRunning",
    91  			ResponseType: "BatchUpdateBooksResponse",
    92  			problems:     testutils.Problems{},
    93  		},
    94  		{
    95  			testName: "Valid-LongRunningEmptyResponseType",
    96  			problems: testutils.Problems{},
    97  		},
    98  	}
    99  
   100  	// Run each test individually.
   101  	for _, test := range tests {
   102  		t.Run(test.testName, func(t *testing.T) {
   103  			file := testutils.ParseProto3Tmpl(t, `
   104  				import "google/api/annotations.proto";
   105  				import "google/longrunning/operations.proto";
   106  				
   107  				service BookService {
   108  					rpc BatchUpdateBooks(BatchUpdateBooksRequest) returns (google.longrunning.Operation) {
   109  						option (google.api.http) = {
   110  							post: "/v1/{parent=publishers/*}/books:batchUpdate"
   111  							body: "*"
   112  						};
   113  						option (google.longrunning.operation_info) = {
   114  							response_type: "{{.ResponseType}}"
   115  						};
   116  					}
   117  				}
   118  				message BatchUpdateBooksRequest {}
   119  				message BatchUpdateBooksResponse{}
   120  				`, test)
   121  
   122  			m := file.GetServices()[0].GetMethods()[0]
   123  
   124  			problems := responseMessageName.Lint(file)
   125  			if diff := test.problems.SetDescriptor(m).Diff(problems); diff != "" {
   126  				t.Errorf(diff)
   127  			}
   128  		})
   129  	}
   130  }