github.com/googleapis/api-linter@v1.65.2/rules/aip0133/request_id_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 aip0133
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestRequestIDField(t *testing.T) {
    24  	problems := testutils.Problems{{Message: "`string book_id`"}}
    25  	for _, test := range []struct {
    26  		name     string
    27  		IDField  string
    28  		problems testutils.Problems
    29  	}{
    30  		{"Valid", "string book_id = 2;", nil},
    31  		{"InvalidMissing", "", problems},
    32  		{"InvalidType", "bytes book_id = 2;", problems},
    33  		{"InvalidRepeated", "repeated string book_id = 2;", problems},
    34  	} {
    35  		t.Run(test.name, func(t *testing.T) {
    36  			f := testutils.ParseProto3Tmpl(t, `
    37  				import "google/api/resource.proto";
    38  
    39  				service Library {
    40  					rpc CreateBook(CreateBookRequest) returns (Book);
    41  				}
    42  
    43  				message Book {
    44  					option (google.api.resource) = {
    45  						type: "library.googleapis.com/Book"
    46  						pattern: "publishers/{publisher}/books/{book}"
    47  					};
    48  				}
    49  
    50  				message CreateBookRequest {
    51  					string parent = 1;
    52  					{{.IDField}}
    53  					Book book = 3;
    54  				}
    55  			`, test)
    56  			m := f.FindMessage("CreateBookRequest")
    57  			if diff := test.problems.SetDescriptor(m).Diff(requestIDField.Lint(f)); diff != "" {
    58  				t.Errorf(diff)
    59  			}
    60  		})
    61  	}
    62  }