gopkg.in/rethinkdb/rethinkdb-go.v6@v6.2.2/encoding/encoder_test.go

package encoding

import (
	"errors"
	"image"
	"reflect"
	"testing"
	"time"
)

var encodeExpected = map[string]interface{}{
	"Level0":  int64(1),
	"Level1b": int64(2),
	"Level1c": int64(3),
	"Level1a": int64(5),
	"LEVEL1B": int64(6),
	"e": map[string]interface{}{
		"Level1a": int64(8),
		"Level1b": int64(9),
		"Level1c": int64(10),
		"Level1d": int64(11),
		"x":       int64(12),
	},
	"Loop1": int64(13),
	"Loop2": int64(14),
	"X":     int64(15),
	"Y":     int64(16),
	"Z":     int64(17),
}

func TestEncode(t *testing.T) {
	// Top is defined in decoder_test.go
	var in = Top{
		Level0: 1,
		Embed0: Embed0{
			Level1b: 2,
			Level1c: 3,
		},
		Embed0a: &Embed0a{
			Level1a: 5,
			Level1b: 6,
		},
		Embed0b: &Embed0b{
			Level1a: 8,
			Level1b: 9,
			Level1c: 10,
			Level1d: 11,
			Level1e: 12,
		},
		Loop: Loop{
			Loop1: 13,
			Loop2: 14,
		},
		Embed0p: Embed0p{
			Point: image.Point{X: 15, Y: 16},
		},
		Embed0q: Embed0q{
			Point: Point{Z: 17},
		},
	}

	got, err := Encode(&in)
	if err != nil {
		t.Fatal(err)
	}
	if !reflect.DeepEqual(got, encodeExpected) {
		t.Errorf(" got: %v\nwant: %v\n", got, encodeExpected)
	}
}

type Optionals struct {
	Sr string `rethinkdb:"sr"`
	So string `rethinkdb:"so,omitempty"`
	Sw string `rethinkdb:"-"`

	Ir int `rethinkdb:"omitempty"` // actually named omitempty, not an option
	Io int `rethinkdb:"io,omitempty"`

	Tr time.Time `rethinkdb:"tr"`
	To time.Time `rethinkdb:"to,omitempty"`

	Slr []string `rethinkdb:"slr"`
	Slo []string `rethinkdb:"slo,omitempty"`

	Mr map[string]interface{} `rethinkdb:"mr"`
	Mo map[string]interface{} `rethinkdb:",omitempty"`
}

var optionalsExpected = map[string]interface{}{
	"sr":        "",
	"omitempty": int64(0),
	"tr":        map[string]interface{}{"$reql_type$": "TIME", "epoch_time": 0, "timezone": "+00:00"},
	"slr":       []interface{}(nil),
	"mr":        map[string]interface{}{},
}

func TestOmitEmpty(t *testing.T) {
	var o Optionals
	o.Sw = "something"
	o.Tr = time.Unix(0, 0).In(time.UTC)
	o.Mr = map[string]interface{}{}
	o.Mo = map[string]interface{}{}

	got, err := Encode(&o)
	if err != nil {
		t.Fatal(err)
	}
	if !jsonEqual(got, optionalsExpected) {
		t.Errorf("\ngot:  %#v\nwant: %#v\n", got, optionalsExpected)
	}
}

type IntType int

type MyStruct struct {
	IntType
}

func TestAnonymousNonstruct(t *testing.T) {
	var i IntType = 11
	a := MyStruct{i}
	var want = map[string]interface{}{"IntType": int64(11)}

	got, err := Encode(a)
	if err != nil {
		t.Fatalf("Encode: %v", err)
	}
	if !reflect.DeepEqual(got, want) {
		t.Errorf("got %v, want %v", got, want)
	}
}

