github.com/googleapis/api-linter@v1.65.2/rules/aip0136/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 aip0136
    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  		MethodName string
    27  		Method     string
    28  		Body       string
    29  		problems   testutils.Problems
    30  	}{
    31  		{"ValidPostBody", "ArchiveBook", "post", "*", testutils.Problems{}},
    32  		{"ValidPostBodyBook", "ArchiveBook", "post", "book", testutils.Problems{}},
    33  		{"InvalidPostBody", "ArchiveBook", "post", "random", testutils.Problems{{Message: `body: "*"`}}},
    34  		{"InvalidPostNoBody", "ArchiveBook", "post", "", testutils.Problems{{Message: `body: "*"`}}},
    35  		{"ValidGetNoBody", "ReadBook", "get", "", testutils.Problems{}},
    36  		{"InvalidGetBody", "ReadBook", "get", "*", testutils.Problems{{Message: "should not set"}}},
    37  		{"InvalidGetOtherBody", "ReadBook", "get", "Book", testutils.Problems{{Message: "should not set"}}},
    38  		{"ValidStdMethod", "CreateBook", "post", "book", testutils.Problems{}},
    39  	}
    40  	for _, test := range tests {
    41  		t.Run(test.testName, func(t *testing.T) {
    42  			file := testutils.ParseProto3Tmpl(t, `
    43  				import "google/api/annotations.proto";
    44  				service Library {
    45  					rpc {{.MethodName}}({{.MethodName}}Request) returns ({{.MethodName}}Response) {
    46  						option (google.api.http) = {
    47  							{{.Method}}: "/v1:frob"
    48  							body: "{{.Body}}"
    49  						};
    50  					}
    51  				}
    52  				message {{.MethodName}}Request {}
    53  				message {{.MethodName}}Response {}
    54  			`, test)
    55  			method := file.GetServices()[0].GetMethods()[0]
    56  			problems := httpBody.Lint(file)
    57  			if diff := test.problems.SetDescriptor(method).Diff(problems); diff != "" {
    58  				t.Errorf(diff)
    59  			}
    60  		})
    61  	}
    62  }