autobrr/internal/database/irc_test.go
KaiserBh 666bdf68cd
feat(database): setup integration tests (#1118)
* refactor: this should be Debug() just like the rest.

* feat: catch error when updating client table.

Before if we provided the wrong ID it will just say it's successful when it shouldn't.

* chore: handle the errors.

* fix: defer tx.Rollback().

When I try handling the error we always hit the error no matter what even though there wasn't any error, This is due that defer block being executed unconditionally so even after we commit it successfully it will just give error. So add checking then commit it if all good.

* feat: added testing env.

This way we can use in memory sqlite.

* chore: Delete log should be debug as well.

* feat: enable foreign keys for testing for sqlite.

I recommend enabling all together. Not sure why it's commented but for now will keep it the same and only enable for testing.

* chore: catch error, if deleting a record fails.

* chore: catch error, if deleting a record fails.

* chore: catch error, when failed to enable toggle.

* chore: catch error, if updating failed.

* chore(filter): catch error, if deleting failed.

* chore(filter): catch error, if row is not modified for ToggleEnabled.

* chore(feed): Should be debug level to match with others.

* chore(feed): catch error when nothing is updated.

* chore: update docker-compose.yml add test_db for postgres.

* chore(ci): update include postgres db service before running tests.

* feat(database): Added database testing.

* feat(database): Added api integration testing.

* feat(database): Added action integration testing.

* feat(database): Added download_client integration testing.

* feat(database): Added filter integration testing.

* test(database): initial tests model (WIP)

* chore(feed): handle error when nothing is deleted.

* tests(feed): added delete testing.

* chore(feed): handle error when nothing is updated.

* chore(feed): handle error when nothing is updated.

* chore(feed): handle error when nothing is updated.

* feat(database): Added feed integration testing.

* fix(feed_cache): This should be time.Time not time.Duration.

* chore(feed_cache): handle error when deleting fails.

* feat(database): Added feed_cache integration testing.

* chore: add EOL

* feat: added indexer_test.go

* feat: added mock irc data

* fix: the column is not pass anymore it's password.

* chore: added assertion.

* fix: This is password column not pass test is failing because of it.

* feat: added tests cases for irc.

* feat: added test cases for release.

* feat: added test cases for notifications.

* feat: added Delete to the User DB that way it can be used for testing.

* feat: added user database tests.

* refactor: Make setupLogger and setupDatabase private also renamed them.

Changed the visibility of `setupLogger` to private based on feedback. Also renamed the function to `setupLoggerForTest` and `setupDatabaseForTest` to make its purpose more descriptive.

* fix(database): tests postgres ssl mode disable

* refactor(database): setup and teardown

---------

Co-authored-by: ze0s <43699394+zze0s@users.noreply.github.com>
2023-11-18 20:04:30 +01:00

483 lines
13 KiB
Go

package database
import (
"context"
"fmt"
"testing"
"time"
"github.com/autobrr/autobrr/internal/domain"
"github.com/stretchr/testify/assert"
)
func getMockIrcChannel() domain.IrcChannel {
return domain.IrcChannel{
ID: 0,
Enabled: true,
Name: "ab_announcement",
Password: "password123",
Detached: true,
Monitoring: false,
}
}
func getMockIrcNetwork() domain.IrcNetwork {
connectedSince := time.Now().Add(-time.Hour) // Example time 1 hour ago
return domain.IrcNetwork{
ID: 0,
Name: "Freenode",
Enabled: true,
Server: "irc.freenode.net",
Port: 6667,
TLS: true,
Pass: "serverpass",
Nick: "nickname",
Auth: domain.IRCAuth{
Mechanism: domain.IRCAuthMechanismSASLPlain,
Account: "useraccount",
Password: "userpassword",
},
InviteCommand: "INVITE",
UseBouncer: true,
BouncerAddr: "bouncer.freenode.net",
Channels: []domain.IrcChannel{
getMockIrcChannel(),
},
Connected: true,
ConnectedSince: &connectedSince,
}
}
func TestIrcRepo_StoreNetwork(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
mockData := getMockIrcNetwork()
t.Run(fmt.Sprintf("StoreNetwork_Succeeds [%s]", dbType), func(t *testing.T) {
// Setup
assert.NotNil(t, mockData)
// Execute
err := repo.StoreNetwork(context.Background(), &mockData)
assert.NoError(t, err)
// Verify
assert.NotEqual(t, int64(0), mockData.ID)
// Cleanup
_ = repo.DeleteNetwork(context.Background(), int64(int(mockData.ID)))
})
}
}
func TestIrcRepo_StoreChannel(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
mockNetwork := getMockIrcNetwork()
mockChannel := getMockIrcChannel()
t.Run(fmt.Sprintf("StoreChannel_Insert_Succeeds [%s]", dbType), func(t *testing.T) {
// Setup
err := repo.StoreNetwork(context.Background(), &mockNetwork)
assert.NoError(t, err)
// Execute
err = repo.StoreChannel(context.Background(), mockNetwork.ID, &mockChannel)
assert.NoError(t, err)
// Verify
assert.NotEqual(t, int64(0), mockChannel.ID)
// No need to clean up, since the test below will delete the network
})
t.Run(fmt.Sprintf("StoreChannel_Update_Succeeds [%s]", dbType), func(t *testing.T) {
// Setup
err := repo.StoreChannel(context.Background(), mockNetwork.ID, &mockChannel)
assert.NoError(t, err)
// Update mockChannel fields
mockChannel.Enabled = false
mockChannel.Name = "updated_name"
// Execute
err = repo.StoreChannel(context.Background(), mockNetwork.ID, &mockChannel)
assert.NoError(t, err)
// Verify
fetchedChannel, fetchErr := repo.ListChannels(mockNetwork.ID)
assert.NoError(t, fetchErr)
assert.Equal(t, mockChannel.Enabled, fetchedChannel[0].Enabled)
assert.Equal(t, mockChannel.Name, fetchedChannel[0].Name)
// Cleanup
_ = repo.DeleteNetwork(context.Background(), mockNetwork.ID)
})
}
}
func TestIrcRepo_UpdateNetwork(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
mockData := getMockIrcNetwork()
t.Run(fmt.Sprintf("UpdateNetwork_Succeeds [%s]", dbType), func(t *testing.T) {
// Setup
assert.NotNil(t, mockData)
err := repo.StoreNetwork(context.Background(), &mockData)
assert.NoError(t, err)
assert.NotEqual(t, int64(0), mockData.ID)
// Update mockData fields
mockData.Enabled = true
mockData.Name = "UpdatedNetworkName"
// Execute
err = repo.UpdateNetwork(context.Background(), &mockData)
assert.NoError(t, err)
// Verify
updatedNetwork, fetchErr := repo.GetNetworkByID(context.Background(), mockData.ID)
assert.NoError(t, fetchErr)
assert.Equal(t, mockData.Enabled, updatedNetwork.Enabled)
assert.Equal(t, mockData.Name, updatedNetwork.Name)
// Cleanup
_ = repo.DeleteNetwork(context.Background(), mockData.ID)
})
}
}
func TestIrcRepo_GetNetworkByID(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
mockData := getMockIrcNetwork()
t.Run(fmt.Sprintf("GetNetworkByID_Succeeds [%s]", dbType), func(t *testing.T) {
// Setup
assert.NotNil(t, mockData)
err := repo.StoreNetwork(context.Background(), &mockData)
assert.NoError(t, err)
assert.NotEqual(t, int64(0), mockData.ID)
// Execute
fetchedNetwork, err := repo.GetNetworkByID(context.Background(), mockData.ID)
assert.NoError(t, err)
// Verify
assert.NotNil(t, fetchedNetwork)
assert.Equal(t, mockData.ID, fetchedNetwork.ID)
assert.Equal(t, mockData.Enabled, fetchedNetwork.Enabled)
assert.Equal(t, mockData.Name, fetchedNetwork.Name)
// Cleanup
_ = repo.DeleteNetwork(context.Background(), mockData.ID)
})
}
}
func TestIrcRepo_DeleteNetwork(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
mockData := getMockIrcNetwork()
t.Run(fmt.Sprintf("DeleteNetwork_Succeeds [%s]", dbType), func(t *testing.T) {
// Setup
assert.NotNil(t, mockData)
err := repo.StoreNetwork(context.Background(), &mockData)
assert.NoError(t, err)
assert.NotEqual(t, int64(0), mockData.ID)
// Execute
err = repo.DeleteNetwork(context.Background(), mockData.ID)
assert.NoError(t, err)
// Verify
fetchedNetwork, fetchErr := repo.GetNetworkByID(context.Background(), mockData.ID)
assert.Error(t, fetchErr)
assert.Nil(t, fetchedNetwork)
})
}
}
func TestIrcRepo_FindActiveNetworks(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
mockData1 := getMockIrcNetwork()
mockData1.Enabled = true
mockData2 := getMockIrcNetwork()
mockData2.Enabled = false
// These fields are required to be unique
mockData2.Server = "irc.example.com"
mockData2.Port = 6664
mockData2.Nick = "nickname2"
t.Run(fmt.Sprintf("FindActiveNetworks_Succeeds [%s]", dbType), func(t *testing.T) {
// Setup
err := repo.StoreNetwork(context.Background(), &mockData1)
assert.NoError(t, err)
err = repo.StoreNetwork(context.Background(), &mockData2)
assert.NoError(t, err)
// Execute
activeNetworks, err := repo.FindActiveNetworks(context.Background())
assert.NoError(t, err)
// Verify
assert.NotEmpty(t, activeNetworks)
assert.Len(t, activeNetworks, 1)
assert.True(t, activeNetworks[0].Enabled)
// Cleanup
_ = repo.DeleteNetwork(context.Background(), mockData1.ID)
_ = repo.DeleteNetwork(context.Background(), mockData2.ID)
})
}
}
func TestIrcRepo_ListNetworks(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
// Prepare mock data
mockData1 := getMockIrcNetwork()
mockData1.Name = "ZNetwork"
mockData2 := getMockIrcNetwork()
mockData2.Name = "ANetwork"
mockData2.Server = "irc.example.com"
mockData2.Port = 6664
mockData2.Nick = "nickname2"
t.Run(fmt.Sprintf("ListNetworks_Succeeds [%s]", dbType), func(t *testing.T) {
// Setup
err := repo.StoreNetwork(context.Background(), &mockData1)
assert.NoError(t, err)
err = repo.StoreNetwork(context.Background(), &mockData2)
assert.NoError(t, err)
// Execute
listedNetworks, err := repo.ListNetworks(context.Background())
assert.NoError(t, err)
// Verify
assert.NotEmpty(t, listedNetworks)
assert.Len(t, listedNetworks, 2)
// Verify the order is alphabetical based on the name
assert.Equal(t, "ANetwork", listedNetworks[0].Name)
assert.Equal(t, "ZNetwork", listedNetworks[1].Name)
// Cleanup
_ = repo.DeleteNetwork(context.Background(), mockData1.ID)
_ = repo.DeleteNetwork(context.Background(), mockData2.ID)
})
}
}
func TestIrcRepo_ListChannels(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
mockNetwork := getMockIrcNetwork()
mockChannel := getMockIrcChannel()
t.Run(fmt.Sprintf("ListChannels_Succeeds [%s]", dbType), func(t *testing.T) {
// Setup
err := repo.StoreNetwork(context.Background(), &mockNetwork)
assert.NoError(t, err)
err = repo.StoreChannel(context.Background(), mockNetwork.ID, &mockChannel)
assert.NoError(t, err)
// Execute
listedChannels, err := repo.ListChannels(mockNetwork.ID)
assert.NoError(t, err)
// Verify
assert.NotEmpty(t, listedChannels)
assert.Len(t, listedChannels, 1)
// Cleanup
_ = repo.DeleteNetwork(context.Background(), mockNetwork.ID)
})
}
}
func TestIrcRepo_CheckExistingNetwork(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
mockNetwork := getMockIrcNetwork()
t.Run(fmt.Sprintf("CheckExistingNetwork_NoMatch [%s]", dbType), func(t *testing.T) {
// Execute
existingNetwork, err := repo.CheckExistingNetwork(context.Background(), &mockNetwork)
assert.NoError(t, err)
// Verify
assert.Nil(t, existingNetwork)
})
t.Run(fmt.Sprintf("CheckExistingNetwork_MatchFound [%s]", dbType), func(t *testing.T) {
// Setup
err := repo.StoreNetwork(context.Background(), &mockNetwork)
assert.NoError(t, err)
// Execute
existingNetwork, err := repo.CheckExistingNetwork(context.Background(), &mockNetwork)
assert.NoError(t, err)
// Verify
assert.NotNil(t, existingNetwork)
assert.Equal(t, mockNetwork.Server, existingNetwork.Server)
assert.Equal(t, mockNetwork.Port, existingNetwork.Port)
assert.Equal(t, mockNetwork.Nick, existingNetwork.Nick)
// Cleanup
_ = repo.DeleteNetwork(context.Background(), mockNetwork.ID)
})
}
}
func TestIrcRepo_StoreNetworkChannels(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
mockNetwork := getMockIrcNetwork()
mockChannels := []domain.IrcChannel{getMockIrcChannel()}
t.Run(fmt.Sprintf("StoreNetworkChannels_DeleteOldChannels [%s]", dbType), func(t *testing.T) {
// Setup
err := repo.StoreNetwork(context.Background(), &mockNetwork)
assert.NoError(t, err)
err = repo.StoreNetworkChannels(context.Background(), mockNetwork.ID, mockChannels)
assert.NoError(t, err)
// Execute
err = repo.StoreNetworkChannels(context.Background(), mockNetwork.ID, []domain.IrcChannel{})
assert.NoError(t, err)
// Verify
existingChannels, err := repo.ListChannels(mockNetwork.ID)
assert.NoError(t, err)
assert.Len(t, existingChannels, 0)
// Cleanup
_ = repo.DeleteNetwork(context.Background(), mockNetwork.ID)
})
t.Run(fmt.Sprintf("StoreNetworkChannels_InsertNewChannels [%s]", dbType), func(t *testing.T) {
// Setup
err := repo.StoreNetwork(context.Background(), &mockNetwork)
assert.NoError(t, err)
// Execute
err = repo.StoreNetworkChannels(context.Background(), mockNetwork.ID, mockChannels)
assert.NoError(t, err)
// Verify
existingChannels, err := repo.ListChannels(mockNetwork.ID)
assert.NoError(t, err)
assert.Len(t, existingChannels, len(mockChannels))
// Cleanup
_ = repo.DeleteNetwork(context.Background(), mockNetwork.ID)
})
}
}
func TestIrcRepo_UpdateChannel(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
mockNetwork := getMockIrcNetwork()
mockChannel := getMockIrcChannel()
t.Run(fmt.Sprintf("UpdateChannel_Success [%s]", dbType), func(t *testing.T) {
// Setup
err := repo.StoreNetwork(context.Background(), &mockNetwork)
assert.NoError(t, err)
err = repo.StoreChannel(context.Background(), mockNetwork.ID, &mockChannel)
assert.NoError(t, err)
// Update mockChannel properties
updatedChannel := mockChannel
updatedChannel.Enabled = false
updatedChannel.Name = "updated_name"
updatedChannel.Password = "updated_password"
// Execute
err = repo.UpdateChannel(&updatedChannel)
assert.NoError(t, err)
// Verify
fetchedChannels, err := repo.ListChannels(mockNetwork.ID)
assert.NoError(t, err)
fetchedChannel := fetchedChannels[0]
assert.Equal(t, updatedChannel.Enabled, fetchedChannel.Enabled)
assert.Equal(t, updatedChannel.Name, fetchedChannel.Name)
assert.Equal(t, updatedChannel.Password, fetchedChannel.Password)
// Cleanup
_ = repo.DeleteNetwork(context.Background(), mockNetwork.ID)
})
}
}
func TestIrcRepo_UpdateInviteCommand(t *testing.T) {
for dbType, db := range testDBs {
log := setupLoggerForTest()
repo := NewIrcRepo(log, db)
mockNetwork := getMockIrcNetwork()
t.Run(fmt.Sprintf("UpdateInviteCommand_Success [%s]", dbType), func(t *testing.T) {
// Setup
err := repo.StoreNetwork(context.Background(), &mockNetwork)
assert.NoError(t, err)
// Update invite_command
newInviteCommand := "/new_invite_command"
err = repo.UpdateInviteCommand(mockNetwork.ID, newInviteCommand)
assert.NoError(t, err)
// Verify
updatedNetwork, err := repo.ListNetworks(context.Background())
assert.NoError(t, err)
assert.Equal(t, newInviteCommand, updatedNetwork[0].InviteCommand)
// Cleanup
_ = repo.DeleteNetwork(context.Background(), mockNetwork.ID)
})
}
}