[rbdr/mobius] / hotline / server_blackbox_test.go

package hotline

import (
	"bytes"
	"context"
	"fmt"
	"github.com/davecgh/go-spew/spew"
	"github.com/stretchr/testify/assert"
	"go.uber.org/zap"
	"go.uber.org/zap/zapcore"
	"net"
	"os"
	"testing"
)

type testCase struct {
	name        string       // test case description
	account     Account      // Account struct for a user that will test transaction will execute under
	request     *Transaction // transaction that will be sent by the client to the server
	setup       func()       // Optional test-specific setup required for the scenario
	teardown    func()       // Optional test-specific teardown for the scenario
	mockHandler map[int]*mockClientHandler
}

func (tt *testCase) Setup(srv *Server) error {
	if err := srv.NewUser(tt.account.Login, tt.account.Name, string(negateString([]byte(tt.account.Password))), *tt.account.Access); err != nil {
		return err
	}

	if tt.setup != nil {
		tt.setup()
	}

	return nil
}

func (tt *testCase) Teardown(srv *Server) error {
	if err := srv.DeleteUser(tt.account.Login); err != nil {
		return err
	}

	if tt.teardown != nil {
		tt.teardown()
	}

	return nil
}

func NewTestLogger() *zap.SugaredLogger {
	encoderCfg := zap.NewProductionEncoderConfig()
	encoderCfg.TimeKey = "timestamp"
	encoderCfg.EncodeTime = zapcore.ISO8601TimeEncoder

	core := zapcore.NewCore(
		zapcore.NewConsoleEncoder(encoderCfg),
		zapcore.Lock(os.Stdout),
		zap.DebugLevel,
	)

	cores := []zapcore.Core{core}
	l := zap.New(zapcore.NewTee(cores...))
	defer func() { _ = l.Sync() }()
	return l.Sugar()
}

func StartTestServer() (*Server, context.Context, context.CancelFunc) {
	ctx, cancelRoot := context.WithCancel(context.Background())

	srv, err := NewServer("test/config/", "localhost", 0, NewTestLogger())
	if err != nil {
		panic(err)
	}

	go func() {
		err := srv.ListenAndServe(ctx, cancelRoot)
		if err != nil {
			panic(err)
		}
	}()

	return srv, ctx, cancelRoot
}

func TestHandshake(t *testing.T) {
	srv, _, cancelFunc := StartTestServer()
	defer cancelFunc()

	port := srv.APIListener.Addr().(*net.TCPAddr).Port

	conn, err := net.Dial("tcp", fmt.Sprintf(":%v", port))
	if err != nil {
		t.Fatal(err)
	}
	defer conn.Close()

	conn.Write([]byte{0x54, 0x52, 0x54, 0x50, 0x00, 0x01, 0x00, 0x00})

	replyBuf := make([]byte, 8)
	_, _ = conn.Read(replyBuf)

	want := []byte{84, 82, 84, 80, 0, 0, 0, 0}
	if bytes.Compare(replyBuf, want) != 0 {
		t.Errorf("%q, want %q", replyBuf, want)
	}

}

//func TestLogin(t *testing.T) {
//
//	tests := []struct {
//		name   string
//		client *Client
//	}{
//		{
//			name:   "when login is successful",
//			client: NewClient("guest", NewTestLogger()),
//		},
//	}
//	for _, test := range tests {
//		t.Run(test.name, func(t *testing.T) {
//
//		})
//	}
//}

