From bfcbe6d3d6f83cf7b9af3a063d8a7f5b2cee7403 Mon Sep 17 00:00:00 2001 From: CPunch Date: Thu, 1 Feb 2024 17:11:50 -0600 Subject: [PATCH] started testutil: login_test now uses these helpers should simplify new tests in the future --- login/login_test.go | 80 ++++++++------------------------------------- testutil/helpers.go | 76 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 90 insertions(+), 66 deletions(-) create mode 100644 testutil/helpers.go diff --git a/login/login_test.go b/login/login_test.go index 3125880..2bd2930 100644 --- a/login/login_test.go +++ b/login/login_test.go @@ -3,8 +3,6 @@ package login_test import ( "context" "encoding/binary" - "fmt" - "net" "os" "testing" @@ -13,8 +11,7 @@ import ( "github.com/CPunch/gopenfusion/internal/db" "github.com/CPunch/gopenfusion/internal/redis" "github.com/CPunch/gopenfusion/login" - "github.com/alicebob/miniredis/v2" - "github.com/bitcomplete/sqltestutil" + "github.com/CPunch/gopenfusion/testutil" "github.com/matryer/is" ) @@ -44,65 +41,16 @@ var ( } ) -func makeDummyPeer(ctx context.Context, is *is.I, recv chan<- *cnet.PacketEvent) *cnet.Peer { - conn, err := net.Dial("tcp", fmt.Sprintf("127.0.0.1:%d", loginPort)) - is.NoErr(err) - - peer := cnet.NewPeer(ctx, conn) - go func() { - peer.Handler(recv) - }() - - return peer -} - -func sendAndRecv(peer *cnet.Peer, recv chan *cnet.PacketEvent, is *is.I, sID, rID uint32, out, in interface{}) { - // send out packet - err := peer.Send(sID, out) - is.NoErr(err) // peer.Send() should not return an error - - // receive response - evnt := <-recv - defer protocol.PutBuffer(evnt.Pkt) - - is.Equal(evnt.PktID, rID) // should receive expected type - is.NoErr(protocol.NewPacket(evnt.Pkt).Decode(in)) // packet.Decode() should not return an error -} - func TestMain(m *testing.M) { ctx, cancel := context.WithCancel(context.Background()) defer cancel() - // spawn postgres container - psql, err := sqltestutil.StartPostgresContainer(ctx, "15") - if err != nil { - panic(err) - } - - // open db handler - testDB, err = db.OpenFromConnectionString("postgres", psql.ConnectionString()+"?sslmode=disable") - if err != nil { - panic(err) - } - - if err = testDB.Setup(); err != nil { - panic(err) - } - - // start miniredis - r, err := miniredis.Run() - if err != nil { - panic(err) - } - defer r.Close() - - // open redis handler - rh, err = redis.OpenRedis(r.Addr()) - if err != nil { - panic(err) - } - defer rh.Close() + // setup environment + var closer func() + testDB, rh, closer = testutil.SetupEnvironment(ctx) + defer closer() + var err error loginPort, err = cnet.RandomPort() if err != nil { panic(err) @@ -135,12 +83,12 @@ func TestLoginSuccSequence(t *testing.T) { defer cancel() recv := make(chan *cnet.PacketEvent) - peer := makeDummyPeer(ctx, is, recv) + peer := testutil.MakeDummyPeer(ctx, is, loginPort, recv) defer peer.Kill() // send login request (this should create an account) var resp protocol.SP_LS2CL_REP_LOGIN_SUCC - sendAndRecv(peer, recv, is, protocol.P_CL2LS_REQ_LOGIN, protocol.P_LS2CL_REP_LOGIN_SUCC, + testutil.SendAndRecv(peer, recv, is, protocol.P_CL2LS_REQ_LOGIN, protocol.P_LS2CL_REP_LOGIN_SUCC, protocol.SP_CL2LS_REQ_LOGIN{ SzID: "testLoginSequence", SzPassword: "test", @@ -162,12 +110,12 @@ func TestLoginFailSequence(t *testing.T) { defer cancel() recv := make(chan *cnet.PacketEvent) - peer := makeDummyPeer(ctx, is, recv) + peer := testutil.MakeDummyPeer(ctx, is, loginPort, recv) defer peer.Kill() // send login request (this should not create an account) var resp protocol.SP_LS2CL_REP_LOGIN_FAIL - sendAndRecv(peer, recv, is, protocol.P_CL2LS_REQ_LOGIN, protocol.P_LS2CL_REP_LOGIN_FAIL, + testutil.SendAndRecv(peer, recv, is, protocol.P_CL2LS_REQ_LOGIN, protocol.P_LS2CL_REP_LOGIN_FAIL, protocol.SP_CL2LS_REQ_LOGIN{ SzID: "", SzPassword: "", @@ -185,12 +133,12 @@ func TestCharacterSequence(t *testing.T) { defer cancel() recv := make(chan *cnet.PacketEvent) - peer := makeDummyPeer(ctx, is, recv) + peer := testutil.MakeDummyPeer(ctx, is, loginPort, recv) defer peer.Kill() // send login request (this should create an account) var resp protocol.SP_LS2CL_REP_LOGIN_SUCC - sendAndRecv(peer, recv, is, protocol.P_CL2LS_REQ_LOGIN, protocol.P_LS2CL_REP_LOGIN_SUCC, + testutil.SendAndRecv(peer, recv, is, protocol.P_CL2LS_REQ_LOGIN, protocol.P_LS2CL_REP_LOGIN_SUCC, protocol.SP_CL2LS_REQ_LOGIN{ SzID: "testCharacterSequence", SzPassword: "test", @@ -214,7 +162,7 @@ func TestCharacterSequence(t *testing.T) { // send character name check request var charResp protocol.SP_LS2CL_REP_SAVE_CHAR_NAME_SUCC - sendAndRecv(peer, recv, is, protocol.P_CL2LS_REQ_SAVE_CHAR_NAME, protocol.P_LS2CL_REP_SAVE_CHAR_NAME_SUCC, + testutil.SendAndRecv(peer, recv, is, protocol.P_CL2LS_REQ_SAVE_CHAR_NAME, protocol.P_LS2CL_REP_SAVE_CHAR_NAME_SUCC, protocol.SP_CL2LS_REQ_SAVE_CHAR_NAME{ ISlotNum: 1, IGender: 1, @@ -235,7 +183,7 @@ func TestCharacterSequence(t *testing.T) { charCreate := testCharCreate charCreate.PCStyle.IPC_UID = charResp.IPC_UID var charCreateResp protocol.SP_LS2CL_REP_CHAR_CREATE_SUCC - sendAndRecv(peer, recv, is, protocol.P_CL2LS_REQ_CHAR_CREATE, protocol.P_LS2CL_REP_CHAR_CREATE_SUCC, + testutil.SendAndRecv(peer, recv, is, protocol.P_CL2LS_REQ_CHAR_CREATE, protocol.P_LS2CL_REP_CHAR_CREATE_SUCC, charCreate, &charCreateResp) // verify response diff --git a/testutil/helpers.go b/testutil/helpers.go new file mode 100644 index 0000000..007e03d --- /dev/null +++ b/testutil/helpers.go @@ -0,0 +1,76 @@ +package testutil + +import ( + "context" + "fmt" + "net" + + "github.com/CPunch/gopenfusion/cnet" + "github.com/CPunch/gopenfusion/cnet/protocol" + "github.com/CPunch/gopenfusion/internal/db" + "github.com/CPunch/gopenfusion/internal/redis" + "github.com/alicebob/miniredis/v2" + "github.com/bitcomplete/sqltestutil" + "github.com/matryer/is" +) + +func SetupEnvironment(ctx context.Context) (*db.DBHandler, *redis.RedisHandler, func()) { + // spawn postgres container + psql, err := sqltestutil.StartPostgresContainer(ctx, "15") + if err != nil { + panic(err) + } + + // open db handler + testDB, err := db.OpenFromConnectionString("postgres", psql.ConnectionString()+"?sslmode=disable") + if err != nil { + panic(err) + } + + if err = testDB.Setup(); err != nil { + panic(err) + } + + // start miniredis + r, err := miniredis.Run() + if err != nil { + panic(err) + } + + // open redis handler + rh, err := redis.OpenRedis(r.Addr()) + if err != nil { + panic(err) + } + + return testDB, rh, func() { + psql.Shutdown(ctx) + rh.Close() + r.Close() + } +} + +func MakeDummyPeer(ctx context.Context, is *is.I, port int, recv chan<- *cnet.PacketEvent) *cnet.Peer { + conn, err := net.Dial("tcp", fmt.Sprintf("127.0.0.1:%d", port)) + is.NoErr(err) + + peer := cnet.NewPeer(ctx, conn) + go func() { + peer.Handler(recv) + }() + + return peer +} + +func SendAndRecv(peer *cnet.Peer, recv chan *cnet.PacketEvent, is *is.I, sID, rID uint32, out, in interface{}) { + // send out packet + err := peer.Send(sID, out) + is.NoErr(err) // peer.Send() should not return an error + + // receive response + evnt := <-recv + defer protocol.PutBuffer(evnt.Pkt) + + is.Equal(evnt.PktID, rID) // should receive expected type + is.NoErr(protocol.NewPacket(evnt.Pkt).Decode(in)) // packet.Decode() should not return an error +}