// Vikunja is a to-do list application to facilitate your life. // Copyright 2018-present Vikunja and contributors. All rights reserved. // // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU Affero General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Affero General Public License for more details. // // You should have received a copy of the GNU Affero General Public License // along with this program. If not, see . package events import ( "encoding/json" "testing" "github.com/ThreeDotsLabs/watermill" "github.com/ThreeDotsLabs/watermill/message" "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) var ( isUnderTest bool dispatchedTestEvents []Event ) // Fake sets up the "test mode" of the events package. Typically you'd call this function in the TestMain function // in the package you're testing. It will prevent any events from being fired, instead they will be recorded and be // available for assertions. func Fake() { isUnderTest = true dispatchedTestEvents = nil } // AssertDispatched asserts an event has been dispatched. func AssertDispatched(t *testing.T, event Event) { var found bool for _, testEvent := range dispatchedTestEvents { if event.Name() == testEvent.Name() { found = true break } } assert.True(t, found, "Failed to assert "+event.Name()+" has been dispatched.") } // TestListener takes an event and a listener and calls the listener's Handle method. func TestListener(t *testing.T, event Event, listener Listener) { content, err := json.Marshal(event) require.NoError(t, err) msg := message.NewMessage(watermill.NewUUID(), content) err = listener.Handle(msg) require.NoError(t, err) } // ClearDispatchedEvents clears the list of dispatched test events. This is useful when you want to // test event dispatch counts in a specific section of code without events from previous test operations. func ClearDispatchedEvents() { dispatchedTestEvents = nil } // CountDispatchedEvents counts how many events of a specific type have been dispatched. func CountDispatchedEvents(eventName string) int { count := 0 for _, testEvent := range dispatchedTestEvents { if testEvent.Name() == eventName { count++ } } return count }