github.com/googleapis/api-linter@v1.65.2/rules/aip0191/file_layout_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 aip0191
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  	"github.com/jhump/protoreflect/desc/builder"
    22  )
    23  
    24  func TestFileLayout(t *testing.T) {
    25  	t.Run("Valid", func(t *testing.T) {
    26  		f := testutils.ParseProto3String(t, `
    27  			service Library {}
    28  			message Book {}
    29  			enum Format {
    30  				FORMAT_UNSPECIFIED = 0;
    31  			}
    32  		`)
    33  		if problems := fileLayout.Lint(f); len(problems) > 0 {
    34  			t.Errorf("%v", problems)
    35  		}
    36  	})
    37  
    38  	t.Run("InvalidServiceAfterMessage", func(t *testing.T) {
    39  		f := testutils.ParseProto3String(t, `
    40  			message Book {}
    41  			service Library {}
    42  		`)
    43  		want := testutils.Problems{{Descriptor: f.GetServices()[0]}}
    44  		if diff := want.Diff(fileLayout.Lint(f)); diff != "" {
    45  			t.Errorf(diff)
    46  		}
    47  	})
    48  
    49  	t.Run("InvalidEnumBeforeMessage", func(t *testing.T) {
    50  		f := testutils.ParseProto3String(t, `
    51  			enum Format {
    52  				FORMAT_UNSPECIFIED = 0;
    53  			}
    54  			message Book {}
    55  		`)
    56  		want := testutils.Problems{{Descriptor: f.GetEnumTypes()[0]}}
    57  		if diff := want.Diff(fileLayout.Lint(f)); diff != "" {
    58  			t.Errorf(diff)
    59  		}
    60  	})
    61  
    62  	t.Run("NoSourceInfo", func(t *testing.T) {
    63  		f, err := builder.NewFile("test.proto").AddMessage(
    64  			builder.NewMessage("Book"),
    65  		).AddService(
    66  			builder.NewService("Library"),
    67  		).Build()
    68  		if err != nil {
    69  			t.Fatalf("Failed to build proto.")
    70  		}
    71  		if problems := fileLayout.Lint(f); len(problems) > 0 {
    72  			t.Errorf("%v", problems)
    73  		}
    74  	})
    75  }