github.com/googleapis/api-linter@v1.65.2/rules/aip0134/request_resource_field_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 aip0134
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestResourceField(t *testing.T) {
    24  	// Set up the testing permutations.
    25  	tests := []struct {
    26  		name              string
    27  		MessageName       string
    28  		ResourceName      string
    29  		ResourceFieldName string
    30  		problems          testutils.Problems
    31  	}{
    32  		{"Valid", "UpdateBookRequest", "Book", "book", nil},
    33  		{"InvalidFieldName", "UpdateBookRequest", "Book", "big_book", testutils.Problems{{Suggestion: "book"}}},
    34  		{"IrrelevantMessage", "ModifyBookRequest", "Book", "big_book", nil},
    35  		{"IrrelevantFieldType", "UpdateBookRequest", "string", "big_book", nil},
    36  		{"IrrelevantFieldMessage", "UpdateBookRequest", "Foo", "big_book", nil},
    37  	}
    38  
    39  	// Run each test individually.
    40  	for _, test := range tests {
    41  		t.Run(test.name, func(t *testing.T) {
    42  			file := testutils.ParseProto3Tmpl(t, `
    43  				import "google/protobuf/field_mask.proto";
    44  				message {{.MessageName}} {
    45  					{{.ResourceName}} {{.ResourceFieldName}} = 1;
    46  				}
    47  				message {{.ResourceName}} {}
    48  			`, test)
    49  			field := file.GetMessageTypes()[0].GetFields()[0]
    50  
    51  			// Run the lint rule, and establish that it returns the correct problems.
    52  			problems := requestResourceField.Lint(file)
    53  			if diff := test.problems.SetDescriptor(field).Diff(problems); diff != "" {
    54  				t.Errorf(diff)
    55  			}
    56  		})
    57  	}
    58  }