github.com/googleapis/api-linter@v1.65.2/rules/aip0122/camel_case_uris_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 aip0122
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestHttpUriField(t *testing.T) {
    24  	tests := []struct {
    25  		testName string
    26  		URI      string
    27  		problems testutils.Problems
    28  	}{
    29  		{"Valid", "/v1/{name=publishers/*/books/*}:frob", testutils.Problems{}},
    30  		{"ValidCamelPattern", "/v1/{name=publishers/*/frobbableBooks/*}:frob", testutils.Problems{}},
    31  		{"InvalidSnakePattern", "/v1/{name=publishers/*/frobbable_books/*}:frob", testutils.Problems{{Message: "URI patterns"}}},
    32  		{"InvalidCamelVariable", "/v1/{bookName=publishers/*/books/*}:frob", testutils.Problems{{Message: "Variable names"}}},
    33  		{"ValidSnakeVariable", "/v1/{book_name=publishers/*/books/*}:frob", testutils.Problems{}},
    34  		{"ValidSnakeSoloVariable", "/v1/{book_name}:frob", testutils.Problems{}},
    35  		{"InvalidCamelSoloVariable", "/v1/{bookName}:frob", testutils.Problems{{Message: "Variable names"}}},
    36  		{"ValidVersionTemplateVariable", "/{$api_version}/{book_name}:frob", testutils.Problems{}},
    37  	}
    38  	for _, test := range tests {
    39  		t.Run(test.testName, func(t *testing.T) {
    40  			file := testutils.ParseProto3Tmpl(t, `
    41  				import "google/api/annotations.proto";
    42  				service Library {
    43  					rpc FrobBook(FrobBookRequest) returns (FrobBookResponse) {
    44  						option (google.api.http) = {
    45  							post: "{{.URI}}"
    46  							body: "*"
    47  						};
    48  					}
    49  				}
    50  				message FrobBookRequest {}
    51  				message FrobBookResponse {}
    52  			`, test)
    53  			method := file.GetServices()[0].GetMethods()[0]
    54  			problems := httpURICase.Lint(file)
    55  			if diff := test.problems.SetDescriptor(method).Diff(problems); diff != "" {
    56  				t.Errorf(diff)
    57  			}
    58  		})
    59  	}
    60  }