func TestEncodePointer(t *testing.T) {
	v := Pointer{PPoint: &Point{Z: 1}, Point: Point{Z: 2}}
	var want = map[string]interface{}{
		"PPoint": map[string]interface{}{"Z": int64(1)},
		"Point":  map[string]interface{}{"Z": int64(2)},
	}

	got, err := Encode(v)
	if err != nil {
		t.Fatalf("Encode: %v", err)
	}
	if !reflect.DeepEqual(got, want) {
		t.Errorf("got %v, want %v", got, want)
	}
}

func TestEncodeNilPointer(t *testing.T) {
	v := Pointer{PPoint: nil, Point: Point{Z: 2}}
	var want = map[string]interface{}{
		"PPoint": nil,
		"Point":  map[string]interface{}{"Z": int64(2)},
	}

	got, err := Encode(v)
	if err != nil {
		t.Fatalf("Encode: %v", err)
	}
	if !reflect.DeepEqual(got, want) {
		t.Errorf("got %v, want %v", got, want)
	}
}

type BugA struct {
	S string
}

type BugB struct {
	BugA
	S string
}

type BugC struct {
	S string
}

// Legal Go: We never use the repeated embedded field (S).
type BugX struct {
	A int
	BugA
	BugB
}

// Issue 5245.
func TestEmbeddedBug(t *testing.T) {
	v := BugB{
		BugA{"A"},
		"B",
	}
	got, err := Encode(v)
	if err != nil {
		t.Fatal("Encode:", err)
	}
	want := map[string]interface{}{"S": "B"}
	if !reflect.DeepEqual(got, want) {
		t.Fatalf("Encode: got %v want %v", got, want)
	}
	// Now check that the duplicate field, S, does not appear.
	x := BugX{
		A: 23,
	}
	got, err = Encode(x)
	if err != nil {
		t.Fatal("Encode:", err)
	}
	want = map[string]interface{}{"A": int64(23)}
	if !reflect.DeepEqual(got, want) {
		t.Fatalf("Encode: got %v want %v", got, want)
	}
}

type BugD struct { // Same as BugA after tagging.
	XXX string `rethinkdb:"S"`
}

// BugD's tagged S field should dominate BugA's.
type BugY struct {
	BugA
	BugD
}

// Test that a field with a tag dominates untagged fields.
func TestTaggedFieldDominates(t *testing.T) {
	v := BugY{
		BugA{"BugA"},
		BugD{"BugD"},
	}
	got, err := Encode(v)
	if err != nil {
		t.Fatal("Encode:", err)
	}
	want := map[string]interface{}{"S": "BugD"}
	if !reflect.DeepEqual(got, want) {
		t.Fatalf("Encode: got %v want %v", got, want)
	}
}

// There are no tags here, so S should not appear.
type BugZ struct {
	BugA
	BugC
	BugY // Contains a tagged S field through BugD; should not dominate.
}

func TestDuplicatedFieldDisappears(t *testing.T) {
	v := BugZ{
		BugA{"BugA"},
		BugC{"BugC"},
		BugY{
			BugA{"nested BugA"},
			BugD{"nested BugD"},
		},
	}
	got, err := Encode(v)
	if err != nil {
		t.Fatal("Encode:", err)
	}
	want := map[string]interface{}{}
	if !reflect.DeepEqual(got, want) {
		t.Fatalf("Encode: got %v want %v", got, want)
	}
}

func TestEncodeMapIntKeys(t *testing.T) {
	input := map[int]int{1: 1, 2: 2, 3: 3}
	want := map[string]int{"1": 1, "2": 2, "3": 3}

	out, err := Encode(input)
	if err != nil {
		t.Errorf("got error %v, expected nil", err)
	}
	if !jsonEqual(out, want) {
		t.Errorf("got %q, want %q", out, want)
	}
}

type RefA struct {
	ID string `rethinkdb:"id,omitempty"`
	B  *RefB  `rethinkdb:"b_id,reference" rethinkdb_ref:"id"`
}

type RefB struct {
	ID   string `rethinkdb:"id,omitempty"`
	Name string `rethinkdb:"name"`
}

