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
|
package soju
import (
"context"
"net"
"os"
"reflect"
"testing"
"time"
"gopkg.in/irc.v4"
"codeberg.org/emersion/soju/database"
"codeberg.org/emersion/soju/xirc"
)
var testServerPrefix = &irc.Prefix{Name: "soju-test-server"}
const (
testUsername = "soju-test-user"
testPassword = testUsername
)
type testingLogger struct {
t *testing.T
}
func (tl testingLogger) Printf(format string, v ...interface{}) {
tl.t.Logf(format, v...)
}
func createTempSqliteDB(t *testing.T) database.Database {
if !database.SqliteEnabled {
t.Skip("SQLite support is disabled")
}
db, err := database.OpenTempSqliteDB()
if err != nil {
t.Fatalf("failed to create temporary SQLite database: %v", err)
}
return db
}
func createTempPostgresDB(t *testing.T) database.Database {
source, ok := os.LookupEnv("SOJU_TEST_POSTGRES")
if !ok {
t.Skip("set SOJU_TEST_POSTGRES to a connection string to execute PostgreSQL tests")
}
db, err := database.OpenTempPostgresDB(source)
if err != nil {
t.Fatalf("failed to create temporary PostgreSQL database: %v", err)
}
return db
}
func createTestUser(t *testing.T, db database.Database) *database.User {
record := database.NewUser(testUsername)
if err := record.SetPassword(testPassword); err != nil {
t.Fatalf("failed to generate bcrypt hash: %v", err)
}
if err := db.StoreUser(context.Background(), record); err != nil {
t.Fatalf("failed to store test user: %v", err)
}
return record
}
func createTestDownstream(t *testing.T, srv *Server) ircConn {
c1, c2 := net.Pipe()
go srv.Handle(newNetIRCConn(c1))
return newNetIRCConn(c2)
}
func createTestUpstream(t *testing.T, db database.Database, user *database.User) (*database.Network, net.Listener) {
ln, err := net.Listen("tcp", "localhost:0")
if err != nil {
t.Fatalf("failed to create TCP listener: %v", err)
}
network := database.NewNetwork("irc+insecure://" + ln.Addr().String())
network.Name = "testnet"
if err := db.StoreNetwork(context.Background(), user.ID, network); err != nil {
t.Fatalf("failed to store test network: %v", err)
}
return network, ln
}
func mustAccept(t *testing.T, ln net.Listener) ircConn {
c, err := ln.Accept()
if err != nil {
t.Fatalf("failed accepting connection: %v", err)
}
return newNetIRCConn(c)
}
func expectMessage(t *testing.T, c ircConn, cmd string) *irc.Message {
msg, err := c.ReadMessage()
if err != nil {
t.Fatalf("failed to read IRC message (want %q): %v", cmd, err)
}
if msg.Command != cmd {
t.Fatalf("invalid message received: want %q, got: %v", cmd, msg)
}
return msg
}
func roundtrip(t *testing.T, c ircConn) []*irc.Message {
c.WriteMessage(&irc.Message{Command: "PING", Params: []string{"roundtrip"}})
var msgs []*irc.Message
for {
msg, err := c.ReadMessage()
if err != nil {
t.Fatalf("failed to read IRC message: %v", err)
}
if msg.Command == "PONG" {
break
}
msgs = append(msgs, msg)
}
return msgs
}
func registerDownstreamConn(t *testing.T, c ircConn, network *database.Network) {
c.WriteMessage(&irc.Message{
Command: "PASS",
Params: []string{testPassword},
})
c.WriteMessage(&irc.Message{
Command: "NICK",
Params: []string{testUsername},
})
c.WriteMessage(&irc.Message{
Command: "USER",
Params: []string{testUsername + "/" + network.Name, "0", "*", testUsername},
})
expectMessage(t, c, irc.RPL_WELCOME)
}
func registerUpstreamConn(t *testing.T, c ircConn) {
msg := expectMessage(t, c, "CAP")
if msg.Params[0] != "LS" {
t.Fatalf("invalid CAP LS: got: %v", msg)
}
msg = expectMessage(t, c, "NICK")
nick := msg.Params[0]
if nick != testUsername {
t.Fatalf("invalid NICK: want %q, got: %v", testUsername, msg)
}
expectMessage(t, c, "USER")
c.WriteMessage(&irc.Message{
Prefix: testServerPrefix,
Command: irc.RPL_WELCOME,
Params: []string{nick, "Welcome!"},
})
c.WriteMessage(&irc.Message{
Prefix: testServerPrefix,
Command: irc.RPL_YOURHOST,
Params: []string{nick, "Your host is soju-test-server"},
})
c.WriteMessage(&irc.Message{
Prefix: testServerPrefix,
Command: irc.RPL_CREATED,
Params: []string{nick, "Who cares when the server was created?"},
})
c.WriteMessage(&irc.Message{
Prefix: testServerPrefix,
Command: irc.RPL_MYINFO,
Params: []string{nick, testServerPrefix.Name, "soju", "aiwroO", "OovaimnqpsrtklbeI"},
})
c.WriteMessage(&irc.Message{
Prefix: testServerPrefix,
Command: irc.ERR_NOMOTD,
Params: []string{nick, "No MOTD"},
})
}
func newDebugLogger(t *testing.T) *DebugLogger {
l := &DebugLogger{
logger: &testingLogger{t},
}
l.debug.Store(true)
return l
}
func testBroadcast(t *testing.T, db database.Database) {
user := createTestUser(t, db)
network, upstream := createTestUpstream(t, db, user)
defer upstream.Close()
srv := NewServer(db)
srv.Logger = newDebugLogger(t)
if err := srv.Start(); err != nil {
t.Fatalf("failed to start server: %v", err)
}
defer srv.Shutdown()
uc := mustAccept(t, upstream)
defer uc.Close()
registerUpstreamConn(t, uc)
dc := createTestDownstream(t, srv)
defer dc.Close()
registerDownstreamConn(t, dc, network)
noticeText := "This is a very important server notice."
uc.WriteMessage(&irc.Message{
Prefix: testServerPrefix,
Command: "NOTICE",
Params: []string{testUsername, noticeText},
})
var msg *irc.Message
for {
var err error
msg, err = dc.ReadMessage()
if err != nil {
t.Fatalf("failed to read IRC message: %v", err)
}
if msg.Command == "NOTICE" {
break
}
}
if msg.Params[1] != noticeText {
t.Fatalf("invalid NOTICE text: want %q, got: %v", noticeText, msg)
}
}
func TestServer_broadcast(t *testing.T) {
t.Run("sqlite", func(t *testing.T) {
db := createTempSqliteDB(t)
testBroadcast(t, db)
})
t.Run("postgres", func(t *testing.T) {
db := createTempPostgresDB(t)
testBroadcast(t, db)
})
}
func testChatHistory(t *testing.T, msgStoreDriver, msgStorePath string) {
db := createTempSqliteDB(t)
user := createTestUser(t, db)
network, upstream := createTestUpstream(t, db, user)
defer upstream.Close()
srv := NewServer(db)
srv.Logger = newDebugLogger(t)
cfg := *srv.Config()
cfg.MsgStoreDriver = msgStoreDriver
cfg.MsgStorePath = msgStorePath
srv.SetConfig(&cfg)
if err := srv.Start(); err != nil {
t.Fatalf("failed to start server: %v", err)
}
defer srv.Shutdown()
uc := mustAccept(t, upstream)
defer uc.Close()
registerUpstreamConn(t, uc)
texts := []string{
"Hiya!",
"How are you doing?",
"Can I take a sip from your glass of soju?",
}
baseTime := time.Date(2023, 05, 23, 6, 0, 0, 0, time.UTC)
for i, text := range texts {
msgTime := baseTime.Add(time.Duration(i) * time.Second)
uc.WriteMessage(&irc.Message{
Tags: irc.Tags{"time": xirc.FormatServerTime(msgTime)},
Prefix: &irc.Prefix{Name: "foo"},
Command: "PRIVMSG",
Params: []string{testUsername, text},
})
}
roundtrip(t, uc)
dc := createTestDownstream(t, srv)
defer dc.Close()
registerDownstreamConn(t, dc, network)
roundtrip(t, dc) // drain post-connection-registration messages
testCases := []struct {
Name string
After time.Time
Texts []string
}{
{
Name: "all",
After: baseTime.Add(-time.Second),
Texts: texts,
},
{
Name: "none",
After: baseTime.Add(time.Duration(len(texts)-1) * time.Second),
Texts: nil,
},
{
Name: "all_but_first",
After: baseTime,
Texts: texts[1:],
},
}
for _, tc := range testCases {
t.Run(tc.Name, func(t *testing.T) {
dc.WriteMessage(&irc.Message{
Command: "CHATHISTORY",
Params: []string{"AFTER", "foo", "timestamp=" + xirc.FormatServerTime(tc.After), "100"},
})
var got []string
for _, msg := range roundtrip(t, dc) {
if msg.Command != "PRIVMSG" {
t.Fatalf("unexpected reply: %v", msg)
}
got = append(got, msg.Params[1])
}
if !reflect.DeepEqual(got, tc.Texts) {
t.Errorf("got %v, want %v", got, tc.Texts)
}
})
}
}
func TestServer_chatHistory(t *testing.T) {
t.Run("fs", func(t *testing.T) {
testChatHistory(t, "fs", t.TempDir())
})
t.Run("db", func(t *testing.T) {
testChatHistory(t, "db", "")
})
}
|