firestore/fieldpath_test.go

// Copyright 2017 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
//
//      http://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 firestore

import (
	"reflect"
	"strings"
	"testing"

	"cloud.google.com/go/internal/testutil"
)

func TestFieldPathValidate(t *testing.T) {
	for _, in := range [][]string{nil, {}, {"a", "", "b"}} {
		if err := FieldPath(in).validate(); err == nil {
			t.Errorf("%v: want error, got nil", in)
		}
	}
}

func TestFieldPathLess(t *testing.T) {
	for _, test := range []struct {
		in1, in2 string
		want     bool
	}{
		{"a b", "a b", false},
		{"a", "b", true},
		{"b", "a", false},
		{"a", "a b", true},
		{"a b", "a", false},
		{"a b c", "a b d", true},
		{"a b d", "a b c", false},
	} {
		fp1 := FieldPath(strings.Fields(test.in1))
		fp2 := FieldPath(strings.Fields(test.in2))
		got := fp1.less(fp2)
		if got != test.want {
			t.Errorf("%q.less(%q): got %t, want %t", test.in1, test.in2, got, test.want)
		}
	}
}

func TestCheckForPrefix(t *testing.T) {
	for _, test := range []struct {
		in      []string // field paths as space-separated strings
		wantErr bool
	}{
		{in: []string{"a", "b", "c"}, wantErr: false},
		{in: []string{"a b", "b", "c d"}, wantErr: false},
		{in: []string{"a b", "a c", "a d"}, wantErr: false},
		{in: []string{"a b", "b", "b d"}, wantErr: true},
		{in: []string{"a b", "b", "b d"}, wantErr: true},
		{in: []string{"b c d", "c d", "b c"}, wantErr: true},
	} {
		var fps []FieldPath
		for _, s := range test.in {
			fps = append(fps, strings.Fields(s))
		}
		err := checkNoDupOrPrefix(fps)
		if got, want := (err != nil), test.wantErr; got != want {
			t.Errorf("%#v: got '%v', want %t", test.in, err, want)
		}
	}
}

func TestGetAtPath(t *testing.T) {
	type S struct {
		X    int
		Y    int `firestore:"y"`
		M    map[string]interface{}
		Next *S
	}

	const fail = "ERROR" // value for expected error

	for _, test := range []struct {
		val  interface{}
		fp   FieldPath
		want interface{}
	}{
		{
			val:  map[string]int(nil),
			fp:   nil,
			want: map[string]int(nil),
		},
		{
			val:  1,
			fp:   nil,
			want: 1,
		},
		{
			val:  1,
			fp:   []string{"a"},
			want: fail,
		},
		{
			val:  map[string]int{"a": 2},
			fp:   []string{"a"},
			want: 2,
		},
		{
			val:  map[string]int{"a": 2},
			fp:   []string{"b"},
			want: fail,
		},
		{
			val:  map[string]interface{}{"a": map[string]int{"b": 3}},
			fp:   []string{"a", "b"},
			want: 3,
		},
		{
			val:  map[string]interface{}{"a": map[string]int{"b": 3}},
			fp:   []string{"a", "b", "c"},
			want: fail,
		},
		{
			val:  S{X: 1, Y: 2},
			fp:   nil,
			want: S{X: 1, Y: 2},
		},
		{
			val:  S{X: 1, Y: 2},
			fp:   []string{"X"},
			want: 1,
		},
		{
			val:  S{X: 1, Y: 2},
			fp:   []string{"Y"},
			want: fail, // because Y is tagged with name "y"
		},
		{
			val:  S{X: 1, Y: 2},
			fp:   []string{"y"},
			want: 2,
		},
		{
			val:  &S{X: 1},
			fp:   []string{"X"},
			want: 1,
		},
		{
			val:  &S{X: 1, Next: nil},
			fp:   []string{"Next"},
			want: (*S)(nil),
		},
		{
			val:  &S{X: 1, Next: nil},
			fp:   []string{"Next", "Next"},
			want: fail,
		},
		{
			val:  map[string]S{"a": {X: 1, Y: 2}},
			fp:   []string{"a", "y"},
			want: 2,
		},
		{
			val:  map[string]S{"a": {X: 1, Y: 2}},
			fp:   []string{"a", "z"},
			want: fail,
		},
		{
			val: map[string]*S{
				"a": {
					M: map[string]interface{}{
						"b": S{
							Next: &S{
								X: 17,
							},
						},
					},
				},
			},
			fp:   []string{"a", "M", "b", "Next", "X"},
			want: 17,
		},
	} {
		got, err := getAtPath(reflect.ValueOf(test.val), test.fp)
		if err != nil && test.want != fail {
			t.Errorf("%+v: got error <%v>, want nil", test, err)
		}
		if err == nil && !testutil.Equal(got, test.want) {
			t.Errorf("%+v: got %v, want %v, want nil", test, got, test.want)
		}
	}
}

func TestToServiceFieldPath(t *testing.T) {
	for _, test := range []struct {
		in   FieldPath
		want string
	}{
		{[]string{"a"}, "a"},
		{[]string{"a", "b"}, "a.b"},
		{[]string{"a.", "[b*", "c2"}, "`a.`.`[b*`.c2"},
		{[]string{"`a", `b\`}, "`\\`a`.`b\\\\`"},
	} {
		got := test.in.toServiceFieldPath()
		if got != test.want {
			t.Errorf("%v: got %s, want %s", test.in, got, test.want)
		}
	}
}

func TestToServiceFieldPathComponent(t *testing.T) {
	for _, test := range []struct {
		in, want string
	}{
		{"", "``"},
		{"clam_chowder23", "clam_chowder23"},
		{"23skidoo", "`23skidoo`"},
		{"bak`tik", "`bak\\`tik`"},
		{"a\\b", "`a\\\\b`"},
		{"dots.are.confusing", "`dots.are.confusing`"},
	} {
		got := toServiceFieldPathComponent(test.in)
		if got != test.want {
			t.Errorf("%q: got %q, want %q", test.in, got, test.want)
		}
	}
}