check for interface inheritance #15
Conversation
k8s-ci-robot
added
cncf-cla: yes
|
This issue is currently awaiting triage. If logtools contributors determine this is a relevant issue, they will accept it by applying the The Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
k8s-ci-robot
added
the
size/L
k8s-ci-robot
added
the
do-not-merge/work-in-progress
|
The same check also makes sense for |
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
|
I added logr.Marshaler checking and proposed klog.Format. That PR needs to get merged first. /hold |
k8s-ci-robot
added
the
do-not-merge/hold
|
/hold cancel klog.Format got merged. |
k8s-ci-robot
removed
the
do-not-merge/hold
|
/assign @serathius |
logcheck/pkg/logcheck.go
Outdated
| @@ -561,6 +565,14 @@ func kvCheck(keyValues []ast.Expr, fun ast.Expr, pass *analysis.Pass, funName st | |||
|
|
|||
| for index, arg := range keyValues { | |||
| if index%2 != 0 { | |||
| // Check values? | |||
There was a problem hiding this comment.
Oh, this makes this loop even harder to read. Could we separate key and value validation by using a dedicated functions? For example
func kvCheck(keyValues []ast.Expr, fun ast.Expr, pass *analysis.Pass, funName string, keyCheckEnabled, parametersCheckEnabled, valueCheckEnabled bool) {
...
for index, arg := range keyValues {
if index%2 == 0 {
checkKey(keyValues []ast.Expr, fun ast.Expr, pass *analysis.Pass, funName string, keyCheckEnabled)
checkParameters(keyValues []ast.Expr, fun ast.Expr, pass *analysis.Pass, funName string, parametersCheckEnabled)
}
checkValue(keyValues []ast.Expr, fun ast.Expr, pass *analysis.Pass, funName string, valueCheckEnabled)
}
}
There was a problem hiding this comment.
Agreed, let's split it up.
I think a switch statement with two cases works best here because it puts both check calls at the same indention. Indenting one but not the other as in an if+continue looks weird.
There was a problem hiding this comment.
Yes, switch is great idea. I hate golang aversion for else.
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: pohly, serathius The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/hold golangci-lint is unhappy. |
k8s-ci-robot
added
the
do-not-merge/hold
The two flavors of key checking (plain ASCII and the stricter Kubernetes guidelines) are now done in the same function. This is a first step towards also checking values in that same function. While at it, a small bug for format specifier checking of klog calls gets fixed: it was done twice, once without honoring the enable flag for it.
If a type inherits String from some embedded field, then the klog text output will only print the result of that function call, which then includes only information about the embedded field (example: kubernetes/kubernetes#115950). The right solution for this problem is TBD.
k8s-ci-robot
removed
the
lgtm
|
/lgtm |
k8s-ci-robot
added
the
lgtm
|
/hold cancel |
k8s-ci-robot
removed
the
do-not-merge/hold
|
/hold |
k8s-ci-robot
added
the
do-not-merge/hold
|
/hold cancel Tide seems to have missed the label change... let's do it again. |
k8s-ci-robot
removed
the
do-not-merge/hold
This is a static analysis check for the problem reported in kubernetes/kubernetes#115950: converting unstructured logging of the form
"%v", someObjto"obj", someObjproduces undesirable output in the klog text format whensomeObjis of a type which has an incompletefmt.Stringerimplementation because it inherits that from an embedded field.In Kubernetes, this currently finds: