mirror of
https://github.com/ossf/scorecard.git
synced 2024-09-20 21:47:51 +03:00
90332a9cb9
* Add counting of shell parsing errors * Use existing CheckErrors metric instead Co-authored-by: Azeem Shaikh <azeemshaikh38@gmail.com>
58 lines
1.8 KiB
Go
58 lines
1.8 KiB
Go
// Copyright 2021 Security 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"
|
|
)
|
|
|
|
//nolint
|
|
var (
|
|
ErrScorecardInternal = errors.New("internal error")
|
|
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")
|
|
)
|
|
|
|
// 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"
|
|
}
|
|
}
|