mirror of
https://github.com/mum4k/termdash.git
synced 2025-04-25 13:48:50 +08:00
534 lines
12 KiB
Go
534 lines
12 KiB
Go
// Copyright 2018 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 canvas
|
|
|
|
import (
|
|
"image"
|
|
"testing"
|
|
|
|
"github.com/kylelemons/godebug/pretty"
|
|
"github.com/mum4k/termdash/area"
|
|
"github.com/mum4k/termdash/cell"
|
|
"github.com/mum4k/termdash/terminal/faketerm"
|
|
)
|
|
|
|
func TestNew(t *testing.T) {
|
|
tests := []struct {
|
|
desc string
|
|
area image.Rectangle
|
|
wantSize image.Point
|
|
wantArea image.Rectangle
|
|
wantErr bool
|
|
}{
|
|
{
|
|
desc: "area min has negative X",
|
|
area: image.Rect(-1, 0, 0, 0),
|
|
wantErr: true,
|
|
},
|
|
{
|
|
desc: "area min has negative Y",
|
|
area: image.Rect(0, -1, 0, 0),
|
|
wantErr: true,
|
|
},
|
|
{
|
|
desc: "area max has negative X",
|
|
area: image.Rect(0, 0, -1, 0),
|
|
wantErr: true,
|
|
},
|
|
{
|
|
desc: "area max has negative Y",
|
|
area: image.Rect(0, 0, 0, -1),
|
|
wantErr: true,
|
|
},
|
|
{
|
|
desc: "zero area is invalid",
|
|
area: image.Rect(0, 0, 0, 0),
|
|
wantErr: true,
|
|
},
|
|
{
|
|
desc: "smallest valid size",
|
|
area: image.Rect(0, 0, 1, 1),
|
|
wantSize: image.Point{1, 1},
|
|
wantArea: image.Rect(0, 0, 1, 1),
|
|
},
|
|
{
|
|
desc: "rectangular canvas 3 by 4",
|
|
area: image.Rect(0, 0, 3, 4),
|
|
wantSize: image.Point{3, 4},
|
|
wantArea: image.Rect(0, 0, 3, 4),
|
|
},
|
|
{
|
|
desc: "non-zero based area",
|
|
area: image.Rect(1, 1, 2, 3),
|
|
wantSize: image.Point{1, 2},
|
|
wantArea: image.Rect(0, 0, 1, 2),
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.desc, func(t *testing.T) {
|
|
c, err := New(tc.area)
|
|
if (err != nil) != tc.wantErr {
|
|
t.Errorf("New => unexpected error: %v, wantErr: %v", err, tc.wantErr)
|
|
}
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
gotSize := c.Size()
|
|
if diff := pretty.Compare(tc.wantSize, gotSize); diff != "" {
|
|
t.Errorf("Size => unexpected diff (-want, +got):\n%s", diff)
|
|
}
|
|
|
|
gotArea := c.Area()
|
|
if diff := pretty.Compare(tc.wantArea, gotArea); diff != "" {
|
|
t.Errorf("Area => unexpected diff (-want, +got):\n%s", diff)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestSetCellAndApply(t *testing.T) {
|
|
tests := []struct {
|
|
desc string
|
|
termSize image.Point
|
|
canvasArea image.Rectangle
|
|
point image.Point
|
|
r rune
|
|
opts []cell.Option
|
|
want cell.Buffer // Expected back buffer in the fake terminal.
|
|
wantCells int
|
|
wantSetCellErr bool
|
|
wantApplyErr bool
|
|
}{
|
|
{
|
|
desc: "setting cell outside the designated area",
|
|
termSize: image.Point{2, 2},
|
|
canvasArea: image.Rect(0, 0, 1, 1),
|
|
point: image.Point{0, 2},
|
|
wantSetCellErr: true,
|
|
},
|
|
{
|
|
desc: "sets a top-left corner cell",
|
|
termSize: image.Point{3, 3},
|
|
canvasArea: image.Rect(1, 1, 3, 3),
|
|
point: image.Point{0, 0},
|
|
r: 'X',
|
|
wantCells: 1,
|
|
want: cell.Buffer{
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New('X'),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "sets a full-width rune in the top-left corner cell",
|
|
termSize: image.Point{3, 3},
|
|
canvasArea: image.Rect(1, 1, 3, 3),
|
|
point: image.Point{0, 0},
|
|
r: '界',
|
|
wantCells: 2,
|
|
want: cell.Buffer{
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New('界'),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "not enough space for a full-width rune",
|
|
termSize: image.Point{3, 3},
|
|
canvasArea: image.Rect(1, 1, 3, 3),
|
|
point: image.Point{1, 0},
|
|
r: '界',
|
|
wantSetCellErr: true,
|
|
},
|
|
{
|
|
desc: "sets a top-right corner cell",
|
|
termSize: image.Point{3, 3},
|
|
canvasArea: image.Rect(1, 1, 3, 3),
|
|
point: image.Point{1, 0},
|
|
r: 'X',
|
|
wantCells: 1,
|
|
want: cell.Buffer{
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New('X'),
|
|
cell.New(0),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "sets a bottom-left corner cell",
|
|
termSize: image.Point{3, 3},
|
|
canvasArea: image.Rect(1, 1, 3, 3),
|
|
point: image.Point{0, 1},
|
|
r: 'X',
|
|
wantCells: 1,
|
|
want: cell.Buffer{
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New('X'),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "sets a bottom-right corner cell",
|
|
termSize: image.Point{3, 3},
|
|
canvasArea: image.Rect(1, 1, 3, 3),
|
|
point: image.Point{1, 1},
|
|
r: 'Z',
|
|
wantCells: 1,
|
|
want: cell.Buffer{
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New('Z'),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "sets cell options",
|
|
termSize: image.Point{3, 3},
|
|
canvasArea: image.Rect(1, 1, 3, 3),
|
|
point: image.Point{1, 1},
|
|
r: 'A',
|
|
opts: []cell.Option{
|
|
cell.BgColor(cell.ColorRed),
|
|
},
|
|
wantCells: 1,
|
|
want: cell.Buffer{
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New('A', cell.BgColor(cell.ColorRed)),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "canvas size equals terminal size",
|
|
termSize: image.Point{1, 1},
|
|
canvasArea: image.Rect(0, 0, 1, 1),
|
|
point: image.Point{0, 0},
|
|
r: 'A',
|
|
wantCells: 1,
|
|
want: cell.Buffer{
|
|
{
|
|
cell.New('A'),
|
|
},
|
|
},
|
|
},
|
|
{
|
|
desc: "terminal too small for the area",
|
|
termSize: image.Point{1, 1},
|
|
canvasArea: image.Rect(0, 0, 2, 2),
|
|
point: image.Point{0, 0},
|
|
r: 'A',
|
|
wantCells: 1,
|
|
wantApplyErr: true,
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.desc, func(t *testing.T) {
|
|
c, err := New(tc.canvasArea)
|
|
if err != nil {
|
|
t.Fatalf("New => unexpected error: %v", err)
|
|
}
|
|
|
|
gotCells, err := c.SetCell(tc.point, tc.r, tc.opts...)
|
|
if (err != nil) != tc.wantSetCellErr {
|
|
t.Errorf("SetCell => unexpected error: %v, wantSetCellErr: %v", err, tc.wantSetCellErr)
|
|
}
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
if gotCells != tc.wantCells {
|
|
t.Errorf("SetCell => unexpected number of cells %d, want %d", gotCells, tc.wantCells)
|
|
}
|
|
|
|
ft, err := faketerm.New(tc.termSize)
|
|
if err != nil {
|
|
t.Fatalf("faketerm.New => unexpected error: %v", err)
|
|
}
|
|
err = c.Apply(ft)
|
|
if (err != nil) != tc.wantApplyErr {
|
|
t.Errorf("Apply => unexpected error: %v, wantApplyErr: %v", err, tc.wantApplyErr)
|
|
}
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
got := ft.BackBuffer()
|
|
if diff := pretty.Compare(tc.want, got); diff != "" {
|
|
t.Errorf("faketerm.BackBuffer => unexpected diff (-want, +got):\n%s", diff)
|
|
}
|
|
})
|
|
}
|
|
}
|
|
|
|
func TestClear(t *testing.T) {
|
|
c, err := New(image.Rect(1, 1, 3, 3))
|
|
if err != nil {
|
|
t.Fatalf("New => unexpected error: %v", err)
|
|
}
|
|
|
|
if _, err := c.SetCell(image.Point{0, 0}, 'X'); err != nil {
|
|
t.Fatalf("SetCell => unexpected error: %v", err)
|
|
}
|
|
|
|
ft, err := faketerm.New(image.Point{3, 3})
|
|
if err != nil {
|
|
t.Fatalf("faketerm.New => unexpected error: %v", err)
|
|
}
|
|
// Set one cell outside of the canvas on the terminal.
|
|
if err := ft.SetCell(image.Point{0, 0}, 'A'); err != nil {
|
|
t.Fatalf("faketerm.SetCell => unexpected error: %v", err)
|
|
}
|
|
|
|
if err := c.Apply(ft); err != nil {
|
|
t.Fatalf("Apply => unexpected error: %v", err)
|
|
}
|
|
|
|
want := cell.Buffer{
|
|
{
|
|
cell.New('A'),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New('X'),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
}
|
|
got := ft.BackBuffer()
|
|
if diff := pretty.Compare(want, got); diff != "" {
|
|
t.Errorf("faketerm.BackBuffer before Clear => unexpected diff (-want, +got):\n%s", diff)
|
|
}
|
|
|
|
// Call Clear(), Apply() and verify that only the area belonging to the
|
|
// canvas was cleared.
|
|
if err := c.Clear(); err != nil {
|
|
t.Fatalf("Clear => unexpected error: %v", err)
|
|
}
|
|
if err := c.Apply(ft); err != nil {
|
|
t.Fatalf("Apply => unexpected error: %v", err)
|
|
}
|
|
|
|
want = cell.Buffer{
|
|
{
|
|
cell.New('A'),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
{
|
|
cell.New(0),
|
|
cell.New(0),
|
|
cell.New(0),
|
|
},
|
|
}
|
|
|
|
got = ft.BackBuffer()
|
|
if diff := pretty.Compare(want, got); diff != "" {
|
|
t.Errorf("faketerm.BackBuffer after Clear => unexpected diff (-want, +got):\n%s", diff)
|
|
}
|
|
}
|
|
|
|
// TestApplyFullWidthRunes verifies that when applying a full-width rune to the
|
|
// terminal, canvas doesn't touch the neighbor cell that holds the remaining
|
|
// part of the full-width rune.
|
|
func TestApplyFullWidthRunes(t *testing.T) {
|
|
ar := image.Rect(0, 0, 3, 3)
|
|
c, err := New(ar)
|
|
if err != nil {
|
|
t.Fatalf("New => unexpected error: %v", err)
|
|
}
|
|
|
|
fullP := image.Point{0, 0}
|
|
if _, err := c.SetCell(fullP, '界'); err != nil {
|
|
t.Fatalf("SetCell => unexpected error: %v", err)
|
|
}
|
|
|
|
ft, err := faketerm.New(area.Size(ar))
|
|
if err != nil {
|
|
t.Fatalf("faketerm.New => unexpected error: %v", err)
|
|
}
|
|
partP := image.Point{1, 0}
|
|
if err := ft.SetCell(partP, 'A'); err != nil {
|
|
t.Fatalf("faketerm.SetCell => unexpected error: %v", err)
|
|
}
|
|
|
|
if err := c.Apply(ft); err != nil {
|
|
t.Fatalf("Apply => unexpected error: %v", err)
|
|
}
|
|
|
|
want, err := cell.NewBuffer(area.Size(ar))
|
|
if err != nil {
|
|
t.Fatalf("NewBuffer => unexpected error: %v", err)
|
|
}
|
|
want[fullP.X][fullP.Y].Rune = '界'
|
|
want[partP.X][partP.Y].Rune = 'A'
|
|
|
|
got := ft.BackBuffer()
|
|
if diff := pretty.Compare(want, got); diff != "" {
|
|
t.Errorf("faketerm.BackBuffer => unexpected diff (-want, +got):\n%s", diff)
|
|
}
|
|
}
|
|
|
|
func TestCell(t *testing.T) {
|
|
tests := []struct {
|
|
desc string
|
|
cvs func() (*Canvas, error)
|
|
point image.Point
|
|
want *cell.Cell
|
|
wantErr bool
|
|
}{
|
|
{
|
|
desc: "requested point falls outside of the canvas",
|
|
cvs: func() (*Canvas, error) {
|
|
cvs, err := New(image.Rect(0, 0, 1, 1))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
return cvs, nil
|
|
},
|
|
point: image.Point{1, 1},
|
|
wantErr: true,
|
|
},
|
|
{
|
|
desc: "returns the cell",
|
|
cvs: func() (*Canvas, error) {
|
|
cvs, err := New(image.Rect(0, 0, 2, 2))
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if _, err := cvs.SetCell(
|
|
image.Point{1, 1}, 'A',
|
|
cell.FgColor(cell.ColorRed),
|
|
cell.BgColor(cell.ColorBlue),
|
|
); err != nil {
|
|
return nil, err
|
|
}
|
|
return cvs, nil
|
|
},
|
|
point: image.Point{1, 1},
|
|
want: &cell.Cell{
|
|
Rune: 'A',
|
|
Opts: cell.NewOptions(
|
|
cell.FgColor(cell.ColorRed),
|
|
cell.BgColor(cell.ColorBlue),
|
|
),
|
|
},
|
|
},
|
|
}
|
|
|
|
for _, tc := range tests {
|
|
t.Run(tc.desc, func(t *testing.T) {
|
|
cvs, err := tc.cvs()
|
|
if err != nil {
|
|
t.Fatalf("tc.cvs => unexpected error: %v", err)
|
|
}
|
|
|
|
got, err := cvs.Cell(tc.point)
|
|
if (err != nil) != tc.wantErr {
|
|
t.Errorf("Cell => unexpected error: %v, wantErr: %v", err, tc.wantErr)
|
|
}
|
|
if err != nil {
|
|
return
|
|
}
|
|
|
|
if diff := pretty.Compare(tc.want, got); diff != "" {
|
|
t.Errorf("Cell => unexpected diff (-want, +got):\n%s", diff)
|
|
}
|
|
})
|
|
}
|
|
}
|