github.com/googleapis/api-linter@v1.65.2/rules/aip0142/time_field_names_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 aip0142
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestFieldName(t *testing.T) {
    24  	tests := []struct {
    25  		testName  string
    26  		FieldType string
    27  		FieldName string
    28  		problems  testutils.Problems
    29  	}{
    30  		{"Valid", "google.protobuf.Timestamp", "create_time", testutils.Problems{}},
    31  		{"InvalidIsMistake", "google.protobuf.Timestamp", "created", testutils.Problems{{Suggestion: "create_time"}}},
    32  		{"InvalidContainsMistake", "google.protobuf.Timestamp", "last_modified", testutils.Problems{{Suggestion: "update_time"}}},
    33  		{"InvalidNoSuffix", "google.protobuf.Timestamp", "create", testutils.Problems{{Message: "should end"}}},
    34  		{"ValidSuffixRepeatedPlural", "repeated google.protobuf.Timestamp", "sample_times", testutils.Problems{}},
    35  		{"ValidSuffixRepeated", "repeated google.protobuf.Timestamp", "sample_time", testutils.Problems{}},
    36  		{"InvalidNoSuffixRepeated", "repeated google.protobuf.Timestamp", "create", testutils.Problems{{Message: "should end"}}},
    37  		{"SkipNonTimestamp", "int32", "created", testutils.Problems{}},
    38  		{"IrrelevantWeirdType", "bytes", "created", nil},
    39  	}
    40  	for _, test := range tests {
    41  		t.Run(test.testName, func(t *testing.T) {
    42  			file := testutils.ParseProto3Tmpl(t, `
    43  				import "google/protobuf/timestamp.proto";
    44  				message Book {
    45  					{{.FieldType}} {{.FieldName}} = 1;
    46  				}
    47  			`, test)
    48  			field := file.GetMessageTypes()[0].GetFields()[0]
    49  			if diff := test.problems.SetDescriptor(field).Diff(fieldNames.Lint(file)); diff != "" {
    50  				t.Errorf(diff)
    51  			}
    52  		})
    53  	}
    54  }