github.com/googleapis/api-linter@v1.65.2/rules/aip0158/response_repeated_first_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 aip0158
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestResponseRepeatedFirstField(t *testing.T) {
    24  	tests := []struct {
    25  		testName    string
    26  		FirstField  string
    27  		SecondField string
    28  		problems    testutils.Problems
    29  	}{
    30  		{"Valid", "repeated Book books = 1;", "string next_page_token = 2;", nil},
    31  		{"SkippedZeroFields", "", "", nil},
    32  		{"InvalidFirstFieldsNoMatch", "string next_page_token = 2;", "repeated Book books = 1;", testutils.Problems{{Message: "protobuf ID"}}},
    33  		{"InvalidNotRepeated", "Book book = 1;", "string next_page_token = 2;", testutils.Problems{{Message: "repeated"}}},
    34  	}
    35  	for _, test := range tests {
    36  		t.Run(test.testName, func(t *testing.T) {
    37  			// Create the proto message.
    38  			f := testutils.ParseProto3Tmpl(t, `
    39  				message Book {
    40  					string name = 1;
    41  				}
    42  				message ListBooksResponse {
    43  					{{.FirstField}}
    44  					{{.SecondField}}
    45  				}
    46  			`, test)
    47  
    48  			// Determine the descriptor that a failing test will attach to.
    49  			if m := f.GetMessageTypes()[1]; len(m.GetFields()) > 0 {
    50  				test.problems.SetDescriptor(m.GetFields()[0])
    51  			}
    52  
    53  			// Run the lint rule and establish we get the correct problems.
    54  			problems := responseRepeatedFirstField.Lint(f)
    55  			if diff := test.problems.Diff(problems); diff != "" {
    56  				t.Errorf(diff)
    57  			}
    58  		})
    59  	}
    60  }