github.com/googleapis/api-linter@v1.65.2/rules/aip0140/lower_snake_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 aip0140
    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 TestLowerSnake(t *testing.T) {
    25  	// Define permutations.
    26  	tests := []struct {
    27  		testName  string
    28  		fieldName string
    29  		problems  testutils.Problems
    30  	}{
    31  		{"ValidOneWord", "rated", testutils.Problems{}},
    32  		{"ValidTwoWords", "has_rating", testutils.Problems{}},
    33  		{"InvalidCamel", "hasRating", testutils.Problems{{Suggestion: "has_rating"}}},
    34  		{"InvalidConstantOneWord", "RATED", testutils.Problems{{Suggestion: "rated"}}},
    35  		{"InvalidConstantTwoWords", "HAS_RATING", testutils.Problems{{Suggestion: "has_rating"}}},
    36  	}
    37  
    38  	// Test each permutation.
    39  	for _, test := range tests {
    40  		t.Run(test.testName, func(t *testing.T) {
    41  			// Create the given field.
    42  			message, err := builder.NewMessage("Book").AddField(
    43  				builder.NewField(test.fieldName, builder.FieldTypeBool()),
    44  			).Build()
    45  			if err != nil {
    46  				t.Fatalf("Could not build `%s` field.", test.fieldName)
    47  			}
    48  
    49  			// Run the lint rule and verify that we got the expected set
    50  			// of problems.
    51  			problems := lowerSnake.Lint(message.GetFile())
    52  			if diff := test.problems.SetDescriptor(message.GetFields()[0]).Diff(problems); diff != "" {
    53  				t.Errorf(diff)
    54  			}
    55  		})
    56  	}
    57  }