-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Write unit tests for join/part/quit handlers (#300)
* Started working on interfaces for IRC side * Started working on implementing interface for IRC client * Continued working on fulfilling interface * Finished converting IRC client to interface * Added one test and added comment to IRCClient * Added test for when ShowJoinMessage is false * Added part handler tests * Added quit handler tests * Got rid of pesky spaces
- Loading branch information
Showing
8 changed files
with
642 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,207 @@ | ||
package irc | ||
|
||
import ( | ||
"testing" | ||
|
||
gomock "github.com/golang/mock/gomock" | ||
"github.com/lrstanley/girc" | ||
"github.com/ritlug/teleirc/internal" | ||
) | ||
|
||
func TestJoinHandler_On(t *testing.T) { | ||
ctrl := gomock.NewController(t) | ||
|
||
defer ctrl.Finish() | ||
|
||
tgSettings := internal.TelegramSettings{ | ||
ShowJoinMessage: true, | ||
} | ||
|
||
mockClient := NewMockClientInterface(ctrl) | ||
mockLogger := internal.NewMockDebugLogger(ctrl) | ||
mockClient. | ||
EXPECT(). | ||
Logger(). | ||
Return(mockLogger) | ||
mockLogger. | ||
EXPECT(). | ||
LogDebug(gomock.Eq("joinHandler triggered")) | ||
mockClient. | ||
EXPECT(). | ||
TgSettings(). | ||
Return(&tgSettings) | ||
mockClient. | ||
EXPECT(). | ||
SendToTg(gomock.Eq("* TEST_NAME joins")) | ||
|
||
myHandler := joinHandler(mockClient) | ||
myHandler(&girc.Client{}, girc.Event{ | ||
Source: &girc.Source{ | ||
Name: "TEST_NAME", | ||
}, | ||
}) | ||
} | ||
|
||
func TestJoinHandler_Off(t *testing.T) { | ||
ctrl := gomock.NewController(t) | ||
|
||
defer ctrl.Finish() | ||
|
||
tgSettings := internal.TelegramSettings{ | ||
ShowJoinMessage: false, | ||
} | ||
|
||
mockClient := NewMockClientInterface(ctrl) | ||
mockLogger := internal.NewMockDebugLogger(ctrl) | ||
mockClient. | ||
EXPECT(). | ||
Logger(). | ||
Return(mockLogger) | ||
mockLogger. | ||
EXPECT(). | ||
LogDebug(gomock.Eq("joinHandler triggered")) | ||
mockClient. | ||
EXPECT(). | ||
TgSettings(). | ||
Return(&tgSettings) | ||
mockClient. | ||
EXPECT(). | ||
SendToTg(gomock.Any()). | ||
MaxTimes(0) | ||
|
||
myHandler := joinHandler(mockClient) | ||
myHandler(&girc.Client{}, girc.Event{}) | ||
} | ||
|
||
func TestPartHandler_On(t *testing.T) { | ||
ctrl := gomock.NewController(t) | ||
|
||
defer ctrl.Finish() | ||
|
||
tgSettings := internal.TelegramSettings{ | ||
ShowLeaveMessage: true, | ||
} | ||
|
||
mockClient := NewMockClientInterface(ctrl) | ||
mockLogger := internal.NewMockDebugLogger(ctrl) | ||
mockClient. | ||
EXPECT(). | ||
Logger(). | ||
Return(mockLogger) | ||
mockLogger. | ||
EXPECT(). | ||
LogDebug(gomock.Eq("partHandler triggered")) | ||
mockClient. | ||
EXPECT(). | ||
TgSettings(). | ||
Return(&tgSettings) | ||
mockClient. | ||
EXPECT(). | ||
SendToTg(gomock.Eq("* TEST_NAME parts")) | ||
|
||
myHandler := partHandler(mockClient) | ||
myHandler(&girc.Client{}, girc.Event{ | ||
Source: &girc.Source{ | ||
Name: "TEST_NAME", | ||
}, | ||
}) | ||
} | ||
|
||
func TestPartHandler_Off(t *testing.T) { | ||
ctrl := gomock.NewController(t) | ||
|
||
defer ctrl.Finish() | ||
|
||
tgSettings := internal.TelegramSettings{ | ||
ShowLeaveMessage: false, | ||
} | ||
|
||
mockClient := NewMockClientInterface(ctrl) | ||
mockLogger := internal.NewMockDebugLogger(ctrl) | ||
mockClient. | ||
EXPECT(). | ||
Logger(). | ||
Return(mockLogger) | ||
mockLogger. | ||
EXPECT(). | ||
LogDebug(gomock.Eq("partHandler triggered")) | ||
mockClient. | ||
EXPECT(). | ||
TgSettings(). | ||
Return(&tgSettings) | ||
mockClient. | ||
EXPECT(). | ||
SendToTg(gomock.Any()). | ||
MaxTimes(0) | ||
|
||
myHandler := partHandler(mockClient) | ||
myHandler(&girc.Client{}, girc.Event{}) | ||
} | ||
|
||
func TestQuitHandler_On(t *testing.T) { | ||
ctrl := gomock.NewController(t) | ||
|
||
defer ctrl.Finish() | ||
|
||
tgSettings := internal.TelegramSettings{ | ||
ShowLeaveMessage: true, | ||
} | ||
|
||
mockClient := NewMockClientInterface(ctrl) | ||
mockLogger := internal.NewMockDebugLogger(ctrl) | ||
mockClient. | ||
EXPECT(). | ||
Logger(). | ||
Return(mockLogger) | ||
mockLogger. | ||
EXPECT(). | ||
LogDebug(gomock.Eq("quitHandler triggered")) | ||
mockClient. | ||
EXPECT(). | ||
TgSettings(). | ||
Return(&tgSettings) | ||
mockClient. | ||
EXPECT(). | ||
SendToTg(gomock.Eq("* TEST_NAME quit (TEST_REASON)")) | ||
|
||
myHandler := quitHandler(mockClient) | ||
myHandler(&girc.Client{}, girc.Event{ | ||
Source: &girc.Source{ | ||
Name: "TEST_NAME", | ||
}, | ||
Params: []string{ | ||
"TEST_REASON", | ||
}, | ||
}) | ||
} | ||
|
||
func TestQuitHandler_Off(t *testing.T) { | ||
ctrl := gomock.NewController(t) | ||
|
||
defer ctrl.Finish() | ||
|
||
tgSettings := internal.TelegramSettings{ | ||
ShowLeaveMessage: false, | ||
} | ||
|
||
mockClient := NewMockClientInterface(ctrl) | ||
mockLogger := internal.NewMockDebugLogger(ctrl) | ||
mockClient. | ||
EXPECT(). | ||
Logger(). | ||
Return(mockLogger) | ||
mockLogger. | ||
EXPECT(). | ||
LogDebug(gomock.Eq("quitHandler triggered")) | ||
mockClient. | ||
EXPECT(). | ||
TgSettings(). | ||
Return(&tgSettings) | ||
mockClient. | ||
EXPECT(). | ||
SendToTg(gomock.Any()). | ||
MaxTimes(0) | ||
|
||
myHandler := quitHandler(mockClient) | ||
myHandler(&girc.Client{}, girc.Event{}) | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
package irc | ||
|
||
import ( | ||
"github.com/lrstanley/girc" | ||
"github.com/ritlug/teleirc/internal" | ||
) | ||
|
||
/* | ||
ClientInterface represents an IRC client | ||
*/ | ||
type ClientInterface interface { | ||
SendMessage(string) | ||
StartBot(chan<- error, func(string)) | ||
Logger() internal.DebugLogger | ||
addHandlers() | ||
SendToTg(string) | ||
IRCSettings() *internal.IRCSettings | ||
TgSettings() *internal.TelegramSettings | ||
|
||
AddHandler(string, func(*girc.Client, girc.Event)) | ||
ConnectDialer(girc.Dialer) error | ||
Message(string, string) | ||
JoinKey(string, string) | ||
Join(...string) | ||
} |
Oops, something went wrong.