github.com/googleapis/api-linter@v1.65.2/rules/aip0128/resource_annotations_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 aip0128
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  	"github.com/jhump/protoreflect/desc"
    22  )
    23  
    24  func TestResourceAnnotationsField(t *testing.T) {
    25  	for _, test := range []struct {
    26  		name        string
    27  		Style       string
    28  		Annotations string
    29  		problems    testutils.Problems
    30  	}{
    31  		{"ValidMissingNotDF", "", "", nil},
    32  		{"ValidPresentNotDF", "", "map<string, string> annotations = 2;", nil},
    33  		{"ValidBadTypeNotDF", "", "int32 annotations = 2;", nil},
    34  		{"ValidPresentDF", "style: DECLARATIVE_FRIENDLY", "map<string, string> annotations = 2;", nil},
    35  		{"InvalidMissingDF", "style: DECLARATIVE_FRIENDLY", "", testutils.Problems{{Message: "annotations"}}},
    36  		{"InvalidBadTypeDF", "style: DECLARATIVE_FRIENDLY", "map<string, int32> annotations = 2;", testutils.Problems{{Suggestion: "map<string, string>"}}},
    37  	} {
    38  		t.Run(test.name, func(t *testing.T) {
    39  			f := testutils.ParseProto3Tmpl(t, `
    40  				import "google/api/resource.proto";
    41  				message Book {
    42  					option (google.api.resource) = {
    43  						type: "library.googleapis.com/Book"
    44  						{{.Style}}
    45  					};
    46  					string name = 1;
    47  					{{.Annotations}}
    48  				}
    49  				message DeleteBookRequest {}
    50  			`, test)
    51  			var d desc.Descriptor = f.GetMessageTypes()[0]
    52  			if test.name == "InvalidBadTypeDF" {
    53  				d = f.GetMessageTypes()[0].GetFields()[1]
    54  			}
    55  			if diff := test.problems.SetDescriptor(d).Diff(resourceAnnotationsField.Lint(f)); diff != "" {
    56  				t.Errorf(diff)
    57  			}
    58  		})
    59  	}
    60  }