1
1
mirror of https://github.com/walles/moar.git synced 2024-09-11 20:17:13 +03:00
moar/m/ansiTokenizer_test.go
Johan Walles f84ae1df18 Move some tests into screenLines_test.go
Fix one crash, but I can provoke more so there are still more tests to
write.
2021-05-30 09:45:14 +02:00

234 lines
8.1 KiB
Go

package m
import (
"fmt"
"os"
"strings"
"testing"
"unicode"
"unicode/utf8"
log "github.com/sirupsen/logrus"
"github.com/walles/moar/twin"
"gotest.tools/assert"
)
// Convert a cells array to a plain string
func cellsToPlainString(cells []twin.Cell) string {
returnMe := ""
for _, cell := range cells {
returnMe += string(cell.Rune)
}
return returnMe
}
// Verify that we can tokenize all lines in ../sample-files/*
// without logging any errors
func TestTokenize(t *testing.T) {
for _, fileName := range getTestFiles() {
file, err := os.Open(fileName)
if err != nil {
t.Errorf("Error opening file <%s>: %s", fileName, err.Error())
continue
}
defer func() {
if err := file.Close(); err != nil {
panic(err)
}
}()
myReader := NewReaderFromStream(fileName, file)
<-myReader.done
for lineNumber := 1; lineNumber <= myReader.GetLineCount(); lineNumber++ {
line := myReader.GetLine(lineNumber)
lineNumber++
var loglines strings.Builder
log.SetOutput(&loglines)
tokens := cellsFromString(line.raw)
plainString := withoutFormatting(line.raw)
if len(tokens) != utf8.RuneCountInString(plainString) {
t.Errorf("%s:%d: len(tokens)=%d, len(plainString)=%d for: <%s>",
fileName, lineNumber,
len(tokens), utf8.RuneCountInString(plainString), line.raw)
continue
}
// Tokens and plain have the same lengths, compare contents
plainStringChars := []rune(plainString)
for index, plainChar := range plainStringChars {
cellChar := tokens[index]
if cellChar.Rune == plainChar {
continue
}
if cellChar.Rune == '•' && plainChar == 'o' {
// Pretty bullets on man pages
continue
}
// Chars mismatch!
plainStringFromCells := cellsToPlainString(tokens)
positionMarker := strings.Repeat(" ", index) + "^"
cellCharString := string(cellChar.Rune)
if !unicode.IsPrint(cellChar.Rune) {
cellCharString = fmt.Sprint(int(cellChar.Rune))
}
plainCharString := string(plainChar)
if !unicode.IsPrint(plainChar) {
plainCharString = fmt.Sprint(int(plainChar))
}
t.Errorf("%s:%d, 0-based column %d: cell char <%s> != plain char <%s>:\nPlain: %s\nCells: %s\n %s",
fileName, lineNumber, index,
cellCharString, plainCharString,
plainString,
plainStringFromCells,
positionMarker,
)
break
}
if len(loglines.String()) != 0 {
t.Errorf("%s: %s", fileName, loglines.String())
continue
}
}
}
}
func TestUnderline(t *testing.T) {
tokens := cellsFromString("a\x1b[4mb\x1b[24mc")
assert.Equal(t, len(tokens), 3)
assert.Equal(t, tokens[0], twin.Cell{Rune: 'a', Style: twin.StyleDefault})
assert.Equal(t, tokens[1], twin.Cell{Rune: 'b', Style: twin.StyleDefault.WithAttr(twin.AttrUnderline)})
assert.Equal(t, tokens[2], twin.Cell{Rune: 'c', Style: twin.StyleDefault})
}
func TestManPages(t *testing.T) {
// Bold
tokens := cellsFromString("ab\bbc")
assert.Equal(t, len(tokens), 3)
assert.Equal(t, tokens[0], twin.Cell{Rune: 'a', Style: twin.StyleDefault})
assert.Equal(t, tokens[1], twin.Cell{Rune: 'b', Style: twin.StyleDefault.WithAttr(twin.AttrBold)})
assert.Equal(t, tokens[2], twin.Cell{Rune: 'c', Style: twin.StyleDefault})
// Underline
tokens = cellsFromString("a_\bbc")
assert.Equal(t, len(tokens), 3)
assert.Equal(t, tokens[0], twin.Cell{Rune: 'a', Style: twin.StyleDefault})
assert.Equal(t, tokens[1], twin.Cell{Rune: 'b', Style: twin.StyleDefault.WithAttr(twin.AttrUnderline)})
assert.Equal(t, tokens[2], twin.Cell{Rune: 'c', Style: twin.StyleDefault})
// Bullet point 1, taken from doing this on my macOS system:
// env PAGER="hexdump -C" man printf | moar
tokens = cellsFromString("a+\b+\bo\bob")
assert.Equal(t, len(tokens), 3)
assert.Equal(t, tokens[0], twin.Cell{Rune: 'a', Style: twin.StyleDefault})
assert.Equal(t, tokens[1], twin.Cell{Rune: '•', Style: twin.StyleDefault})
assert.Equal(t, tokens[2], twin.Cell{Rune: 'b', Style: twin.StyleDefault})
// Bullet point 2, taken from doing this using the "fish" shell on my macOS system:
// man printf | hexdump -C | moar
tokens = cellsFromString("a+\bob")
assert.Equal(t, len(tokens), 3)
assert.Equal(t, tokens[0], twin.Cell{Rune: 'a', Style: twin.StyleDefault})
assert.Equal(t, tokens[1], twin.Cell{Rune: '•', Style: twin.StyleDefault})
assert.Equal(t, tokens[2], twin.Cell{Rune: 'b', Style: twin.StyleDefault})
}
func TestConsumeCompositeColorHappy(t *testing.T) {
// 8 bit color
// Example from: https://github.com/walles/moar/issues/14
newIndex, color, err := consumeCompositeColor([]string{"38", "5", "74"}, 0)
assert.NilError(t, err)
assert.Equal(t, newIndex, 3)
assert.Equal(t, *color, twin.NewColor256(74))
// 24 bit color
newIndex, color, err = consumeCompositeColor([]string{"38", "2", "10", "20", "30"}, 0)
assert.NilError(t, err)
assert.Equal(t, newIndex, 5)
assert.Equal(t, *color, twin.NewColor24Bit(10, 20, 30))
}
func TestConsumeCompositeColorHappyMidSequence(t *testing.T) {
// 8 bit color
// Example from: https://github.com/walles/moar/issues/14
newIndex, color, err := consumeCompositeColor([]string{"whatever", "38", "5", "74"}, 1)
assert.NilError(t, err)
assert.Equal(t, newIndex, 4)
assert.Equal(t, *color, twin.NewColor256(74))
// 24 bit color
newIndex, color, err = consumeCompositeColor([]string{"whatever", "38", "2", "10", "20", "30"}, 1)
assert.NilError(t, err)
assert.Equal(t, newIndex, 6)
assert.Equal(t, *color, twin.NewColor24Bit(10, 20, 30))
}
func TestConsumeCompositeColorBadPrefix(t *testing.T) {
// 8 bit color
// Example from: https://github.com/walles/moar/issues/14
_, color, err := consumeCompositeColor([]string{"29"}, 0)
assert.Equal(t, err.Error(), "unknown start of color sequence <29>, expected 38 (foreground) or 48 (background): <CSI 29m>")
assert.Assert(t, color == nil)
// Same test but mid-sequence, with initial index > 0
_, color, err = consumeCompositeColor([]string{"whatever", "29"}, 1)
assert.Equal(t, err.Error(), "unknown start of color sequence <29>, expected 38 (foreground) or 48 (background): <CSI 29m>")
assert.Assert(t, color == nil)
}
func TestConsumeCompositeColorBadType(t *testing.T) {
_, color, err := consumeCompositeColor([]string{"38", "4"}, 0)
// https://en.wikipedia.org/wiki/ANSI_escape_code#Colors
assert.Equal(t, err.Error(), "unknown color type <4>, expected 5 (8 bit color) or 2 (24 bit color): <CSI 38;4m>")
assert.Assert(t, color == nil)
// Same test but mid-sequence, with initial index > 0
_, color, err = consumeCompositeColor([]string{"whatever", "38", "4"}, 1)
assert.Equal(t, err.Error(), "unknown color type <4>, expected 5 (8 bit color) or 2 (24 bit color): <CSI 38;4m>")
assert.Assert(t, color == nil)
}
func TestConsumeCompositeColorIncomplete(t *testing.T) {
_, color, err := consumeCompositeColor([]string{"38"}, 0)
assert.Equal(t, err.Error(), "incomplete color sequence: <CSI 38m>")
assert.Assert(t, color == nil)
// Same test, mid-sequence
_, color, err = consumeCompositeColor([]string{"whatever", "38"}, 1)
assert.Equal(t, err.Error(), "incomplete color sequence: <CSI 38m>")
assert.Assert(t, color == nil)
}
func TestConsumeCompositeColorIncomplete8Bit(t *testing.T) {
_, color, err := consumeCompositeColor([]string{"38", "5"}, 0)
assert.Equal(t, err.Error(), "incomplete 8 bit color sequence: <CSI 38;5m>")
assert.Assert(t, color == nil)
// Same test, mid-sequence
_, color, err = consumeCompositeColor([]string{"whatever", "38", "5"}, 1)
assert.Equal(t, err.Error(), "incomplete 8 bit color sequence: <CSI 38;5m>")
assert.Assert(t, color == nil)
}
func TestConsumeCompositeColorIncomplete24Bit(t *testing.T) {
_, color, err := consumeCompositeColor([]string{"38", "2", "10", "20"}, 0)
assert.Equal(t, err.Error(), "incomplete 24 bit color sequence, expected N8;2;R;G;Bm: <CSI 38;2;10;20m>")
assert.Assert(t, color == nil)
// Same test, mid-sequence
_, color, err = consumeCompositeColor([]string{"whatever", "38", "2", "10", "20"}, 1)
assert.Equal(t, err.Error(), "incomplete 24 bit color sequence, expected N8;2;R;G;Bm: <CSI 38;2;10;20m>")
assert.Assert(t, color == nil)
}
func TestUpdateStyle(t *testing.T) {
numberColored := updateStyle(twin.StyleDefault, "\x1b[33m")
assert.Equal(t, numberColored, twin.StyleDefault.Foreground(twin.NewColor16(3)))
}