tcell/terminfo/terminfo_test.go

// Copyright 2016 The TCell Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use 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 terminfo

import (
	"bytes"
	"os"
	"testing"

	. "github.com/smartystreets/goconvey/convey"
)

// This terminfo entry is a stripped down version from
// xterm-256color, but I've added some of my own entries.
var testTerminfo = &Terminfo{
	Name:      "simulation_test",
	Columns:   80,
	Lines:     24,
	Colors:    256,
	Bell:      "\a",
	Blink:     "\x1b2ms$<2>",
	Reverse:   "\x1b[7m",
	SetFg:     "\x1b[%?%p1%{8}%<%t3%p1%d%e%p1%{16}%<%t9%p1%{8}%-%d%e38;5;%p1%d%;m",
	SetBg:     "\x1b[%?%p1%{8}%<%t4%p1%d%e%p1%{16}%<%t10%p1%{8}%-%d%e48;5;%p1%d%;m",
	AltChars:  "``aaffggiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz{{||}}~~",
	Mouse:     "\x1b[M",
	MouseMode: "%?%p1%{1}%=%t%'h'%Pa%e%'l'%Pa%;\x1b[?1000%ga%c\x1b[?1003%ga%c\x1b[?1006%ga%c",
	SetCursor: "\x1b[%i%p1%d;%p2%dH",
	PadChar:   "\x00",
}

func TestTerminfo(t *testing.T) {

	ti := testTerminfo

	Convey("Terminfo parameter processing", t, func() {
		// This tests %i, and basic parameter strings too
		Convey("TGoto works", func() {
			s := ti.TGoto(7, 9)
			So(s, ShouldEqual, "\x1b[10;8H")
		})

		// This tests some conditionals
		Convey("TParm extended formats work", func() {
			s := ti.TParm("A[%p1%2.2X]B", 47)
			So(s, ShouldEqual, "A[2F]B")
		})

		// This tests some conditionals
		Convey("TParm colors work", func() {
			s := ti.TParm(ti.SetFg, 7)
			So(s, ShouldEqual, "\x1b[37m")

			s = ti.TParm(ti.SetFg, 15)
			So(s, ShouldEqual, "\x1b[97m")

			s = ti.TParm(ti.SetFg, 200)
			So(s, ShouldEqual, "\x1b[38;5;200m")
		})

		// This tests variables
		Convey("TParm mouse mode works", func() {
			s := ti.TParm(ti.MouseMode, 1)
			So(s, ShouldEqual, "\x1b[?1000h\x1b[?1003h\x1b[?1006h")
			s = ti.TParm(ti.MouseMode, 0)
			So(s, ShouldEqual, "\x1b[?1000l\x1b[?1003l\x1b[?1006l")
		})

	})

	Convey("Terminfo delay handling", t, func() {

		Convey("19200 baud", func() {
			buf := bytes.NewBuffer(nil)
			ti.TPuts(buf, ti.Blink, 19200)
			s := string(buf.Bytes())
			So(s, ShouldEqual, "\x1b2ms\x00\x00\x00\x00")
		})

		Convey("50 baud", func() {
			buf := bytes.NewBuffer(nil)
			ti.TPuts(buf, ti.Blink, 50)
			s := string(buf.Bytes())
			So(s, ShouldEqual, "\x1b2ms")
		})
	})
}

func TestTerminfoDatabase(t *testing.T) {

	Convey("Database Lookups work", t, func() {
		Convey("Basic lookup works", func() {
			os.Setenv("TCELLDB", "testdata/test1")
			ti, err := LookupTerminfo("test1")
			So(err, ShouldBeNil)
			So(ti, ShouldNotBeNil)
			So(ti.Columns, ShouldEqual, 80)

			ti, err = LookupTerminfo("alias1")
			So(err, ShouldBeNil)
			So(ti, ShouldNotBeNil)
			So(ti.Columns, ShouldEqual, 80)

			os.Setenv("TCELLDB", "testdata")
			ti, err = LookupTerminfo("test2")
			So(err, ShouldBeNil)
			So(ti, ShouldNotBeNil)
			So(ti.Columns, ShouldEqual, 80)
			So(len(ti.Aliases), ShouldEqual, 1)
			So(ti.Aliases[0], ShouldEqual, "alias2")
		})

		Convey("Incorrect primary name works", func() {
			os.Setenv("TCELLDB", "testdata")
			ti, err := LookupTerminfo("test3")
			So(err, ShouldNotBeNil)
			So(ti, ShouldBeNil)
		})

		Convey("Loops fail", func() {
			os.Setenv("TCELLDB", "testdata")
			ti, err := LookupTerminfo("loop1")
			So(ti, ShouldBeNil)
			So(err, ShouldNotBeNil)
		})

		Convey("Gzip database works", func() {
			os.Setenv("TCELLDB", "testdata")
			ti, err := LookupTerminfo("test-gzip")
			So(err, ShouldBeNil)
			So(ti, ShouldNotBeNil)
			So(ti.Columns, ShouldEqual, 80)
		})

		Convey("Gzip alias lookup works", func() {
			os.Setenv("TCELLDB", "testdata")
			ti, err := LookupTerminfo("alias-gzip")
			So(err, ShouldBeNil)
			So(ti, ShouldNotBeNil)
			So(ti.Columns, ShouldEqual, 80)
		})

		Convey("Broken alias works", func() {
			os.Setenv("TCELLDB", "testdata")
			ti, err := LookupTerminfo("alias-none")
			So(err, ShouldNotBeNil)
			So(ti, ShouldBeNil)
		})

		Convey("Combined database works", func() {
			os.Setenv("TCELLDB", "testdata/combined")
			ti, err := LookupTerminfo("combined2")
			So(err, ShouldBeNil)
			So(ti, ShouldNotBeNil)
			So(ti.Lines, ShouldEqual, 102)

			ti, err = LookupTerminfo("alias-comb1")
			So(err, ShouldBeNil)
			So(ti, ShouldNotBeNil)
			So(ti.Lines, ShouldEqual, 101)

			ti, err = LookupTerminfo("combined3")
			So(err, ShouldBeNil)
			So(ti, ShouldNotBeNil)
			So(ti.Lines, ShouldEqual, 103)

			ti, err = LookupTerminfo("combined1")
			So(err, ShouldBeNil)
			So(ti, ShouldNotBeNil)
			So(ti.Lines, ShouldEqual, 101)
		})
	})
}

func BenchmarkSetFgBg(b *testing.B) {
	ti := testTerminfo

	for i := 0; i < b.N; i++ {
		ti.TParm(ti.SetFg, 100, 200)
		ti.TParm(ti.SetBg, 100, 200)
	}
}