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