func TestNewUser(t *testing.T) {
	srv, _, _ := StartTestServer()

	tests := []testCase{
		//{
		//	name: "a valid new account",
		//	mockHandler: func() mockClientHandler {
		//		mh := mockClientHandler{}
		//		mh.On("Handle", mock.AnythingOfType("*hotline.Client"), mock.MatchedBy(func(t *Transaction) bool {
		//			println("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@")
		//			spew.Dump(t.Type)
		//			spew.Dump(bytes.Equal(t.Type, []byte{0x01, 0x5e}))
		//			//if !bytes.Equal(t.GetField(fieldError).Data, []byte("You are not allowed to create new accounts.")) {
		//			//	return false
		//			//}
		//			return bytes.Equal(t.Type, []byte{0x01, 0x5e},
		//			)
		//		})).Return(
		//			[]Transaction{}, nil,
		//		)
		//
		//		clientHandlers[tranNewUser] = mh
		//		return mh
		//	}(),
		//	client: func() *Client {
		//		c := NewClient("testUser", NewTestLogger())
		//		return c
		//	}(),
		//	teardown: func() {
		//		_ = srv.DeleteUser("testUser")
		//	},
		//	account: Account{
		//		Login:    "test",
		//		Name:     "unnamed",
		//		Password: "test",
		//		Access:   &[]byte{255, 255, 255, 255, 255, 255, 255, 255},
		//	},
		//	request: NewTransaction(
		//		tranNewUser, nil,
		//		NewField(fieldUserLogin, []byte(NegatedUserString([]byte("testUser")))),
		//		NewField(fieldUserName, []byte("testUserName")),
		//		NewField(fieldUserPassword, []byte(NegatedUserString([]byte("testPw")))),
		//		NewField(fieldUserAccess, []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}),
		//	),
		//	want: &Transaction{
		//		Fields: []Field{},
		//	},
		//},
		//{
		//	name: "a newUser request from a user without the required access",
		//	mockHandler: func() *mockClientHandler {
		//		mh := mockClientHandler{}
		//		mh.On("Handle", mock.AnythingOfType("*hotline.Client"), mock.MatchedBy(func(t *Transaction) bool {
		//			if !bytes.Equal(t.GetField(fieldError).Data, []byte("You are not allowed to create new accounts.")) {
		//				return false
		//			}
		//			return bytes.Equal(t.Type, []byte{0x01, 0x5e})
		//		})).Return(
		//			[]Transaction{}, nil,
		//		)
		//		return &mh
		//	}(),
		//	teardown: func() {
		//		_ = srv.DeleteUser("testUser")
		//	},
		//	account: Account{
		//		Login:    "test",
		//		Name:     "unnamed",
		//		Password: "test",
		//		Access:   &[]byte{0, 0, 0, 0, 0, 0, 0, 0},
		//	},
		//	request: NewTransaction(
		//		tranNewUser, nil,
		//		NewField(fieldUserLogin, []byte(NegatedUserString([]byte("testUser")))),
		//		NewField(fieldUserName, []byte("testUserName")),
		//		NewField(fieldUserPassword, []byte(NegatedUserString([]byte("testPw")))),
		//		NewField(fieldUserAccess, []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}),
		//	),
		//},
		//{
		//	name: "when user does not have required permission",
		//	mockHandler: func() map[int]*mockClientHandler {
		//		mockHandlers := make(map[int]*mockClientHandler)
		//
		//		mh := mockClientHandler{}
		//		mh.On("Handle", mock.AnythingOfType("*hotline.Client"), mock.MatchedBy(func(t *Transaction) bool {
		//			return t.equal(Transaction{
		//				Type:      []byte{0x01, 0x5e},
		//				IsReply:   1,
		//				ErrorCode: []byte{0, 0, 0, 1},
		//				Fields: []Field{
		//					NewField(fieldError, []byte("You are not allowed to create new accounts.")),
		//				},
		//			})
		//		})).Return(
		//			[]Transaction{}, nil,
		//		)
		//		mockHandlers[tranNewUser] = &mh
		//
		//		return mockHandlers
		//	}(),
		//
		//	teardown: func() {
		//		_ = srv.DeleteUser("testUser")
		//	},
		//	account: Account{
		//		Login:    "test",
		//		Name:     "unnamed",
		//		Password: "test",
		//		Access:   &[]byte{0, 0, 0, 0, 0, 0, 0, 0},
		//	},
		//	request: NewTransaction(
		//		tranNewUser, nil,
		//		NewField(fieldUserLogin, []byte(NegatedUserString([]byte("testUser")))),
		//		NewField(fieldUserName, []byte("testUserName")),
		//		NewField(fieldUserPassword, []byte(NegatedUserString([]byte("testPw")))),
		//		NewField(fieldUserAccess, []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}),
		//	),
		//},

		//{
		//	name: "a request to create a user that already exists",
		//	setup: func() {
		//
		//	},
		//	teardown: func() {
		//		_ = srv.DeleteUser("testUser")
		//	},
		//	account: Account{
		//		Login:    "test",
		//		Name:     "unnamed",
		//		Password: "test",
		//		Access:   &[]byte{255, 255, 255, 255, 255, 255, 255, 255},
		//	},
		//	request: NewTransaction(
		//		tranNewUser, nil,
		//		NewField(fieldUserLogin, []byte(NegatedUserString([]byte("guest")))),
		//		NewField(fieldUserName, []byte("testUserName")),
		//		NewField(fieldUserPassword, []byte(NegatedUserString([]byte("testPw")))),
		//		NewField(fieldUserAccess, []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}),
		//	),
		//	want: &Transaction{
		//		Fields: []Field{
		//			NewField(fieldError, []byte("Cannot create account guest because there is already an account with that login.")),
		//		},
		//	},
		//},
	}

	for _, test := range tests {
		t.Run(test.name, func(t *testing.T) {
			test.Setup(srv)

			// move to Setup?
			c := NewClient(test.account.Name, NewTestLogger())
			err := c.JoinServer(fmt.Sprintf(":%v", srv.APIPort()), test.account.Login, test.account.Password)
			if err != nil {
				t.Errorf("login failed: %v", err)
			}
			// end move to Setup??

			for key, value := range test.mockHandler {
				c.Handlers[uint16(key)] = value
			}

			// send test case request
			_ = c.Send(*test.request)

			//time.Sleep(1 * time.Second)
			// ===

			transactions, _ := readN(c.Connection, 1)
			for _, t := range transactions {
				_ = c.HandleTransaction(&t)
			}

			// ===

			for _, handler := range test.mockHandler {
				handler.AssertExpectations(t)
			}

			test.Teardown(srv)
		})
	}
}

