types_test.go

package ofxgo

import (
	"fmt"
	"github.com/aclindsa/xml"
	"reflect"
	"testing"
	"time"
)

func getTypeName(i interface{}) string {
	val := reflect.ValueOf(i)

	// Do the same thing that encoding/xml does to get the name
	for val.Kind() == reflect.Interface || val.Kind() == reflect.Ptr {
		if val.IsNil() {
			return ""
		}
		val = val.Elem()
	}
	return val.Type().Name()
}

func marshalHelper(t *testing.T, expected string, i interface{}) {
	t.Helper()
	typename := getTypeName(i)
	expectedstring := fmt.Sprintf("<%s>%s</%s>", typename, expected, typename)
	b, err := xml.Marshal(i)
	if err != nil {
		t.Fatalf("Unexpected error on xml.Marshal(%T): %s\n", i, err)
	}
	if string(b) != expectedstring {
		t.Fatalf("Expected '%s', got '%s'\n", expectedstring, string(b))
	}
}

func unmarshalHelper2(t *testing.T, input string, expected interface{}, overwritten interface{}, eq func(a, b interface{}) bool) {
	t.Helper()
	typename := getTypeName(expected)
	inputstring := fmt.Sprintf("<%s>%s</%s>", typename, input, typename)
	err := xml.Unmarshal([]byte(inputstring), &overwritten)
	if err != nil {
		t.Fatalf("Unexpected error on xml.Unmarshal(%T): %s\n", expected, err)
	}
	if !eq(overwritten, expected) {
		t.Fatalf("Expected '%s', got '%s'\n", expected, overwritten)
	}
}

func unmarshalHelper(t *testing.T, input string, expected interface{}, overwritten interface{}) {
	t.Helper()
	eq := func(a, b interface{}) bool {
		return reflect.DeepEqual(a, b)
	}
	unmarshalHelper2(t, input, expected, overwritten, eq)
}

func TestMarshalInt(t *testing.T) {
	var i Int = 927
	marshalHelper(t, "927", &i)
	i = 0
	marshalHelper(t, "0", &i)
	i = -768276587425
	marshalHelper(t, "-768276587425", &i)
}

func TestUnmarshalInt(t *testing.T) {
	var i, overwritten Int = -48394, 0
	unmarshalHelper(t, "-48394", &i, &overwritten)
	i = 0
	unmarshalHelper(t, "0", &i, &overwritten)
	i = 198237198
	unmarshalHelper(t, "198237198", &i, &overwritten)
	// Make sure stray newlines are handled properly
	unmarshalHelper(t, "198237198\n", &i, &overwritten)
	unmarshalHelper(t, "198237198\n\t", &i, &overwritten)
}

func TestMarshalAmount(t *testing.T) {
	var a Amount

	a.SetFrac64(8, 1)
	marshalHelper(t, "8", &a)
	a.SetFrac64(1, 8)
	marshalHelper(t, "0.125", &a)
	a.SetFrac64(-1, 200)
	marshalHelper(t, "-0.005", &a)
	a.SetInt64(0)
	marshalHelper(t, "0", &a)
	a.SetInt64(-768276587425)
	marshalHelper(t, "-768276587425", &a)
	a.SetFrac64(1, 12)
	marshalHelper(t, "0.0833333333333333333333333333333333333333333333333333333333333333333333333333333333333333333333333333", &a)

	type AmountStruct struct {
		A Amount
	}
	var as AmountStruct
	as.A.SetFrac64(1, 8)
	marshalHelper(t, "<A>0.125</A>", as)
}

func TestUnmarshalAmount(t *testing.T) {
	var a, overwritten Amount

	// Amount/big.Rat needs a special equality test because reflect.DeepEqual
	// doesn't always return equal for two values that big.Rat.Cmp() does
	eq := func(a, b interface{}) bool {
		if amountA, ok := a.(*Amount); ok {
			if amountB, ok2 := b.(*Amount); ok2 {
				return amountA.Cmp(&amountB.Rat) == 0
			}
		}
		return false
	}

	a.SetFrac64(12, 1)
	unmarshalHelper2(t, "12", &a, &overwritten, eq)
	a.SetFrac64(-21309, 100)
	unmarshalHelper2(t, "-213.09", &a, &overwritten, eq)
	a.SetFrac64(8192, 1000)
	unmarshalHelper2(t, "8.192", &a, &overwritten, eq)
	unmarshalHelper2(t, "+8.192", &a, &overwritten, eq)
	a.SetInt64(0)
	unmarshalHelper2(t, "0", &a, &overwritten, eq)
	unmarshalHelper2(t, "+0", &a, &overwritten, eq)
	unmarshalHelper2(t, "-0", &a, &overwritten, eq)
	a.SetInt64(-19487135)
	unmarshalHelper2(t, "-19487135", &a, &overwritten, eq)
	// Make sure stray newlines are handled properly
	unmarshalHelper2(t, "-19487135\n", &a, &overwritten, eq)
	unmarshalHelper2(t, "-19487135\n \t ", &a, &overwritten, eq)
}