func TestReferenceField(t *testing.T) {
	input := RefA{"1", &RefB{"2", "Name"}}
	want := map[string]interface{}{"id": "1", "b_id": "2"}

	out, err := Encode(input)
	if err != nil {
		t.Errorf("got error %v, expected nil", err)
	}
	if !jsonEqual(out, want) {
		t.Errorf("got %q, want %q", out, want)
	}
}

type RefC struct {
	ID string `rethinkdb:"id,omitempty"`
	B  *RefB  `rethinkdb:"b_id,reference" rethinkdb_ref:"b_id"`
}

func TestReferenceFieldMissing(t *testing.T) {
	input := RefC{"1", &RefB{"2", "Name"}}

	_, err := Encode(input)
	if err == nil {
		t.Errorf("expected non-nil error but got nil")
	}
}

type RefD struct {
	ID string `rethinkdb:"id,omitempty"`
	B  string `rethinkdb:"b_id,reference" rethinkdb_ref:"b_id"`
}

func TestReferenceFieldInvalid(t *testing.T) {
	input := RefD{"1", "B"}

	_, err := Encode(input)
	if err == nil {
		t.Errorf("expected non-nil error but got nil")
	}
}

type RefE struct {
	ID   string  `rethinkdb:"id,omitempty"`
	FIDs *[]RefF `rethinkdb:"f_ids,reference" rethinkdb_ref:"id"`
}

type RefF struct {
	ID   string `rethinkdb:"id,omitempty"`
	Name string `rethinkdb:"name"`
}

func TestReferenceFieldArray(t *testing.T) {
	input := RefE{"1", &[]RefF{RefF{"2", "Name2"}, RefF{"3", "Name3"}}}
	want := map[string]interface{}{"id": "1", "f_ids": []string{"2", "3"}}

	out, err := Encode(input)
	if err != nil {
		t.Errorf("got error %v, expected nil", err)
	}
	if !jsonEqual(out, want) {
		t.Errorf("got %q, want %q", out, want)
	}
}

func TestEncodeBytes(t *testing.T) {
	type BytesStruct struct {
		A []byte
		B [1]byte
	}

	input := BytesStruct{[]byte("A"), [1]byte{'B'}}
	want := map[string]interface{}{
		"A": map[string]interface{}{"$reql_type$": "BINARY", "data": "QQ=="},
		"B": map[string]interface{}{"$reql_type$": "BINARY", "data": "Qg=="},
	}

	out, err := Encode(input)
	if err != nil {
		t.Errorf("got error %v, expected nil", err)
	}
	if !jsonEqual(out, want) {
		t.Errorf("got %q, want %q", out, want)
	}
}

type Compound struct {
	PartA string `rethinkdb:"id[0]"`
	PartB string `rethinkdb:"id[1]"`
	ErrA  string `rethinkdb:"err_a[]"`
	ErrB  string `rethinkdb:"err_b["`
	ErrC  string `rethinkdb:"err_c]"`
}

func TestEncodeCompound(t *testing.T) {
	input := Compound{"1", "2", "3", "4", "5"}
	want := map[string]interface{}{"id": []string{"1", "2"}, "err_a[]": "3", "err_b[": "4", "err_c]": "5"}

	out, err := Encode(input)
	if err != nil {
		t.Errorf("got error %v, expected nil", err)
	}
	if !jsonEqual(out, want) {
		t.Errorf("got %q, want %q", out, want)
	}
}

type CompoundRef struct {
	PartA string `rethinkdb:"id[0]"`
	PartB *RefB  `rethinkdb:"id[1],reference" rethinkdb_ref:"id"`
}

func TestEncodeCompoundRef(t *testing.T) {
	input := CompoundRef{"1", &RefB{"2", "Name"}}
	want := map[string]interface{}{"id": []string{"1", "2"}}

	out, err := Encode(input)
	if err != nil {
		t.Errorf("got error %v, expected nil", err)
	}
	if !jsonEqual(out, want) {
		t.Errorf("got %q, want %q", out, want)
	}
}

