scorecard/errors/public.go

// Copyright 2021 OpenSSF Scorecard Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package errors

import (
	"errors"
	"fmt"
)

var (
	// ErrScorecardInternal indicates a runtime error in Scorecard code.
	ErrScorecardInternal = errors.New("internal error")
	// ErrRepoUnreachable indicates Scorecard is unable to establish connection with the repository.
	ErrRepoUnreachable = errors.New("repo unreachable")
	// ErrorUnsupportedHost indicates the repo's host is unsupported.
	ErrorUnsupportedHost = errors.New("unsupported host")
	// ErrorInvalidURL indicates the repo's full URL was not passed.
	ErrorInvalidURL = errors.New("invalid repo flag")
	// ErrorShellParsing indicates there was an error when parsing shell code.
	ErrorShellParsing = errors.New("error parsing shell code")
	// ErrorUnsupportedCheck indicates check cannot be run for given request.
	ErrorUnsupportedCheck = errors.New("check is not supported for this request")
	// ErrorCheckRuntime indicates an individual check had a runtime error.
	ErrorCheckRuntime = errors.New("check runtime error")
)

// WithMessage wraps any of the errors listed above.
// For examples, see errors/errors.md.
func WithMessage(e error, msg string) error {
	// Note: Errorf automatically wraps the error when used with `%w`.
	if len(msg) > 0 {
		return fmt.Errorf("%w: %v", e, msg)
	}
	// We still need to use %w to prevent callers from using e == ErrInvalidDockerFile.
	return fmt.Errorf("%w", e)
}

// GetName returns the name of the error.
func GetName(err error) string {
	switch {
	case errors.Is(err, ErrScorecardInternal):
		return "ErrScorecardInternal"
	case errors.Is(err, ErrRepoUnreachable):
		return "ErrRepoUnreachable"
	case errors.Is(err, ErrorShellParsing):
		return "ErrorShellParsing"
	default:
		return "ErrUnknown"
	}
}