func tranAssertEqual(t *testing.T, tran1, tran2 []Transaction) bool {
	var newT1 []Transaction
	var newT2 []Transaction
	for _, trans := range tran1{
		trans.ID = []byte{0,0,0,0}
		newT1 = append(newT1, trans)
	}

	for _, trans := range tran2{
		trans.ID = []byte{0,0,0,0}
		newT2 = append(newT2, trans)

	}

	spew.Dump(newT1, newT2)

	return assert.Equal(t, newT1, newT2)
}
Commit	Line	Data
6988a057 JH	1	package hotline
6988a057 JH	2
625b0580 JH	3	import (
	4	"bytes"
	5	"context"
	6	"fmt"
00d1ef67 JH	7	"github.com/davecgh/go-spew/spew"
00d1ef67 JH	8	"github.com/stretchr/testify/assert"
625b0580 JH	9	"go.uber.org/zap"
	10	"go.uber.org/zap/zapcore"
	11	"net"
	12	"os"
625b0580 JH	13	"testing"
	14	)
	15
	16	type testCase struct {
	17	name string // test case description
	18	account Account // Account struct for a user that will test transaction will execute under
	19	request *Transaction // transaction that will be sent by the client to the server
	20	setup func() // Optional test-specific setup required for the scenario
	21	teardown func() // Optional test-specific teardown for the scenario
	22	mockHandler map[int]*mockClientHandler
	23	}
	24
	25	func (tt testCase) Setup(srv Server) error {
b25c4a19	26	if err := srv.NewUser(tt.account.Login, tt.account.Name, string(negateString([]byte(tt.account.Password))), *tt.account.Access); err != nil {
625b0580 JH	27	return err
	28	}
	29
	30	if tt.setup != nil {
	31	tt.setup()
	32	}
	33
	34	return nil
	35	}
	36
	37	func (tt testCase) Teardown(srv Server) error {
	38	if err := srv.DeleteUser(tt.account.Login); err != nil {
	39	return err
	40	}
	41
	42	if tt.teardown != nil {
	43	tt.teardown()
	44	}
	45
	46	return nil
	47	}
	48
	49	func NewTestLogger() *zap.SugaredLogger {
	50	encoderCfg := zap.NewProductionEncoderConfig()
	51	encoderCfg.TimeKey = "timestamp"
	52	encoderCfg.EncodeTime = zapcore.ISO8601TimeEncoder
	53
	54	core := zapcore.NewCore(
	55	zapcore.NewConsoleEncoder(encoderCfg),
	56	zapcore.Lock(os.Stdout),
	57	zap.DebugLevel,
	58	)
	59
	60	cores := []zapcore.Core{core}
	61	l := zap.New(zapcore.NewTee(cores...))
	62	defer func() { _ = l.Sync() }()
	63	return l.Sugar()
	64	}
	65
	66	func StartTestServer() (*Server, context.Context, context.CancelFunc) {
	67	ctx, cancelRoot := context.WithCancel(context.Background())
	68
	69	srv, err := NewServer("test/config/", "localhost", 0, NewTestLogger())
	70	if err != nil {
	71	panic(err)
	72	}
	73
	74	go func() {
	75	err := srv.ListenAndServe(ctx, cancelRoot)
	76	if err != nil {
	77	panic(err)
	78	}
	79	}()
	80
	81	return srv, ctx, cancelRoot
	82	}
	83
	84	func TestHandshake(t *testing.T) {
	85	srv, _, cancelFunc := StartTestServer()
	86	defer cancelFunc()
	87
	88	port := srv.APIListener.Addr().(*net.TCPAddr).Port
	89
	90	conn, err := net.Dial("tcp", fmt.Sprintf(":%v", port))
91	if err != nil {
92	t.Fatal(err)
93	}
94	defer conn.Close()
95
96	conn.Write([]byte{0x54, 0x52, 0x54, 0x50, 0x00, 0x01, 0x00, 0x00})
97
98	replyBuf := make([]byte, 8)
99	_, _ = conn.Read(replyBuf)
100
101	want := []byte{84, 82, 84, 80, 0, 0, 0, 0}
102	if bytes.Compare(replyBuf, want) != 0 {
103	t.Errorf("%q, want %q", replyBuf, want)
104	}
105
106	}
107
108	//func TestLogin(t *testing.T) {
6988a057	109	//
625b0580 JH	110	// tests := []struct {
	111	// name string
	112	// client *Client
	113	// }{
