github.com/googleapis/api-linter@v1.65.2/rules/aip0122/resource_id_output_only_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 aip0122
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestResourceIdOutputOnly(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name          string
    26  		FieldName     string
    27  		FieldBehavior string
    28  		problems      testutils.Problems
    29  	}{
    30  		{"ValidWithSuffix", "book_id", "[(google.api.field_behavior) = OUTPUT_ONLY]", testutils.Problems{}},
    31  		{"ValidUID", "uid", "[(google.api.field_behavior) = OUTPUT_ONLY]", testutils.Problems{}},
    32  		{"InvalidWithSuffix", "book_id", "", testutils.Problems{{Message: "OUTPUT_ONLY"}}},
    33  		{"InvalidUID", "uid", "", testutils.Problems{{Message: "OUTPUT_ONLY"}}},
    34  		{"SkipDifferentIdField", "foo_id", "", testutils.Problems{}},
    35  	} {
    36  		f := testutils.ParseProto3Tmpl(t, `
    37  			import "google/api/resource.proto";
    38  			import "google/api/field_behavior.proto";
    39  
    40  			message Book {
    41  				option (google.api.resource) = {
    42  					type: "library.googleapis.com/Book"
    43  					pattern: "books/{book}"
    44  				};
    45  				string name = 1;
    46  				string {{.FieldName}} = 2 {{.FieldBehavior}};
    47  			}
    48  		`, test)
    49  		field := f.GetMessageTypes()[0].GetFields()[1]
    50  		if diff := test.problems.SetDescriptor(field).Diff(resourceIdOutputOnly.Lint(f)); diff != "" {
    51  			t.Errorf(diff)
    52  		}
    53  	}
    54  }