github.com/googleapis/api-linter@v1.65.2/rules/aip0135/request_name_required_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 aip0135
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestRequestNameRequired(t *testing.T) {
    24  	// Set up the testing permutations.
    25  	tests := []struct {
    26  		name        string
    27  		MessageName string
    28  		FieldName   string
    29  		problems    testutils.Problems
    30  	}{
    31  		{"Valid", "DeleteBookRequest", "name", nil},
    32  		{"InvalidName", "DeleteBookRequest", "id", testutils.Problems{{Message: "name"}}},
    33  		{"Irrelevant", "RemoveBookRequest", "id", nil},
    34  	}
    35  
    36  	// Run each test individually.
    37  	for _, test := range tests {
    38  		t.Run(test.name, func(t *testing.T) {
    39  			f := testutils.ParseProto3Tmpl(t, `
    40  				message {{.MessageName}} {
    41  					string {{.FieldName}} = 1;
    42  				}
    43  			`, test)
    44  
    45  			// Run the lint rule, and establish that it returns the correct problems.
    46  			problems := requestNameRequired.Lint(f)
    47  			message := f.GetMessageTypes()[0]
    48  			if diff := test.problems.SetDescriptor(message).Diff(problems); diff != "" {
    49  				t.Errorf("Problems did not match: %v", diff)
    50  			}
    51  		})
    52  	}
    53  }