github.com/googleapis/api-linter@v1.65.2/rules/aip0133/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 aip0133
    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  		ResourceField string
    27  		Body          string
    28  		MethodName    string
    29  		problems      testutils.Problems
    30  	}{
    31  		{"Valid", "Book book = 1;", "book", "CreateBook", nil},
    32  		{"Valid", "Book textbook = 1;", "textbook", "CreateBook", nil},
    33  		{"Valid", "", "book", "CreateBook", nil}, // valid for http body rule check, but it will fail under resource fail rule check
    34  		{"Invalid_BodyMissing", "Book book = 1;", "", "CreateBook", testutils.Problems{{Message: "Post methods should have an HTTP body"}}},
    35  		{"Invalid_BodyMismatch", "Book book = 1;", "abook", "CreateBook", testutils.Problems{{Message: `The content of body "abook" must map to the resource field "book" in the request message`}}},
    36  		{"Irrelevant", "Book book = 1;", "book", "CreateBook", nil},
    37  	}
    38  
    39  	for _, test := range tests {
    40  		t.Run(test.testName, func(t *testing.T) {
    41  			file := testutils.ParseProto3Tmpl(t, `
    42  				import "google/api/annotations.proto";
    43  				service Library {
    44  					rpc {{.MethodName}}({{.MethodName}}Request) returns (Book) {
    45  						option (google.api.http) = {
    46  							post: "/v1/{parent=publishers/*}/books"
    47  							body: "{{.Body}}"
    48  						};
    49  					}
    50  				}
    51  				message Book {}
    52  				message {{.MethodName}}Request {
    53  					{{.ResourceField}}
    54  				}
    55  			`, test)
    56  			method := file.GetServices()[0].GetMethods()[0]
    57  			problems := httpBody.Lint(file)
    58  			if diff := test.problems.SetDescriptor(method).Diff(problems); diff != "" {
    59  				t.Error(diff)
    60  			}
    61  		})
    62  	}
    63  }