forked from golang/glog
-
Notifications
You must be signed in to change notification settings - Fork 218
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
logcheck: optionally warn about using legacy klog logging
This is even stricter than the check for unstructured klog functions: *all* legacy logging functions can be banned, leaving only those that are still needed for contextual logging.
- Loading branch information
Showing
7 changed files
with
206 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
hack/tools/logcheck/testdata/src/doNotAllowKlog/doNotAllowKlog.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
/* | ||
Copyright 2021 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. | ||
*/ | ||
|
||
// This fake package is created as golang.org/x/tools/go/analysis/analysistest | ||
// expects it to be here for loading. This package is used to test allow-unstructured | ||
// flag which suppresses errors when unstructured logging is used. | ||
// This is a test file for unstructured logging static check tool unit tests. | ||
|
||
package allowUnstructuredLogs | ||
|
||
import ( | ||
klog "k8s.io/klog/v2" | ||
) | ||
|
||
func doNotAlllowKlog() { | ||
klog.InfoS("test log") // want `function "InfoS" should not be used, convert to contextual logging` | ||
klog.ErrorS(nil, "test log") // want `function "ErrorS" should not be used, convert to contextual logging` | ||
klog.V(1).Infof("test log") // want `function "V" should not be used, convert to contextual logging` `function "Infof" should not be used, convert to contextual logging` | ||
} |
37 changes: 37 additions & 0 deletions
37
hack/tools/logcheck/testdata/src/doNotAllowKlog/whitelistedKlog.go
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
/* | ||
Copyright 2021 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. | ||
*/ | ||
|
||
// This fake package is created as golang.org/x/tools/go/analysis/analysistest | ||
// expects it to be here for loading. This package is used to test allow-unstructured | ||
// flag which suppresses errors when unstructured logging is used. | ||
// This is a test file for unstructured logging static check tool unit tests. | ||
|
||
package allowUnstructuredLogs | ||
|
||
import ( | ||
klog "k8s.io/klog/v2" | ||
) | ||
|
||
func allowKlog() { | ||
klog.KObj(nil) | ||
klog.KObjs(nil) | ||
klog.KRef("", "") | ||
klog.FromContext(nil) | ||
klog.TODO() | ||
klog.Background() | ||
klog.LoggerWithName(klog.Logger{}, "foo") | ||
klog.LoggerWithValues(klog.Logger{}, "a", "b") | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters