File: term_test.go

package info (click to toggle)
kind 0.30.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,392 kB
  • sloc: sh: 1,900; makefile: 97; javascript: 55; xml: 9
file content (140 lines) | stat: -rw-r--r-- 3,223 bytes parent folder | download | duplicates (2)
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
/*
Copyright 2019 The Kubernetes Authors.

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 env

import (
	"bytes"
	"io"
	"os"
	"testing"

	"sigs.k8s.io/kind/pkg/internal/assert"
)

func TestIsTerminal(t *testing.T) {
	// test trivial nil case
	if IsTerminal(nil) {
		t.Fatalf("IsTerminal should be false for nil Writer")
	}
	// test something that isn't even a file
	var buff bytes.Buffer
	if IsTerminal(&buff) {
		t.Fatalf("IsTerminal should be false for bytes.Buffer")
	}
	// test a file
	f, err := os.CreateTemp("", "kind-isterminal")
	if err != nil {
		t.Fatalf("Failed to create tempfile %v", err)
	}
	if IsTerminal(f) {
		t.Fatalf("IsTerminal should be false for nil Writer")
	}
	// TODO: testing an actual PTY would be somewhat tricky to do cleanly
	// but we should maybe do this in the future.
	// At least we know this doesn't trigger on things that are obviously not
	// terminals
	if !IsTerminal(&testFakeTTY{}) {
		t.Fatalf("IsTerminal should be true for testFakeTTY")
	}
}

func TestIsSmartTerminal(t *testing.T) {
	cases := []struct {
		Name    string
		FakeEnv map[string]string
		GOOS    string
		Writer  io.Writer
		IsSmart bool
	}{
		{
			Name:    "tty, no env",
			FakeEnv: map[string]string{},
			GOOS:    "linux",
			IsSmart: true,
			Writer:  &testFakeTTY{},
		},
		{
			Name:    "nil writer, no env",
			FakeEnv: map[string]string{},
			GOOS:    "linux",
			IsSmart: false,
		},
		{
			Name:    "tty, windows, no env",
			FakeEnv: map[string]string{},
			GOOS:    "windows",
			IsSmart: false,
			Writer:  &testFakeTTY{},
		},
		{
			Name: "tty, windows, modern terminal env",
			FakeEnv: map[string]string{
				"WT_SESSION": "baz",
			},
			GOOS:    "windows",
			IsSmart: true,
			Writer:  &testFakeTTY{},
		},
		{
			Name: "tty, TERM=dumb",
			FakeEnv: map[string]string{
				"TERM": "dumb",
			},
			GOOS:    "linux",
			IsSmart: false,
			Writer:  &testFakeTTY{},
		},
		{
			Name: "tty, NO_COLOR=",
			FakeEnv: map[string]string{
				"NO_COLOR": "",
			},
			GOOS:    "linux",
			IsSmart: false,
			Writer:  &testFakeTTY{},
		},
		{
			Name: "tty, Travis CI",
			FakeEnv: map[string]string{
				"TRAVIS":                      "true",
				"HAS_JOSH_K_SEAL_OF_APPROVAL": "true",
			},
			GOOS:    "linux",
			IsSmart: false,
			Writer:  &testFakeTTY{},
		},
		{
			Name: "tty, TERM=st-256color",
			FakeEnv: map[string]string{
				"TERM": "st-256color",
			},
			GOOS:    "linux",
			IsSmart: false,
			Writer:  &testFakeTTY{},
		},
	}
	for _, tc := range cases {
		tc := tc // capture tc
		t.Run(tc.Name, func(t *testing.T) {
			res := isSmartTerminal(tc.Writer, tc.GOOS, func(s string) (string, bool) {
				k, set := tc.FakeEnv[s]
				return k, set
			})
			assert.BoolEqual(t, tc.IsSmart, res)
		})
	}
}