github.com/googleapis/api-linter@v1.65.2/rules/aip0216/value_synonyms_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 aip0216
    16  
    17  import (
    18  	"testing"
    19  
    20  	"github.com/googleapis/api-linter/rules/internal/testutils"
    21  )
    22  
    23  func TestValueSynonyms(t *testing.T) {
    24  	for _, test := range []struct {
    25  		name      string
    26  		EnumName  string
    27  		ValueName string
    28  		problems  testutils.Problems
    29  	}{
    30  		{"ValidSucceeded", "State", "SUCCEEDED", nil},
    31  		{"ValidDeleted", "State", "DELETED", nil},
    32  		{"InvalidSuccess", "State", "SUCCESS", testutils.Problems{{Suggestion: "SUCCEEDED"}}},
    33  		{"InvalidSuccessful", "State", "SUCCESSFUL", testutils.Problems{{Suggestion: "SUCCEEDED"}}},
    34  		{"InvalidCanceled", "State", "CANCELED", testutils.Problems{{Suggestion: "CANCELLED"}}},
    35  		{"InvalidCanceling", "State", "CANCELING", testutils.Problems{{Suggestion: "CANCELLING"}}},
    36  		{"InvalidFail", "State", "FAIL", testutils.Problems{{Suggestion: "FAILED"}}},
    37  		{"InvalidFailure", "State", "FAILURE", testutils.Problems{{Suggestion: "FAILED"}}},
    38  		{"Irrelevant", "Foo", "SUCCESSFUL", nil},
    39  	} {
    40  		t.Run(test.name, func(t *testing.T) {
    41  			file := testutils.ParseProto3Tmpl(t, `
    42  				enum {{.EnumName}} {
    43  					{{.EnumName}}_UNSPECIFIED = 0;
    44  					{{.ValueName}} = 1;
    45  				}
    46  			`, test)
    47  			ev := file.GetEnumTypes()[0].GetValues()[1]
    48  			if diff := test.problems.SetDescriptor(ev).Diff(valueSynonyms.Lint(file)); diff != "" {
    49  				t.Errorf(diff)
    50  			}
    51  		})
    52  	}
    53  }