github.com/googleapis/api-linter@v1.65.2/rules/aip0136/http_name_variable_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 TestHTTPVariables(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name       string
    26  		MethodName string
    27  		URI        string
    28  		problems   testutils.Problems
    29  	}{
    30  		{"Valid", "WriteBook", "/v1/{name=publishers/*/books/*}:write", testutils.Problems{}},
    31  		{"ValidRevision", "TagBookRevision", "/v1/{name=publishers/*/books/*}:tagRevision", testutils.Problems{}},
    32  		{"ValidRevisions", "ListBookRevisions", "/v1/{name=publishers/*/books/*}:listRevisions", testutils.Problems{}},
    33  		{"Invalid", "WritePage", "/v1/{name=publishers/*/books/*}:writePage", testutils.Problems{{Message: "name variable"}}},
    34  		{"ValidBookVar", "WritePage", "/v1/{book=publishers/*/books/*}:writePage", testutils.Problems{}},
    35  		{"ValidTwoWordNoun", "WriteAudioBook", "/v1/{name=publishers/*/audioBooks/*}:write", testutils.Problems{}},
    36  	} {
    37  		t.Run(test.name, func(t *testing.T) {
    38  			f := testutils.ParseProto3Tmpl(t, `
    39  				import "google/api/annotations.proto";
    40  				service Library {
    41  					rpc {{.MethodName}}({{.MethodName}}Request)
    42  							returns ({{.MethodName}}Response) {
    43  						option (google.api.http) = {
    44  							post: "{{.URI}}"
    45  							body: "*"
    46  						};
    47  					}
    48  				}
    49  				message {{.MethodName}}Request {}
    50  				message {{.MethodName}}Response {}
    51  			`, test)
    52  			m := f.GetServices()[0].GetMethods()[0]
    53  			if diff := test.problems.SetDescriptor(m).Diff(httpNameVariable.Lint(f)); diff != "" {
    54  				t.Errorf(diff)
    55  			}
    56  		})
    57  	}
    58  }