Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ktesting + textlogger config api #368

Merged
merged 2 commits into from
Feb 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions ktesting/example_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -98,3 +98,26 @@ func ExampleNewLogger() {
// E...] I failed err="failure" what="something" data={field:1}
// I...] Logged at level 5.
}

func ExampleConfig_Verbosity() {
var buffer ktesting.BufferTL
config := ktesting.NewConfig(ktesting.Verbosity(1))
logger := ktesting.NewLogger(&buffer, config)

logger.Info("initial verbosity", "v", config.Verbosity().String())
logger.V(2).Info("now you don't see me")
if err := config.Verbosity().Set("2"); err != nil {
logger.Error(err, "setting verbosity to 2")
}
logger.V(2).Info("now you see me")
if err := config.Verbosity().Set("1"); err != nil {
logger.Error(err, "setting verbosity to 1")
}
logger.V(2).Info("now I'm gone again")

fmt.Print(headerRe.ReplaceAllString(buffer.String(), "${1}...] "))

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be nice to have an example here where it reduced the level back to the old one after increasing it to 2.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if err := config.Verbosity().Set("1"); err != nil {
		logger.Error(err, "setting verbosity")
	}
	logger.V(2).Info("now you don't see me")
	logger.Info("restored verbosity", "v", config.Verbosity().String())

Something like above would be nice. Can you please check if that makes sense to add this example here?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


// Output:
// I...] initial verbosity v="1"
// I...] now you see me
}
14 changes: 14 additions & 0 deletions ktesting/options.go
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ type Config struct {
co configOptions
}

// Verbosity returns a value instance that can be used to query (via String) or
// modify (via Set) the verbosity threshold. This is thread-safe and can be
// done at runtime.
func (c *Config) Verbosity() flag.Value {
return c.vstate.V()
}

// VModule returns a value instance that can be used to query (via String) or
// modify (via Set) the vmodule settings. This is thread-safe and can be done
// at runtime.
func (c *Config) VModule() flag.Value {
return c.vstate.VModule()
}

// ConfigOption implements functional parameters for NewConfig.
//
// # Experimental
Expand Down
3 changes: 3 additions & 0 deletions ktesting/testinglogger.go
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,9 @@ var _ TL = &BufferTL{}
// that output will be printed via the global klog logger with
// `<test name> leaked goroutine` as prefix.
//
// Verbosity can be modified at any time through the Config.V and
// Config.VModule API.
//
// # Experimental
//
// Notice: This type is EXPERIMENTAL and may be changed or removed in a
Expand Down
50 changes: 50 additions & 0 deletions textlogger/example_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*
Copyright 2023 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 textlogger_test

import (
"bytes"
"fmt"
"regexp"

"k8s.io/klog/v2/textlogger"
)

var headerRe = regexp.MustCompile(`([IE])[[:digit:]]{4} [[:digit:]]{2}:[[:digit:]]{2}:[[:digit:]]{2}\.[[:digit:]]{6}[[:space:]]+[[:digit:]]+ example_test.go:[[:digit:]]+\] `)

func ExampleConfig_Verbosity() {
var buffer bytes.Buffer
config := textlogger.NewConfig(textlogger.Verbosity(1), textlogger.Output(&buffer))
logger := textlogger.NewLogger(config)

logger.Info("initial verbosity", "v", config.Verbosity().String())
logger.V(2).Info("now you don't see me")
if err := config.Verbosity().Set("2"); err != nil {
logger.Error(err, "setting verbosity to 2")
}
logger.V(2).Info("now you see me")
if err := config.Verbosity().Set("1"); err != nil {
logger.Error(err, "setting verbosity to 1")
}
logger.V(2).Info("now I'm gone again")

fmt.Print(headerRe.ReplaceAllString(buffer.String(), "${1}...] "))

// Output:
// I...] "initial verbosity" v="1"
// I...] "now you see me"
}
24 changes: 19 additions & 5 deletions textlogger/options.go
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,22 @@ import (
// Notice: This type is EXPERIMENTAL and may be changed or removed in a
// later release.
type Config struct {
*verbosity.VState
co configOptions
vstate *verbosity.VState
co configOptions
}

// Verbosity returns a value instance that can be used to query (via String) or
// modify (via Set) the verbosity threshold. This is thread-safe and can be
// done at runtime.
func (c *Config) Verbosity() flag.Value {
return c.vstate.V()
}

// VModule returns a value instance that can be used to query (via String) or
// modify (via Set) the vmodule settings. This is thread-safe and can be done
// at runtime.
func (c *Config) VModule() flag.Value {
return c.vstate.VModule()
}

// ConfigOption implements functional parameters for NewConfig.
Expand Down Expand Up @@ -111,7 +125,7 @@ func Output(output io.Writer) ConfigOption {
// later release.
func NewConfig(opts ...ConfigOption) *Config {
c := &Config{
VState: verbosity.New(),
vstate: verbosity.New(),
co: configOptions{
verbosityFlagName: "v",
vmoduleFlagName: "vmodule",
Expand All @@ -123,7 +137,7 @@ func NewConfig(opts ...ConfigOption) *Config {
opt(&c.co)
}

c.V().Set(strconv.FormatInt(int64(c.co.verbosityDefault), 10))
c.Verbosity().Set(strconv.FormatInt(int64(c.co.verbosityDefault), 10))
return c
}

Expand All @@ -134,6 +148,6 @@ func NewConfig(opts ...ConfigOption) *Config {
// Notice: This function is EXPERIMENTAL and may be changed or removed in a
// later release.
func (c *Config) AddFlags(fs *flag.FlagSet) {
fs.Var(c.V(), c.co.verbosityFlagName, "number for the log level verbosity of the testing logger")
fs.Var(c.Verbosity(), c.co.verbosityFlagName, "number for the log level verbosity of the testing logger")
fs.Var(c.VModule(), c.co.vmoduleFlagName, "comma-separated list of pattern=N log level settings for files matching the patterns")
}
5 changes: 4 additions & 1 deletion textlogger/textlogger.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ var (

// NewLogger constructs a new logger.
//
// Verbosity can be modified at any time through the Config.V and
// Config.VModule API.
//
// # Experimental
//
// Notice: This function is EXPERIMENTAL and may be changed or removed in a
Expand Down Expand Up @@ -82,7 +85,7 @@ func (l *tlogger) WithCallDepth(depth int) logr.LogSink {
func (l *tlogger) Enabled(level int) bool {
// Skip this function and the Logger.Info call, then
// also any additional stack frames from WithCallDepth.
return l.config.Enabled(verbosity.Level(level), 2+l.callDepth)
return l.config.vstate.Enabled(verbosity.Level(level), 2+l.callDepth)
}

func (l *tlogger) Info(level int, msg string, kvList ...interface{}) {
Expand Down