github.com/googleapis/api-linter@v1.65.2/rules/aip0203/unordered_list_repeated_test.go (about)

     1  // Copyright 2020 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 aip0203
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestUnorderedList(t *testing.T) {
    24  	testCases := []struct {
    25  		name     string
    26  		Field    string
    27  		problems testutils.Problems
    28  	}{
    29  		{
    30  			name:     "ValidSingularNoAnnotation",
    31  			Field:    `string title = 1;`,
    32  			problems: nil,
    33  		},
    34  		{
    35  			name:     "ValidRepeatedNoAnnotation",
    36  			Field:    `repeated string authors = 1;`,
    37  			problems: nil,
    38  		},
    39  		{
    40  			name:     "ValidRepeatedAnnotation",
    41  			Field:    `repeated string authors = 1 [(google.api.field_behavior) = UNORDERED_LIST];`,
    42  			problems: nil,
    43  		},
    44  		{
    45  			name:     "InvalidSingularAnnotation",
    46  			Field:    `string title = 1 [(google.api.field_behavior) = UNORDERED_LIST];`,
    47  			problems: testutils.Problems{{Message: "must not be applied to non-repeated fields"}},
    48  		},
    49  	}
    50  
    51  	for _, test := range testCases {
    52  		t.Run(test.name, func(t *testing.T) {
    53  			file := testutils.ParseProto3Tmpl(t, `
    54  				import "google/api/field_behavior.proto";
    55  				message Book {
    56  					{{.Field}}
    57  				}`, test)
    58  			f := file.GetMessageTypes()[0].GetFields()[0]
    59  			problems := unorderedListRepeated.Lint(file)
    60  			if diff := test.problems.SetDescriptor(f).Diff(problems); diff != "" {
    61  				t.Error(diff)
    62  			}
    63  		})
    64  	}
    65  }