github.com/googleapis/api-linter@v1.65.2/rules/aip0123/name_never_optional_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 aip0123
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestNameNeverOptional(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name      string
    26  		FieldName string
    27  		NameField string
    28  		Label     string
    29  		problems  testutils.Problems
    30  	}{
    31  		{"Valid", "name", "", "", testutils.Problems{}},
    32  		{"ValidAlternativeName", "resource", "resource", "", testutils.Problems{}},
    33  		{"InvalidProto3Optional", "name", "", "optional", testutils.Problems{{Message: "never be labeled"}}},
    34  		{"SkipNameFieldDNE", "name", "does_not_exist", "", testutils.Problems{}},
    35  	} {
    36  		t.Run(test.name, func(t *testing.T) {
    37  			f := testutils.ParseProto3Tmpl(t, `
    38  				import "google/api/resource.proto";
    39  				message Book {
    40  					option (google.api.resource) = {
    41  						type: "library.googleapis.com/Book"
    42  						pattern: "publishers/{publisher}/books/{book}"
    43  						name_field: "{{.NameField}}"
    44  					};
    45  
    46  					{{.Label}} string {{.FieldName}} = 1;
    47  				}
    48  			`, test)
    49  			field := f.GetMessageTypes()[0].GetFields()[0]
    50  			if diff := test.problems.SetDescriptor(field).Diff(nameNeverOptional.Lint(f)); diff != "" {
    51  				t.Errorf(diff)
    52  			}
    53  		})
    54  	}
    55  }