func TestAmountEqual(t *testing.T) {
	assertEq := func(a, b Amount) {
		if !a.Equal(b) {
			t.Fatalf("Amounts should be equal but Equal returned false: %s and %s\n", a, b)
		}
	}
	assertNEq := func(a, b Amount) {
		if a.Equal(b) {
			t.Fatalf("Amounts should not be equal but Equal returned true: %s and %s\n", a, b)
		}
	}

	var a, b Amount
	a.SetInt64(-19487135)
	b.SetInt64(-19487135)
	assertEq(a, b)
	b.SetInt64(19487135)
	assertNEq(a, b)
	b.SetInt64(0)
	assertNEq(a, b)
	a.SetInt64(-0)
	assertEq(a, b)
	a.SetFrac64(1, 1000000000000000000)
	b.SetFrac64(1, 1000000000000000001)
	assertNEq(a, b)
}

func TestMarshalDate(t *testing.T) {
	var d *Date
	UTC := time.FixedZone("UTC", 0)
	GMTNodesc := time.FixedZone("", 0)
	EST := time.FixedZone("EST", -5*60*60)
	NPT := time.FixedZone("NPT", (5*60+45)*60)
	IST := time.FixedZone("IST", (5*60+30)*60)
	NST := time.FixedZone("NST", -(3*60+30)*60)

	d = NewDateGMT(2017, 3, 14, 15, 9, 26, 53*1000*1000)
	marshalHelper(t, "20170314150926.053[0:GMT]", d)
	d = NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, NPT)
	marshalHelper(t, "20170314150926.053[5.75:NPT]", d)
	d = NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, EST)
	marshalHelper(t, "20170314150926.053[-5:EST]", d)
	d = NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, UTC)
	marshalHelper(t, "20170314150926.053[0:UTC]", d)
	d = NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, IST)
	marshalHelper(t, "20170314150926.053[5.50:IST]", d)
	d = NewDate(9999, 11, 1, 23, 59, 59, 1000, EST)
	marshalHelper(t, "99991101235959.000[-5:EST]", d)
	d = NewDate(0, 1, 1, 0, 0, 0, 0, IST)
	marshalHelper(t, "00000101000000.000[5.50:IST]", d)
	d = &Date{Time: time.Unix(0, 0).In(UTC)}
	marshalHelper(t, "19700101000000.000[0:UTC]", d)
	d = NewDate(2017, 3, 14, 0, 0, 26, 53*1000*1000, EST)
	marshalHelper(t, "20170314000026.053[-5:EST]", d)
	d = NewDate(2017, 3, 14, 0, 0, 26, 53*1000*1000, NST)
	marshalHelper(t, "20170314000026.053[-3.50:NST]", d)

	// Time zone without textual description
	d = NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, GMTNodesc)
	marshalHelper(t, "20170314150926.053[0]", d)

	type DateStruct struct {
		D Date
	}
	d = NewDateGMT(2017, 3, 14, 15, 9, 26, 53*1000*1000)
	ds := DateStruct{D: *d}
	marshalHelper(t, "<D>20170314150926.053[0:GMT]</D>", ds)
}

