github.com/googleapis/api-linter@v1.65.2/rules/aip0136/http_method_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 TestHttpMethod(t *testing.T) {
    24  	tests := []struct {
    25  		testName   string
    26  		MethodName string
    27  		HTTPMethod string
    28  		Suffix     string
    29  		problems   testutils.Problems
    30  	}{
    31  		{"ValidGet", "ArchiveBook", "get", "", nil},
    32  		{"ValidPost", "ArchiveBook", "post", "", nil},
    33  		{"ValidDeleteRevision", "DeleteBookRevision", "delete", ":deleteRevision", nil},
    34  		{"InvalidPut", "ArchiveBook", "put", ":archive", testutils.Problems{{Message: "POST or GET"}}},
    35  		{"InvalidPatch", "ArchiveBook", "patch", ":archive", testutils.Problems{{Message: "POST or GET"}}},
    36  		{"InvalidDelete", "ArchiveBook", "delete", "", testutils.Problems{{Message: "POST or GET"}}},
    37  		{"IrrelevantPatch", "UpdateBook", "patch", "", nil},
    38  		{"IrrelevantDelete", "DeleteBook", "delete", "", nil},
    39  		{"IrrelevantPut", "ReplaceBook", "put", "", nil},
    40  	}
    41  	for _, test := range tests {
    42  		t.Run(test.testName, func(t *testing.T) {
    43  			file := testutils.ParseProto3Tmpl(t, `
    44  				import "google/api/annotations.proto";
    45  				service Library {
    46  					rpc {{.MethodName}}({{.MethodName}}Request) returns ({{.MethodName}}Response) {
    47  						option (google.api.http) = {
    48  							{{.HTTPMethod}}: "/v1/{{.MethodName}}{{.Suffix}}"
    49  						};
    50  					}
    51  				}
    52  				message {{.MethodName}}Request {}
    53  				message {{.MethodName}}Response {}
    54  			`, test)
    55  			method := file.GetServices()[0].GetMethods()[0]
    56  			got := httpMethod.Lint(file)
    57  			if diff := test.problems.SetDescriptor(method).Diff(got); diff != "" {
    58  				t.Errorf(diff)
    59  			}
    60  		})
    61  	}
    62  }