forked from go-chat-bot/bot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cmd_test.go
395 lines (329 loc) · 9.54 KB
/
cmd_test.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
package bot
import (
"errors"
"fmt"
"reflect"
"sort"
"strings"
"testing"
)
var (
channel string
replies []string
user *User
)
const (
expectedMsg = "msg"
cmd = "cmd"
cmdDescription = "Command description"
cmdExampleArgs = "arg1 arg2"
)
func responseHandler(target string, message string, sender *User) {
channel = target
user = sender
replies = append(replies, message)
}
func resetResponses() {
channel = ""
user = &User{Nick: ""}
replies = []string{}
commands = make(map[string]*customCommand)
}
func newBot() *Bot {
return New(&Handlers{
Response: responseHandler,
})
}
func resetRegisteredPeriodicCommands() {
periodicCommands = make(map[string]PeriodicConfig)
}
func registerValidCommand() {
RegisterCommand(cmd, cmdDescription, cmdExampleArgs,
func(c *Cmd) (string, error) {
return expectedMsg, nil
})
}
func TestPeriodicCommands(t *testing.T) {
resetResponses()
resetRegisteredPeriodicCommands()
RegisterPeriodicCommand("morning",
PeriodicConfig{
CronSpec: "0 0 08 * * mon-fri",
Channels: []string{"#channel"},
CmdFunc: func(channel string) (string, error) { return "ok " + channel, nil },
})
b := New(&Handlers{Response: responseHandler})
entries := b.cron.Entries()
if len(entries) != 1 {
t.Fatal("Should have one cron job entry")
}
if entries[0].Next.Hour() != 8 {
t.Fatal("Cron job should be scheduled to 8am")
}
entries[0].Job.Run()
if len(replies) != 1 {
t.Fatal("Should have one reply in the channel")
}
if replies[0] != "ok #channel" {
t.Fatal("Invalid reply")
}
}
func TestMultiplePeriodicCommands(t *testing.T) {
resetResponses()
resetRegisteredPeriodicCommands()
RegisterPeriodicCommand("morning",
PeriodicConfig{
CronSpec: "0 0 08 * * mon-fri",
Channels: []string{"#channel"},
CmdFunc: func(channel string) (string, error) { return "ok_morning " + channel, nil },
})
RegisterPeriodicCommand("afternoon",
PeriodicConfig{
CronSpec: "0 0 12 * * mon-fri",
Channels: []string{"#channel"},
CmdFunc: func(channel string) (string, error) { return "ok_afternoon " + channel, nil },
})
b := New(&Handlers{Response: responseHandler})
entries := b.cron.Entries()
if len(entries) != 2 {
t.Fatal("Should have 2 cron job entries")
}
if entries[0].Next.Hour() != 8 {
t.Fatal("First cron job should be scheduled for 8am")
}
if entries[1].Next.Hour() != 12 {
t.Fatal("Second cron job should be schedule for 12am")
}
entries[0].Job.Run()
entries[1].Job.Run()
if len(replies) != 2 {
t.Fatal("Should have two replies in the channel")
}
if replies[0] != "ok_morning #channel" {
t.Fatal("Invalid reply in first cron job")
}
if replies[1] != "ok_afternoon #channel" {
t.Fatal("Invalid reply in second cron job")
}
}
func TestErroredPeriodicCommand(t *testing.T) {
resetResponses()
resetRegisteredPeriodicCommands()
RegisterPeriodicCommand("bugged",
PeriodicConfig{
CronSpec: "0 0 08 * * mon-fri",
Channels: []string{"#channel"},
CmdFunc: func(channel string) (string, error) { return "bug", errors.New("error") },
})
b := New(&Handlers{Response: responseHandler})
entries := b.cron.Entries()
if len(entries) != 1 {
t.Fatal("Should have one cron job entry")
}
entries[0].Job.Run()
if len(replies) != 0 {
t.Fatal("Should not have a reply in the channel")
}
}
func TestDisabledCommands(t *testing.T) {
resetResponses()
commands = make(map[string]*customCommand)
b := New(&Handlers{
Response: responseHandler,
})
RegisterCommand("cmd", "", "",
func(c *Cmd) (string, error) {
return "active", nil
})
RegisterPassiveCommand("passive",
func(cmd *PassiveCmd) (string, error) {
return "passive", nil
})
b.Disable([]string{"cmd"})
b.MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!cmd"}, &User{Nick: "user"})
if len(replies) != 0 {
t.Fatal("Should not execute disabled active commands")
}
b.Disable([]string{"passive"})
b.MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "regular message"}, &User{Nick: "user"})
if len(replies) != 0 {
t.Fatal("Should not execute disabled passive commands")
}
}
func TestCommandNotRegistered(t *testing.T) {
resetResponses()
newBot().MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!not_a_cmd"}, &User{})
if len(replies) != 0 {
t.Fatal("Should not reply if a command is not found")
}
}
func TestInvalidCmdArgs(t *testing.T) {
resetResponses()
registerValidCommand()
newBot().MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!cmd \"invalid arg"}, &User{Nick: "user"})
if channel != "#go-bot" {
t.Error("Should reply to #go-bot channel")
}
if len(replies) != 1 {
t.Fatal("Invalid reply")
}
if !strings.HasPrefix(replies[0], "Error parsing") {
t.Fatal("Should reply with an error message")
}
}
func TestErroredCmd(t *testing.T) {
resetResponses()
cmdError := errors.New("error")
RegisterCommand("cmd", "", "",
func(c *Cmd) (string, error) {
return "", cmdError
})
newBot().MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!cmd"}, &User{Nick: "user"})
if channel != "#go-bot" {
t.Fatal("Invalid channel")
}
if len(replies) != 1 {
t.Fatal("Invalid reply")
}
if replies[0] != fmt.Sprintf(errorExecutingCommand, "cmd", cmdError.Error()) {
t.Fatal("Reply should contain the error message")
}
}
func TestValidCmdOnChannel(t *testing.T) {
resetResponses()
registerValidCommand()
newBot().MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!cmd"}, &User{Nick: "user"})
if channel != "#go-bot" {
t.Fatal("Command called on channel should reply to channel")
}
if len(replies) != 1 {
t.Fatal("Should have one reply on channel")
}
if replies[0] != expectedMsg {
t.Fatal("Invalid command reply")
}
}
func TestChannelData(t *testing.T) {
cd := ChannelData{
Protocol: "irc",
Server: "myserver",
Channel: "#mychan",
}
if cd.URI() != "irc://myserver/#mychan" {
t.Fatal("URI should return a valid IRC URI")
}
}
func TestHelpWithNoArgs(t *testing.T) {
resetResponses()
registerValidCommand()
newBot().MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!help"}, &User{Nick: "user"})
expectedReply := []string{
fmt.Sprintf(helpAboutCommand, CmdPrefix),
fmt.Sprintf(availableCommands, "cmd"),
}
if !reflect.DeepEqual(replies, expectedReply) {
t.Fatalf("Invalid reply. Expected %v got %v", expectedReply, replies)
}
}
func TestDisableHelp(t *testing.T) {
resetResponses()
registerValidCommand()
b := newBot()
b.Disable([]string{"help"})
b.MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!help"}, &User{Nick: "user"})
if len(replies) > 0 {
t.Fatalf("Should not execute help after disabling it")
}
}
func TestHelpForACommand(t *testing.T) {
resetResponses()
registerValidCommand()
newBot().MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!help cmd"}, &User{Nick: "user"})
expectedReply := []string{
fmt.Sprintf(helpDescripton, cmdDescription),
fmt.Sprintf(helpUsage, CmdPrefix, cmd, cmdExampleArgs),
}
if !reflect.DeepEqual(replies, expectedReply) {
t.Fatalf("Invalid reply. Expected %v got %v", expectedReply, replies)
}
}
func TestHelpWithNonExistingCommand(t *testing.T) {
resetResponses()
registerValidCommand()
newBot().MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!help not_a_cmd"}, &User{Nick: "user"})
expectedReply := []string{
fmt.Sprintf(helpAboutCommand, CmdPrefix),
fmt.Sprintf(availableCommands, "cmd"),
}
if !reflect.DeepEqual(replies, expectedReply) {
t.Fatalf("Invalid reply. Expected %v got %v", expectedReply, replies)
}
}
func TestHelpWithInvalidArgs(t *testing.T) {
resetResponses()
registerValidCommand()
newBot().MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!help cmd \"invalid arg"}, &User{Nick: "user"})
if len(replies) != 1 {
t.Fatal("Invalid reply")
}
if !strings.HasPrefix(replies[0], "Error parsing") {
t.Fatal("Should reply with an error message")
}
}
func TestCmdV2(t *testing.T) {
resetResponses()
RegisterCommandV2("cmd", "", "",
func(c *Cmd) (CmdResult, error) {
return CmdResult{
Channel: "#channel",
Message: "message"}, nil
})
newBot().MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!cmd"}, &User{Nick: "user"})
if channel != "#channel" {
t.Error("Wrong channel")
}
if !reflect.DeepEqual([]string{"message"}, replies) {
t.Error("Invalid reply")
}
}
func TestCmdV2WithoutSpecifyingChannel(t *testing.T) {
resetResponses()
RegisterCommandV2("cmd", "", "",
func(c *Cmd) (CmdResult, error) {
return CmdResult{Message: "message"}, nil
})
newBot().MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "!cmd"}, &User{Nick: "user"})
if channel != "#go-bot" {
t.Error("Should reply to original channel if no channel is returned")
}
}
func TestPassiveCommand(t *testing.T) {
resetResponses()
passiveCommands = make(map[string]passiveCmdFunc)
echo := func(cmd *PassiveCmd) (string, error) {
return cmd.Raw, nil
}
ping := func(cmd *PassiveCmd) (string, error) {
return "pong", nil
}
errored := func(cmd *PassiveCmd) (string, error) {
return "", errors.New("error")
}
RegisterPassiveCommand("echo", echo)
RegisterPassiveCommand("ping", ping)
RegisterPassiveCommand("errored", errored)
newBot().MessageReceived(&ChannelData{Channel: "#go-bot"}, &Message{Text: "test"}, &User{Nick: "user"})
if channel != "#go-bot" {
t.Error("Invalid channel")
}
if len(replies) != 2 {
t.Fatal("Invalid reply")
}
sort.Strings(replies)
if replies[0] != "pong" {
t.Error("ping command not executed")
}
if replies[1] != "test" {
t.Error("echo command not executed")
}
}