6988a057	114	// {
625b0580 JH	115	// name: "when login is successful",
625b0580 JH	116	// client: NewClient("guest", NewTestLogger()),
6988a057	117	// },
6988a057	118	// }
6988a057 JH	119	// for _, test := range tests {
6988a057 JH	120	// t.Run(test.name, func(t *testing.T) {
6988a057	121	//
6988a057 JH	122	// })
	123	// }
	124	//}
625b0580	125
625b0580 JH	126	func TestNewUser(t *testing.T) {
	127	srv, _, _ := StartTestServer()
	128
	129	tests := []testCase{
	130	//{
	131	// name: "a valid new account",
	132	// mockHandler: func() mockClientHandler {
	133	// mh := mockClientHandler{}
	134	// mh.On("Handle", mock.AnythingOfType("hotline.Client"), mock.MatchedBy(func(t Transaction) bool {
	135	// println("@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@")
	136	// spew.Dump(t.Type)
	137	// spew.Dump(bytes.Equal(t.Type, []byte{0x01, 0x5e}))
	138	// //if !bytes.Equal(t.GetField(fieldError).Data, []byte("You are not allowed to create new accounts.")) {
	139	// // return false
	140	// //}
	141	// return bytes.Equal(t.Type, []byte{0x01, 0x5e},
	142	// )
	143	// })).Return(
	144	// []Transaction{}, nil,
	145	// )
	146	//
	147	// clientHandlers[tranNewUser] = mh
	148	// return mh
	149	// }(),
	150	// client: func() *Client {
	151	// c := NewClient("testUser", NewTestLogger())
	152	// return c
	153	// }(),
	154	// teardown: func() {
	155	// _ = srv.DeleteUser("testUser")
	156	// },
	157	// account: Account{
	158	// Login: "test",
	159	// Name: "unnamed",
	160	// Password: "test",
	161	// Access: &[]byte{255, 255, 255, 255, 255, 255, 255, 255},
	162	// },
	163	// request: NewTransaction(
	164	// tranNewUser, nil,
	165	// NewField(fieldUserLogin, []byte(NegatedUserString([]byte("testUser")))),
	166	// NewField(fieldUserName, []byte("testUserName")),
	167	// NewField(fieldUserPassword, []byte(NegatedUserString([]byte("testPw")))),
	168	// NewField(fieldUserAccess, []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}),
	169	// ),
	170	// want: &Transaction{
	171	// Fields: []Field{},
	172	// },
	173	//},
	174	//{
	175	// name: "a newUser request from a user without the required access",
	176	// mockHandler: func() *mockClientHandler {
	177	// mh := mockClientHandler{}
	178	// mh.On("Handle", mock.AnythingOfType("hotline.Client"), mock.MatchedBy(func(t Transaction) bool {
	179	// if !bytes.Equal(t.GetField(fieldError).Data, []byte("You are not allowed to create new accounts.")) {
	180	// return false
	181	// }
	182	// return bytes.Equal(t.Type, []byte{0x01, 0x5e})
	183	// })).Return(
	184	// []Transaction{}, nil,
	185	// )
	186	// return &mh
	187	// }(),
	188	// teardown: func() {
	189	// _ = srv.DeleteUser("testUser")
190	// },
191	// account: Account{
192	// Login: "test",
193	// Name: "unnamed",
194	// Password: "test",
195	// Access: &[]byte{0, 0, 0, 0, 0, 0, 0, 0},
196	// },
197	// request: NewTransaction(
198	// tranNewUser, nil,
199	// NewField(fieldUserLogin, []byte(NegatedUserString([]byte("testUser")))),
200	// NewField(fieldUserName, []byte("testUserName")),
201	// NewField(fieldUserPassword, []byte(NegatedUserString([]byte("testPw")))),
202	// NewField(fieldUserAccess, []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}),
203	// ),
204	//},
205	//{
206	// name: "when user does not have required permission",
207	// mockHandler: func() map[int]*mockClientHandler {
208	// mockHandlers := make(map[int]*mockClientHandler)
209	//
210	// mh := mockClientHandler{}
211	// mh.On("Handle", mock.AnythingOfType("hotline.Client"), mock.MatchedBy(func(t Transaction) bool {
212	// return t.equal(Transaction{
213	// Type: []byte{0x01, 0x5e},
214	// IsReply: 1,
215	// ErrorCode: []byte{0, 0, 0, 1},
216	// Fields: []Field{
217	// NewField(fieldError, []byte("You are not allowed to create new accounts.")),
218	// },
219	// })
220	// })).Return(
221	// []Transaction{}, nil,
222	// )
223	// mockHandlers[tranNewUser] = &mh
224	//
225	// return mockHandlers
226	// }(),
227	//
228	// teardown: func() {
229	// _ = srv.DeleteUser("testUser")
230	// },
231	// account: Account{
232	// Login: "test",
233	// Name: "unnamed",
234	// Password: "test",
235	// Access: &[]byte{0, 0, 0, 0, 0, 0, 0, 0},
236	// },
237	// request: NewTransaction(
238	// tranNewUser, nil,
239	// NewField(fieldUserLogin, []byte(NegatedUserString([]byte("testUser")))),
240	// NewField(fieldUserName, []byte("testUserName")),
241	// NewField(fieldUserPassword, []byte(NegatedUserString([]byte("testPw")))),
242	// NewField(fieldUserAccess, []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}),
243	// ),
244	//},
245
246	//{
247	// name: "a request to create a user that already exists",
248	// setup: func() {
249	//
250	// },
251	// teardown: func() {
252	// _ = srv.DeleteUser("testUser")
253	// },
254	// account: Account{
255	// Login: "test",
256	// Name: "unnamed",
257	// Password: "test",
258	// Access: &[]byte{255, 255, 255, 255, 255, 255, 255, 255},
259	// },
260	// request: NewTransaction(
261	// tranNewUser, nil,
262	// NewField(fieldUserLogin, []byte(NegatedUserString([]byte("guest")))),
263	// NewField(fieldUserName, []byte("testUserName")),
264	// NewField(fieldUserPassword, []byte(NegatedUserString([]byte("testPw")))),
265	// NewField(fieldUserAccess, []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}),
266	// ),
267	// want: &Transaction{
268	// Fields: []Field{
269	// NewField(fieldError, []byte("Cannot create account guest because there is already an account with that login.")),
270	// },
271	// },
272	//},
273	}
274
275	for _, test := range tests {
276	t.Run(test.name, func(t *testing.T) {
277	test.Setup(srv)
278
279	// move to Setup?
280	c := NewClient(test.account.Name, NewTestLogger())
281	err := c.JoinServer(fmt.Sprintf(":%v", srv.APIPort()), test.account.Login, test.account.Password)
282	if err != nil {
283	t.Errorf("login failed: %v", err)
284	}
285	// end move to Setup??
286
287	for key, value := range test.mockHandler {
288	c.Handlers[uint16(key)] = value
289	}
290
291	// send test case request
292	_ = c.Send(*test.request)
293
294	//time.Sleep(1 * time.Second)
295	// ===
296
297	transactions, _ := readN(c.Connection, 1)
298	for _, t := range transactions {
299	_ = c.HandleTransaction(&t)
300	}
301
302	// ===
303
304	for _, handler := range test.mockHandler {
305	handler.AssertExpectations(t)
306	}
307
308	test.Teardown(srv)
309	})
310	}
311	}
312
00d1ef67 JH	313	func tranAssertEqual(t *testing.T, tran1, tran2 []Transaction) bool {
	314	var newT1 []Transaction
	315	var newT2 []Transaction
	316	for _, trans := range tran1{
	317	trans.ID = []byte{0,0,0,0}
	318	newT1 = append(newT1, trans)
	319	}
625b0580	320
00d1ef67 JH	321	for _, trans := range tran2{
	322	trans.ID = []byte{0,0,0,0}
	323	newT2 = append(newT2, trans)
625b0580	324
00d1ef67	325	}
625b0580	326
00d1ef67	327	spew.Dump(newT1, newT2)
625b0580	328
00d1ef67 JH	329	return assert.Equal(t, newT1, newT2)
00d1ef67 JH	330	}