matchbox_test.go

/*
Copyright 2015 Workiva

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 matchbox

import (
	"strconv"
	"sync"
	"testing"

	"github.com/stretchr/testify/assert"
)

type subscriber string

func (m subscriber) ID() string {
	return string(m)
}

func TestBasic(t *testing.T) {
	assert := assert.New(t)
	mb := New(NewAMQPConfig())
	sub1 := subscriber("sub1")
	sub2 := subscriber("sub2")
	sub3 := subscriber("sub3")

	mb.Subscribe("foo.bar.baz.qux", sub1)
	mb.Unsubscribe("foo.bar.baz.qux", sub1)
	mb.Subscribe("foo.bar.baz", sub2)
	mb.Subscribe("foo.bar.baz.blah", sub3)

	assert.Equal([]Subscriber{}, mb.Subscribers("foo.bar.baz.qux"))
	assert.Equal([]Subscriber{sub2}, mb.Subscribers("foo.bar.baz"))
	assert.Equal([]Subscriber{sub3}, mb.Subscribers("foo.bar.baz.blah"))
}

func TestSingleNode(t *testing.T) {
	assert := assert.New(t)
	mb := New(NewAMQPConfig())
	sub1 := subscriber("sub1")
	sub2 := subscriber("sub2")

	mb.Subscribe("a", sub1)
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("a"))
	mb.Unsubscribe("a", sub1)
	assert.Equal([]Subscriber{}, mb.Subscribers("a"))

	mb.Subscribe("a", sub2)
	assert.Equal([]Subscriber{sub2}, mb.Subscribers("a"))
	mb.Subscribe("b", sub1)
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("b"))
	mb.Unsubscribe("a", sub2)
	assert.Equal([]Subscriber{}, mb.Subscribers("a"))
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("b"))
	mb.Unsubscribe("b", sub1)
	assert.Equal([]Subscriber{}, mb.Subscribers("a"))
	assert.Equal([]Subscriber{}, mb.Subscribers("b"))
}

func TestContraction(t *testing.T) {
	assert := assert.New(t)
	mb := New(NewAMQPConfig())
	sub1 := subscriber("sub1")

	mb.Subscribe("a", sub1)
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("a"))

	mb.Subscribe("a.b.c", sub1)
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("a.b.c"))

	mb.Unsubscribe("a.b.c", sub1)
	assert.Equal([]Subscriber{}, mb.Subscribers("a.b.c"))
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("a"))
}

func TestMatchbox(t *testing.T) {
	assert := assert.New(t)
	mb := New(NewAMQPConfig())
	sub1 := subscriber("sub1")
	sub2 := subscriber("sub2")
	sub3 := subscriber("sub3")
	sub4 := subscriber("sub4")
	sub5 := subscriber("sub5")

	assert.Equal([]Subscriber{}, mb.Subscribers("foo"))
	mb.Unsubscribe("moo", sub1)

	mb.Subscribe("a", sub1)
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("a"))
	mb.Unsubscribe("a", sub1)
	assert.Equal([]Subscriber{}, mb.Subscribers("a"))
	mb.Subscribe("a", sub1)
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("a"))
	mb.Subscribe("a", sub2)
	assert.Equal(2, len(mb.Subscribers("a")))

	mb.Subscribe("a.b.c", sub1)
	mb.Subscribe("a.*.c", sub2)
	mb.Subscribe("*.*.c", sub3)
	mb.Subscribe("*.*.*", sub4)
	mb.Subscribe("a.b.c", sub5)
	subscribers := mb.Subscribers("a.b.c")
	sessions := []Subscriber{sub1, sub2, sub3, sub4, sub5}
	assert.Len(subscribers, 5)
	for _, subscriber := range subscribers {
		assert.Contains(sessions, subscriber)
	}
	mb.Unsubscribe("a.b.c", sub1)
	mb.Unsubscribe("a.b.c", sub5)
	sessions = []Subscriber{sub2, sub3, sub4}
	subscribers = mb.Subscribers("a.b.c")
	assert.Len(subscribers, 3)
	for _, subscriber := range subscribers {
		assert.Contains(sessions, subscriber)
	}
	mb.Unsubscribe("a.*.c", sub2)
	sessions = []Subscriber{sub3, sub4}
	subscribers = mb.Subscribers("a.b.c")
	assert.Len(subscribers, 2)
	for _, subscriber := range subscribers {
		assert.Contains(sessions, subscriber)
	}
	mb.Unsubscribe("*.*.c", sub3)
	assert.Equal([]Subscriber{sub4}, mb.Subscribers("a.b.c"))
	mb.Unsubscribe("*.*.*", sub4)
	assert.Equal([]Subscriber{}, mb.Subscribers("a.b.c"))

	mb.Subscribe("a.b.b.c", sub2)
	mb.Subscribe("a.*.*.c", sub3)
	subscribers = mb.Subscribers("a.b.b.c")
	sessions = []Subscriber{sub2, sub3}
	assert.Len(subscribers, 2)
	for _, subscriber := range subscribers {
		assert.Contains(sessions, subscriber)
	}
	assert.Equal([]Subscriber{sub3}, mb.Subscribers("a.b.x.c"))
	mb.Unsubscribe("a.b", sub2)
	mb.Unsubscribe("a.b.b.c", sub2)
	mb.Unsubscribe("a.b.b.c", sub2)
	assert.Equal([]Subscriber{sub3}, mb.Subscribers("a.b.b.c"))
	mb.Unsubscribe("a.*.*.c", sub3)

	mb.Subscribe("d.#.f", sub1)
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("d.f"))
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("d.e.f"))
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("d.e.e.e.e.e.f"))
	mb.Unsubscribe("d.#.f", sub1)

	mb.Subscribe("x.#", sub3)
	assert.Equal([]Subscriber{sub3}, mb.Subscribers("x"))
	assert.Equal([]Subscriber{sub3}, mb.Subscribers("x.y"))
	subscribers = mb.Subscribers("x.y.z")
	sessions = []Subscriber{sub3, sub4}
	for _, subscriber := range subscribers {
		assert.Contains(sessions, subscriber)
	}
	assert.Equal([]Subscriber{sub3}, mb.Subscribers("x.y.z.z.z.z.z.z.z"))
	mb.Unsubscribe("x.#", sub3)

	mb.Subscribe("x.#.#.#.y.z", sub4)
	assert.Equal([]Subscriber{sub4}, mb.Subscribers("x.a.y.z"))
	assert.Equal([]Subscriber{sub4}, mb.Subscribers("x.a.a.a.y.z"))
	assert.Equal([]Subscriber{}, mb.Subscribers("x.a.a.a.y"))
	mb.Unsubscribe("x.#.#.#.y.z", sub4)
	assert.Equal([]Subscriber{}, mb.Subscribers("x.a.y.z"))
	assert.Equal([]Subscriber{}, mb.Subscribers("x.a.a.a.y.z"))
	assert.Equal([]Subscriber{}, mb.Subscribers("x.a.a.a.y"))
}

func TestInternalPoundSubscriber(t *testing.T) {
	assert := assert.New(t)

	mb := New(NewAMQPConfig())
	sub1 := subscriber("Subcriber1")
	mb.Subscribe("*.b.#", sub1)
	sub2 := subscriber("Subscriber2")
	mb.Subscribe("*.b.*.d", sub2)
	subscribers := mb.Subscribers("a.b.c.d")
	sessions := []Subscriber{sub1, sub2}
	assert.Len(subscribers, 2)
	for _, subscriber := range subscribers {
		assert.Contains(sessions, subscriber)
	}

	mb = New(NewAMQPConfig())
	sub1 = subscriber("Subcriber1")
	mb.Subscribe("*.b.#", sub1)
	sub2 = subscriber("Subscriber2")
	mb.Subscribe("*.b.#.d", sub2)
	sessions = []Subscriber{sub1, sub2}
	subscribers = mb.Subscribers("a.b.c.d")
	assert.Len(subscribers, 2)
	for _, subscriber := range subscribers {
		assert.Contains(sessions, subscriber)
	}
}

func TestChildParentSubscriber(t *testing.T) {
	assert := assert.New(t)
	mb := New(NewAMQPConfig())
	sub1 := subscriber("sub1")
	sub2 := subscriber("sub2")
	sub3 := subscriber("sub3")

	mb.Subscribe("foo.bar.baz.qux.1", sub1)
	mb.Subscribe("foo.bar.baz.qux.2", sub2)
	mb.Subscribe("foo.bar.baz.qux", sub3)

	assert.Equal([]Subscriber{sub1}, mb.Subscribers("foo.bar.baz.qux.1"))
	assert.Equal([]Subscriber{sub2}, mb.Subscribers("foo.bar.baz.qux.2"))
	assert.Equal([]Subscriber{sub3}, mb.Subscribers("foo.bar.baz.qux"))
}

func TestAlreadySubscribed(t *testing.T) {
	assert := assert.New(t)
	mb := New(NewAMQPConfig())
	sub1 := subscriber("sub1")

	mb.Subscribe("foo", sub1)
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("foo"))
	mb.Subscribe("foo", sub1)
	assert.Equal([]Subscriber{sub1}, mb.Subscribers("foo"))
}

func TestConfig(t *testing.T) {
	assert := assert.New(t)
	mb := New(&Config{Delimiter: "|", SingleWildcard: "$", ZeroOrMoreWildcard: "%"})
	sub := subscriber("abc")

	mb.Subscribe("foo|bar", sub)
	assert.Equal([]Subscriber{sub}, mb.Subscribers("foo|bar"))
	mb.Unsubscribe("foo|bar", sub)
	assert.Equal([]Subscriber{}, mb.Subscribers("foo|bar"))

	mb.Subscribe("foo|%", sub)
	assert.Equal([]Subscriber{sub}, mb.Subscribers("foo"))
	assert.Equal([]Subscriber{sub}, mb.Subscribers("foo|bar|baz|qux"))
	assert.Equal([]Subscriber{}, mb.Subscribers("foo.barblah"))
	mb.Unsubscribe("foo|%", sub)
	assert.Equal([]Subscriber{}, mb.Subscribers("foo"))
	assert.Equal([]Subscriber{}, mb.Subscribers("foo|bar|baz|qux"))
	assert.Equal([]Subscriber{}, mb.Subscribers("foo.barblah"))

	mb.Subscribe("foo|$|baz", sub)
	assert.Equal([]Subscriber{sub}, mb.Subscribers("foo|bar|baz"))
	assert.Equal([]Subscriber{sub}, mb.Subscribers("foo|qux|baz"))
	assert.Equal([]Subscriber{}, mb.Subscribers("foo|baz"))
	mb.Unsubscribe("foo|$|baz", sub)
	assert.Equal([]Subscriber{}, mb.Subscribers("foo|bar|baz"))
	assert.Equal([]Subscriber{}, mb.Subscribers("foo|qux|baz"))
	assert.Equal([]Subscriber{}, mb.Subscribers("foo|baz"))
}

func TestSubscriptions(t *testing.T) {
	assert := assert.New(t)
	mb := New(NewAMQPConfig())
	assert.Equal(map[string][]Subscriber{}, mb.Subscriptions())
	sub1 := subscriber("abc")
	sub2 := subscriber("def")
	sub3 := subscriber("ghi")
	sub4 := subscriber("jkl")
	sub5 := subscriber("mno")
	mb.Subscribe("a", sub1)
	mb.Subscribe("a", sub2)
	mb.Subscribe("b", sub1)
	mb.Subscribe("a.b", sub3)
	mb.Subscribe("a.b", sub4)
	mb.Subscribe("a.b", sub5)
	mb.Subscribe("a.b.c", sub5)

	subscriptions := mb.Subscriptions()

	expected := map[string][]Subscriber{
		"a":     []Subscriber{sub1, sub2},
		"b":     []Subscriber{sub1},
		"a.b":   []Subscriber{sub3, sub4, sub5},
		"a.b.c": []Subscriber{sub5},
	}

	if assert.Len(subscriptions, len(expected)) {
		for topic, subscribers := range subscriptions {
			exp, ok := expected[topic]
			if assert.True(ok) && assert.Len(subscribers, len(exp)) {
				for _, actual := range subscribers {
					assert.Contains(exp, actual)
				}
			}
		}
	}
}

func TestTopics(t *testing.T) {
	assert := assert.New(t)
	mb := New(NewAMQPConfig())
	assert.Equal([]string{}, mb.Topics())
	sub := subscriber("abc")
	mb.Subscribe("a", sub)
	mb.Subscribe("b", sub)
	mb.Subscribe("a.b.c", sub)
	mb.Subscribe("a.#.c", sub)
	mb.Subscribe("a.*.c", sub)

	topics := mb.Topics()

	expected := []string{"a", "b", "a.b", "a.b.c", "a.#", "a.*", "a.#.c", "a.*.c"}

	if assert.Len(topics, len(expected)) {
		for _, actual := range topics {
			assert.Contains(expected, actual)
		}
	}
}

// Ensures reduceZeroOrMoreWildcards reduces sequences of # to a single
// instance.
func TestReduceZeroOrMoreWildcards(t *testing.T) {
	assert := assert.New(t)
	config := NewAMQPConfig()
	words := []string{"a", "b", "c", "d"}
	assert.Equal(words, config.reduceZeroOrMoreWildcards(words))
	words = []string{"a", "#", "c", "d"}
	assert.Equal(words, config.reduceZeroOrMoreWildcards(words))
	words = []string{"a", "#", "#", "d"}
	assert.Equal([]string{"a", "#", "d"}, config.reduceZeroOrMoreWildcards(words))
	words = []string{"a", "#", "#", "#"}
	assert.Equal([]string{"a", "#"}, config.reduceZeroOrMoreWildcards(words))
	words = []string{"a", "#", "#", "b", "#", "c", "#", "#", "#", "d"}
	assert.Equal([]string{"a", "#", "b", "#", "c", "#", "d"},
		config.reduceZeroOrMoreWildcards(words))
}

func BenchmarkSubscribeSingleChild(b *testing.B) {
	mb := New(NewAMQPConfig())
	sub := subscriber("abc")
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		mb.Subscribe("a", sub)
	}
}

func BenchmarkSubscribeLongBranch(b *testing.B) {
	mb := New(NewAMQPConfig())
	sub := subscriber("abc")
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		mb.Subscribe("a.b.c.d.e.f.g.h", sub)
	}
}

func BenchmarkSubscribeFanOutChild(b *testing.B) {
	mb := New(NewAMQPConfig())
	sub := subscriber("abc")
	mb.Subscribe("a", sub)
	mb.Subscribe("b", sub)
	mb.Subscribe("c", sub)
	mb.Subscribe("d", sub)
	mb.Subscribe("e", sub)
	mb.Subscribe("f", sub)
	mb.Subscribe("g", sub)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		mb.Subscribe("g.h", sub)
	}
}

func BenchmarkUnsubscribeSingleChild(b *testing.B) {
	mb := New(NewAMQPConfig())
	sub := subscriber("abc")
	mb.Subscribe("a", sub)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		mb.Unsubscribe("a", sub)
	}
}

func BenchmarkUnsubscribeLongBranch(b *testing.B) {
	mb := New(NewAMQPConfig())
	sub := subscriber("abc")
	mb.Subscribe("a.b.c.d.e.f.g.h", sub)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		mb.Unsubscribe("a.b.c.d.e.f.g.h", sub)
	}
}

func BenchmarkUnsubscribeFanOutChild(b *testing.B) {
	mb := New(NewAMQPConfig())
	sub := subscriber("abc")
	mb.Subscribe("a", sub)
	mb.Subscribe("b", sub)
	mb.Subscribe("c", sub)
	mb.Subscribe("d", sub)
	mb.Subscribe("e", sub)
	mb.Subscribe("f", sub)
	mb.Subscribe("g", sub)
	mb.Subscribe("h", sub)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		mb.Unsubscribe("h", sub)
	}
}

func BenchmarkSubscribersSingleChild(b *testing.B) {
	mb := New(NewAMQPConfig())
	sub := subscriber("abc")
	mb.Subscribe("a", sub)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		mb.Subscribers("a")
	}
}

func BenchmarkSubscribersLongBranch(b *testing.B) {
	mb := New(NewAMQPConfig())
	sub := subscriber("abc")
	mb.Subscribe("a.b.c.d.e.f.g.h", sub)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		mb.Subscribers("a.b.c.d.e.f.g.h")
	}
}

func BenchmarkSubscribersFanOutChild(b *testing.B) {
	mb := New(NewAMQPConfig())
	sub := subscriber("abc")
	mb.Subscribe("a", sub)
	mb.Subscribe("b", sub)
	mb.Subscribe("c", sub)
	mb.Subscribe("d", sub)
	mb.Subscribe("e", sub)
	mb.Subscribe("f", sub)
	mb.Subscribe("g", sub)
	mb.Subscribe("h", sub)
	b.ResetTimer()
	for i := 0; i < b.N; i++ {
		mb.Subscribers("h")
	}
}

func BenchmarkMultithreaded5050Insert1Threads(b *testing.B) {
	numItems := 1000
	numThreads := 1
	benchmark5050(b, numItems, numThreads)
}

func BenchmarkMultithreaded5050Insert2Threads(b *testing.B) {
	numItems := 1000
	numThreads := 2
	benchmark5050(b, numItems, numThreads)
}

func BenchmarkMultithreaded5050Insert3Threads(b *testing.B) {
	numItems := 1000
	numThreads := 3
	benchmark5050(b, numItems, numThreads)
}

func BenchmarkMultithreaded5050Insert4Threads(b *testing.B) {
	numItems := 1000
	numThreads := 4
	benchmark5050(b, numItems, numThreads)
}

func BenchmarkMultithreaded5050Insert5Threads(b *testing.B) {
	numItems := 1000
	numThreads := 5
	benchmark5050(b, numItems, numThreads)
}

func BenchmarkMultithreaded5050Insert6Threads(b *testing.B) {
	numItems := 1000
	numThreads := 6
	benchmark5050(b, numItems, numThreads)
}

func BenchmarkMultithreaded5050Insert7Threads(b *testing.B) {
	numItems := 1000
	numThreads := 7
	benchmark5050(b, numItems, numThreads)
}

func BenchmarkMultithreaded5050Insert8Threads(b *testing.B) {
	numItems := 1000
	numThreads := 8
	benchmark5050(b, numItems, numThreads)
}

func BenchmarkMultithreaded5050Insert12Threads(b *testing.B) {
	numItems := 1000
	numThreads := 12
	benchmark5050(b, numItems, numThreads)
}

func BenchmarkMultithreaded5050Insert16Threads(b *testing.B) {
	numItems := 1000
	numThreads := 16
	benchmark5050(b, numItems, numThreads)
}

func BenchmarkMultithreaded2575Insert1Threads(b *testing.B) {
	numItems := 1000
	numThreads := 1
	benchmark2575(b, numItems, numThreads)
}

func BenchmarkMultithreaded2575Insert2Threads(b *testing.B) {
	numItems := 1000
	numThreads := 2
	benchmark2575(b, numItems, numThreads)
}

func BenchmarkMultithreaded2575Insert3Threads(b *testing.B) {
	numItems := 1000
	numThreads := 3
	benchmark2575(b, numItems, numThreads)
}

func BenchmarkMultithreaded2575Insert4Threads(b *testing.B) {
	numItems := 1000
	numThreads := 4
	benchmark2575(b, numItems, numThreads)
}

func BenchmarkMultithreaded2575Insert5Threads(b *testing.B) {
	numItems := 1000
	numThreads := 5
	benchmark2575(b, numItems, numThreads)
}

func BenchmarkMultithreaded2575Insert6Threads(b *testing.B) {
	numItems := 1000
	numThreads := 6
	benchmark2575(b, numItems, numThreads)
}

func BenchmarkMultithreaded2575Insert7Threads(b *testing.B) {
	numItems := 1000
	numThreads := 7
	benchmark2575(b, numItems, numThreads)
}

func BenchmarkMultithreaded2575Insert8Threads(b *testing.B) {
	numItems := 1000
	numThreads := 8
	benchmark2575(b, numItems, numThreads)
}

func BenchmarkMultithreaded2575Insert12Threads(b *testing.B) {
	numItems := 1000
	numThreads := 12
	benchmark2575(b, numItems, numThreads)
}

func BenchmarkMultithreaded2575Insert16Threads(b *testing.B) {
	numItems := 1000
	numThreads := 16
	benchmark2575(b, numItems, numThreads)
}

func benchmark5050(b *testing.B, numItems, numThreads int) {
	itemsToInsert := make([][]string, 0, numThreads)
	for i := 0; i < numThreads; i++ {
		items := make([]string, 0, numItems)
		for j := 0; j < numItems; j++ {
			topic := strconv.Itoa(j%10) + "." + strconv.Itoa(j%50) + "." + strconv.Itoa(j)
			items = append(items, topic)
		}
		itemsToInsert = append(itemsToInsert, items)
	}

	var wg sync.WaitGroup
	mb := New(NewAMQPConfig())
	sub := subscriber("abc")
	b.ResetTimer()

	for i := 0; i < b.N; i++ {
		wg.Add(numThreads)
		for j := 0; j < numThreads; j++ {
			go func(j int) {
				if j%2 != 0 {
					for _, key := range itemsToInsert[j] {
						mb.Subscribe(key, sub)
					}
				} else {
					for _, key := range itemsToInsert[j] {
						mb.Subscribers(key)
					}
				}

				wg.Done()
			}(j)
		}
		wg.Wait()
	}
}

func benchmark2575(b *testing.B, numItems, numThreads int) {
	itemsToInsert := make([][]string, 0, numThreads)
	for i := 0; i < numThreads; i++ {
		items := make([]string, 0, numItems)
		for j := 0; j < numItems; j++ {
			topic := strconv.Itoa(j%10) + "." + strconv.Itoa(j%50) + "." + strconv.Itoa(j)
			items = append(items, topic)
		}
		itemsToInsert = append(itemsToInsert, items)
	}

	var wg sync.WaitGroup
	mb := New(NewAMQPConfig())
	sub := subscriber("abc")
	b.ResetTimer()

	for i := 0; i < b.N; i++ {
		wg.Add(numThreads)
		for j := 0; j < numThreads; j++ {
			go func(j int) {
				if j%4 == 0 {
					for _, key := range itemsToInsert[j] {
						mb.Subscribe(key, sub)
					}
				} else {
					for _, key := range itemsToInsert[j] {
						mb.Subscribers(key)
					}
				}

				wg.Done()
			}(j)
		}
		wg.Wait()
	}
}