derrors

Documentation

Overview

Package derrors defines internal error values to categorize the different types of semantic errors.

Index

• Variables
• func CategorizeError(err error) string
• func Cleanup(errp *error, f func() error)
• func IncludeStderr(err error) string
• func IsGoVersionMismatchError(msg string) bool
• func Report(err error)
• func SetReportingClient(c *errorreporting.Client)
• func Wrap(errp *error, format string, args ...interface{})
• func WrapAndReport(errp *error, format string, args ...interface{})
• func WrapStack(errp *error, format string, args ...interface{})
• type StackError
  • func NewStackError(err error) *StackError
  • func (e *StackError) Error() string
  • func (e *StackError) Unwrap() error

Variables

var (
	// NotFound indicates that a requested entity was not found (HTTP 404).
	NotFound = errors.New("not found")

	// NotFetched means that the proxy returned "not found" with the
	// Disable-Module-Fetch header set. We don't know if the module really
	// doesn't exist, or the proxy just didn't fetch it.
	NotFetched = errors.New("not fetched by proxy")

	// InvalidArgument indicates that the input into the request is invalid in
	// some way (HTTP 400).
	InvalidArgument = errors.New("invalid argument")

	// BadModule indicates a problem with a module.
	BadModule = errors.New("bad module")

	// ProxyTimedOut indicates that a request timed out when fetching from the Module Mirror.
	ProxyTimedOut = errors.New("proxy timed out")

	// ProxyError is used to capture non-actionable server errors returned from the proxy.
	ProxyError = errors.New("proxy error")

	// BigQueryError is used to capture server errors returned by BigQuery.
	BigQueryError = errors.New("BigQuery error")

	// ScanModulePanicError is used to capture panic issues.
	ScanModulePanicError = errors.New("scan module panic")

	// ScanModuleOSError is used to capture issues with writing the module zip
	// to disk during the scan setup process. This is not an error with govulncheck.
	ScanModuleOSError = errors.New("scan module OS error")

	// LoadPackagesError is used to capture general unclassified issues with
	// load packages during the scan setup process. This is not an error with
	// govulncheck. There are specific load packages errors that are categorized
	// separately, e.g., LoadPackagesNoGoModError.
	LoadPackagesError = errors.New("scan module load packages error")

	// LoadPackagesGoVersionError is used to capture issues with loading
	// packages where the module is not supported by the current Go version.
	// This is not an error with any specific scan technique.
	LoadPackagesGoVersionError = errors.New("scan module load packages error: Go version mismatch")

	// LoadPackagesNoGoModError is used to capture a specific issue with
	// loading packages during the scan setup process where a go.mod file
	// is missing. This is not an error with govulncheck.
	LoadPackagesNoGoModError = errors.New("scan module load packages error: does not have go.mod")

	// LoadPackagesNoGoSumError is used to capture a specific issue with
	// loading packages during the scan setup process where a go.sum file
	// is missing. This is not an error with govulncheck.
	LoadPackagesNoGoSumError = errors.New("scan module load packages error: does not have go.sum")

	// LoadPackagesNoRequiredModuleError is used to capture a specific
	// issue with loading packages during the scan setup process where a package
	// is imported but no required module is provided. This is not an error with
	// govulncheck and is likely happening due to outdated go.sum file.
	LoadPackagesNoRequiredModuleError = errors.New("scan module load packages error: no required module provided")

	// LoadPackagesMissingGoSumEntryError is used to capture a specific
	// issue with loading packages during the scan setup process where a package
	// is imported but some of its go.sum entries are missing. This is not an error
	// with govulncheck and is likely happening due to outdated go.sum file.
	LoadPackagesMissingGoSumEntryError = errors.New("scan module load packages error: missing go.sum entry")

	// LoadVendorError occurs when loading a package fails because of a vendor directory.
	LoadVendorError = errors.New("scan module load packages error: -mod=vendor mode")

	// LoadPackagesSyntheticError is like LoadPackagesError, but when the target
	// packages are from a synthetic module, i.e., non-module we converted into a module.
	LoadPackagesSyntheticError = errors.New("scan synthetic module error")

	// LoadPackagesImportedLocalError occurs when packages use a replace directive
	// with a local directory in their go.mod file. This is not an error with govulncheck.
	LoadPackagesImportedLocalError = errors.New("scan module load packages error: package replaces an import with a local file/directory")

	// ScanModuleGovulncheckDBConnectionError is used to capture a specific
	// govulncheck scan error where a connection to vuln db failed.
	ScanModuleGovulncheckDBConnectionError = errors.New("scan module govulncheck error: communication with vuln db failed")

	// ScanModuleGovulncheckError is used to capture general issues where
	// govulncheck fails due to an uncategorized error.
	ScanModuleGovulncheckError = errors.New("scan module govulncheck error")

	// ScanSyntheticModuleError is used to capture general issues where
	// govulncheck or analysis fails due to an uncategorized error on a
	// synthetic module. The failure can be due to loading of packages or
	// due to an issue in the analysis.
	ScanSyntheticModuleError = errors.New("scan synthetic module error")

	// ScanModuleSandboxError is used to capture general sandbox related issues.
	ScanModuleSandboxError = errors.New("sandbox related issue")

	// ScanModuleMemoryLimitExceeded occurs when scanning uses too much memory.
	ScanModuleMemoryLimitExceeded = errors.New("scan module memory limit exceeded")

	// ScanModuleTooManyOpenFiles occurs when there are too many files open while scanning.
	ScanModuleTooManyOpenFiles = errors.New("scan module too many open files")
)

Functions

func CategorizeError

func CategorizeError(err error) string

CategorizeError returns the category for a given error.

func Cleanup

func Cleanup(errp *error, f func() error)

Cleanup calls f and combines the error with errp. It is meant to be deferred.

func IncludeStderr

func IncludeStderr(err error) string

IncludeStderr includes the stderr with an *exec.ExitError. If err is not an *exec.ExitError, it returns err.Error().

func IsGoVersionMismatchError

func IsGoVersionMismatchError(msg string) bool

func Report

func Report(err error)

Report uses the errorreporting API to report an error.

func SetReportingClient

func SetReportingClient(c *errorreporting.Client)

SetReportingClient sets an errorreporting client, for use by Report.

func Wrap

func Wrap(errp *error, format string, args ...interface{})

Wrap adds context to the error and allows unwrapping the result to recover the original error.

Example:

defer derrors.Wrap(&err, "copy(%s, %s)", dst, src)
defer derrors.Wrap(&err, "copy(%s, %s)", src, dst)

See Add for an equivalent function that does not allow the result to be unwrapped.

func WrapAndReport

func WrapAndReport(errp *error, format string, args ...interface{})

WrapAndReport calls Wrap followed by Report.

func WrapStack

func WrapStack(errp *error, format string, args ...interface{})

WrapStack is like Wrap, but adds a stack trace if there isn't one already.

Types

type StackError

type StackError struct {
	Stack []byte
	// contains filtered or unexported fields
}

StackError wraps an error and adds a stack trace.

func NewStackError

func NewStackError(err error) *StackError

NewStackError returns a StackError, capturing a stack trace.

func (*StackError) Error

func (e *StackError) Error() string

func (*StackError) Unwrap

func (e *StackError) Unwrap() error