Skip to content

Commit c786e4f

Browse files
committed
commands/.../scorecard/test_definitions: add some godoc
1 parent 11b1270 commit c786e4f

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

commands/operator-sdk/cmd/scorecard/test_definitions.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ import (
2525

2626
// Struct definitions
2727

28+
// ScorecardVars contains all necessary variables for running scorecard tests
2829
type ScorecardVars struct {
2930
client *client.Client
3031
crObj *unstructured.Unstructured
@@ -34,13 +35,14 @@ type ScorecardVars struct {
3435
retryInterval int
3536
}
3637

38+
// Score contains the number of earned points and maximum number of points
3739
type Score struct {
3840
earnedPoints int
3941
maximumPoints int
4042
}
4143

44+
// Test defines a scorecard test
4245
type Test struct {
43-
testType string
4446
name string
4547
description string
4648
// by having an array of scores, we can more easily add support for multiple CR
@@ -50,6 +52,7 @@ type Test struct {
5052
run func(*Test, ScorecardVars) error
5153
}
5254

55+
// TestSuite defines a suite of scorecard tests
5356
type TestSuite struct {
5457
name string
5558
description string

0 commit comments

Comments
 (0)