helpers_test.go

// Copyright 2021 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 gengapic

import (
	"testing"

	"github.com/google/go-cmp/cmp"
	"google.golang.org/genproto/googleapis/api/annotations"
	"google.golang.org/protobuf/proto"
	"google.golang.org/protobuf/types/descriptorpb"
)

func TestCamelToSnake(t *testing.T) {
	for _, tst := range []struct {
		in, want string
	}{
		{"IAMCredentials", "iam_credentials"},
		{"DLP", "dlp"},
		{"OsConfig", "os_config"},
	} {
		if got := camelToSnake(tst.in); got != tst.want {
			t.Errorf("camelToSnake(%q) = %q, want %q", tst.in, got, tst.want)
		}
	}
}

func TestSnakeToCamel(t *testing.T) {
	for _, tst := range []struct {
		in, want string
	}{
		// Note: we cannot determine if a sequence of lower case letters
		// represent an acronym, so they are treated like discrete words.
		{"iam_credentials", "IamCredentials"},
		{"dlp", "Dlp"},
		{"os_config", "OsConfig"},
		{"display_video_360_advertiser_links", "DisplayVideo_360AdvertiserLinks"},
	} {
		got := snakeToCamel(tst.in)
		if diff := cmp.Diff(got, tst.want); diff != "" {
			t.Errorf("snakeToCamel(%q) = got(-),want(+):\n%s", tst.in, diff)
		}
	}
}

func TestLowerFirst(t *testing.T) {
	for _, tst := range []struct {
		in, want string
	}{
		{"Foo", "foo"},
		{"", ""},
		{"BarBaz", "barBaz"},
	} {
		got := lowerFirst(tst.in)
		if diff := cmp.Diff(got, tst.want); diff != "" {
			t.Errorf("Test_lowerFirst: got(-),want(+):\n%s", diff)
		}
	}
}

func TestUpperFirst(t *testing.T) {
	for _, tst := range []struct {
		in, want string
	}{
		{"foo", "Foo"},
		{"", ""},
		{"barBaz", "BarBaz"},
	} {
		got := upperFirst(tst.in)
		if diff := cmp.Diff(got, tst.want); diff != "" {
			t.Errorf("upperFirst(%q): got(-),want(+):\n%s", tst.in, diff)
		}
	}
}

func TestIsOptional(t *testing.T) {
	msg := &descriptorpb.DescriptorProto{
		Field: []*descriptorpb.FieldDescriptorProto{
			{
				Name:           proto.String("opt"),
				Proto3Optional: proto.Bool(true),
			},
			{
				Name: proto.String("not_opt"),
			},
		},
	}
	for _, tst := range []struct {
		field string
		want  bool
	}{
		{
			field: "opt",
			want:  true,
		},
		{
			field: "not_opt",
		},
		{
			field: "no_such_field",
		},
	} {
		if got := isOptional(msg, tst.field); got != tst.want {
			t.Errorf("isOptional(%q) = got %v, want %v", tst.field, got, tst.want)
		}
	}
}

func TestStrContains(t *testing.T) {
	set := []string{
		"foo",
		"bar",
		"exists",
		"baz",
	}
	for _, tst := range []struct {
		in   string
		want bool
	}{
		{
			in:   "exists",
			want: true,
		},
		{
			in: "doesn't exist",
		},
	} {
		if got := strContains(set, tst.in); got != tst.want {
			t.Errorf("strContains(%v, %q): got %v, want %v", set, tst.in, got, tst.want)
		}
	}
}

func TestHasField(t *testing.T) {
	msg := &descriptorpb.DescriptorProto{
		Field: []*descriptorpb.FieldDescriptorProto{
			{Name: proto.String("foo")},
			{Name: proto.String("bar")},
		},
	}
	for _, tst := range []struct {
		in   string
		want bool
	}{
		{in: "foo", want: true},
		{in: "baz"},
	} {
		if got := hasField(msg, tst.in); !cmp.Equal(got, tst.want) {
			t.Errorf("TestHasField got %v want %v", got, tst.want)
		}
	}
}

