Rainbond/util/termtables/table_test.go
2020-09-06 11:11:11 +08:00

563 lines
16 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// Copyright 2012-2013 Apcera Inc. All rights reserved.
package termtables
import "testing"
func DisplayFailedOutput(actual, expected string) string {
return "Output didn't match expected\n\n" +
"Actual:\n\n" +
actual + "\n" +
"Expected:\n\n" +
expected
}
func checkRendersTo(t *testing.T, table *Table, expected string) {
output := table.Render()
if output != expected {
t.Fatal(DisplayFailedOutput(output, expected))
}
}
func TestCreateTable(t *testing.T) {
expected := "" +
"+-----------+-------+\n" +
"| Name | Value |\n" +
"+-----------+-------+\n" +
"| hey | you |\n" +
"| ken | 1234 |\n" +
"| derek | 3.14 |\n" +
"| derek too | 3.15 |\n" +
"| escaping | rox%% |\n" +
"+-----------+-------+\n"
table := CreateTable()
table.AddHeaders("Name", "Value")
table.AddRow("hey", "you")
table.AddRow("ken", 1234)
table.AddRow("derek", 3.14)
table.AddRow("derek too", 3.1456788)
table.AddRow("escaping", "rox%%")
checkRendersTo(t, table, expected)
}
func TestStyleResets(t *testing.T) {
expected := "" +
"+-----------+-------+\n" +
"| Name | Value |\n" +
"+-----------+-------+\n" +
"| hey | you |\n" +
"| ken | 1234 |\n" +
"| derek | 3.14 |\n" +
"| derek too | 3.15 |\n" +
"+-----------+-------+\n"
table := CreateTable()
table.UTF8Box()
table.Style.setAsciiBoxStyle()
table.AddHeaders("Name", "Value")
table.AddRow("hey", "you")
table.AddRow("ken", 1234)
table.AddRow("derek", 3.14)
table.AddRow("derek too", 3.1456788)
checkRendersTo(t, table, expected)
}
func TestTableWithHeader(t *testing.T) {
expected := "" +
"+-------------------+\n" +
"| Example |\n" +
"+-----------+-------+\n" +
"| Name | Value |\n" +
"+-----------+-------+\n" +
"| hey | you |\n" +
"| ken | 1234 |\n" +
"| derek | 3.14 |\n" +
"| derek too | 3.15 |\n" +
"+-----------+-------+\n"
table := CreateTable()
table.AddTitle("Example")
table.AddHeaders("Name", "Value")
table.AddRow("hey", "you")
table.AddRow("ken", 1234)
table.AddRow("derek", 3.14)
table.AddRow("derek too", 3.1456788)
checkRendersTo(t, table, expected)
}
// TestTableWithHeaderMultipleTimes ensures that printing a table with headers
// multiple times continues to render correctly.
func TestTableWithHeaderMultipleTimes(t *testing.T) {
expected := "" +
"+-------------------+\n" +
"| Example |\n" +
"+-----------+-------+\n" +
"| Name | Value |\n" +
"+-----------+-------+\n" +
"| hey | you |\n" +
"| ken | 1234 |\n" +
"| derek | 3.14 |\n" +
"| derek too | 3.15 |\n" +
"+-----------+-------+\n"
table := CreateTable()
table.AddTitle("Example")
table.AddHeaders("Name", "Value")
table.AddRow("hey", "you")
table.AddRow("ken", 1234)
table.AddRow("derek", 3.14)
table.AddRow("derek too", 3.1456788)
checkRendersTo(t, table, expected)
checkRendersTo(t, table, expected)
}
func TestTableTitleWidthAdjusts(t *testing.T) {
expected := "" +
"+---------------------------+\n" +
"| Example My Foo Bar'd Test |\n" +
"+-----------+---------------+\n" +
"| Name | Value |\n" +
"+-----------+---------------+\n" +
"| hey | you |\n" +
"| ken | 1234 |\n" +
"| derek | 3.14 |\n" +
"| derek too | 3.15 |\n" +
"+-----------+---------------+\n"
table := CreateTable()
table.AddTitle("Example My Foo Bar'd Test")
table.AddHeaders("Name", "Value")
table.AddRow("hey", "you")
table.AddRow("ken", 1234)
table.AddRow("derek", 3.14)
table.AddRow("derek too", 3.1456788)
checkRendersTo(t, table, expected)
}
func TestTableHeaderWidthAdjusts(t *testing.T) {
expected := "" +
"+---------------+---------------------+\n" +
"| Slightly Long | More than 2 columns |\n" +
"+---------------+---------------------+\n" +
"| a | b |\n" +
"+---------------+---------------------+\n"
table := CreateTable()
table.AddHeaders("Slightly Long", "More than 2 columns")
table.AddRow("a", "b")
checkRendersTo(t, table, expected)
}
func TestTableWithNoHeaders(t *testing.T) {
expected := "" +
"+-----------+------+\n" +
"| hey | you |\n" +
"| ken | 1234 |\n" +
"| derek | 3.14 |\n" +
"| derek too | 3.15 |\n" +
"+-----------+------+\n"
table := CreateTable()
table.AddRow("hey", "you")
table.AddRow("ken", 1234)
table.AddRow("derek", 3.14)
table.AddRow("derek too", 3.1456788)
checkRendersTo(t, table, expected)
}
func TestTableUnicodeWidths(t *testing.T) {
expected := "" +
"+-----------+------+\n" +
"| Name | Cost |\n" +
"+-----------+------+\n" +
"| Currency | ¤10 |\n" +
"| US Dollar | $30 |\n" +
"| Euro | €27 |\n" +
"| Thai | ฿70 |\n" +
"+-----------+------+\n"
table := CreateTable()
table.AddHeaders("Name", "Cost")
table.AddRow("Currency", "¤10")
table.AddRow("US Dollar", "$30")
table.AddRow("Euro", "€27")
table.AddRow("Thai", "฿70")
checkRendersTo(t, table, expected)
}
func TestTableInUTF8(t *testing.T) {
expected := "" +
"╭───────────────────╮\n" +
"│ Example │\n" +
"├───────────┬───────┤\n" +
"│ Name │ Value │\n" +
"├───────────┼───────┤\n" +
"│ hey │ you │\n" +
"│ ken │ 1234 │\n" +
"│ derek │ 3.14 │\n" +
"│ derek too │ 3.15 │\n" +
"│ escaping │ rox%% │\n" +
"╰───────────┴───────╯\n"
table := CreateTable()
table.UTF8Box()
table.AddTitle("Example")
table.AddHeaders("Name", "Value")
table.AddRow("hey", "you")
table.AddRow("ken", 1234)
table.AddRow("derek", 3.14)
table.AddRow("derek too", 3.1456788)
table.AddRow("escaping", "rox%%")
checkRendersTo(t, table, expected)
}
func TestTableUnicodeUTF8AndSGR(t *testing.T) {
// at present, this mostly just tests that alignment still works
expected := "" +
"╭───────────────────────╮\n" +
"│ \033[1mFanciness\033[0m │\n" +
"├──────────┬────────────┤\n" +
"│ \033[31mred\033[0m │ \033[32mgreen\033[0m │\n" +
"├──────────┼────────────┤\n" +
"│ plain │ text │\n" +
"│ Καλημέρα │ κόσμε │\n" +
"│ \033[1mvery\033[0m │ \033[4munderlined\033[0m │\n" +
"│ a\033[1mb\033[0mc │ \033[45mmagenta\033[0m │\n" +
"│ \033[31m→\033[0m │ \033[32m←\033[0m │\n" +
"╰──────────┴────────────╯\n"
sgred := func(in string, sgrPm string) string {
return "\033[" + sgrPm + "m" + in + "\033[0m"
}
bold := func(in string) string { return sgred(in, "1") }
table := CreateTable()
table.UTF8Box()
table.AddTitle(bold("Fanciness"))
table.AddHeaders(sgred("red", "31"), sgred("green", "32"))
table.AddRow("plain", "text")
table.AddRow("Καλημέρα", "κόσμε") // from http://plan9.bell-labs.com/sys/doc/utf.html
table.AddRow(bold("very"), sgred("underlined", "4"))
table.AddRow("a"+bold("b")+"c", sgred("magenta", "45"))
table.AddRow(sgred("→", "31"), sgred("←", "32"))
// TODO: in future, if we start detecting presence of SGR sequences, we
// should ensure that the SGR reset is done at the end of the cell content,
// so that SGR doesn't "bleed across" (cells or rows). We would then add
// tests for that here.
//
// Of course, at that point, we'd also want to support automatic HTML
// styling conversion too, so would need a test for that also.
checkRendersTo(t, table, expected)
}
func TestTableInMarkdown(t *testing.T) {
expected := "" +
"Table: Example\n\n" +
"| Name | Value |\n" +
"| ----- | ----- |\n" +
"| hey | you |\n" +
"| a | b | esc |\n" +
"| esc | rox%% |\n"
table := CreateTable()
table.SetModeMarkdown()
table.AddTitle("Example")
table.AddHeaders("Name", "Value")
table.AddRow("hey", "you")
table.AddRow("a | b", "esc")
table.AddRow("esc", "rox%%")
checkRendersTo(t, table, expected)
}
func TestTitleUnicodeWidths(t *testing.T) {
expected := "" +
"+-------+\n" +
"| ← 5 → |\n" +
"+---+---+\n" +
"| a | b |\n" +
"| c | d |\n" +
"| e | 3 |\n" +
"+---+---+\n"
// minimum width for a table of two columns is 9 characters, given
// one space of padding, and non-empty tables.
table := CreateTable()
// We have 4 characters down for left and right columns and padding, so
// a width of 5 for us should match the minimum per the columns
// 5 characters; each arrow is three octets in UTF-8, giving 9 bytes
// so, same in character-count-width, longer in bytes
table.AddTitle("← 5 →")
// a single character per cell, here; use ASCII characters
table.AddRow("a", "b")
table.AddRow("c", "d")
table.AddRow("e", 3)
checkRendersTo(t, table, expected)
}
// We identified two error conditions wherein length wrapping would not correctly
// wrap width when, for instance, in a two-column table, the longest row in the
// right-hand column was not the same as the longest row in the left-hand column.
// This tests that we correctly accumulate the maximum width across all rows of
// the termtable and adjust width accordingly.
func TestTableWidthHandling(t *testing.T) {
expected := "" +
"+-----------------------------------------+\n" +
"| Example... to Fix My Test |\n" +
"+-----------------+-----------------------+\n" +
"| hey foo bar baz | you |\n" +
"| ken | you should write code |\n" +
"| derek | 3.14 |\n" +
"| derek too | 3.15 |\n" +
"+-----------------+-----------------------+\n"
table := CreateTable()
table.AddTitle("Example... to Fix My Test")
table.AddRow("hey foo bar baz", "you")
table.AddRow("ken", "you should write code")
table.AddRow("derek", 3.14)
table.AddRow("derek too", 3.1456788)
output := table.Render()
if output != expected {
t.Fatal(DisplayFailedOutput(output, expected))
}
}
func TestTableWidthHandling_SecondErrorCondition(t *testing.T) {
expected := "" +
"+----------------------------------------+\n" +
"| Example... to Fix My Test |\n" +
"+-----------------+----------------------+\n" +
"| hey foo bar baz | you |\n" +
"| ken | you should sell cod! |\n" +
"| derek | 3.14 |\n" +
"| derek too | 3.15 |\n" +
"+-----------------+----------------------+\n"
table := CreateTable()
table.AddTitle("Example... to Fix My Test")
table.AddRow("hey foo bar baz", "you")
table.AddRow("ken", "you should sell cod!")
table.AddRow("derek", 3.14)
table.AddRow("derek too", 3.1456788)
output := table.Render()
if output != expected {
t.Fatal(DisplayFailedOutput(output, expected))
}
}
func TestTableAlignPostsetting(t *testing.T) {
expected := "" +
"+-----------+-------+\n" +
"| Name | Value |\n" +
"+-----------+-------+\n" +
"| hey | you |\n" +
"| ken | 1234 |\n" +
"| derek | 3.14 |\n" +
"| derek too | 3.15 |\n" +
"| escaping | rox%% |\n" +
"+-----------+-------+\n"
table := CreateTable()
table.AddHeaders("Name", "Value")
table.AddRow("hey", "you")
table.AddRow("ken", 1234)
table.AddRow("derek", 3.14)
table.AddRow("derek too", 3.1456788)
table.AddRow("escaping", "rox%%")
table.SetAlign(AlignRight, 1)
checkRendersTo(t, table, expected)
}
func TestTableMissingCells(t *testing.T) {
expected := "" +
"+----------+---------+---------+\n" +
"| Name | Value 1 | Value 2 |\n" +
"+----------+---------+---------+\n" +
"| hey | you | person |\n" +
"| ken | 1234 |\n" +
"| escaping | rox%s%% |\n" +
"+----------+---------+---------+\n"
// FIXME: missing extra cells there
table := CreateTable()
table.AddHeaders("Name", "Value 1", "Value 2")
table.AddRow("hey", "you", "person")
table.AddRow("ken", 1234)
table.AddRow("escaping", "rox%s%%")
checkRendersTo(t, table, expected)
}
// We don't yet support combining characters, double-width characters or
// anything to do with estimating a tty-style "character width" for what in
// Unicode is a grapheme cluster. This disabled test shows what we want
// to support, but don't yet.
func TestTableWithCombiningChars(t *testing.T) {
expected := "" +
"+------+---+\n" +
"| noel | 1 |\n" +
"| noël | 2 |\n" +
"| noël | 3 |\n" +
"+------+---+\n"
table := CreateTable()
table.AddRow("noel", "1")
table.AddRow("noe\u0308l", "2") // LATIN SMALL LETTER E + COMBINING DIAERESIS
table.AddRow("noël", "3") // Hex EB; LATIN SMALL LETTER E WITH DIAERESIS
checkRendersTo(t, table, expected)
}
// another unicode length issue
func TestTableWithFullwidthChars(t *testing.T) {
expected := "" +
"+----------+------------+\n" +
"| wide | not really |\n" +
"| | fullwidth |\n" +
"+----------+------------+\n"
table := CreateTable()
table.AddRow("wide", "not really")
table.AddRow("", "fullwidth") // FULLWIDTH LATIN SMALL LETTER <X>
checkRendersTo(t, table, expected)
}
// Tests CJK characters using examples given in issue #33. The examples may not
// look like they line up but you can visually confirm its accuracy with a
// fmt.Print.
func TestCJKChars(t *testing.T) {
expected := "" +
"+-------+---------+----------+\n" +
"| KeyID | ValueID | ValueCN |\n" +
"+-------+---------+----------+\n" +
"| 8 | 51 | 精钢 |\n" +
"| 8 | 52 | 鳄鱼皮 |\n" +
"| 8 | 53 | 镀金皮带 |\n" +
"| 8 | 54 | 精钢 |\n" +
"+-------+---------+----------+\n"
table := CreateTable()
table.AddHeaders("KeyID", "ValueID", "ValueCN")
table.AddRow("8", 51, "精钢")
table.AddRow("8", 52, "鳄鱼皮")
table.AddRow("8", 53, "镀金皮带")
table.AddRow("8", 54, "精钢")
checkRendersTo(t, table, expected)
expected2 := "" +
"+--------------------+----------------------+\n" +
"| field | value |\n" +
"+--------------------+----------------------+\n" +
"| GoodsPropertyKeyID | 9 |\n" +
"| MerchantAccountID | 0 |\n" +
"| GoodsCategoryCode | 100001 |\n" +
"| NameCN | 机芯类型 |\n" +
"| NameJP | ムーブメントのタイプ |\n" +
"+--------------------+----------------------+\n"
table = CreateTable()
table.AddHeaders("field", "value")
table.AddRow("GoodsPropertyKeyID", 9)
table.AddRow("MerchantAccountID", 0)
table.AddRow("GoodsCategoryCode", 100001)
table.AddRow("NameCN", "机芯类型")
table.AddRow("NameJP", "ムーブメントのタイプ")
checkRendersTo(t, table, expected2)
}
func TestTableMultipleAddHeader(t *testing.T) {
expected := "" +
"+--------------+--------+-------+\n" +
"| First column | Second | Third |\n" +
"+--------------+--------+-------+\n" +
"| 2 | 3 | 5 |\n" +
"+--------------+--------+-------+\n"
table := CreateTable()
table.AddHeaders("First column", "Second")
table.AddHeaders("Third")
table.AddRow(2, 3, 5)
checkRendersTo(t, table, expected)
}
func createTestTable() *Table {
table := CreateTable()
header := []interface{}{}
for i := 0; i < 50; i++ {
header = append(header, "First Column")
}
table.AddHeaders(header...)
for i := 0; i < 3000; i++ {
row := []interface{}{}
for i := 0; i < 50; i++ {
row = append(row, "First row value")
}
table.AddRow(row...)
}
return table
}
func BenchmarkTableRenderTerminal(b *testing.B) {
table := createTestTable()
table.SetModeTerminal()
b.ResetTimer()
for i := 0; i < b.N; i++ {
table.Render()
}
}
func BenchmarkTableRenderMarkdown(b *testing.B) {
table := createTestTable()
table.SetModeMarkdown()
b.ResetTimer()
for i := 0; i < b.N; i++ {
table.Render()
}
}
func BenchmarkTableRenderHTML(b *testing.B) {
table := createTestTable()
table.SetModeHTML()
b.ResetTimer()
for i := 0; i < b.N; i++ {
table.Render()
}
}