1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
|
package internal
import (
"fmt"
"os"
"path"
"regexp"
"runtime"
"strings"
"testing"
"github.com/alecthomas/chroma/v2"
"github.com/alecthomas/chroma/v2/formatters"
"github.com/alecthomas/chroma/v2/lexers"
"github.com/alecthomas/chroma/v2/styles"
"github.com/google/go-cmp/cmp"
"github.com/walles/moor/internal/linemetadata"
"github.com/walles/moor/internal/reader"
"github.com/walles/moor/internal/textstyles"
"github.com/walles/moor/twin"
"gotest.tools/v3/assert"
)
// NOTE: You can find related tests in screenLines_test.go.
const blueBackgroundClearToEol0 = "\x1b[44m\x1b[0K" // With 0 before the K, should clear to EOL
const blueBackgroundClearToEol = "\x1b[44m\x1b[K" // No 0 before the K, should also clear to EOL
const samplesDir = "../sample-files"
func TestUnicodeRendering(t *testing.T) {
reader := reader.NewFromTextForTesting("", "åäö")
var answers = []twin.StyledRune{
twin.NewStyledRune('å', twin.StyleDefault),
twin.NewStyledRune('ä', twin.StyleDefault),
twin.NewStyledRune('ö', twin.StyleDefault),
}
contents := startPaging(t, reader).GetRow(0)
for pos, expected := range answers {
assertRunesEqual(t, expected, contents[pos])
}
}
func assertRunesEqual(t *testing.T, expected twin.StyledRune, actual twin.StyledRune) {
if actual.Rune == expected.Rune && actual.Style == expected.Style {
return
}
t.Errorf("Expected %v, got %v", expected, actual)
}
func TestFgColorRendering(t *testing.T) {
reader := reader.NewFromTextForTesting("",
"\x1b[30ma\x1b[31mb\x1b[32mc\x1b[33md\x1b[34me\x1b[35mf\x1b[36mg\x1b[37mh\x1b[0mi")
var answers = []twin.StyledRune{
twin.NewStyledRune('a', twin.StyleDefault.WithForeground(twin.NewColor16(0))),
twin.NewStyledRune('b', twin.StyleDefault.WithForeground(twin.NewColor16(1))),
twin.NewStyledRune('c', twin.StyleDefault.WithForeground(twin.NewColor16(2))),
twin.NewStyledRune('d', twin.StyleDefault.WithForeground(twin.NewColor16(3))),
twin.NewStyledRune('e', twin.StyleDefault.WithForeground(twin.NewColor16(4))),
twin.NewStyledRune('f', twin.StyleDefault.WithForeground(twin.NewColor16(5))),
twin.NewStyledRune('g', twin.StyleDefault.WithForeground(twin.NewColor16(6))),
twin.NewStyledRune('h', twin.StyleDefault.WithForeground(twin.NewColor16(7))),
twin.NewStyledRune('i', twin.StyleDefault),
}
contents := startPaging(t, reader).GetRow(0)
for pos, expected := range answers {
assertRunesEqual(t, expected, contents[pos])
}
}
func TestPageEmpty(t *testing.T) {
// "---" is the eofSpinner of pager.go
assert.Equal(t, "---", renderTextLine(""))
}
func TestBrokenUtf8(t *testing.T) {
// The broken UTF8 character in the middle is based on "©" = 0xc2a9
reader := reader.NewFromTextForTesting("", "abc\xc2def")
var answers = []twin.StyledRune{
twin.NewStyledRune('a', twin.StyleDefault),
twin.NewStyledRune('b', twin.StyleDefault),
twin.NewStyledRune('c', twin.StyleDefault),
twin.NewStyledRune('?', twin.StyleDefault.WithForeground(twin.NewColor16(7)).WithBackground(twin.NewColor16(1))),
twin.NewStyledRune('d', twin.StyleDefault),
twin.NewStyledRune('e', twin.StyleDefault),
twin.NewStyledRune('f', twin.StyleDefault),
}
contents := startPaging(t, reader).GetRow(0)
for pos, expected := range answers {
assertRunesEqual(t, expected, contents[pos])
}
}
func startPaging(t *testing.T, reader *reader.ReaderImpl) *twin.FakeScreen {
err := reader.Wait()
if err != nil {
t.Fatalf("Failed waiting for reader: %v", err)
}
screen := twin.NewFakeScreen(20, 10)
pager := NewPager(reader)
pager.ShowLineNumbers = false
// Tell our Pager to quit immediately
pager.Quit()
// Except for just quitting, this also associates our FakeScreen with the Pager
pager.StartPaging(screen, nil, nil)
// This makes sure at least one frame gets rendered
pager.redraw("")
return screen
}
// Set style to "native" and use the TTY16m formatter
func startPagingWithTerminalFg(t *testing.T, reader *reader.ReaderImpl, withTerminalFg bool) *twin.FakeScreen {
err := reader.Wait()
if err != nil {
t.Fatalf("Failed waiting for reader: %v", err)
}
screen := twin.NewFakeScreen(20, 10)
pager := NewPager(reader)
pager.ShowLineNumbers = false
pager.WithTerminalFg = withTerminalFg
// Tell our Pager to quit immediately
pager.Quit()
// Except for just quitting, this also associates our FakeScreen with the Pager
pager.StartPaging(screen, styles.Get("native"), &formatters.TTY16m)
// This makes sure at least one frame gets rendered
pager.redraw("")
return screen
}
// assertIndexOfFirstX verifies the (zero-based) index of the first 'x'
func assertIndexOfFirstX(t *testing.T, s string, expectedIndex int) {
reader := reader.NewFromTextForTesting("", s)
contents := startPaging(t, reader).GetRow(0)
for pos, cell := range contents {
if cell.Rune != 'x' {
continue
}
if pos == expectedIndex {
// Success!
return
}
t.Errorf("Expected first 'x' to be at (zero-based) index %d, but was at %d: \"%s\"",
expectedIndex, pos, strings.ReplaceAll(s, "\x09", "<TAB>"))
return
}
panic("No 'x' found")
}
func TestTabHandling(t *testing.T) {
assertIndexOfFirstX(t, "x", 0)
assertIndexOfFirstX(t, "\x09x", 4)
assertIndexOfFirstX(t, "\x09\x09x", 8)
assertIndexOfFirstX(t, "J\x09x", 4)
assertIndexOfFirstX(t, "Jo\x09x", 4)
assertIndexOfFirstX(t, "Joh\x09x", 4)
assertIndexOfFirstX(t, "Joha\x09x", 8)
assertIndexOfFirstX(t, "Johan\x09x", 8)
assertIndexOfFirstX(t, "\x09J\x09x", 8)
assertIndexOfFirstX(t, "\x09Jo\x09x", 8)
assertIndexOfFirstX(t, "\x09Joh\x09x", 8)
assertIndexOfFirstX(t, "\x09Joha\x09x", 12)
assertIndexOfFirstX(t, "\x09Johan\x09x", 12)
}
func TestCodeHighlighting(t *testing.T) {
// From: https://coderwall.com/p/_fmbug/go-get-path-to-current-file
_, filename, _, ok := runtime.Caller(0)
if !ok {
panic("Getting current filename failed")
}
reader, err := reader.NewFromFilename(filename, formatters.TTY16m, reader.ReaderOptions{Style: styles.Get("native")})
assert.NilError(t, err)
assert.NilError(t, reader.Wait())
packageKeywordStyle := twin.StyleDefault.WithAttr(twin.AttrBold).WithForeground(twin.NewColorHex(0x6AB825))
packageSpaceStyle := twin.StyleDefault.WithForeground(twin.NewColorHex(0x666666))
packageNameStyle := twin.StyleDefault.WithForeground(twin.NewColorHex(0xD0D0D0))
var answers = []twin.StyledRune{
twin.NewStyledRune('p', packageKeywordStyle),
twin.NewStyledRune('a', packageKeywordStyle),
twin.NewStyledRune('c', packageKeywordStyle),
twin.NewStyledRune('k', packageKeywordStyle),
twin.NewStyledRune('a', packageKeywordStyle),
twin.NewStyledRune('g', packageKeywordStyle),
twin.NewStyledRune('e', packageKeywordStyle),
twin.NewStyledRune(' ', packageSpaceStyle),
twin.NewStyledRune('i', packageNameStyle),
twin.NewStyledRune('n', packageNameStyle),
twin.NewStyledRune('t', packageNameStyle),
twin.NewStyledRune('e', packageNameStyle),
twin.NewStyledRune('r', packageNameStyle),
twin.NewStyledRune('n', packageNameStyle),
twin.NewStyledRune('a', packageNameStyle),
twin.NewStyledRune('l', packageNameStyle),
}
contents := startPaging(t, reader).GetRow(0)
for pos, expected := range answers {
assertRunesEqual(t, expected, contents[pos])
}
}
func TestCodeHighlight_compressed(t *testing.T) {
// Same as TestCodeHighlighting but with "compressed-markdown.md.gz"
reader, err := reader.NewFromFilename("../sample-files/compressed-markdown.md.gz", formatters.TTY16m, reader.ReaderOptions{Style: styles.Get("native")})
assert.NilError(t, err)
assert.NilError(t, reader.Wait())
markdownHeading1Style := twin.StyleDefault.WithAttr(twin.AttrBold).WithForeground(twin.NewColorHex(0xffffff))
var answers = []twin.StyledRune{
twin.NewStyledRune('#', markdownHeading1Style),
twin.NewStyledRune(' ', markdownHeading1Style),
twin.NewStyledRune('M', markdownHeading1Style),
twin.NewStyledRune('a', markdownHeading1Style),
twin.NewStyledRune('r', markdownHeading1Style),
twin.NewStyledRune('k', markdownHeading1Style),
twin.NewStyledRune('d', markdownHeading1Style),
twin.NewStyledRune('o', markdownHeading1Style),
twin.NewStyledRune('w', markdownHeading1Style),
twin.NewStyledRune('n', markdownHeading1Style),
}
contents := startPaging(t, reader).GetRow(0)
for pos, expected := range answers {
assertRunesEqual(t, expected, contents[pos])
}
}
// Regression test for:
// https://github.com/walles/moor/issues/236#issuecomment-2282677792
//
// Sample file sysctl.h from:
// https://github.com/fastfetch-cli/fastfetch/blob/f9597eba39d6afd278eeca2f2972f73a7e54f111/src/common/sysctl.h
func TestCodeHighlightingIncludes(t *testing.T) {
reader, err := reader.NewFromFilename("../sample-files/sysctl.h", formatters.TTY16m, reader.ReaderOptions{Style: styles.Get("native")})
assert.NilError(t, err)
assert.NilError(t, reader.Wait())
screen := startPaging(t, reader)
firstIncludeLine := screen.GetRow(2)
secondIncludeLine := screen.GetRow(3)
// Both should start with "#include" colored the same way
assertRunesEqual(t, firstIncludeLine[0], secondIncludeLine[0])
}
func TestUnicodePrivateUse(t *testing.T) {
// This character lives in a Private Use Area:
// https://codepoints.net/U+f244
//
// It's used by Font Awesome as "fa-battery-empty":
// https://fontawesome.com/v4/icon/battery-empty
char := '\uf244'
reader := reader.NewFromTextForTesting("hello", string(char))
renderedRune := startPaging(t, reader).GetRow(0)[0]
// Make sure we display this character unmodified
assertRunesEqual(t, twin.NewStyledRune(char, twin.StyleDefault), renderedRune)
}
func resetManPageFormat() {
textstyles.ManPageBold = twin.StyleDefault.WithAttr(twin.AttrBold)
textstyles.ManPageUnderline = twin.StyleDefault.WithAttr(twin.AttrUnderline)
}
func testManPageFormatting(t *testing.T, input string, expected twin.StyledRune) {
reader := reader.NewFromTextForTesting("", input)
// Without these lines the man page tests will fail if either of these
// environment variables are set when the tests are run.
assert.NilError(t, os.Setenv("LESS_TERMCAP_md", ""))
assert.NilError(t, os.Setenv("LESS_TERMCAP_us", ""))
assert.NilError(t, os.Setenv("LESS_TERMCAP_so", ""))
resetManPageFormat()
contents := startPaging(t, reader).GetRow(0)
assertRunesEqual(t, expected, contents[0])
assert.Equal(t, contents[1].Rune, ' ')
}
func TestManPageFormatting(t *testing.T) {
testManPageFormatting(t, "n\x08n", twin.NewStyledRune('n', twin.StyleDefault.WithAttr(twin.AttrBold)))
testManPageFormatting(t, "_\x08x", twin.NewStyledRune('x', twin.StyleDefault.WithAttr(twin.AttrUnderline)))
// Non-breaking space UTF-8 encoded (0xc2a0) should render as a non-breaking unicode space (0xa0)
testManPageFormatting(t, string([]byte{0xc2, 0xa0}), twin.NewStyledRune(rune(0xa0), twin.StyleDefault))
// Corner cases
testManPageFormatting(t, "\x08", twin.NewStyledRune('<', twin.StyleDefault.WithForeground(twin.NewColor16(7)).WithBackground(twin.NewColor16(1))))
// FIXME: Test two consecutive backspaces
// FIXME: Test backspace between two uncombinable characters
}
func TestToPattern(t *testing.T) {
assert.Assert(t, toPattern("") == nil)
// Test regexp matching
assert.Assert(t, toPattern("G.*S").MatchString("GRIIIS"))
assert.Assert(t, !toPattern("G.*S").MatchString("gRIIIS"))
// Test case insensitive regexp matching
assert.Assert(t, toPattern("g.*s").MatchString("GRIIIS"))
assert.Assert(t, toPattern("g.*s").MatchString("gRIIIS"))
// Test non-regexp matching
assert.Assert(t, toPattern(")G").MatchString(")G"))
assert.Assert(t, !toPattern(")G").MatchString(")g"))
// Test case insensitive non-regexp matching
assert.Assert(t, toPattern(")g").MatchString(")G"))
assert.Assert(t, toPattern(")g").MatchString(")g"))
}
func TestFindFirstHitSimple(t *testing.T) {
reader := reader.NewFromTextForTesting("TestFindFirstHitSimple", "AB")
pager := NewPager(reader)
pager.screen = twin.NewFakeScreen(40, 10)
assert.NilError(t, pager.reader.Wait())
pager.searchPattern = toPattern("AB")
hit := pager.findFirstHit(linemetadata.Index{}, nil, false)
assert.Assert(t, hit.internalDontTouch.lineIndex.IsZero())
assert.Equal(t, hit.internalDontTouch.deltaScreenLines, 0)
}
func TestFindFirstHitAnsi(t *testing.T) {
reader := reader.NewFromTextForTesting("", "A\x1b[30mB")
pager := NewPager(reader)
pager.screen = twin.NewFakeScreen(40, 10)
assert.NilError(t, pager.reader.Wait())
pager.searchPattern = toPattern("AB")
hit := pager.findFirstHit(linemetadata.Index{}, nil, false)
assert.Assert(t, hit.internalDontTouch.lineIndex.IsZero())
assert.Equal(t, hit.internalDontTouch.deltaScreenLines, 0)
}
func TestFindFirstHitNoMatch(t *testing.T) {
reader := reader.NewFromTextForTesting("TestFindFirstHitSimple", "AB")
pager := NewPager(reader)
pager.screen = twin.NewFakeScreen(40, 10)
assert.NilError(t, pager.reader.Wait())
pager.searchPattern = toPattern("this pattern should not be found")
hit := pager.findFirstHit(linemetadata.Index{}, nil, false)
assert.Assert(t, hit == nil)
}
func TestFindFirstHitNoMatchBackwards(t *testing.T) {
reader := reader.NewFromTextForTesting("TestFindFirstHitSimple", "AB")
pager := NewPager(reader)
pager.screen = twin.NewFakeScreen(40, 10)
assert.NilError(t, pager.reader.Wait())
pager.searchPattern = toPattern("this pattern should not be found")
theEnd := *linemetadata.IndexFromLength(reader.GetLineCount())
hit := pager.findFirstHit(theEnd, nil, true)
assert.Assert(t, hit == nil)
}
// Converts a cell row to a plain string and removes trailing whitespace.
func rowToString(row []twin.StyledRune) string {
rowString := ""
for _, cell := range row {
rowString += string(cell.Rune)
}
return strings.TrimRight(rowString, " ")
}
func TestScrollToBottomWrapNextToLastLine(t *testing.T) {
reader := reader.NewFromTextForTesting("",
"first line\nline two will be wrapped\nhere's the last line")
// Heigh 3 = two lines of contents + one footer
screen := twin.NewFakeScreen(10, 3)
pager := NewPager(reader)
pager.WrapLongLines = true
pager.ShowLineNumbers = false
pager.screen = screen
assert.NilError(t, pager.reader.Wait())
// This is what we're testing really
pager.scrollToEnd()
// Exit immediately
pager.Quit()
// Get contents onto our fake screen
pager.StartPaging(screen, nil, nil)
pager.redraw("")
actual := strings.Join([]string{
rowToString(screen.GetRow(0)),
rowToString(screen.GetRow(1)),
rowToString(screen.GetRow(2)),
}, "\n")
expected := strings.Join([]string{
"here's the",
"last line",
"3 lines 1", // "3 lines 100%" clipped after 10 characters (screen width)
}, "\n")
assert.Equal(t, actual, expected)
}
// Repro for https://github.com/walles/moor/issues/105
func TestScrollToEndLongInput(t *testing.T) {
const lineCount = 10100 // At least five digits
// "X" marks the spot
reader := reader.NewFromTextForTesting("test", strings.Repeat(".\n", lineCount-1)+"X")
pager := NewPager(reader)
pager.ShowLineNumbers = true
// Tell our Pager to quit immediately
pager.Quit()
// Connect the pager with a screen
const screenHeight = 10
screen := twin.NewFakeScreen(20, screenHeight)
pager.StartPaging(screen, nil, nil)
// This is what we're really testing
pager.scrollToEnd()
// This makes sure at least one frame gets rendered
pager.redraw("")
// The last screen line holds the status field, and the next to last screen
// line holds the last contents line.
lastContentsLine := screen.GetRow(screenHeight - 2)
firstContentsColumn := len("10_100 ")
assertRunesEqual(t, twin.NewStyledRune('X', twin.StyleDefault), lastContentsLine[firstContentsColumn])
}
func TestIsScrolledToEnd_LongFile(t *testing.T) {
// Six lines of contents
reader := reader.NewFromTextForTesting("Testing", "a\nb\nc\nd\ne\nf\n")
// Three lines screen
screen := twin.NewFakeScreen(20, 3)
// Create the pager
pager := NewPager(reader)
pager.screen = screen
assert.Equal(t, false, pager.isScrolledToEnd())
pager.scrollToEnd()
assert.Equal(t, true, pager.isScrolledToEnd())
}
func TestIsScrolledToEnd_ShortFile(t *testing.T) {
// Three lines of contents
reader := reader.NewFromTextForTesting("Testing", "a\nb\nc")
// Six lines screen
screen := twin.NewFakeScreen(20, 6)
// Create the pager
pager := NewPager(reader)
pager.screen = screen
assert.Equal(t, true, pager.isScrolledToEnd())
pager.scrollToEnd()
assert.Equal(t, true, pager.isScrolledToEnd())
}
func TestIsScrolledToEnd_ExactFile(t *testing.T) {
// Three lines of contents
reader := reader.NewFromTextForTesting("Testing", "a\nb\nc")
// Three lines screen
screen := twin.NewFakeScreen(20, 3)
// Create the pager
pager := NewPager(reader)
pager.screen = screen
pager.ShowStatusBar = false
assert.Equal(t, true, pager.isScrolledToEnd())
pager.scrollToEnd()
assert.Equal(t, true, pager.isScrolledToEnd())
}
func TestIsScrolledToEnd_WrappedLastLine(t *testing.T) {
// Three lines of contents
reader := reader.NewFromTextForTesting("Testing", "a\nb\nc d e f g h i j k l m n")
// Three lines screen
screen := twin.NewFakeScreen(5, 3)
// Create the pager
pager := NewPager(reader)
pager.screen = screen
pager.WrapLongLines = true
assert.Equal(t, false, pager.isScrolledToEnd())
pager.scrollToEnd()
assert.Equal(t, true, pager.isScrolledToEnd())
pager.mode.onKey(twin.KeyUp)
pager.redraw("XXX")
assert.Equal(t, false, pager.isScrolledToEnd())
}
func TestIsScrolledToEnd_EmptyFile(t *testing.T) {
// No contents
reader := reader.NewFromTextForTesting("Testing", "")
// Three lines screen
screen := twin.NewFakeScreen(20, 3)
// Create the pager
pager := NewPager(reader)
pager.screen = screen
assert.Equal(t, true, pager.isScrolledToEnd())
pager.scrollToEnd()
assert.Equal(t, true, pager.isScrolledToEnd())
}
func getTestFiles(t *testing.T) []string {
files, err := os.ReadDir(samplesDir)
assert.NilError(t, err)
var filenames []string
for _, file := range files {
filenames = append(filenames, path.Join(samplesDir, file.Name()))
}
return filenames
}
// Verify that we can page all files in ../sample-files/* without crashing
func TestPageSamples(t *testing.T) {
for _, fileName := range getTestFiles(t) {
t.Run(fileName, func(t *testing.T) {
file, err := os.Open(fileName)
if err != nil {
t.Errorf("Error opening file <%s>: %s", fileName, err.Error())
return
}
defer func() {
if err := file.Close(); err != nil {
panic(err)
}
}()
myReader, err := reader.NewFromStream(fileName, file, nil, reader.ReaderOptions{Style: &chroma.Style{}})
assert.NilError(t, err)
assert.NilError(t, myReader.Wait())
pager := NewPager(myReader)
pager.WrapLongLines = false
pager.ShowLineNumbers = false
// Heigh 3 = two lines of contents + one footer
screen := twin.NewFakeScreen(10, 3)
// Exit immediately
pager.Quit()
// Get contents onto our fake screen
pager.StartPaging(screen, nil, nil)
pager.redraw("")
firstReaderLine := myReader.GetLine(linemetadata.Index{})
if firstReaderLine == nil {
return
}
firstPagerLine := rowToString(screen.GetRow(0))
// Handle the case when first line is chopped off to the right
firstPagerLine = strings.TrimSuffix(firstPagerLine, ">")
assert.Assert(t,
strings.HasPrefix(firstReaderLine.Plain(), firstPagerLine),
"\nreader line = <%s>\npager line = <%s>",
firstReaderLine.Plain(), firstPagerLine,
)
})
}
}
// Validate rendering of https://en.wikipedia.org/wiki/ANSI_escape_code#EL
func TestClearToEndOfLine_ClearFromStart(t *testing.T) {
screen := startPaging(t, reader.NewFromTextForTesting("TestClearToEol", blueBackgroundClearToEol))
screenWidth, _ := screen.Size()
var expected []twin.StyledRune
for len(expected) < screenWidth {
expected = append(expected,
twin.NewStyledRune(' ', twin.StyleDefault.WithBackground(twin.NewColor16(4))),
)
}
actual := screen.GetRow(0)
assert.DeepEqual(t, actual, expected, cmp.AllowUnexported(twin.Style{}))
}
// Validate rendering of https://en.wikipedia.org/wiki/ANSI_escape_code#EL
func TestClearToEndOfLine_ClearFromNotStart(t *testing.T) {
screen := startPaging(t, reader.NewFromTextForTesting("TestClearToEol", "a"+blueBackgroundClearToEol))
screenWidth, _ := screen.Size()
expected := []twin.StyledRune{
twin.NewStyledRune('a', twin.StyleDefault),
}
for len(expected) < screenWidth {
expected = append(expected,
twin.NewStyledRune(' ', twin.StyleDefault.WithBackground(twin.NewColor16(4))),
)
}
actual := screen.GetRow(0)
assert.DeepEqual(t, actual, expected, cmp.AllowUnexported(twin.Style{}))
}
// Validate rendering of https://en.wikipedia.org/wiki/ANSI_escape_code#EL
func TestClearToEndOfLine_ClearFromStartScrolledRight(t *testing.T) {
pager := NewPager(reader.NewFromTextForTesting("TestClearToEol", blueBackgroundClearToEol0))
pager.ShowLineNumbers = false
// Tell our Pager to quit immediately
pager.Quit()
// Except for just quitting, this also associates a FakeScreen with the Pager
screen := twin.NewFakeScreen(3, 10)
pager.StartPaging(screen, nil, nil)
// Scroll right, this is what we're testing
pager.leftColumnZeroBased = 44
// This makes sure at least one frame gets rendered
pager.redraw("")
screenWidth, _ := screen.Size()
var expected []twin.StyledRune
for len(expected) < screenWidth {
expected = append(expected,
twin.NewStyledRune(' ', twin.StyleDefault.WithBackground(twin.NewColor16(4))),
)
}
actual := screen.GetRow(0)
assert.DeepEqual(t, actual, expected, cmp.AllowUnexported(twin.Style{}))
}
// Render a line of text on our 20 cell wide screen
func renderTextLine(text string) string {
reader := reader.NewFromTextForTesting("renderTextLine", text)
screen := startPaging(nil, reader)
return rowToString(screen.GetRow(0))
}
// Ref: https://github.com/walles/moor/issues/243
func TestPageWideChars(t *testing.T) {
// Both of these characters are 2 cells wide on a terminal
const monospaced4cells = "上午"
const monospaced8cells = monospaced4cells + monospaced4cells
const monospaced16cells = monospaced8cells + monospaced8cells
const monospaced20cells = monospaced16cells + monospaced4cells
const monospaced24cells = monospaced16cells + monospaced8cells
// Cut the line in the middle of a wide character
const monospaced18cells = monospaced16cells + "上"
assert.Equal(t, monospaced18cells+" >", renderTextLine(monospaced24cells))
// Just the right length, no cutting
assert.Equal(t, monospaced20cells, renderTextLine(monospaced20cells))
// Cut this line after a whide character
assert.Equal(t, "x"+monospaced18cells+">", renderTextLine("x"+monospaced24cells))
}
func TestTerminalFg(t *testing.T) {
reader := reader.NewFromTextForTesting("", "x")
var styleAnswer = twin.NewStyledRune('x', twin.StyleDefault.WithForeground(twin.NewColor24Bit(0xd0, 0xd0, 0xd0)))
var terminalAnswer = twin.NewStyledRune('x', twin.StyleDefault)
assertRunesEqual(t, styleAnswer, startPagingWithTerminalFg(t, reader, false).GetRow(0)[0])
assertRunesEqual(t, terminalAnswer, startPagingWithTerminalFg(t, reader, true).GetRow(0)[0])
}
func benchmarkSearch(b *testing.B, highlighted bool) {
// Pick a go file so we get something with highlighting
_, sourceFilename, _, ok := runtime.Caller(0)
if !ok {
panic("Getting current filename failed")
}
sourceBytes, err := os.ReadFile(sourceFilename)
assert.NilError(b, err)
fileContents := string(sourceBytes)
// Read one copy of the example input
if highlighted {
highlightedSourceCode, err := reader.Highlight(fileContents, *styles.Get("native"), formatters.TTY16m, lexers.Get("go"))
assert.NilError(b, err)
if highlightedSourceCode == nil {
panic("Highlighting didn't want to, returned nil")
}
fileContents = *highlightedSourceCode
}
// Create some input to search
testString := ""
for range 100 {
testString += fileContents
}
reader := reader.NewFromTextForTesting("hello", testString)
pager := NewPager(reader)
pager.screen = twin.NewFakeScreen(40, 10)
// The [] around the 't' is there to make sure it doesn't match, remember
// we're searching through this very file.
pager.searchPattern = regexp.MustCompile("This won'[t] match anything")
// I hope forcing a GC here will make numbers more predictable
runtime.GC()
b.ResetTimer()
for range b.N {
// This test will search through all the N copies we made of our file
hit := pager.findFirstHit(linemetadata.Index{}, nil, false)
if hit != nil {
panic(fmt.Errorf("This test is meant to scan the whole file without finding anything"))
}
}
}
// How long does it take to search a highlighted file for some regex?
//
// Run with: go test -run='^$' -bench=. . ./...
func BenchmarkHighlightedSearch(b *testing.B) {
benchmarkSearch(b, true)
}
// How long does it take to search a plain text file for some regex?
//
// Search performance was a problem for me when I had a 600MB file to search in.
//
// Run with: go test -run='^$' -bench=. . ./...
func BenchmarkPlainTextSearch(b *testing.B) {
benchmarkSearch(b, false)
}
|