Skip to content

Add comprehensive test coverage for bot command functions #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

Add comprehensive test coverage for bot command functions #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6a4e358
Initial plan
Copilot Sep 30, 2025
1c78b91
Add comprehensive tests for caffeine, apb, s, and reload commands
Copilot Sep 30, 2025
601cdfe
Add tests for say, emote, roll commands and thought help function
Copilot Sep 30, 2025
c3a5a53
Add test for type.go constants and complete comprehensive test suite
Copilot Sep 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
176 changes: 176 additions & 0 deletions internal/handler/commands/apb_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
package commands

import (
"encoding/json"
"github.com/mattermost/mattermost/server/public/model"
"github.com/pyrousnet/pyrous-gobot/internal/cache"
"github.com/pyrousnet/pyrous-gobot/internal/comms"
"github.com/pyrousnet/pyrous-gobot/internal/mmclient"
"github.com/pyrousnet/pyrous-gobot/internal/pubsub"
"github.com/pyrousnet/pyrous-gobot/internal/settings"
"github.com/pyrousnet/pyrous-gobot/internal/users"
"testing"
"time"
)

// MockCacheWithUser extends MockCache to return specific user data
type MockCacheWithUser struct {
cache.MockCache
userData map[string]interface{}
}

func (m *MockCacheWithUser) Get(key string) (interface{}, bool, error) {
if m.userData != nil {
if val, exists := m.userData[key]; exists {
return val, true, nil
}
}
return nil, false, nil
}

func TestBotCommand_Apb(t *testing.T) {
// Create test user data
testUser := users.User{
Id: "testuser123",
Name: "testuser",
Message: "test message",
}
userData, _ := json.Marshal(testUser)
userDataString := string(userData)

type fields struct {
body string
sender string
target string
mm *mmclient.MMClient
settings *settings.Settings
ReplyChannel *model.Channel
ResponseChannel chan comms.Response
method Method
cache cache.Cache
pubsub pubsub.Pubsub
Quit chan bool
}
type args struct {
event BotCommand
}
tests := []struct {
name string
fields fields
args args
wantErr bool
wantMsg string
wantType string
}{
{
name: "test apb with existing user",
fields: fields{
body: "testuser",
sender: "@sender",
target: "",
mm: nil,
settings: nil,
ReplyChannel: &model.Channel{Id: "test"},
ResponseChannel: make(chan comms.Response, 1),
method: Method{},
cache: &MockCacheWithUser{
userData: map[string]interface{}{
"user-testuser": userDataString,
},
},
Quit: make(chan bool),
},
args: args{
event: BotCommand{
body: "testuser",
sender: "@sender",
target: "",
mm: nil,
settings: nil,
ReplyChannel: &model.Channel{Id: "test"},
ResponseChannel: make(chan comms.Response, 1),
method: Method{},
cache: &MockCacheWithUser{
userData: map[string]interface{}{
"user-testuser": userDataString,
},
},
Quit: make(chan bool),
},
},
wantErr: false,
wantMsg: "/me sends out the blood hounds to find testuser",
wantType: "command",
},
{
name: "test apb with non-existing user",
fields: fields{
body: "unknownuser",
sender: "@sender",
target: "",
mm: nil,
settings: nil,
ReplyChannel: &model.Channel{Id: "test"},
ResponseChannel: make(chan comms.Response, 1),
method: Method{},
cache: &cache.MockCache{},
Quit: make(chan bool),
},
args: args{
event: BotCommand{
body: "unknownuser",
sender: "@sender",
target: "",
mm: nil,
settings: nil,
ReplyChannel: &model.Channel{Id: "test"},
ResponseChannel: make(chan comms.Response, 1),
method: Method{},
cache: &cache.MockCache{},
Quit: make(chan bool),
},
},
wantErr: false,
wantMsg: "Who's unknownuser?",
wantType: "dm",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
bc := BotCommand{
body: tt.fields.body,
sender: tt.fields.sender,
target: tt.fields.target,
mm: tt.fields.mm,
settings: tt.fields.settings,
ReplyChannel: tt.fields.ReplyChannel,
ResponseChannel: tt.fields.ResponseChannel,
method: tt.fields.method,
cache: tt.fields.cache,
pubsub: tt.fields.pubsub,
Quit: tt.fields.Quit,
}
var r comms.Response
go func() {
select {
case r = <-tt.args.event.ResponseChannel:
return
case <-time.After(2 * time.Second):
t.Error("Test timed out waiting for response")
return
}
}()
if err := bc.Apb(tt.args.event); (err != nil) != tt.wantErr {
t.Errorf("Apb() error = %v, wantErr %v", err, tt.wantErr)
}
// Small delay to allow goroutine to capture response
time.Sleep(10 * time.Millisecond)
if r.Message != tt.wantMsg {
t.Errorf("Apb() message = %v, want %v", r.Message, tt.wantMsg)
}
if r.Type != tt.wantType {
t.Errorf("Apb() type = %v, want %v", r.Type, tt.wantType)
}
})
}
}
167 changes: 167 additions & 0 deletions internal/handler/commands/caffeine_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
package commands

