github.com/googleapis/api-linter@v1.65.2/rules/aip0165/response_purge_sample_field_test.go (about)

     1  // Copyright 2020 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 aip0165
    16  
    17  import (
    18  	"strings"
    19  	"testing"
    20  
    21  	"github.com/googleapis/api-linter/rules/internal/testutils"
    22  	"github.com/jhump/protoreflect/desc"
    23  )
    24  
    25  func TestResponsePurgeSampleField(t *testing.T) {
    26  	for _, test := range []struct {
    27  		name     string
    28  		RPC      string
    29  		Field    string
    30  		problems testutils.Problems
    31  	}{
    32  		{"Valid", "PurgeBooks", "repeated string purge_sample = 1;", nil},
    33  		{"Missing", "PurgeBooks", "", testutils.Problems{{Message: "no `purge_sample`"}}},
    34  		{"InvalidType", "PurgeBooks", "repeated int64 purge_sample = 1;", testutils.Problems{{Suggestion: "repeated string"}}},
    35  		{"InvalidTypeNotRepeated", "PurgeBooks", "string purge_sample = 1;", testutils.Problems{{Suggestion: "repeated string"}}},
    36  		{"IrrelevantMessage", "EnumerateBooks", "", nil},
    37  	} {
    38  		t.Run(test.name, func(t *testing.T) {
    39  			f := testutils.ParseProto3Tmpl(t, `
    40  				message {{.RPC}}Response {
    41  					{{.Field}}
    42  					int32 purge_count = 2;
    43  				}
    44  			`, test)
    45  			var d desc.Descriptor = f.GetMessageTypes()[0]
    46  			if strings.HasPrefix(test.name, "InvalidType") {
    47  				d = f.GetMessageTypes()[0].GetFields()[0]
    48  			}
    49  			if diff := test.problems.SetDescriptor(d).Diff(responsePurgeSampleField.Lint(f)); diff != "" {
    50  				t.Errorf(diff)
    51  			}
    52  		})
    53  	}
    54  }