Skip to content

Commit 303915f

Browse files
committed
Respond to review comments.
1 parent 389b06b commit 303915f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

contributors/devel/sig-testing/verify-tests.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
- [Verification Tests](#verification-tests)
66
- [Overview](#overview)
7-
- [`verify-govet-leveee`](#verify-govet-levee)
7+
- [`verify-govet-levee`](#verify-govet-leve)
88

99
## Overview
1010

@@ -15,7 +15,8 @@ All blocking verification tests can be executed via `make verify`.
1515
Individual verification tests also can be found in vestigial shell scripts at `hack/verify-*.sh`.
1616

1717
Most verification tests are self-explanatory.
18-
`verify-golint` and `verify-gofmt`, for instance, fail when a contribution does not adhere to lint and formatting conventions.
18+
`verify-govet`, for instance, performs `go vet` checks, which [defends against common mistakes](https://golang.org/cmd/vet/).
19+
The verification tests fails when `go vet` produces any findings.
1920
More complex verification tests are described below.
2021

2122
### `verify-govet-levee`
@@ -27,7 +28,7 @@ Field tagging was introduced by [KEP-1753](https://github.com/kubernetes/enhance
2728
Additional credential sources may be identified in analysis configuration (see below).
2829

2930
Taint propagation analysis defends against both direct and indirect logging of credentials.
30-
For consider the following hypothetical snippet.
31+
Consider the following hypothetical snippet.
3132

3233
```golang
3334
// kubernetes/cmd/kubelet/app/server.go
@@ -68,9 +69,8 @@ The analysis will detect this as well and call the verification test to fail.
6869

6970
When this analysis causes the verification test to fail, a developer has several options.
7071
In order of decreasing preference:
71-
* Reconstruct logging calls such that only relevant information is passed.
72-
* If analysis warning is produced by a tainted value reaching logs, reconstruct the method which caused taint to spread so that it only takes non-credential values.
73-
* Reconstruct the method which caused taint to spread to return indicators which are not logged directly, e.g. return `value, ok` rather than `value, err`.
72+
* Reconstruct logging calls such that only non-secret information is passed.
73+
* Reconstruct a method which caused taint to spread to return indicators which are not logged directly, e.g. return `value, ok` rather than `value, err`.
7474
* Write a *sanitizer* whose return value is guaranteed to be log-safe. Add this sanitizer to the analysis configuration (see below).
7575
* Add the method where the log call occurs to the analysis configuration exclude-list.
7676

0 commit comments

Comments
 (0)