github.com/googleapis/api-linter@v1.65.2/rules/aip0134/http_body_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 TestHttpBody(t *testing.T) {
    24  	tests := []struct {
    25  		testName   string
    26  		Body       string
    27  		MethodName string
    28  		problems   testutils.Problems
    29  	}{
    30  		{"Valid", "book", "UpdateBook", nil},
    31  		{"InvalidFoo", "foo", "UpdateBook", testutils.Problems{{Message: "HTTP body"}}},
    32  		{"InvalidStar", "*", "UpdateBook", testutils.Problems{{Message: "HTTP body"}}},
    33  		{"InvalidEmpty", "", "UpdateBook", testutils.Problems{{Message: "HTTP body"}}},
    34  		{"Irrelevant", "*", "AcquireBook", nil},
    35  	}
    36  
    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  							patch: "/v1/{book.name=publishers/*/books/*}"
    45  							body: "{{.Body}}"
    46  						};
    47  					}
    48  				}
    49  				message Book {
    50  					string name = 1;
    51  				}
    52  				message {{.MethodName}}Request {}
    53  			`, test)
    54  			method := file.GetServices()[0].GetMethods()[0]
    55  			problems := httpBody.Lint(file)
    56  			if diff := test.problems.SetDescriptor(method).Diff(problems); diff != "" {
    57  				t.Error(diff)
    58  			}
    59  		})
    60  	}
    61  }