github.com/googleapis/api-linter@v1.65.2/rules/aip0132/http_uri_parent_test.go (about)

     1  // Copyright 2021 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 aip0132
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestHTTPURIParent(t *testing.T) {
    24  	tests := []struct {
    25  		testName     string
    26  		URI          string
    27  		MethodName   string
    28  		RequestField string
    29  		problems     testutils.Problems
    30  	}{
    31  		{"Valid", "/v1/{parent=publishers/*/books/*}", "ListBooks", "string parent = 1;", nil},
    32  		{"InvalidVarParent", "/v1/{book=publishers/*/books/*}", "ListBooks", "string parent = 1;", testutils.Problems{{Message: "`parent` variable"}}},
    33  		{"InvalidNoVarParent", "/v1/publishers/*/books/*", "ListBooks", "string parent = 1;", testutils.Problems{{Message: "`parent` variable"}}},
    34  		{"ValidNoParent", "/v1/books/*", "ListBooks", "", nil},
    35  		{"Irrelevant", "/v1/{book=publishers/*/books/*}", "BuildBook", "string parent = 1;", nil},
    36  	}
    37  
    38  	for _, test := range tests {
    39  		t.Run(test.testName, func(t *testing.T) {
    40  			f := testutils.ParseProto3Tmpl(t, `
    41  				import "google/api/annotations.proto";
    42  				service Library {
    43  					rpc {{.MethodName}}({{.MethodName}}Request) returns ({{.MethodName}}Response) {
    44  						option (google.api.http) = {
    45  							get: "{{.URI}}"
    46  						};
    47  					}
    48  				}
    49  				message {{.MethodName}}Request {
    50  					{{.RequestField}}
    51  				}
    52  				message {{.MethodName}}Response {}
    53  			`, test)
    54  			method := f.GetServices()[0].GetMethods()[0]
    55  			if diff := test.problems.SetDescriptor(method).Diff(httpURIParent.Lint(f)); diff != "" {
    56  				t.Error(diff)
    57  			}
    58  		})
    59  	}
    60  }