import (
"github.com/mattermost/mattermost/server/public/model"
"github.com/pyrousnet/pyrous-gobot/internal/cache"
"github.com/pyrousnet/pyrous-gobot/internal/comms"
"github.com/pyrousnet/pyrous-gobot/internal/mmclient"
"github.com/pyrousnet/pyrous-gobot/internal/pubsub"
"github.com/pyrousnet/pyrous-gobot/internal/settings"
"testing"
"time"
)

func TestBotCommand_Caffeine(t *testing.T) {
type fields struct {
body string
sender string
target string
mm *mmclient.MMClient
settings *settings.Settings
ReplyChannel *model.Channel
ResponseChannel chan comms.Response
method Method
cache cache.Cache
pubsub pubsub.Pubsub
Quit chan bool
}
type args struct {
event BotCommand
}
tests := []struct {
name string
fields fields
args args
wantErr bool
wantMsg string
}{
{
name: "test caffeine without number - default message",
fields: fields{
body: "",
sender: "@testuser",
target: "",
mm: nil,
settings: nil,
ReplyChannel: &model.Channel{Id: "test"},
ResponseChannel: make(chan comms.Response, 1),
method: Method{},
cache: &cache.MockCache{},
Quit: make(chan bool),
},
args: args{
event: BotCommand{
body: "",
sender: "@testuser",
target: "",
mm: nil,
settings: nil,
ReplyChannel: &model.Channel{Id: "test"},
ResponseChannel: make(chan comms.Response, 1),
method: Method{},
cache: &cache.MockCache{},
Quit: make(chan bool),
},
},
wantErr: false,
wantMsg: "/me walks over to @testuser and gives them a shot of caffeine straight into the blood stream.",
},
{
name: "test caffeine with number 5",
fields: fields{
body: "5",
sender: "@testuser",
target: "",
mm: nil,
settings: nil,
ReplyChannel: &model.Channel{Id: "test"},
ResponseChannel: make(chan comms.Response, 1),
method: Method{},
cache: &cache.MockCache{},
Quit: make(chan bool),
},
args: args{
event: BotCommand{
body: "5",
sender: "@testuser",
target: "",
mm: nil,
settings: nil,
ReplyChannel: &model.Channel{Id: "test"},
ResponseChannel: make(chan comms.Response, 1),
method: Method{},
cache: &cache.MockCache{},
Quit: make(chan bool),
},
},
wantErr: false,
wantMsg: "/me walks over to @testuser and gives them 5 shots of caffeine straight into the blood stream.",
},
{
name: "test caffeine with invalid input - no message set (potential bug)",
fields: fields{
body: "abc",
sender: "@testuser",
target: "",
mm: nil,
settings: nil,
ReplyChannel: &model.Channel{Id: "test"},
ResponseChannel: make(chan comms.Response, 1),
method: Method{},
cache: &cache.MockCache{},
Quit: make(chan bool),
},
args: args{
event: BotCommand{
body: "abc",
sender: "@testuser",
target: "",
mm: nil,
settings: nil,
ReplyChannel: &model.Channel{Id: "test"},
ResponseChannel: make(chan comms.Response, 1),
method: Method{},
cache: &cache.MockCache{},
Quit: make(chan bool),
},
},
wantErr: false,
wantMsg: "", // Currently, the command doesn't set a message for invalid input
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
bc := BotCommand{
body: tt.fields.body,
sender: tt.fields.sender,
target: tt.fields.target,
mm: tt.fields.mm,
settings: tt.fields.settings,
ReplyChannel: tt.fields.ReplyChannel,
ResponseChannel: tt.fields.ResponseChannel,
method: tt.fields.method,
cache: tt.fields.cache,
pubsub: tt.fields.pubsub,
Quit: tt.fields.Quit,
}
var r comms.Response
go func() {
select {
case r = <-tt.args.event.ResponseChannel:
return
case <-time.After(2 * time.Second):
t.Error("Test timed out waiting for response")
return
}
}()
if err := bc.Caffeine(tt.args.event); (err != nil) != tt.wantErr {
t.Errorf("Caffeine() error = %v, wantErr %v", err, tt.wantErr)
}
// Small delay to allow goroutine to capture response
time.Sleep(10 * time.Millisecond)
if r.Message != tt.wantMsg {
t.Errorf("Caffeine() = %v, want %v", r.Message, tt.wantMsg)
}
})
}
}
Loading