func TestUnmarshalDate(t *testing.T) {
	var d *Date
	var overwritten Date
	GMT := time.FixedZone("GMT", 0)
	EST := time.FixedZone("EST", -5*60*60)
	NPT := time.FixedZone("NPT", (5*60+45)*60)
	IST := time.FixedZone("IST", (5*60+30)*60)
	NST := time.FixedZone("NST", -(3*60+30)*60)
	NSTNodesc := time.FixedZone("", -(3*60+30)*60)

	eq := func(a, b interface{}) bool {
		if dateA, ok := a.(*Date); ok {
			if dateB, ok2 := b.(*Date); ok2 {
				return dateA.Equal(*dateB)
			}
		}
		return false
	}

	// Ensure omitted fields default to the correct values
	d = NewDateGMT(2017, 3, 14, 15, 9, 26, 53*1000*1000)
	unmarshalHelper2(t, "20170314150926.053[0]", d, &overwritten, eq)
	unmarshalHelper2(t, "20170314150926.053", d, &overwritten, eq)
	d = NewDate(2017, 3, 14, 0, 0, 0, 0, GMT)
	unmarshalHelper2(t, "20170314", d, &overwritten, eq)

	// Ensure all signs on time zone offsets are properly handled
	d = NewDateGMT(2017, 3, 14, 15, 9, 26, 53*1000*1000)
	unmarshalHelper2(t, "20170314150926.053[0:GMT]", d, &overwritten, eq)
	unmarshalHelper2(t, "20170314150926.053[+0:GMT]", d, &overwritten, eq)
	unmarshalHelper2(t, "20170314150926.053[-0:GMT]", d, &overwritten, eq)
	unmarshalHelper2(t, "20170314150926.053[0]", d, &overwritten, eq)
	unmarshalHelper2(t, "20170314150926.053[+0]", d, &overwritten, eq)
	unmarshalHelper2(t, "20170314150926.053[-0]", d, &overwritten, eq)

	d = NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, NPT)
	unmarshalHelper2(t, "20170314150926.053[5.75:NPT]", d, &overwritten, eq)
	d = NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, EST)
	unmarshalHelper2(t, "20170314150926.053[-5:EST]", d, &overwritten, eq)
	d = NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, GMT)
	unmarshalHelper2(t, "20170314150926.053[0:GMT]", d, &overwritten, eq)
	d = NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, IST)
	unmarshalHelper2(t, "20170314150926.053[5.50:IST]", d, &overwritten, eq)
	d = NewDate(2018, 11, 1, 23, 59, 58, 0, EST)
	unmarshalHelper2(t, "20181101235958.000[-5:EST]", d, &overwritten, eq)
	d = NewDate(0, 1, 1, 0, 0, 0, 0, IST)
	unmarshalHelper2(t, "00000101000000.000[5.50:IST]", d, &overwritten, eq)
	d = &Date{Time: time.Unix(0, 0).In(GMT)}
	unmarshalHelper2(t, "19700101000000.000[0:GMT]", d, &overwritten, eq)
	d = NewDate(2017, 3, 14, 0, 0, 26, 53*1000*1000, EST)
	unmarshalHelper2(t, "20170314000026.053[-5:EST]", d, &overwritten, eq)
	d = NewDate(2017, 3, 14, 0, 0, 26, 53*1000*1000, NST)
	unmarshalHelper2(t, "20170314000026.053[-3.50:NST]", d, &overwritten, eq)

	// Autopopulate zone without textual description for GMT
	d = NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, GMT)
	unmarshalHelper2(t, "20170314150926.053[0]", d, &overwritten, eq)
	// but not for others:
	d = NewDate(2017, 3, 14, 0, 0, 26, 53*1000*1000, NSTNodesc)
	unmarshalHelper2(t, "20170314000026.053[-3.50]", d, &overwritten, eq)

	// Make sure we handle poorly-formatted dates (from Vanguard)
	d = NewDate(2016, 12, 7, 16, 0, 0, 0, EST)
	unmarshalHelper2(t, "20161207160000.000[-5:EST]610900.500[-9:BST]", d, &overwritten, eq) // extra part intentionally different to ensure the first timezone is parsed

	// Make sure we properly handle ending newlines
	d = NewDate(2018, 11, 1, 23, 59, 58, 0, EST)
	unmarshalHelper2(t, "20181101235958.000[-5:EST]\n", d, &overwritten, eq)
	unmarshalHelper2(t, "20181101235958.000[-5:EST]\n\t", d, &overwritten, eq)
}