func TestHasMethod(t *testing.T) {
	serv := &descriptorpb.ServiceDescriptorProto{
		Method: []*descriptorpb.MethodDescriptorProto{
			{Name: proto.String("ListFoos")},
			{Name: proto.String("GetFoo")},
			{Name: proto.String("CreateFoo")},
		},
	}
	for _, tst := range []struct {
		in   string
		want bool
	}{
		{in: "GetFoo", want: true},
		{in: "DeleteBar"},
	} {
		if got := hasMethod(serv, tst.in); !cmp.Equal(got, tst.want) {
			t.Errorf("TestHasMethod got %v want %v", got, tst.want)
		}
	}
}

func TestIsRequired(t *testing.T) {
	req := &descriptorpb.FieldOptions{}
	proto.SetExtension(req, annotations.E_FieldBehavior, []annotations.FieldBehavior{annotations.FieldBehavior_REQUIRED})

	notReq := &descriptorpb.FieldOptions{}
	proto.SetExtension(notReq, annotations.E_FieldBehavior, []annotations.FieldBehavior{annotations.FieldBehavior_INPUT_ONLY})

	for _, tst := range []struct {
		opts *descriptorpb.FieldOptions
		want bool
	}{
		{
			opts: req,
			want: true,
		},
		{
			opts: notReq,
		},
		{
			opts: nil,
		},
	} {
		if got := isRequired(&descriptorpb.FieldDescriptorProto{Options: tst.opts}); got != tst.want {
			t.Errorf("isRequired(%q) = got %v, want %v", tst.opts, got, tst.want)
		}
	}
}

func TestConvertPathTemplateToRegex(t *testing.T) {
	for _, tst := range []struct {
		in   string
		want string
	}{
		{
			in:   "",
			want: "(.*)",
		},
		{
			in:   "{foo}",
			want: "(?P<foo>.*)",
		},
		{
			in:   "{foo=*}",
			want: "(?P<foo>.*)",
		},
		{
			in:   "{foo=**}",
			want: "(?P<foo>.*)",
		},
		{
			in:   "{foo=projects/*}/bars",
			want: "(?P<foo>projects/[^/]+)/bars",
		},
		{
			in:   "{database=projects/*/databases/*}/documents/*/**",
			want: "(?P<database>projects/[^/]+/databases/[^/]+)/documents/[^/]+(?:/.*)?",
		},
		{
			in:   "projects/*/foos/*/{bar_name=bars/*}/**",
			want: "projects/[^/]+/foos/[^/]+/(?P<bar_name>bars/[^/]+)(?:/.*)?",
		},
	} {
		if got := convertPathTemplateToRegex(tst.in); got != tst.want {
			t.Errorf("convertPathTemplateToRegex(%v): got %v, want %v", tst.in, got, tst.want)
		}
	}
}

func TestGetHeaderName(t *testing.T) {
	for _, tst := range []struct {
		in   string
		want string
	}{
		{
			in:   "{foo}",
			want: "foo",
		},
		{
			in:   "foo",
			want: "",
		},
		{
			in:   "{foo=bar}",
			want: "foo",
		},
		{
			in:   "{foo=*}",
			want: "foo",
		},
		{
			in:   "test/{database=projects/*/databases/*}/documents/*/**",
			want: "database",
		},
		{
			in:   "{new_name_match=projects/*/instances/*/tables/*}",
			want: "new_name_match",
		},
		{
			in:   "profiles/{routing_id=*}",
			want: "routing_id",
		},
	} {
		if got := getHeaderName(tst.in); got != tst.want {
			t.Errorf("getHeaderName(%v): got %v, want %v", tst.in, got, tst.want)
		}
	}
}

func TestHasRESTMethod(t *testing.T) {
	for _, tst := range []struct {
		name string
		want bool
	}{
		{"has_rest_method", true},
		{"does_not_have_rest_method", false},
	} {
		opts := &descriptorpb.MethodOptions{}
		if tst.want {
			proto.SetExtension(opts, annotations.E_Http, &annotations.HttpRule{Pattern: &annotations.HttpRule_Get{Get: "/foo"}})
		}
		s := &descriptorpb.ServiceDescriptorProto{
			Method: []*descriptorpb.MethodDescriptorProto{
				{Options: opts},
			},
		}
		if got := hasRESTMethod(s); got != tst.want {
			t.Fatalf("%s: expected %v, got %v", tst.name, tst.want, got)
		}
	}
}