termdash/mouse/button/button_test.go

package button

import (
	"fmt"
	"image"
	"testing"

	"github.com/mum4k/termdash/mouse"
	"github.com/mum4k/termdash/terminalapi"
)

// eventTestCase is one mouse event and the output expectation.
type eventTestCase struct {
	// event is the mouse event to send.
	event *terminalapi.Mouse

	// wantClick indicates whether we expect the FSM to recognize a mouse click.
	wantClick bool

	// wantState is the expected button state.
	wantState State
}

func TestFSM(t *testing.T) {
	tests := []struct {
		desc       string
		button     mouse.Button
		area       image.Rectangle
		eventCases []*eventTestCase
	}{
		{
			desc:   "tracks single left button click",
			button: mouse.ButtonLeft,
			area:   image.Rect(0, 0, 1, 1),
			eventCases: []*eventTestCase{
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Down,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRelease},
					wantClick: true,
					wantState: Up,
				},
			},
		},
		{
			desc:   "tracks single right button click",
			button: mouse.ButtonRight,
			area:   image.Rect(0, 0, 1, 1),
			eventCases: []*eventTestCase{
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRight},
					wantClick: false,
					wantState: Down,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRelease},
					wantClick: true,
					wantState: Up,
				},
			},
		},
		{
			desc:   "ignores unrelated button in state wantPress",
			button: mouse.ButtonLeft,
			area:   image.Rect(0, 0, 1, 1),
			eventCases: []*eventTestCase{
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRight},
					wantClick: false,
					wantState: Up,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRelease},
					wantClick: false,
					wantState: Up,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Down,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRelease},
					wantClick: true,
					wantState: Up,
				},
			},
		},
		{
			desc:   "reverts to wantPress on unrelated button in state wantRelease",
			button: mouse.ButtonLeft,
			area:   image.Rect(0, 0, 1, 1),
			eventCases: []*eventTestCase{
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Down,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRight},
					wantClick: false,
					wantState: Up,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRelease},
					wantClick: false,
					wantState: Up,
				},
			},
		},
		{
			desc:   "reports button as down when the tracked button is pressed again in the area",
			button: mouse.ButtonLeft,
			area:   image.Rect(0, 0, 1, 1),
			eventCases: []*eventTestCase{
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Down,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Down,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRelease},
					wantClick: true,
					wantState: Up,
				},
			},
		},
		{
			desc:   "reports button as up when the tracked button is pressed again outside the area",
			button: mouse.ButtonLeft,
			area:   image.Rect(0, 0, 1, 1),
			eventCases: []*eventTestCase{
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Down,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{1, 1}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Up,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Down,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRelease},
					wantClick: true,
					wantState: Up,
				},
			},
		},
		{
			desc:   "ignores clicks outside of area in state wantPress",
			button: mouse.ButtonLeft,
			area:   image.Rect(0, 0, 1, 1),
			eventCases: []*eventTestCase{
				{
					event:     &terminalapi.Mouse{Position: image.Point{1, 1}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Up,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{1, 1}, Button: mouse.ButtonRelease},
					wantClick: false,
					wantState: Up,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Down,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRelease},
					wantClick: true,
					wantState: Up,
				},
			},
		},
		{
			desc:   "release outside of area releases button too",
			button: mouse.ButtonLeft,
			area:   image.Rect(0, 0, 1, 1),
			eventCases: []*eventTestCase{
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Down,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{1, 1}, Button: mouse.ButtonRelease},
					wantClick: false,
					wantState: Up,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonLeft},
					wantClick: false,
					wantState: Down,
				},
				{
					event:     &terminalapi.Mouse{Position: image.Point{0, 0}, Button: mouse.ButtonRelease},
					wantClick: true,
					wantState: Up,
				},
			},
		},
	}

	for _, tc := range tests {
		t.Run(fmt.Sprintf(tc.desc), func(t *testing.T) {
			fsm := NewFSM(tc.button, tc.area)
			for _, etc := range tc.eventCases {
				gotClick, gotState := fsm.Event(etc.event)
				t.Logf("Called fsm.Event(%v) => %v, %v", etc.event, gotClick, gotState)
				if gotClick != etc.wantClick || gotState != etc.wantState {
					t.Errorf("fsm.Event(%v) => %v, %v, want %v, %v", etc.event, gotClick, gotState, etc.wantClick, etc.wantState)
				}
			}
		})
	}
}