github.com/googleapis/api-linter@v1.65.2/rules/aip0123/resource_plural_test.go

// Copyright 2023 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//	https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package aip0123

import (
	"testing"

	"github.com/googleapis/api-linter/rules/internal/testutils"
)

func TestResourcePlural(t *testing.T) {
	for _, test := range []struct {
		name     string
		Plural   string
		problems testutils.Problems
	}{
		{
			"Valid",
			`plural: "bookShelves"`,
			nil,
		},
		{
			"InvalidMissing",
			``,
			testutils.Problems{{
				Message: "Resources should declare plural",
			}},
		},
		{
			"InvalidUpperCamel",
			`plural: "BookShelves"`,
			testutils.Problems{{
				Message: "Resource plural should be lowerCamelCase",
			}},
		},
		{
			"InvalidDash",
			`plural: "Book-Shelves"`,
			testutils.Problems{{
				Message: "Resource plural should be lowerCamelCase",
			}},
		},
	} {
		t.Run(test.name, func(t *testing.T) {
			f := testutils.ParseProto3Tmpl(t, `
			import "google/api/resource.proto";
			message Book {
				option (google.api.resource) = {
					type: "library.googleapis.com/BookShelf"
					pattern: "publishers/{publisher}/bookShelves/{book_shelf}"
					{{.Plural}}
				};
				string name = 1;
			}
			`, test)
			m := f.GetMessageTypes()[0]
			if diff := test.problems.SetDescriptor(m).Diff(resourcePlural.Lint(f)); diff != "" {
				t.Error(diff)
			}
		})
	}
}