github.com/googleapis/api-linter@v1.65.2/rules/aip0143/string_type_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 aip0143
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestFieldTypes(t *testing.T) {
    24  	tests := []struct {
    25  		testName  string
    26  		FieldType string
    27  		FieldName string
    28  		problems  testutils.Problems
    29  	}{
    30  		{"Irrelevant", "int32", "book_count", testutils.Problems{}},
    31  		{"Valid", "string", "language_code", testutils.Problems{}},
    32  		{"ValidTimeZone", "google.type.TimeZone", "time_zone", nil},
    33  		{"InvalidScalar", "bytes", "language_code", testutils.Problems{{Suggestion: "string"}}},
    34  		{"InvalidEnum", "Language", "language_code", testutils.Problems{{Suggestion: "string"}}},
    35  	}
    36  	for _, test := range tests {
    37  		t.Run(test.testName, func(t *testing.T) {
    38  			file := testutils.ParseProto3Tmpl(t, `
    39  				import "google/type/datetime.proto";
    40  
    41  				message Foo {
    42  					{{.FieldType}} {{.FieldName}} = 1;
    43  				}
    44  				enum Language {
    45  					LANGUAGE_UNSPECIFIED = 0;
    46  				}
    47  			`, test)
    48  			field := file.GetMessageTypes()[0].GetFields()[0]
    49  			problems := fieldTypes.Lint(file)
    50  			if diff := test.problems.SetDescriptor(field).Diff(problems); diff != "" {
    51  				t.Errorf(diff)
    52  			}
    53  		})
    54  	}
    55  }