func TestDateEqual(t *testing.T) {
	GMT := time.FixedZone("GMT", 0)
	EST := time.FixedZone("EST", -5*60*60)

	assertEq := func(a, b *Date) {
		if !a.Equal(*b) {
			t.Fatalf("Dates should be equal but Equal returned false: %s and %s\n", *a, *b)
		}
	}
	assertNEq := func(a, b *Date) {
		if a.Equal(*b) {
			t.Fatalf("Dates should not be equal but Equal returned true: %s and %s\n", *a, *b)
		}
	}

	// Ensure omitted fields default to the correct values
	gmt1 := NewDateGMT(2017, 3, 14, 15, 9, 26, 53*1000*1000)
	gmt2 := NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, GMT)
	est1 := NewDate(2017, 3, 14, 10, 9, 26, 53*1000*1000, EST)
	est2 := NewDate(2017, 3, 14, 10, 9, 26, 53*1000*1000+1, EST)
	est3 := NewDate(2017, 3, 14, 15, 9, 26, 53*1000*1000, EST)

	assertEq(gmt1, gmt2)
	assertEq(gmt2, gmt1)
	assertEq(gmt1, est1)

	assertNEq(gmt1, est2)
	assertNEq(est1, est2)
	assertNEq(gmt1, est3)
}

func TestMarshalString(t *testing.T) {
	var s String = ""
	marshalHelper(t, "", &s)
	s = "foo&bar"
	marshalHelper(t, "foo&amp;bar", &s)
	s = "\n"
	marshalHelper(t, "&#xA;", &s)
	s = "Some Name"
	marshalHelper(t, "Some Name", &s)
}

func TestUnmarshalString(t *testing.T) {
	var s, overwritten String = "", ""
	unmarshalHelper(t, "", &s, &overwritten)
	s = "foo&bar"
	unmarshalHelper(t, "foo&amp;bar", &s, &overwritten)
	// whitespace intentionally stripped because some OFX servers add newlines
	// inside tags
	s = "new\nline"
	unmarshalHelper(t, " new&#xA;line&#xA;", &s, &overwritten)
	s = "Some Name"
	unmarshalHelper(t, "Some Name", &s, &overwritten)
	// Make sure stray newlines are handled properly
	unmarshalHelper(t, "Some Name\n", &s, &overwritten)
	unmarshalHelper(t, "Some Name\n  ", &s, &overwritten)
}

func TestStringString(t *testing.T) {
	var s String = "foobar"
	if s.String() != "foobar" {
		t.Fatalf("Unexpected result when returning String.String(): %s\n", s.String())
	}
}

func TestMarshalBoolean(t *testing.T) {
	var b Boolean = true
	marshalHelper(t, "Y", &b)
	b = false
	marshalHelper(t, "N", &b)

	type BooleanStruct struct {
		B Boolean
	}
	bs := BooleanStruct{B: true}
	marshalHelper(t, "<B>Y</B>", bs)
}

func TestUnmarshalBoolean(t *testing.T) {
	var b, overwritten Boolean = true, false
	unmarshalHelper(t, "Y", &b, &overwritten)
	b = false
	unmarshalHelper(t, "N", &b, &overwritten)
	// Make sure stray newlines are handled properly
	unmarshalHelper(t, "N\n", &b, &overwritten)
	unmarshalHelper(t, "N\n \t", &b, &overwritten)
}

func TestStringBoolean(t *testing.T) {
	var b Boolean = true
	if b.String() != "true" {
		t.Fatalf("Unexpected string for Boolean.String() for true: %s\n", b.String())
	}
	b = false
	if b.String() != "false" {
		t.Fatalf("Unexpected string for Boolean.String() for false: %s\n", b.String())
	}
}

func TestMarshalUID(t *testing.T) {
	var u UID = "d1cf3d3d-9ef9-4a97-b180-81706829cb04"
	marshalHelper(t, "d1cf3d3d-9ef9-4a97-b180-81706829cb04", &u)
}

func TestUnmarshalUID(t *testing.T) {
	var u, overwritten UID = "d1cf3d3d-9ef9-4a97-b180-81706829cb04", ""
	unmarshalHelper(t, "d1cf3d3d-9ef9-4a97-b180-81706829cb04", &u, &overwritten)
	// Make sure stray newlines are handled properly
	u = "0f94ce83-13b7-7568-e4fc-c02c7b47e7ab"
	unmarshalHelper(t, "0f94ce83-13b7-7568-e4fc-c02c7b47e7ab\n", &u, &overwritten)
	unmarshalHelper(t, "0f94ce83-13b7-7568-e4fc-c02c7b47e7ab\n\t", &u, &overwritten)
}

