github.com/googleapis/api-linter@v1.65.2/rules/aip0123/resource_pattern_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 aip0123
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestResourcePattern(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name     string
    26  		Pattern  string
    27  		problems testutils.Problems
    28  	}{
    29  		{"Valid", `pattern: "publishers/{publisher}/books/{book}"`, testutils.Problems{}},
    30  		{"ValidCamel", `pattern: "publishers/{publisher}/electronicBooks/{electronic_book}"`, testutils.Problems{}},
    31  		{"Missing", "", testutils.Problems{{Message: "declare resource name pattern"}}},
    32  		{"SnakeCase", `pattern: "book_publishers/{book_publisher}/books/{book}"`, testutils.Problems{{
    33  			Message: "bookPublishers/{book_publisher}/books/{book}",
    34  		}}},
    35  		{"HasSpaces", `pattern: "publishers/{publisher}/ books /{book}"`, testutils.Problems{{
    36  			Message: "Resource patterns should not have spaces",
    37  		}}},
    38  	} {
    39  		t.Run(test.name, func(t *testing.T) {
    40  			f := testutils.ParseProto3Tmpl(t, `
    41  				import "google/api/resource.proto";
    42  
    43  				message Book {
    44  					option (google.api.resource) = {
    45  						type: "library.googleapis.com/Book"
    46  						{{.Pattern}}
    47  					};
    48  					string name = 1;
    49  				}
    50  			`, test)
    51  			m := f.GetMessageTypes()[0]
    52  			if diff := test.problems.SetDescriptor(m).Diff(resourcePattern.Lint(f)); diff != "" {
    53  				t.Errorf(diff)
    54  			}
    55  		})
    56  	}
    57  }