github.com/googleapis/api-linter@v1.65.2/rules/aip0136/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 aip0136
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestURISuffix(t *testing.T) {
    24  	tests := []struct {
    25  		testName   string
    26  		MethodName string
    27  		URI        string
    28  		problems   testutils.Problems
    29  	}{
    30  		{"ValidTwoWordNoParent", "SearchAudioBooks", "/v1/audioBooks:search", nil},
    31  		{"ValidVerb", "ArchiveBook", "/v1/{name=publishers/*/books}:archive", testutils.Problems{}},
    32  		{"ValidVerbNested", "ArchiveBook", "/v1/{book.name=publishers/*/books}:archive", testutils.Problems{}},
    33  		{"ValidVerbParent", "ImportBooks", "/v1/{parent=publishers/*}/books:import", testutils.Problems{}},
    34  		{"ValidVerbParentBatchGet", "BatchGetBooks", "/v1/{parent=publishers/*}/books:batchGet", testutils.Problems{}},
    35  		{"InvalidVerb", "ArchiveBook", "/v1/{name=publishers/*/books}:archiveBook", testutils.Problems{{Message: ":archive"}}},
    36  		{"ValidVerbNounNoVars", "TranslateText", "/v3:translateText", testutils.Problems{}},
    37  		{"ValidVerbNounNoName", "TranslateText", "/v3/{location=projects/*/locations/*}:translateText", testutils.Problems{}},
    38  		{"InvalidVerbNoun", "TranslateText", "/v3:translate", testutils.Problems{{Message: ":translateText"}}},
    39  		{"ValidOneWord", "Translate", "/v3:translate", testutils.Problems{}},
    40  		{"ValidStdMethod", "GetBook", "/v1/{name=publishers/*/books/*}", testutils.Problems{}},
    41  		{"ValidTwoWordNoun", "WriteAudioBook", "/v1/{name=publishers/*/audioBooks/*}:write", testutils.Problems{}},
    42  		{"ValidListRevisions", "ListBookRevisions", "/v1/{name=publishers/*/books/*}:listRevisions", testutils.Problems{}},
    43  		{"ValidTagRevision", "TagBookRevision", "/v1/{name=publishers/*/books/*}:tagRevision", testutils.Problems{}},
    44  		{"ValidDeleteRevision", "DeleteBookRevision", "/v1/{name=publishers/*/books/*}:deleteRevision", testutils.Problems{}},
    45  		{"ValidCollection", "SortBooks", "/v1/{publisher=publishers/*}/books:sort", testutils.Problems{}},
    46  		{"ValidNoParent", "SearchBooks", "/v1/books:search", testutils.Problems{}},
    47  		{"InvalidListRevisions", "ListBookRevisions", "/v1/{name=publishers/*/books/*}:list", testutils.Problems{{Message: ":listRevisions"}}},
    48  		{"InvalidTagRevision", "TagBookRevision", "/v1/{name=publishers/*/books/*}:tag", testutils.Problems{{Message: ":tagRevision"}}},
    49  		{"InvalidDeleteRevision", "DeleteBookRevision", "/v1/{name=publishers/*/books/*}:delete", testutils.Problems{{Message: ":deleteRevision"}}},
    50  		{"IgnoredFailsVariables", "AddPages", "/v1/{name=publishers/*/books/*}:addPages", testutils.Problems{}},
    51  	}
    52  	for _, test := range tests {
    53  		t.Run(test.testName, func(t *testing.T) {
    54  			file := testutils.ParseProto3Tmpl(t, `
    55  				import "google/api/annotations.proto";
    56  				service Library {
    57  					rpc {{.MethodName}}({{.MethodName}}Request) returns ({{.MethodName}}Response) {
    58  						option (google.api.http) = {
    59  							post: "{{.URI}}"
    60  							body: "*"
    61  						};
    62  					}
    63  				}
    64  				message {{.MethodName}}Request {}
    65  				message {{.MethodName}}Response {}
    66  			`, test)
    67  			method := file.GetServices()[0].GetMethods()[0]
    68  			problems := uriSuffix.Lint(file)
    69  			if diff := test.problems.SetDescriptor(method).Diff(problems); diff != "" {
    70  				t.Errorf(diff)
    71  			}
    72  		})
    73  	}
    74  }