github.com/googleapis/api-linter@v1.65.2/rules/aip0134/http_method_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 aip0134
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestHttpMethod(t *testing.T) {
    24  	// Set up testing permutations.
    25  	tests := []struct {
    26  		testName   string
    27  		Method     string
    28  		MethodName string
    29  		problems   testutils.Problems
    30  	}{
    31  		{"Valid", "patch", "UpdateBook", nil},
    32  		{"Invalid", "post", "UpdateBook", testutils.Problems{{Message: "HTTP PATCH"}}},
    33  		{"Irrelevant", "post", "AcquireBook", nil},
    34  	}
    35  
    36  	// Run each test.
    37  	for _, test := range tests {
    38  		t.Run(test.testName, func(t *testing.T) {
    39  			file := testutils.ParseProto3Tmpl(t, `
    40  				import "google/api/annotations.proto";
    41  				service Library {
    42  					rpc {{.MethodName}}({{.MethodName}}Request) returns (Book) {
    43  						option (google.api.http) = {
    44  							{{.Method}}: "/v1/{book.name=publishers/*/books/*}"
    45  						};
    46  					}
    47  				}
    48  				message Book {
    49  					string name = 1;
    50  				}
    51  				message {{.MethodName}}Request {
    52  					Book book = 1;
    53  				}
    54  			`, test)
    55  			method := file.GetServices()[0].GetMethods()[0]
    56  			problems := httpMethod.Lint(file)
    57  			if diff := test.problems.SetDescriptor(method).Diff(problems); diff != "" {
    58  				t.Error(diff)
    59  			}
    60  		})
    61  	}
    62  }