cayley/graph/iterator/value_comparison_iterator_test.go

// Copyright 2014 The Cayley Authors. All rights reserved.
//
// 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 iterator

import (
	"errors"
	"reflect"
	"testing"

	"github.com/google/cayley/graph"
)

var simpleStore = &store{data: []string{"0", "1", "2", "3", "4", "5"}}
var stringStore = &store{data: []string{"foo", "bar", "baz", "echo"}}

func simpleFixedIterator() *Fixed {
	f := NewFixed(Identity)
	for i := 0; i < 5; i++ {
		f.Add(i)
	}
	return f
}

func stringFixedIterator() *Fixed {
	f := NewFixed(Identity)
	for _, value := range stringStore.data {
		f.Add(value)
	}
	return f
}

var comparisonTests = []struct {
	message  string
	operand  graph.Value
	operator Operator
	expect   []string
	qs       graph.QuadStore
	iterator func() *Fixed
}{
	{
		message:  "successful int64 less than comparison",
		operand:  int64(3),
		operator: compareLT,
		expect:   []string{"0", "1", "2"},
		qs:       simpleStore,
		iterator: simpleFixedIterator,
	},
	{
		message:  "empty int64 less than comparison",
		operand:  int64(0),
		operator: compareLT,
		expect:   nil,
		qs:       simpleStore,
		iterator: simpleFixedIterator,
	},
	{
		message:  "successful int64 greater than comparison",
		operand:  int64(2),
		operator: compareGT,
		expect:   []string{"3", "4"},
		qs:       simpleStore,
		iterator: simpleFixedIterator,
	},
	{
		message:  "successful int64 greater than or equal comparison",
		operand:  int64(2),
		operator: compareGTE,
		expect:   []string{"2", "3", "4"},
		qs:       simpleStore,
		iterator: simpleFixedIterator,
	},
	{
		message:  "successful string less than comparison",
		operand:  "echo",
		operator: compareLT,
		expect:   []string{"bar", "baz"},
		qs:       stringStore,
		iterator: stringFixedIterator,
	},
	{
		message:  "empty string less than comparison",
		operand:  "",
		operator: compareLT,
		expect:   nil,
		qs:       stringStore,
		iterator: stringFixedIterator,
	},
	{
		message:  "successful string greater than comparison",
		operand:  "echo",
		operator: compareGT,
		expect:   []string{"foo"},
		qs:       stringStore,
		iterator: stringFixedIterator,
	},
	{
		message:  "successful string greater than or equal comparison",
		operand:  "echo",
		operator: compareGTE,
		expect:   []string{"foo", "echo"},
		qs:       stringStore,
		iterator: stringFixedIterator,
	},
}

func TestValueComparison(t *testing.T) {
	for _, test := range comparisonTests {
		qs := test.qs
		vc := NewComparison(test.iterator(), test.operator, test.operand, qs)

		var got []string
		for vc.Next() {
			got = append(got, qs.NameOf(vc.Result()))
		}
		if !reflect.DeepEqual(got, test.expect) {
			t.Errorf("Failed to show %s, got:%q expect:%q", test.message, got, test.expect)
		}
	}
}

var vciContainsTests = []struct {
	message  string
	operator Operator
	check    graph.Value
	expect   bool
	qs       graph.QuadStore
	val      graph.Value
	iterator func() *Fixed
}{
	{
		message:  "1 is less than 2",
		operator: compareGTE,
		check:    1,
		expect:   false,
		qs:       simpleStore,
		val:      int64(2),
		iterator: simpleFixedIterator,
	},
	{
		message:  "2 is greater than or equal to 2",
		operator: compareGTE,
		check:    2,
		expect:   true,
		qs:       simpleStore,
		val:      int64(2),
		iterator: simpleFixedIterator,
	},
	{
		message:  "3 is greater than or equal to 2",
		operator: compareGTE,
		check:    3,
		expect:   true,
		qs:       simpleStore,
		val:      int64(2),
		iterator: simpleFixedIterator,
	},
	{
		message:  "5 is absent from iterator",
		operator: compareGTE,
		check:    5,
		expect:   false,
		qs:       simpleStore,
		val:      int64(2),
		iterator: simpleFixedIterator,
	},
	{
		message:  "foo is greater than or equal to echo",
		operator: compareGTE,
		check:    "foo",
		expect:   true,
		qs:       stringStore,
		val:      "echo",
		iterator: stringFixedIterator,
	},
	{
		message:  "echo is greater than or equal to echo",
		operator: compareGTE,
		check:    "echo",
		expect:   true,
		qs:       stringStore,
		val:      "echo",
		iterator: stringFixedIterator,
	},
	{
		message:  "foo is missing from the iterator",
		operator: compareLTE,
		check:    "foo",
		expect:   false,
		qs:       stringStore,
		val:      "echo",
		iterator: stringFixedIterator,
	},
}

func TestVCIContains(t *testing.T) {
	for _, test := range vciContainsTests {
		vc := NewComparison(test.iterator(), test.operator, test.val, test.qs)
		if vc.Contains(test.check) != test.expect {
			t.Errorf("Failed to show %s", test.message)
		}
	}
}

var comparisonIteratorTests = []struct {
	message string
	qs      graph.QuadStore
	val     graph.Value
}{
	{
		message: "2 is absent from iterator",
		qs:      simpleStore,
		val:     int64(2),
	},
	{
		message: "'missing' is absent from iterator",
		qs:      stringStore,
		val:     "missing",
	},
}

func TestComparisonIteratorErr(t *testing.T) {
	wantErr := errors.New("unique")
	errIt := newTestIterator(false, wantErr)

	for _, test := range comparisonIteratorTests {
		vc := NewComparison(errIt, compareLT, test.val, test.qs)

		if vc.Next() != false {
			t.Errorf("Comparison iterator did not pass through initial 'false': %s", test.message)
		}
		if vc.Err() != wantErr {
			t.Errorf("Comparison iterator did not pass through underlying Err: %s", test.message)
		}
	}
}