mirror of
https://github.com/mum4k/termdash.git
synced 2025-04-27 13:48:49 +08:00
562 lines
15 KiB
Go
562 lines
15 KiB
Go
// Copyright 2019 Google Inc.
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package segmentdisplay
|
|
|
|
import (
|
|
"image"
|
|
"testing"
|
|
|
|
"github.com/kylelemons/godebug/pretty"
|
|
"github.com/mum4k/termdash/align"
|
|
"github.com/mum4k/termdash/canvas"
|
|
"github.com/mum4k/termdash/canvas/testcanvas"
|
|
"github.com/mum4k/termdash/cell"
|
|
"github.com/mum4k/termdash/draw/segdisp/sixteen"
|
|
"github.com/mum4k/termdash/draw/segdisp/sixteen/testsixteen"
|
|
"github.com/mum4k/termdash/terminal/faketerm"
|
|
"github.com/mum4k/termdash/terminalapi"
|
|
"github.com/mum4k/termdash/widgetapi"
|
|
)
|
|
|
|
// mustDrawChar draws the provided character in the area of the canvas or panics.
|
|
func mustDrawChar(cvs *canvas.Canvas, char rune, ar image.Rectangle, opts ...sixteen.Option) {
|
|
d := sixteen.New()
|
|
testsixteen.MustSetCharacter(d, char)
|
|
c := testcanvas.MustNew(ar)
|
|
testsixteen.MustDraw(d, c, opts...)
|
|
testcanvas.MustCopyTo(c, cvs)
|
|
}
|
|
|
|
func TestSegmentDisplay(t *testing.T) {
|
|
tests := []struct {
|
|
desc string
|
|
opts []Option
|
|
update func(*SegmentDisplay) error // update gets called before drawing of the widget.
|
|
canvas image.Rectangle
|
|
want func(size image.Point) *faketerm.Terminal
|
|
wantUpdateErr bool // whether to expect an error on a call to the update function
|
|
wantDrawErr bool
|
|
}{
|
|
{
|
|
desc: "fails on area too small for a segment",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols-1, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("1"))
|
|
},
|
|
wantDrawErr: true,
|
|
},
|
|
{
|
|
desc: "write fails without chunks",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write()
|
|
},
|
|
wantUpdateErr: true,
|
|
},
|
|
{
|
|
desc: "write fails on unsupported characters when requested",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk(".", WriteErrOnUnsupported()))
|
|
},
|
|
wantUpdateErr: true,
|
|
},
|
|
{
|
|
desc: "draws empty without text",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows),
|
|
},
|
|
{
|
|
desc: "draws multiple segments, all fit exactly",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols*3, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("123"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
for _, tc := range []struct {
|
|
char rune
|
|
area image.Rectangle
|
|
}{
|
|
{'1', image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows)},
|
|
{'2', image.Rect(sixteen.MinCols, 0, sixteen.MinCols*2, sixteen.MinRows)},
|
|
{'3', image.Rect(sixteen.MinCols*2, 0, sixteen.MinCols*3, sixteen.MinRows)},
|
|
} {
|
|
mustDrawChar(cvs, tc.char, tc.area)
|
|
}
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "write sanitizes text by default",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols*2, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk(".1"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '1', image.Rect(sixteen.MinCols, 0, sixteen.MinCols*2, sixteen.MinRows))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "write sanitizes text with option",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols*2, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk(".1", WriteSanitize()))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '1', image.Rect(sixteen.MinCols, 0, sixteen.MinCols*2, sixteen.MinRows))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "aligns segment vertical middle by default",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows+2),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("1"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '1', image.Rect(0, 1, sixteen.MinCols, sixteen.MinRows+1))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "subsequent calls to write overwrite previous text",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows+2),
|
|
update: func(sd *SegmentDisplay) error {
|
|
if err := sd.Write(NewChunk("123")); err != nil {
|
|
return err
|
|
}
|
|
return sd.Write(NewChunk("1"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '1', image.Rect(0, 1, sixteen.MinCols, sixteen.MinRows+1))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "sets cell options per text chunk",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols*2, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(
|
|
NewChunk("1", WriteCellOpts(
|
|
cell.FgColor(cell.ColorRed),
|
|
cell.BgColor(cell.ColorBlue),
|
|
)),
|
|
NewChunk("2", WriteCellOpts(
|
|
cell.FgColor(cell.ColorGreen),
|
|
cell.BgColor(cell.ColorYellow),
|
|
)),
|
|
)
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(
|
|
cvs, '1',
|
|
image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows),
|
|
sixteen.CellOpts(
|
|
cell.FgColor(cell.ColorRed),
|
|
cell.BgColor(cell.ColorBlue),
|
|
),
|
|
)
|
|
mustDrawChar(
|
|
cvs, '2',
|
|
image.Rect(sixteen.MinCols, 0, sixteen.MinCols*2, sixteen.MinRows),
|
|
sixteen.CellOpts(
|
|
cell.FgColor(cell.ColorGreen),
|
|
cell.BgColor(cell.ColorYellow),
|
|
),
|
|
)
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "reset resets the text content",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows+2),
|
|
update: func(sd *SegmentDisplay) error {
|
|
if err := sd.Write(NewChunk("123")); err != nil {
|
|
return err
|
|
}
|
|
sd.Reset()
|
|
return nil
|
|
},
|
|
},
|
|
{
|
|
desc: "reset resets provided cell options",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
if err := sd.Write(
|
|
NewChunk("1", WriteCellOpts(
|
|
cell.FgColor(cell.ColorRed),
|
|
cell.BgColor(cell.ColorBlue),
|
|
)),
|
|
); err != nil {
|
|
return err
|
|
}
|
|
sd.Reset()
|
|
return sd.Write(NewChunk("1"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '1', image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "aligns segment vertical middle with option",
|
|
opts: []Option{
|
|
AlignVertical(align.VerticalMiddle),
|
|
},
|
|
canvas: image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows+2),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("1"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '1', image.Rect(0, 1, sixteen.MinCols, sixteen.MinRows+1))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "aligns segment vertical top with option",
|
|
opts: []Option{
|
|
AlignVertical(align.VerticalTop),
|
|
},
|
|
canvas: image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows+2),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("1"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '1', image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "aligns segment vertical bottom with option",
|
|
opts: []Option{
|
|
AlignVertical(align.VerticalBottom),
|
|
},
|
|
canvas: image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows+2),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("1"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '1', image.Rect(0, 2, sixteen.MinCols, sixteen.MinRows+2))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "aligns segment horizontal center by default",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols+2, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("8"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '8', image.Rect(1, 0, sixteen.MinCols+1, sixteen.MinRows))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "aligns segment horizontal center with option",
|
|
opts: []Option{
|
|
AlignHorizontal(align.HorizontalCenter),
|
|
},
|
|
canvas: image.Rect(0, 0, sixteen.MinCols+2, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("8"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '8', image.Rect(1, 0, sixteen.MinCols+1, sixteen.MinRows))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "aligns segment horizontal left with option",
|
|
opts: []Option{
|
|
AlignHorizontal(align.HorizontalLeft),
|
|
},
|
|
canvas: image.Rect(0, 0, sixteen.MinCols+2, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("8"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '8', image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "aligns segment horizontal right with option",
|
|
opts: []Option{
|
|
AlignHorizontal(align.HorizontalRight),
|
|
},
|
|
canvas: image.Rect(0, 0, sixteen.MinCols+2, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("8"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
mustDrawChar(cvs, '8', image.Rect(2, 0, sixteen.MinCols+2, sixteen.MinRows))
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "draws multiple segments, not enough space, maximizes segment height with option",
|
|
opts: []Option{
|
|
MaximizeSegmentHeight(),
|
|
},
|
|
canvas: image.Rect(0, 0, sixteen.MinCols*2, sixteen.MinRows),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("123"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
for _, tc := range []struct {
|
|
char rune
|
|
area image.Rectangle
|
|
}{
|
|
{'1', image.Rect(0, 0, sixteen.MinCols, sixteen.MinRows)},
|
|
{'2', image.Rect(sixteen.MinCols, 0, sixteen.MinCols*2, sixteen.MinRows)},
|
|
} {
|
|
mustDrawChar(cvs, tc.char, tc.area)
|
|
}
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "draws multiple segments, not enough space, maximizes displayed text by default and fits all",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols*3, sixteen.MinRows*4),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("123"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
for _, tc := range []struct {
|
|
char rune
|
|
area image.Rectangle
|
|
}{
|
|
{'1', image.Rect(0, 7, 6, 12)},
|
|
{'2', image.Rect(6, 7, 12, 12)},
|
|
{'3', image.Rect(12, 7, 18, 12)},
|
|
} {
|
|
mustDrawChar(cvs, tc.char, tc.area)
|
|
}
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "draws multiple segments, not enough space, maximizes displayed text but cannot fit all",
|
|
canvas: image.Rect(0, 0, sixteen.MinCols*3, sixteen.MinRows*4),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("1234"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
for _, tc := range []struct {
|
|
char rune
|
|
area image.Rectangle
|
|
}{
|
|
{'1', image.Rect(0, 7, 6, 12)},
|
|
{'2', image.Rect(6, 7, 12, 12)},
|
|
{'3', image.Rect(12, 7, 18, 12)},
|
|
} {
|
|
mustDrawChar(cvs, tc.char, tc.area)
|
|
}
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
{
|
|
desc: "draws multiple segments, not enough space, maximizes displayed text with option",
|
|
opts: []Option{
|
|
MaximizeDisplayedText(),
|
|
},
|
|
canvas: image.Rect(0, 0, sixteen.MinCols*3, sixteen.MinRows*4),
|
|
update: func(sd *SegmentDisplay) error {
|
|
return sd.Write(NewChunk("123"))
|
|
},
|
|
want: func(size image.Point) *faketerm.Terminal {
|
|
ft := faketerm.MustNew(size)
|
|
cvs := testcanvas.MustNew(ft.Area())
|
|
|
|
for _, tc := range []struct {
|
|
char rune
|
|
area image.Rectangle
|
|
}{
|
|
{'1', image.Rect(0, 7, 6, 12)},
|
|
{'2', image.Rect(6, 7, 12, 12)},
|
|
{'3', image.Rect(12, 7, 18, 12)},
|
|
} {
|
|
mustDrawChar(cvs, tc.char, tc.area)
|
|
}
|
|
|
|
testcanvas.MustApply(cvs, ft)
|
|
return ft
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.desc, func(t *testing.T) {
|
|
sd := New(tc.opts...)
|
|
c, err := canvas.New(tc.canvas)
|
|
if err != nil {
|
|
t.Fatalf("canvas.New => unexpected error: %v", err)
|
|
}
|
|
|
|
if tc.update != nil {
|
|
err = tc.update(sd)
|
|
if (err != nil) != tc.wantUpdateErr {
|
|
t.Errorf("update => unexpected error: %v, wantUpdateErr: %v", err, tc.wantUpdateErr)
|
|
|
|
}
|
|
if err != nil {
|
|
return
|
|
}
|
|
}
|
|
|
|
err = sd.Draw(c)
|
|
if (err != nil) != tc.wantDrawErr {
|
|
t.Errorf("Draw => unexpected error: %v, wantDrawErr: %v", err, tc.wantDrawErr)
|
|
}
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
got, err := faketerm.New(c.Size())
|
|
if err != nil {
|
|
t.Fatalf("faketerm.New => unexpected error: %v", err)
|
|
}
|
|
|
|
if err := c.Apply(got); err != nil {
|
|
t.Fatalf("Apply => unexpected error: %v", err)
|
|
}
|
|
|
|
var want *faketerm.Terminal
|
|
if tc.want != nil {
|
|
want = tc.want(c.Size())
|
|
} else {
|
|
want = faketerm.MustNew(c.Size())
|
|
}
|
|
|
|
if diff := faketerm.Diff(want, got); diff != "" {
|
|
t.Errorf("Draw => %v", diff)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestKeyboard(t *testing.T) {
|
|
sd := New()
|
|
if err := sd.Keyboard(&terminalapi.Keyboard{}); err == nil {
|
|
t.Errorf("Keyboard => got nil err, wanted one")
|
|
}
|
|
}
|
|
|
|
func TestMouse(t *testing.T) {
|
|
sd := New()
|
|
if err := sd.Mouse(&terminalapi.Mouse{}); err == nil {
|
|
t.Errorf("Mouse => got nil err, wanted one")
|
|
}
|
|
}
|
|
|
|
func TestOptions(t *testing.T) {
|
|
sd := New()
|
|
got := sd.Options()
|
|
want := widgetapi.Options{
|
|
MinimumSize: image.Point{sixteen.MinCols, sixteen.MinRows},
|
|
WantKeyboard: false,
|
|
WantMouse: false,
|
|
}
|
|
if diff := pretty.Compare(want, got); diff != "" {
|
|
t.Errorf("Options => unexpected diff (-want, +got):\n%s", diff)
|
|
}
|
|
|
|
}
|