utests

package

v5.0.0-rc1 Latest Latest Go to latest Published: Apr 12, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package utests defines util fns for Scorecard unit testing.

This section is empty.

This section is empty.

func ValidateLogMessage(isExpectedMessage func(checker.LogMessage, checker.DetailType) bool,
	dl *TestDetailLogger,
) bool

ValidateLogMessage tests that at least one log message returns true for isExpectedMessage.

func ValidateLogMessageOffsets(dl *TestDetailLogger, offsets []uint) bool

ValidateLogMessageOffsets tests that the log message offsets match those in the passed in slice.

func ValidatePinningDependencies(isExpectedDependency func(checker.Dependency) bool,
	r *checker.PinningDependenciesData,
) bool

ValidatePinningDependencies tests that at least one entry returns true for isExpectedMessage.

func ValidateTestReturn(
	tb testing.TB,
	name string,
	expected *TestReturn,
	actual *checker.CheckResult,
	logger *TestDetailLogger,
)

ValidateTestReturn validates expected TestReturn with actual checker.CheckResult values. All test management is handled by this function.

type TestDetailLogger struct {
	// contains filtered or unexported fields
}

TestDetailLogger implements `checker.DetailLogger`.

func (l *TestDetailLogger) Debug(msg *checker.LogMessage)

Debug implements DetailLogger.Debug.

func (l *TestDetailLogger) Flush() []checker.CheckDetail

Flush implements DetailLogger.Flush.

func (l *TestDetailLogger) Info(msg *checker.LogMessage)

Info implements DetailLogger.Info.

func (l *TestDetailLogger) Warn(msg *checker.LogMessage)

Warn implements DetailLogger.Warn.

type TestReturn struct {
	Error         error
	Score         int
	NumberOfWarn  int
	NumberOfInfo  int
	NumberOfDebug int
}

TestReturn encapsulates expected CheckResult return values.