mirror of
https://github.com/sorenisanerd/gotty.git
synced 2024-12-26 00:27:30 +00:00
Improve webtty test coverage
This commit is contained in:
Søren L. Hansen
parent
6c62ab74b7
commit
f61763f716
@ -9,38 +9,50 @@ import (
|
||||
"testing"
|
||||
)
|
||||
|
||||
type mockMaster struct {
|
||||
gottyToMasterReader io.Reader
|
||||
gottyToMasterWriter io.Writer
|
||||
masterToGottyReader io.Reader
|
||||
masterToGottyWriter io.Writer
|
||||
}
|
||||
|
||||
type mockSlave struct {
|
||||
gottyToSlaveReader io.Reader
|
||||
gottyToSlaveWriter io.Writer
|
||||
slaveToGottyReader io.Reader
|
||||
slaveToGottyWriter io.Writer
|
||||
columns, rows int
|
||||
}
|
||||
|
||||
func TestWriteFromPTY(t *testing.T) {
|
||||
mMaster := newMockMaster()
|
||||
mSlave := newMockSlave()
|
||||
|
||||
dt, err := New(mMaster, mSlave)
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error from New(): %s", err)
|
||||
}
|
||||
|
||||
// Launch GoTTY
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
func TestInitialization(t *testing.T) {
|
||||
var wg sync.WaitGroup
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
wg.Done()
|
||||
dt.Run(ctx)
|
||||
}()
|
||||
defer wg.Wait()
|
||||
|
||||
mMaster, _, _, cancel := prepareSUT(t, &wg)
|
||||
defer cancel()
|
||||
|
||||
// Check that the initialization happens as expected
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetWindowTitle)
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetBufferSize)
|
||||
}
|
||||
|
||||
func TestInitializationWithPreferences(t *testing.T) {
|
||||
var wg sync.WaitGroup
|
||||
defer wg.Wait()
|
||||
|
||||
mMaster, _, _, cancel := prepareSUT(t, &wg, WithMasterPreferences(map[string]string{"foo": "bar"}))
|
||||
defer cancel()
|
||||
|
||||
// Check that the initialization happens as expected
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetWindowTitle)
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetBufferSize)
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetPreferences)
|
||||
}
|
||||
|
||||
func TestInitializationWithReconnect(t *testing.T) {
|
||||
var wg sync.WaitGroup
|
||||
defer wg.Wait()
|
||||
|
||||
mMaster, _, _, cancel := prepareSUT(t, &wg, WithReconnect(10))
|
||||
defer cancel()
|
||||
|
||||
// Check that the initialization happens as expected
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetWindowTitle)
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetBufferSize)
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetReconnect)
|
||||
}
|
||||
|
||||
func TestWriteFromSlaveCommand(t *testing.T) {
|
||||
var wg sync.WaitGroup
|
||||
defer wg.Wait()
|
||||
|
||||
mMaster, mSlave, _, cancel := prepareSUT(t, &wg)
|
||||
defer cancel()
|
||||
|
||||
// Check that the initialization happens as expected
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetWindowTitle)
|
||||
@ -48,17 +60,12 @@ func TestWriteFromPTY(t *testing.T) {
|
||||
|
||||
// Simulate the slave (the process being run by GoTTY)
|
||||
// echoing "foobar"
|
||||
buf := make([]byte, 1024)
|
||||
message := []byte("foobar")
|
||||
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
dt.handleSlaveReadEvent(message)
|
||||
wg.Done()
|
||||
}()
|
||||
mSlave.slaveToGottyWriter.Write(message)
|
||||
|
||||
// And then make sure it makes it way to the client
|
||||
// through the websocket as an output message
|
||||
buf := make([]byte, 1024)
|
||||
n, err := mMaster.gottyToMasterReader.Read(buf)
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error from Read(): %s", err)
|
||||
@ -80,9 +87,137 @@ func TestWriteFromPTY(t *testing.T) {
|
||||
cancel()
|
||||
wg.Wait()
|
||||
}
|
||||
func TestWriteFromFrontend(t *testing.T) {
|
||||
var wg sync.WaitGroup
|
||||
defer wg.Wait()
|
||||
|
||||
func checkNextMsgType(t *testing.T, connInPipeReader io.Reader, expected byte) {
|
||||
msgType, _ := nextMsg(t, connInPipeReader)
|
||||
mMaster, mSlave, _, cancel := prepareSUT(t, &wg, WithPermitWrite())
|
||||
defer cancel()
|
||||
|
||||
// Absorb initialization messages
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetWindowTitle)
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetBufferSize)
|
||||
|
||||
// simulate input from frontend...
|
||||
message := []byte("1hello\n") // line buffered canonical mode
|
||||
mMaster.masterToGottyWriter.Write(message)
|
||||
|
||||
// ...and make sure it makes it through to the slave intact
|
||||
readBuf := make([]byte, 1024)
|
||||
n, err := mSlave.gottyToSlaveReader.Read(readBuf)
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error from Write(): %s", err)
|
||||
}
|
||||
if !bytes.Equal(readBuf[:n], message[1:]) {
|
||||
t.Fatalf("Unexpected message received: `%s`", readBuf[:n])
|
||||
}
|
||||
}
|
||||
|
||||
func TestPing(t *testing.T) {
|
||||
var wg sync.WaitGroup
|
||||
defer wg.Wait()
|
||||
|
||||
mMaster, _, _, cancel := prepareSUT(t, &wg)
|
||||
defer cancel()
|
||||
|
||||
// Absorb initialization messages
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetWindowTitle)
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetBufferSize)
|
||||
|
||||
// ping
|
||||
message := []byte("2\n") // line buffered canonical mode
|
||||
n, err := mMaster.masterToGottyWriter.Write(message)
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error from Write(): %s", err)
|
||||
}
|
||||
if n != len(message) {
|
||||
t.Fatalf("Write() accepted `%d` for message `%s`", n, message)
|
||||
}
|
||||
|
||||
readBuf := make([]byte, 1024)
|
||||
n, err = mMaster.gottyToMasterReader.Read(readBuf)
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error from Read(): %s", err)
|
||||
}
|
||||
if !bytes.Equal(readBuf[:n], []byte{'2'}) {
|
||||
t.Fatalf("Unexpected message received: `%s`", readBuf[:n])
|
||||
}
|
||||
|
||||
cancel()
|
||||
wg.Wait()
|
||||
}
|
||||
|
||||
func TestResizeTerminal(t *testing.T) {
|
||||
var wg sync.WaitGroup
|
||||
defer wg.Wait()
|
||||
|
||||
mMaster, mSlave, _, cancel := prepareSUT(t, &wg)
|
||||
defer cancel()
|
||||
|
||||
// Absorb initialization messages
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetWindowTitle)
|
||||
checkNextMsgType(t, mMaster.gottyToMasterReader, SetBufferSize)
|
||||
|
||||
message := []byte(`3{"Columns": 1234, "Rows": 2345}` + "\n") // line buffered canonical mode
|
||||
|
||||
mSlave.wg.Add(1)
|
||||
n, err := mMaster.masterToGottyWriter.Write(message)
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error from Write(): %s", err)
|
||||
}
|
||||
if n != len(message) {
|
||||
t.Fatalf("Write() accepted `%d` for message `%s`", n, message)
|
||||
}
|
||||
mSlave.wg.Wait()
|
||||
|
||||
if mSlave.columns != 1234 {
|
||||
t.Fatalf("Columns not set correctly. Expected %v, got %v", 1234, mSlave.columns)
|
||||
}
|
||||
|
||||
if mSlave.rows != 2345 {
|
||||
t.Fatalf("Rows not set correctly. Expected %v, got %v", 2345, mSlave.columns)
|
||||
}
|
||||
|
||||
cancel()
|
||||
wg.Wait()
|
||||
}
|
||||
|
||||
type mockMaster struct {
|
||||
gottyToMasterReader *io.PipeReader
|
||||
gottyToMasterWriter *io.PipeWriter
|
||||
masterToGottyReader *io.PipeReader
|
||||
masterToGottyWriter *io.PipeWriter
|
||||
}
|
||||
|
||||
type mockSlave struct {
|
||||
gottyToSlaveReader *io.PipeReader
|
||||
gottyToSlaveWriter *io.PipeWriter
|
||||
slaveToGottyReader *io.PipeReader
|
||||
slaveToGottyWriter *io.PipeWriter
|
||||
wg sync.WaitGroup
|
||||
columns, rows int
|
||||
}
|
||||
|
||||
func prepareSUT(t *testing.T, wg *sync.WaitGroup, options ...Option) (*mockMaster, *mockSlave, *WebTTY, context.CancelFunc) {
|
||||
mMaster := newMockMaster()
|
||||
mSlave := newMockSlave()
|
||||
|
||||
dt, err := New(mMaster, mSlave, options...)
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error from New(): %s", err)
|
||||
}
|
||||
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
wg.Done()
|
||||
dt.Run(ctx)
|
||||
}()
|
||||
return mMaster, mSlave, dt, cancel
|
||||
}
|
||||
|
||||
func checkNextMsgType(t *testing.T, reader io.Reader, expected byte) {
|
||||
msgType, _ := nextMsg(t, reader)
|
||||
if msgType != expected {
|
||||
t.Fatalf("Unexpected message type `%c`", msgType)
|
||||
}
|
||||
@ -97,75 +232,6 @@ func nextMsg(t *testing.T, reader io.Reader) (byte, []byte) {
|
||||
return buf[0], buf[1:]
|
||||
}
|
||||
|
||||
func TestWriteFromConn(t *testing.T) {
|
||||
mMaster := newMockMaster()
|
||||
mSlave := newMockSlave()
|
||||
|
||||
dt, err := New(mMaster, mSlave, WithPermitWrite())
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error from New(): %s", err)
|
||||
}
|
||||
|
||||
// Launch GoTTY
|
||||
ctx, cancel := context.WithCancel(context.Background())
|
||||
var wg sync.WaitGroup
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
wg.Done()
|
||||
dt.Run(ctx)
|
||||
}()
|
||||
|
||||
var (
|
||||
message []byte
|
||||
n int
|
||||
)
|
||||
readBuf := make([]byte, 1024)
|
||||
|
||||
// Absorb initialization messages
|
||||
mMaster.gottyToMasterReader.Read(readBuf)
|
||||
mMaster.gottyToMasterReader.Read(readBuf)
|
||||
|
||||
// simulate input from frontend...
|
||||
message = []byte("1hello\n") // line buffered canonical mode
|
||||
wg.Add(1)
|
||||
go func() {
|
||||
dt.handleMasterReadEvent(message)
|
||||
wg.Done()
|
||||
}()
|
||||
|
||||
// ...and make sure it makes it through to the slave intact
|
||||
n, err = mSlave.gottyToSlaveReader.Read(readBuf)
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error from Write(): %s", err)
|
||||
}
|
||||
if !bytes.Equal(readBuf[:n], message[1:]) {
|
||||
t.Fatalf("Unexpected message received: `%s`", readBuf[:n])
|
||||
}
|
||||
|
||||
// ping
|
||||
message = []byte("2\n") // line buffered canonical mode
|
||||
n, err = mMaster.masterToGottyWriter.Write(message)
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error from Write(): %s", err)
|
||||
}
|
||||
if n != len(message) {
|
||||
t.Fatalf("Write() accepted `%d` for message `%s`", n, message)
|
||||
}
|
||||
|
||||
n, err = mMaster.gottyToMasterReader.Read(readBuf)
|
||||
if err != nil {
|
||||
t.Fatalf("Unexpected error from Read(): %s", err)
|
||||
}
|
||||
if !bytes.Equal(readBuf[:n], []byte{'2'}) {
|
||||
t.Fatalf("Unexpected message received: `%s`", readBuf[:n])
|
||||
}
|
||||
|
||||
// TODO: resize
|
||||
|
||||
cancel()
|
||||
wg.Wait()
|
||||
}
|
||||
|
||||
func newMockMaster() *mockMaster {
|
||||
rv := &mockMaster{}
|
||||
rv.gottyToMasterReader, rv.gottyToMasterWriter = io.Pipe()
|
||||
@ -173,6 +239,11 @@ func newMockMaster() *mockMaster {
|
||||
return rv
|
||||
}
|
||||
|
||||
func (mm *mockMaster) close() {
|
||||
mm.masterToGottyWriter.Close()
|
||||
mm.gottyToMasterReader.Close()
|
||||
}
|
||||
|
||||
func (mm *mockMaster) Read(buf []byte) (int, error) {
|
||||
return mm.masterToGottyReader.Read(buf)
|
||||
}
|
||||
@ -188,6 +259,11 @@ func newMockSlave() *mockSlave {
|
||||
return rv
|
||||
}
|
||||
|
||||
func (ms *mockSlave) close() {
|
||||
ms.slaveToGottyWriter.Close()
|
||||
ms.gottyToSlaveReader.Close()
|
||||
}
|
||||
|
||||
func (ms *mockSlave) Read(buf []byte) (int, error) {
|
||||
return ms.slaveToGottyReader.Read(buf)
|
||||
}
|
||||
@ -203,5 +279,6 @@ func (ms *mockSlave) WindowTitleVariables() map[string]interface{} {
|
||||
func (ms *mockSlave) ResizeTerminal(columns int, rows int) error {
|
||||
ms.columns = columns
|
||||
ms.rows = rows
|
||||
ms.wg.Done()
|
||||
return nil
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user