github.com/googleapis/api-linter@v1.65.2/rules/aip0135/response_lro_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 aip0135
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestResponseLRO(t *testing.T) {
    24  	problems := testutils.Problems{{Suggestion: "google.longrunning.Operation"}}
    25  	for _, test := range []struct {
    26  		name         string
    27  		Style        string
    28  		ResponseType string
    29  		problems     testutils.Problems
    30  	}{
    31  		{"ValidNotDF", "", "Book", nil},
    32  		{"ValidLRO", "style: DECLARATIVE_FRIENDLY", "google.longrunning.Operation", nil},
    33  		{"InvalidDFSync", "style: DECLARATIVE_FRIENDLY", "Book", problems},
    34  	} {
    35  		t.Run(test.name, func(t *testing.T) {
    36  			f := testutils.ParseProto3Tmpl(t, `
    37  				import "google/api/resource.proto";
    38  				import "google/longrunning/operations.proto";
    39  
    40  				service Library {
    41  					rpc DeleteBook(DeleteBookRequest) returns ({{.ResponseType}});
    42  				}
    43  
    44  				message Book {
    45  					option (google.api.resource) = {
    46  						type: "library.googleapis.com/Book"
    47  						pattern: "publishers/{publisher}/books/{book}"
    48  						{{.Style}}
    49  					};
    50  				}
    51  
    52  				message DeleteBookRequest {}
    53  			`, test)
    54  			m := f.GetServices()[0].GetMethods()[0]
    55  			if diff := test.problems.SetDescriptor(m).Diff(responseLRO.Lint(f)); diff != "" {
    56  				t.Errorf(diff)
    57  			}
    58  		})
    59  	}
    60  }