github.com/googleapis/api-linter@v1.65.2/rules/aip0233/http_uri_suffix_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 aip0233
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestHttpUriSuffix(t *testing.T) {
    24  	tests := []struct {
    25  		testName   string
    26  		HTTPURI    string
    27  		MethodName string
    28  		problems   testutils.Problems
    29  	}{
    30  		{"Valid", "/v1/{parent=publishers/*}/books:batchCreate", "BatchCreateBooks", nil},
    31  		{"ValidNoParent", "/v1/books:batchCreate", "BatchCreateBooks", nil},
    32  		{"InvalidSuffix", "/v1/{parent=publishers/*}/books", "BatchCreateBooks", testutils.Problems{{Message: ":batchCreate"}}},
    33  		{"Irrelevant", "/v1/{book=publishers/*/books/*}", "AcquireBook", nil},
    34  	}
    35  
    36  	for _, test := range tests {
    37  		t.Run(test.testName, func(t *testing.T) {
    38  			file := testutils.ParseProto3Tmpl(t, `
    39  				import "google/api/annotations.proto";
    40  
    41  				service BookService {
    42  					rpc {{.MethodName}}({{.MethodName}}Request) returns ({{.MethodName}}Response) {
    43  						option (google.api.http) = {
    44  							post: "{{.HTTPURI}}"
    45  							body: "*"
    46  						};
    47  					}
    48  				}
    49  				message {{.MethodName}}Request{}
    50  				message {{.MethodName}}Response{}
    51  				`, test)
    52  
    53  			// Run the method, ensure we get what we expect.
    54  			problems := httpURISuffix.Lint(file)
    55  			if diff := test.problems.SetDescriptor(file.GetServices()[0].GetMethods()[0]).Diff(problems); diff != "" {
    56  				t.Errorf(diff)
    57  			}
    58  		})
    59  	}
    60  }