File: logs_test.go

package info (click to toggle)
golang-k8s-component-base 0.33.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,480 kB
  • sloc: makefile: 4
file content (119 lines) | stat: -rw-r--r-- 3,117 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
/*
Copyright 2022 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 logs_test

import (
	"os"
	"path"
	"testing"

	"k8s.io/component-base/logs"
	logsapi "k8s.io/component-base/logs/api/v1"
	_ "k8s.io/component-base/logs/json/register"
	"k8s.io/klog/v2"
)

func TestGlogSetter(t *testing.T) {
	testcases := map[string]struct {
		init func(t *testing.T)
		// write must write at verbosity level 1.
		write func()
	}{
		"klog": {
			init: func(t *testing.T) {},
			write: func() {
				klog.V(1).Info("hello")
			},
		},
		"json": {
			init: func(t *testing.T) {
				c := logsapi.NewLoggingConfiguration()
				c.Format = "json"
				if err := logsapi.ValidateAndApply(c, nil /* feature gates */); err != nil {
					t.Fatalf("Unexpected error enabling json output: %v", err)
				}
			},
			write: func() {
				klog.Background().V(1).Info("hello")
			},
		},
		"text": {
			init: func(t *testing.T) {
				c := logsapi.NewLoggingConfiguration()
				c.Format = "text"
				if err := logsapi.ValidateAndApply(c, nil /* feature gates */); err != nil {
					t.Fatalf("Unexpected error enabling text output: %v", err)
				}
			},
			write: func() {
				klog.Background().V(1).Info("hello")
			},
		},
	}

	for name, tc := range testcases {
		t.Run(name, func(t *testing.T) {
			state := klog.CaptureState()
			t.Cleanup(state.Restore)
			tmpdir := t.TempDir()
			tmpfile := path.Join(tmpdir, "stderr.log")
			oldStderr := os.Stderr
			defer func() {
				os.Stderr = oldStderr
			}()
			newStderr, err := os.Create(tmpfile)
			if err != nil {
				t.Fatalf("Unexpected error creating temp file: %v", err)
			}
			os.Stderr = newStderr

			defer func() {
				if err := logsapi.ResetForTest(nil /* feature gates */); err != nil {
					t.Errorf("Unexpected error resetting the logging configuration: %v", err)
				}
			}()
			tc.init(t)

			// First write with default verbosity level of 0 -> no output.
			tc.write()
			klog.Flush()
			out, err := os.ReadFile(tmpfile)
			if err != nil {
				t.Fatalf("Unexpected error reading temp file: %v", err)
			}
			if len(out) > 0 {
				t.Fatalf("Info message should have been discarded, got instead:\n%s", string(out))
			}

			// Increase verbosity at runtime.
			if _, err := logs.GlogSetter("1"); err != nil {
				t.Fatalf("Unexpected error setting verbosity level: %v", err)
			}

			// Now write again -> output.
			tc.write()
			klog.Flush()
			out, err = os.ReadFile(tmpfile)
			if err != nil {
				t.Fatalf("Unexpected error reading temp file: %v", err)
			}
			if len(out) == 0 {
				t.Fatal("Info message should have been written, got empty file instead.")
			}
		})
	}
}