func TestUIDRecommendedFormat(t *testing.T) {
	var u UID = "d1cf3d3d-9ef9-4a97-b180-81706829cb04"
	if ok, err := u.RecommendedFormat(); !ok || err != nil {
		t.Fatalf("UID unexpectedly failed validation\n")
	}
	u = "d1cf3d3d-9ef9-4a97-b180-81706829cb0"
	if ok, err := u.RecommendedFormat(); ok || err == nil {
		t.Fatalf("UID should have failed validation because it's too short\n")
	}
	u = "d1cf3d3d-9ef94a97-b180-81706829cb04"
	if ok, err := u.RecommendedFormat(); ok || err == nil {
		t.Fatalf("UID should have failed validation because it's missing hyphens\n")
	}
	u = "d1cf3d3d-9ef9-4a97-b180981706829cb04"
	if ok, err := u.RecommendedFormat(); ok || err == nil {
		t.Fatalf("UID should have failed validation because its hyphens have been replaced\n")
	}
}

func TestUIDValid(t *testing.T) {
	var u UID = ""
	if ok, err := u.Valid(); ok || err == nil {
		t.Fatalf("Empty UID unexpectedly valid\n")
	}
	u = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
	if ok, err := u.Valid(); ok || err == nil {
		t.Fatalf("Too-long UID unexpectedly valid\n")
	}
	u = "7be37076-623a-425f-ae6b-a5465b7e93b0"
	if ok, err := u.Valid(); !ok || err != nil {
		t.Fatalf("Good UID unexpectedly invalid: %s\n", err.Error())
	}
}

func TestRandomUID(t *testing.T) {
	uid, err := RandomUID()
	if err != nil {
		t.Fatalf("Unexpected error when calling RandomUID: %s\n", err)
	}
	if ok, err := uid.RecommendedFormat(); !ok || err != nil {
		t.Fatalf("UID generated with RandomUID() doesn't match recommended format: %s\n", err)
	}
}

func TestMarshalCurrSymbol(t *testing.T) {
	c, _ := NewCurrSymbol("USD")
	marshalHelper(t, "USD", &c)

	type CurrSymbolStruct struct {
		CS CurrSymbol
	}
	css := CurrSymbolStruct{CS: *c}
	marshalHelper(t, "<CS>USD</CS>", css)
}

func TestUnmarshalCurrSymbol(t *testing.T) {
	var overwritten CurrSymbol
	c, _ := NewCurrSymbol("USD")
	unmarshalHelper(t, "USD", c, &overwritten)
	// Make sure stray newlines are handled properly
	c, _ = NewCurrSymbol("EUR")
	unmarshalHelper(t, "EUR\n", c, &overwritten)
	unmarshalHelper(t, "EUR\n\t", c, &overwritten)
}

func TestCurrSymbolEqual(t *testing.T) {
	usd1, _ := NewCurrSymbol("USD")
	usd2, _ := NewCurrSymbol("USD")
	if !usd1.Equal(*usd2) {
		t.Fatalf("Two \"USD\" CurrSymbols returned !Equal()\n")
	}
	xxx, _ := NewCurrSymbol("XXX")
	if usd1.Equal(*xxx) {
		t.Fatalf("\"USD\" and \"XXX\" CurrSymbols returned Equal()\n")
	}
}

func TestCurrSymbolValid(t *testing.T) {
	var initial CurrSymbol
	ok, err := initial.Valid()
	if ok || err == nil {
		t.Fatalf("CurrSymbol unexpectedly returned Valid() for initial value\n")
	}

	ars, _ := NewCurrSymbol("ARS")
	ok, err = ars.Valid()
	if !ok || err != nil {
		t.Fatalf("CurrSymbol unexpectedly returned !Valid() for \"ARS\": %s\n", err.Error())
	}

	xxx, _ := NewCurrSymbol("XXX")
	ok, err = xxx.Valid()
	if ok || err == nil {
		t.Fatalf("CurrSymbol unexpectedly returned Valid() for \"XXX\"\n")
	}
}

func TestNewCurrSymbol(t *testing.T) {
	curr, err := NewCurrSymbol("GBP")
	if err != nil {
		t.Fatalf("Unexpected error calling NewCurrSymbol: %s\n", err)
	}
	if curr.String() != "GBP" {
		t.Fatalf("Created CurrSymbol doesn't print \"GBP\" as string representation\n")
	}
	curr, err = NewCurrSymbol("AFN")
	if err != nil {
		t.Fatalf("Unexpected error calling NewCurrSymbol: %s\n", err)
	}
	if curr.String() != "AFN" {
		t.Fatalf("Created CurrSymbol doesn't print \"AFN\" as string representation\n")
	}
	curr, err = NewCurrSymbol("BLAH")
	if err == nil {
		t.Fatalf("NewCurrSymbol didn't error on invalid currency identifier\n")
	}
}