check_field_names_use_lower_snake_case_test.go

// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// 		https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package rules

import (
	"fmt"
	"testing"

	"github.com/googleapis/api-linter/lint"
	"github.com/googleapis/api-linter/testutil"
)

func TestFieldNamesUseLowerSnakeCaseRule(t *testing.T) {
	tmpl := `
	syntax = "proto2";
	message Foo {
	  optional string {{.FieldName}} = 1;
	}`

	tests := []struct {
		FieldName  string
		numProblem int
		suggestion string
		startLine  int
	}{
		{"good_field_name", 0, "", -1},
		{"BadFieldName", 1, "bad_field_name", 4},
		{"badFieldName", 1, "bad_field_name", 4},
		{"Bad_Field_Name", 1, "bad_field_name", 4},
		{"bad_Field_Name", 1, "bad_field_name", 4},
		{"badField_Name", 1, "bad_field_name", 4},
	}

	rule := checkFieldNamesUseLowerSnakeCase()

	for _, test := range tests {
		errPrefix := fmt.Sprintf("Check field name `%s`", test.FieldName)

		req, err := lint.NewProtoRequest(testutil.MustCreateFileDescriptorProto(
			t,
			testutil.FileDescriptorSpec{Filename: "test.proto", Template: tmpl, Data: test},
		), nil)
		if err != nil {
			t.Errorf("%s: lint.NewProtoRequest returned error %v", errPrefix, err)
		}

		resp, err := rule.Lint(req)
		if err != nil {
			t.Errorf("%s: lint.Run return error %v", errPrefix, err)
		}

		if got, want := len(resp), test.numProblem; got != want {
			t.Errorf("%s: got %d problems, but want %d", errPrefix, got, want)
		}

		if len(resp) > 0 {
			if got, want := resp[0].Suggestion, test.suggestion; got != want {
				t.Errorf("%s: got suggestion '%s', but want '%s'", errPrefix, got, want)
			}
			if got, want := resp[0].Location.Start.Line, test.startLine; got != want {
				t.Errorf("%s: got location starting with %d, but want %d", errPrefix, got, want)
			}
		}
	}
}