identical_to_test.go

// Copyright 2012 Aaron Jacobs. All Rights Reserved.
// Author: aaronjjacobs@gmail.com (Aaron Jacobs)
//
// 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 oglematchers_test

import (
	. "github.com/jacobsa/oglematchers"
	. "github.com/jacobsa/ogletest"
	"fmt"
	"io"
	"unsafe"
)

////////////////////////////////////////////////////////////////////////
// Helpers
////////////////////////////////////////////////////////////////////////

type IdenticalToTest struct {
}

func init() { RegisterTestSuite(&IdenticalToTest{}) }

////////////////////////////////////////////////////////////////////////
// Tests
////////////////////////////////////////////////////////////////////////

func (t *IdenticalToTest) TypesNotIdentical() {
	var m Matcher
	var err error

	type intAlias int

	// Type alias expected value
	m = IdenticalTo(intAlias(17))
	err = m.Matches(int(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int")))

	// Type alias candidate
	m = IdenticalTo(int(17))
	err = m.Matches(intAlias(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.intAlias")))

	// int and uint
	m = IdenticalTo(int(17))
	err = m.Matches(uint(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type uint")))
}

func (t *IdenticalToTest) PredeclaredNilIdentifier() {
	var m Matcher
	var err error

	// Nil literal
	m = IdenticalTo(nil)
	err = m.Matches(nil)
	ExpectEq(nil, err)

	// Zero interface var (which is the same as above since IdenticalTo takes an
	// interface{} as an arg)
	var nilReader io.Reader
	var nilWriter io.Writer

	m = IdenticalTo(nilReader)
	err = m.Matches(nilWriter)
	ExpectEq(nil, err)

	// Typed nil value.
	m = IdenticalTo(nil)
	err = m.Matches((chan int)(nil))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type chan int")))

	// Non-nil value.
	m = IdenticalTo(nil)
	err = m.Matches("taco")
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type string")))
}

func (t *IdenticalToTest) Slices() {
	var m Matcher
	var err error

	// Nil expected value
	m = IdenticalTo(([]int)(nil))
	ExpectEq("identical to <[]int> []", m.Description())

	err = m.Matches(([]int)(nil))
	ExpectEq(nil, err)

	err = m.Matches([]int{})
	ExpectThat(err, Error(Equals("which is not an identical reference")))

	// Non-nil expected value
	o1 := make([]int, 1)
	o2 := make([]int, 1)
	m = IdenticalTo(o1)
	ExpectEq(fmt.Sprintf("identical to <[]int> %v", o1), m.Description())

	err = m.Matches(o1)
	ExpectEq(nil, err)

	err = m.Matches(o2)
	ExpectThat(err, Error(Equals("which is not an identical reference")))
}

func (t *IdenticalToTest) Maps() {
	var m Matcher
	var err error

	// Nil expected value
	m = IdenticalTo((map[int]int)(nil))
	ExpectEq("identical to <map[int]int> map[]", m.Description())

	err = m.Matches((map[int]int)(nil))
	ExpectEq(nil, err)

	err = m.Matches(map[int]int{})
	ExpectThat(err, Error(Equals("which is not an identical reference")))

	// Non-nil expected value
	o1 := map[int]int{}
	o2 := map[int]int{}
	m = IdenticalTo(o1)
	ExpectEq(fmt.Sprintf("identical to <map[int]int> %v", o1), m.Description())

	err = m.Matches(o1)
	ExpectEq(nil, err)

	err = m.Matches(o2)
	ExpectThat(err, Error(Equals("which is not an identical reference")))
}

func (t *IdenticalToTest) Functions() {
	var m Matcher
	var err error

	// Nil expected value
	m = IdenticalTo((func())(nil))
	ExpectEq("identical to <func()> <nil>", m.Description())

	err = m.Matches((func())(nil))
	ExpectEq(nil, err)

	err = m.Matches(func(){})
	ExpectThat(err, Error(Equals("which is not an identical reference")))

	// Non-nil expected value
	o1 := func() {}
	o2 := func() {}
	m = IdenticalTo(o1)
	ExpectEq(fmt.Sprintf("identical to <func()> %v", o1), m.Description())

	err = m.Matches(o1)
	ExpectEq(nil, err)

	err = m.Matches(o2)
	ExpectThat(err, Error(Equals("which is not an identical reference")))
}

func (t *IdenticalToTest) Channels() {
	var m Matcher
	var err error

	// Nil expected value
	m = IdenticalTo((chan int)(nil))
	ExpectEq("identical to <chan int> <nil>", m.Description())

	err = m.Matches((chan int)(nil))
	ExpectEq(nil, err)

	err = m.Matches(make(chan int))
	ExpectThat(err, Error(Equals("which is not an identical reference")))

	// Non-nil expected value
	o1 := make(chan int)
	o2 := make(chan int)
	m = IdenticalTo(o1)
	ExpectEq(fmt.Sprintf("identical to <chan int> %v", o1), m.Description())

	err = m.Matches(o1)
	ExpectEq(nil, err)

	err = m.Matches(o2)
	ExpectThat(err, Error(Equals("which is not an identical reference")))
}

func (t *IdenticalToTest) Bools() {
	var m Matcher
	var err error

	// false
	m = IdenticalTo(false)
	ExpectEq("identical to <bool> false", m.Description())

	err = m.Matches(false)
	ExpectEq(nil, err)

	err = m.Matches(true)
	ExpectThat(err, Error(Equals("")))

	// true
	m = IdenticalTo(true)
	ExpectEq("identical to <bool> true", m.Description())

	err = m.Matches(false)
	ExpectThat(err, Error(Equals("")))

	err = m.Matches(true)
	ExpectEq(nil, err)
}

func (t *IdenticalToTest) Ints() {
	var m Matcher
	var err error

	m = IdenticalTo(int(17))
	ExpectEq("identical to <int> 17", m.Description())

	// Identical value
	err = m.Matches(int(17))
	ExpectEq(nil, err)

	// Type alias
	type myType int
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Int8s() {
	var m Matcher
	var err error

	m = IdenticalTo(int8(17))
	ExpectEq("identical to <int8> 17", m.Description())

	// Identical value
	err = m.Matches(int8(17))
	ExpectEq(nil, err)

	// Type alias
	type myType int8
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Int16s() {
	var m Matcher
	var err error

	m = IdenticalTo(int16(17))
	ExpectEq("identical to <int16> 17", m.Description())

	// Identical value
	err = m.Matches(int16(17))
	ExpectEq(nil, err)

	// Type alias
	type myType int16
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Int32s() {
	var m Matcher
	var err error

	m = IdenticalTo(int32(17))
	ExpectEq("identical to <int32> 17", m.Description())

	// Identical value
	err = m.Matches(int32(17))
	ExpectEq(nil, err)

	// Type alias
	type myType int32
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int16(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int16")))
}

func (t *IdenticalToTest) Int64s() {
	var m Matcher
	var err error

	m = IdenticalTo(int64(17))
	ExpectEq("identical to <int64> 17", m.Description())

	// Identical value
	err = m.Matches(int64(17))
	ExpectEq(nil, err)

	// Type alias
	type myType int64
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Uints() {
	var m Matcher
	var err error

	m = IdenticalTo(uint(17))
	ExpectEq("identical to <uint> 17", m.Description())

	// Identical value
	err = m.Matches(uint(17))
	ExpectEq(nil, err)

	// Type alias
	type myType uint
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Uint8s() {
	var m Matcher
	var err error

	m = IdenticalTo(uint8(17))
	ExpectEq("identical to <uint8> 17", m.Description())

	// Identical value
	err = m.Matches(uint8(17))
	ExpectEq(nil, err)

	// Type alias
	type myType uint8
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Uint16s() {
	var m Matcher
	var err error

	m = IdenticalTo(uint16(17))
	ExpectEq("identical to <uint16> 17", m.Description())

	// Identical value
	err = m.Matches(uint16(17))
	ExpectEq(nil, err)

	// Type alias
	type myType uint16
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Uint32s() {
	var m Matcher
	var err error

	m = IdenticalTo(uint32(17))
	ExpectEq("identical to <uint32> 17", m.Description())

	// Identical value
	err = m.Matches(uint32(17))
	ExpectEq(nil, err)

	// Type alias
	type myType uint32
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Uint64s() {
	var m Matcher
	var err error

	m = IdenticalTo(uint64(17))
	ExpectEq("identical to <uint64> 17", m.Description())

	// Identical value
	err = m.Matches(uint64(17))
	ExpectEq(nil, err)

	// Type alias
	type myType uint64
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Uintptrs() {
	var m Matcher
	var err error

	m = IdenticalTo(uintptr(17))
	ExpectEq("identical to <uintptr> 17", m.Description())

	// Identical value
	err = m.Matches(uintptr(17))
	ExpectEq(nil, err)

	// Type alias
	type myType uintptr
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Float32s() {
	var m Matcher
	var err error

	m = IdenticalTo(float32(17))
	ExpectEq("identical to <float32> 17", m.Description())

	// Identical value
	err = m.Matches(float32(17))
	ExpectEq(nil, err)

	// Type alias
	type myType float32
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Float64s() {
	var m Matcher
	var err error

	m = IdenticalTo(float64(17))
	ExpectEq("identical to <float64> 17", m.Description())

	// Identical value
	err = m.Matches(float64(17))
	ExpectEq(nil, err)

	// Type alias
	type myType float64
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Complex64s() {
	var m Matcher
	var err error

	m = IdenticalTo(complex64(17))
	ExpectEq("identical to <complex64> (17+0i)", m.Description())

	// Identical value
	err = m.Matches(complex64(17))
	ExpectEq(nil, err)

	// Type alias
	type myType complex64
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) Complex128s() {
	var m Matcher
	var err error

	m = IdenticalTo(complex128(17))
	ExpectEq("identical to <complex128> (17+0i)", m.Description())

	// Identical value
	err = m.Matches(complex128(17))
	ExpectEq(nil, err)

	// Type alias
	type myType complex128
	err = m.Matches(myType(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) EmptyComparableArrays() {
	var m Matcher
	var err error

	m = IdenticalTo([0]int{})
	ExpectEq("identical to <[0]int> []", m.Description())

	// Identical value
	err = m.Matches([0]int{})
	ExpectEq(nil, err)

	// Length too long
	err = m.Matches([1]int{17})
	ExpectThat(err, Error(Equals("which is of type [1]int")))

	// Element type alias
	type myType int
	err = m.Matches([0]myType{})
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type [0]oglematchers_test.myType")))

	// Completely wrong element type
	err = m.Matches([0]int32{})
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type [0]int32")))
}

func (t *IdenticalToTest) NonEmptyComparableArrays() {
	var m Matcher
	var err error

	m = IdenticalTo([2]int{17, 19})
	ExpectEq("identical to <[2]int> [17 19]", m.Description())

	// Identical value
	err = m.Matches([2]int{17, 19})
	ExpectEq(nil, err)

	// Length too short
	err = m.Matches([1]int{17})
	ExpectThat(err, Error(Equals("which is of type [1]int")))

	// Length too long
	err = m.Matches([3]int{17, 19, 23})
	ExpectThat(err, Error(Equals("which is of type [3]int")))

	// First element different
	err = m.Matches([2]int{13, 19})
	ExpectThat(err, Error(Equals("")))

	// Second element different
	err = m.Matches([2]int{17, 23})
	ExpectThat(err, Error(Equals("")))

	// Element type alias
	type myType int
	err = m.Matches([2]myType{17, 19})
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type [2]oglematchers_test.myType")))

	// Completely wrong element type
	err = m.Matches([2]int32{17, 19})
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type [2]int32")))
}

func (t *IdenticalToTest) NonEmptyArraysOfComparableArrays() {
	var m Matcher
	var err error

	x := [2][2]int{
		[2]int{17, 19},
		[2]int{23, 29},
	}
	m = IdenticalTo(x)
	ExpectEq("identical to <[2][2]int> [[17 19] [23 29]]", m.Description())

	// Identical value
	err = m.Matches([2][2]int{[2]int{17, 19}, [2]int{23, 29}})
	ExpectEq(nil, err)

	// Outer length too short
	err = m.Matches([1][2]int{[2]int{17, 19}})
	ExpectThat(err, Error(Equals("which is of type [1][2]int")))

	// Inner length too short
	err = m.Matches([2][1]int{[1]int{17}, [1]int{23}})
	ExpectThat(err, Error(Equals("which is of type [2][1]int")))

	// First element different
	err = m.Matches([2][2]int{[2]int{13, 19}, [2]int{23, 29}})
	ExpectThat(err, Error(Equals("")))

	// Element type alias
	type myType int
	err = m.Matches([2][2]myType{[2]myType{17, 19}, [2]myType{23, 29}})
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type [2][2]oglematchers_test.myType")))
}

func (t *IdenticalToTest) NonComparableArrays() {
	x := [0]func(){}
	f := func() { IdenticalTo(x) }
	ExpectThat(f, Panics(HasSubstr("is not comparable")))
}

func (t *IdenticalToTest) ArraysOfNonComparableArrays() {
	x := [0][0]func(){}
	f := func() { IdenticalTo(x) }
	ExpectThat(f, Panics(HasSubstr("is not comparable")))
}

func (t *IdenticalToTest) Strings() {
	var m Matcher
	var err error

	m = IdenticalTo("taco")
	ExpectEq("identical to <string> taco", m.Description())

	// Identical value
	err = m.Matches("ta" + "co")
	ExpectEq(nil, err)

	// Type alias
	type myType string
	err = m.Matches(myType("taco"))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) ComparableStructs() {
	var m Matcher
	var err error

	type subStruct struct {
		i int
	}

	type myStruct struct {
		u uint
		s subStruct
	}

	x := myStruct{17, subStruct{19}}
	m = IdenticalTo(x)
	ExpectEq("identical to <oglematchers_test.myStruct> {17 {19}}", m.Description())

	// Identical value
	err = m.Matches(myStruct{17, subStruct{19}})
	ExpectEq(nil, err)

	// Wrong outer field
	err = m.Matches(myStruct{13, subStruct{19}})
	ExpectThat(err, Error(Equals("")))

	// Wrong inner field
	err = m.Matches(myStruct{17, subStruct{23}})
	ExpectThat(err, Error(Equals("")))

	// Type alias
	type myType myStruct
	err = m.Matches(myType{17, subStruct{19}})
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) NonComparableStructs() {
	type subStruct struct {
		s []int
	}

	type myStruct struct {
		u uint
		s subStruct
	}

	x := myStruct{17, subStruct{[]int{19}}}
	f := func() { IdenticalTo(x) }
	ExpectThat(f, Panics(AllOf(HasSubstr("IdenticalTo"), HasSubstr("comparable"))))
}

func (t *IdenticalToTest) NilUnsafePointer() {
	var m Matcher
	var err error

	x := unsafe.Pointer(nil)
	m = IdenticalTo(x)
	ExpectEq(fmt.Sprintf("identical to <unsafe.Pointer> %v", x), m.Description())

	// Identical value
	err = m.Matches(unsafe.Pointer(nil))
	ExpectEq(nil, err)

	// Wrong value
	j := 17
	err = m.Matches(unsafe.Pointer(&j))
	ExpectThat(err, Error(Equals("")))

	// Type alias
	type myType unsafe.Pointer
	err = m.Matches(myType(unsafe.Pointer(nil)))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) NonNilUnsafePointer() {
	var m Matcher
	var err error

	i := 17
	x := unsafe.Pointer(&i)
	m = IdenticalTo(x)
	ExpectEq(fmt.Sprintf("identical to <unsafe.Pointer> %v", x), m.Description())

	// Identical value
	err = m.Matches(unsafe.Pointer(&i))
	ExpectEq(nil, err)

	// Nil value
	err = m.Matches(unsafe.Pointer(nil))
	ExpectThat(err, Error(Equals("")))

	// Wrong value
	j := 17
	err = m.Matches(unsafe.Pointer(&j))
	ExpectThat(err, Error(Equals("")))

	// Type alias
	type myType unsafe.Pointer
	err = m.Matches(myType(unsafe.Pointer(&i)))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type oglematchers_test.myType")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}

func (t *IdenticalToTest) IntAlias() {
	var m Matcher
	var err error

	type intAlias int

	m = IdenticalTo(intAlias(17))
	ExpectEq("identical to <oglematchers_test.intAlias> 17", m.Description())

	// Identical value
	err = m.Matches(intAlias(17))
	ExpectEq(nil, err)

	// Int
	err = m.Matches(int(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int")))

	// Completely wrong type
	err = m.Matches(int32(17))
	ExpectTrue(isFatal(err))
	ExpectThat(err, Error(Equals("which is of type int32")))
}