mirror of
https://github.com/k3s-io/kubernetes.git
synced 2025-07-25 20:53:33 +00:00
Merge pull request #102625 from serathius/klog-integration
Add klog integration tests
This commit is contained in:
Kubernetes Prow Robot
GitHub
commit
1b71cc567f
@ -19,7 +19,6 @@ package logs
|
|||||||
import (
|
import (
|
||||||
"bufio"
|
"bufio"
|
||||||
"bytes"
|
"bytes"
|
||||||
"flag"
|
|
||||||
"fmt"
|
"fmt"
|
||||||
"testing"
|
"testing"
|
||||||
"time"
|
"time"
|
||||||
@ -28,8 +27,6 @@ import (
|
|||||||
|
|
||||||
"go.uber.org/zap"
|
"go.uber.org/zap"
|
||||||
"go.uber.org/zap/zapcore"
|
"go.uber.org/zap/zapcore"
|
||||||
|
|
||||||
"k8s.io/klog/v2"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
// TestZapLoggerInfo test ZapLogger json info format
|
// TestZapLoggerInfo test ZapLogger json info format
|
||||||
@ -147,38 +144,6 @@ func TestZapLoggerError(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestKlogV test klog -v(--verbose) func available with json logger
|
|
||||||
func TestKlogV(t *testing.T) {
|
|
||||||
var buffer testBuff
|
|
||||||
logger := NewJSONLogger(&buffer)
|
|
||||||
klog.SetLogger(logger)
|
|
||||||
defer klog.SetLogger(nil)
|
|
||||||
fs := flag.FlagSet{}
|
|
||||||
klog.InitFlags(&fs)
|
|
||||||
totalLogsWritten := 0
|
|
||||||
|
|
||||||
defer fs.Set("v", "0")
|
|
||||||
|
|
||||||
for i := 0; i < 11; i++ {
|
|
||||||
err := fs.Set("v", fmt.Sprintf("%d", i))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("Failed to set verbosity")
|
|
||||||
}
|
|
||||||
for j := 0; j < 11; j++ {
|
|
||||||
klog.V(klog.Level(j)).Info("test", "time", time.Microsecond)
|
|
||||||
logWritten := buffer.writeCount > 0
|
|
||||||
totalLogsWritten += buffer.writeCount
|
|
||||||
buffer.writeCount = 0
|
|
||||||
if logWritten == (i < j) {
|
|
||||||
t.Errorf("klog.V(%d).Info(...) wrote log when -v=%d", j, i)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if totalLogsWritten != 66 {
|
|
||||||
t.Fatalf("Unexpected number of logs written, got %d, expected 66", totalLogsWritten)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type testBuff struct {
|
type testBuff struct {
|
||||||
writeCount int
|
writeCount int
|
||||||
}
|
}
|
||||||
|
|||||||
242
staging/src/k8s.io/component-base/logs/json/klog_test.go
Normal file
242
staging/src/k8s.io/component-base/logs/json/klog_test.go
Normal file
@ -0,0 +1,242 @@
|
|||||||
|
/*
|
||||||
|
Copyright 2020 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
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"errors"
|
||||||
|
"flag"
|
||||||
|
"fmt"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/stretchr/testify/assert"
|
||||||
|
"go.uber.org/zap/zapcore"
|
||||||
|
|
||||||
|
"k8s.io/klog/v2"
|
||||||
|
)
|
||||||
|
|
||||||
|
func TestKlogIntegration(t *testing.T) {
|
||||||
|
fs := flag.FlagSet{}
|
||||||
|
klog.InitFlags(&fs)
|
||||||
|
err := fs.Set("v", fmt.Sprintf("%d", 1))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Failed to set verbosity")
|
||||||
|
}
|
||||||
|
tcs := []struct {
|
||||||
|
name string
|
||||||
|
fun func()
|
||||||
|
format string
|
||||||
|
}{
|
||||||
|
{
|
||||||
|
name: "Info",
|
||||||
|
fun: func() {
|
||||||
|
klog.Info("test ", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "V(1).Info",
|
||||||
|
fun: func() {
|
||||||
|
klog.V(1).Info("test ", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":1}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Infof",
|
||||||
|
fun: func() {
|
||||||
|
klog.Infof("test %d", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "V(1).Infof",
|
||||||
|
fun: func() {
|
||||||
|
klog.V(1).Infof("test %d", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":1}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Infoln",
|
||||||
|
fun: func() {
|
||||||
|
klog.Infoln("test", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "V(1).Infoln",
|
||||||
|
fun: func() {
|
||||||
|
klog.V(1).Infoln("test", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":1}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "InfoDepth",
|
||||||
|
fun: func() {
|
||||||
|
klog.InfoDepth(1, "test ", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "InfoS",
|
||||||
|
fun: func() {
|
||||||
|
klog.InfoS("test", "count", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test","v":0,"count":1}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "V(1).InfoS",
|
||||||
|
fun: func() {
|
||||||
|
klog.V(1).InfoS("test", "count", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test","v":1,"count":1}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "InfoSDepth",
|
||||||
|
fun: func() {
|
||||||
|
klog.InfoSDepth(1, "test", "count", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test","v":0,"count":1}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Warning",
|
||||||
|
fun: func() {
|
||||||
|
klog.Warning("test ", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "WarningDepth",
|
||||||
|
fun: func() {
|
||||||
|
klog.WarningDepth(1, "test ", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Warningln",
|
||||||
|
fun: func() {
|
||||||
|
klog.Warningln("test", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Warningf",
|
||||||
|
fun: func() {
|
||||||
|
klog.Warningf("test %d", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Error",
|
||||||
|
fun: func() {
|
||||||
|
klog.Error("test ", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "ErrorDepth",
|
||||||
|
fun: func() {
|
||||||
|
klog.ErrorDepth(1, "test ", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Errorln",
|
||||||
|
fun: func() {
|
||||||
|
klog.Errorln("test", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "Errorf",
|
||||||
|
fun: func() {
|
||||||
|
klog.Errorf("test %d", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test 1\n","v":0}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "ErrorS",
|
||||||
|
fun: func() {
|
||||||
|
err := errors.New("fail")
|
||||||
|
klog.ErrorS(err, "test", "count", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test","v":0,"count":1,"err":"fail"}`,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "ErrorSDepth",
|
||||||
|
fun: func() {
|
||||||
|
err := errors.New("fail")
|
||||||
|
klog.ErrorSDepth(1, err, "test", "count", 1)
|
||||||
|
},
|
||||||
|
format: `{"ts":%f,"msg":"test","v":0,"count":1,"err":"fail"}`,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
for _, tc := range tcs {
|
||||||
|
t.Run(tc.name, func(t *testing.T) {
|
||||||
|
var buffer bytes.Buffer
|
||||||
|
var logger = NewJSONLogger(zapcore.AddSync(&buffer))
|
||||||
|
klog.SetLogger(logger)
|
||||||
|
defer klog.SetLogger(nil)
|
||||||
|
|
||||||
|
tc.fun()
|
||||||
|
var ts float64
|
||||||
|
logString := strings.TrimSuffix(buffer.String(), "\n")
|
||||||
|
n, err := fmt.Sscanf(logString, tc.format, &ts)
|
||||||
|
if n != 1 || err != nil {
|
||||||
|
t.Errorf("log format error: %d elements, error %s:\n%s", n, err, logString)
|
||||||
|
}
|
||||||
|
expect := fmt.Sprintf(tc.format, ts)
|
||||||
|
if !assert.Equal(t, expect, logString) {
|
||||||
|
t.Errorf("Info has wrong format \n expect:%s\n got:%s", expect, logString)
|
||||||
|
}
|
||||||
|
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestKlogV test klog -v(--verbose) func available with json logger
|
||||||
|
func TestKlogV(t *testing.T) {
|
||||||
|
var buffer testBuff
|
||||||
|
logger := NewJSONLogger(&buffer)
|
||||||
|
klog.SetLogger(logger)
|
||||||
|
defer klog.SetLogger(nil)
|
||||||
|
fs := flag.FlagSet{}
|
||||||
|
klog.InitFlags(&fs)
|
||||||
|
totalLogsWritten := 0
|
||||||
|
|
||||||
|
defer fs.Set("v", "0")
|
||||||
|
|
||||||
|
for i := 0; i < 11; i++ {
|
||||||
|
err := fs.Set("v", fmt.Sprintf("%d", i))
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("Failed to set verbosity")
|
||||||
|
}
|
||||||
|
for j := 0; j < 11; j++ {
|
||||||
|
klog.V(klog.Level(j)).Info("test", "time", time.Microsecond)
|
||||||
|
logWritten := buffer.writeCount > 0
|
||||||
|
totalLogsWritten += buffer.writeCount
|
||||||
|
buffer.writeCount = 0
|
||||||
|
if logWritten == (i < j) {
|
||||||
|
t.Errorf("klog.V(%d).Info(...) wrote log when -v=%d", j, i)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if totalLogsWritten != 66 {
|
||||||
|
t.Fatalf("Unexpected number of logs written, got %d, expected 66", totalLogsWritten)
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue
Block a user