func TestEncodeNilSlice(t *testing.T) {
	input := SliceStruct{}
	want := map[string]interface{}{"X": []string(nil)}

	out, err := Encode(input)
	if err != nil {
		t.Errorf("got error %v, expected nil", err)
	}
	if !jsonEqual(out, want) {
		t.Errorf("got %q, want %q", out, want)
	}
}

func TestEncodeCustomTypeEncodingValue(t *testing.T) {
	type innerType struct {
		Val int
	}

	outer := struct {
		Inner innerType `rethinkdb:"inner"`
	}{Inner: innerType{Val: 5}}
	want := map[string]interface{}{
		"inner": map[string]interface{}{
			"someval": 5,
		},
	}

	SetTypeEncoding(reflect.TypeOf(innerType{}),
		func(v interface{}) (interface{}, error) {
			return map[string]interface{}{"someval": v.(innerType).Val}, nil
		}, nil)

	out, err := Encode(outer)
	if err != nil {
		t.Errorf("got error %v, expected nil", err)
	}
	if !jsonEqual(out, want) {
		t.Errorf("got %q, want %q", out, want)
	}
}

func TestEncodeCustomTypeEncodingPointer(t *testing.T) {
	type innerType struct {
		Val int
	}

	outer := struct {
		Inner *innerType `rethinkdb:"inner"`
	}{Inner: &innerType{Val: 5}}
	want := map[string]interface{}{
		"inner": map[string]interface{}{
			"someval": 5,
		},
	}

	SetTypeEncoding(reflect.TypeOf((*innerType)(nil)),
		func(v interface{}) (interface{}, error) {
			return map[string]interface{}{"someval": v.(*innerType).Val}, nil
		}, nil)

	out, err := Encode(outer)
	if err != nil {
		t.Errorf("got error %v, expected nil", err)
	}
	if !jsonEqual(out, want) {
		t.Errorf("got %q, want %q", out, want)
	}
}

func TestEncodeCustomRootTypeEncodingValue(t *testing.T) {
	type cType struct {
		Val int
	}
	in := cType{Val: 5}

	want := map[string]interface{}{
		"someval": 5,
	}

	SetTypeEncoding(reflect.TypeOf(cType{}),
		func(v interface{}) (interface{}, error) {
			return map[string]interface{}{"someval": v.(cType).Val}, nil
		}, nil)

	out, err := Encode(in)
	if err != nil {
		t.Errorf("got error %v, expected nil", err)
	}
	if !jsonEqual(out, want) {
		t.Errorf("got %q, want %q", out, want)
	}
}

func TestEncodeCustomRootTypeEncodingPointer(t *testing.T) {
	type cType struct {
		Val int
	}
	in := cType{Val: 5}

	want := map[string]interface{}{
		"someval": 5,
	}

	SetTypeEncoding(reflect.TypeOf((*cType)(nil)),
		func(v interface{}) (interface{}, error) {
			return map[string]interface{}{"someval": v.(*cType).Val}, nil
		}, nil)

	out, err := Encode(&in)
	if err != nil {
		t.Errorf("got error %v, expected nil", err)
	}
	if !jsonEqual(out, want) {
		t.Errorf("got %q, want %q", out, want)
	}
}

func TestEncodeCustomRootTypeEncodingError(t *testing.T) {
	type cType struct {
		Val int
	}
	in := cType{Val: 5}

	cerr := errors.New("encode error")

	SetTypeEncoding(reflect.TypeOf((*cType)(nil)),
		func(v interface{}) (interface{}, error) {
			return nil, cerr
		}, nil)

	_, err := Encode(&in)
	if err == nil {
		t.Errorf("got nil error, expected %v", cerr)
	}
	if err != cerr {
		t.Errorf("got %q, want %q", err, cerr)
	}
}