github.com/googleapis/api-linter@v1.65.2/rules/aip0141/count_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 aip0141
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/lint"
    21  	"github.com/googleapis/api-linter/rules/internal/testutils"
    22  )
    23  
    24  func TestCount(t *testing.T) {
    25  	tests := []struct {
    26  		testName  string
    27  		FieldName string
    28  		want      string
    29  		err       bool
    30  	}{
    31  		{"Valid", "item_count", "item_count", false},
    32  		{"NumItems", "num_items", "item_count", true},
    33  		{"NumResults", "num_results", "result_count", true},
    34  		{"NumErrors", "num_errors", "error_count", true},
    35  		{"NumMoose", "num_moose", "moose_count", true}, // singular of "moose" is "moose"
    36  		{"NumGeese", "num_geese", "goose_count", true}, // singular of "geese" is "goose"
    37  	}
    38  	for _, test := range tests {
    39  		file := testutils.ParseProto3Tmpl(t, `
    40  			message Job {
    41  				int32 {{.FieldName}} = 1;
    42  			}
    43  		`, test)
    44  		field := file.GetMessageTypes()[0].GetFields()[0]
    45  		wantProblems := testutils.Problems{}
    46  		if test.err {
    47  			wantProblems = append(wantProblems, lint.Problem{
    48  				Message:    "_count suffix",
    49  				Suggestion: test.want,
    50  				Descriptor: field,
    51  			})
    52  		}
    53  		if diff := wantProblems.Diff(count.Lint(file)); diff != "" {
    54  			t.Errorf(diff)
    55  		}
    56  	}
    57  }