mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
eafe383d54
* Add error category parsing to cmd execution
It is now possible to define `ErrorCategoryMapping` as a `map[string][]string` on a `Command`.
The format contains the category as key which has a list of error patterns assigned.
Example:
```
cmd := Command{
ErrorCategoryMapping: map[string][]string
"build": {"build failed"},
"compliance": {"vulnerabilities found", "outdated components found"},
"test": {"some tests failed"},
},
}
```
Setting this map triggers console log parsing when executing a command.
If a match is found the error category is stored and
it will automatically be added to the `errorDetails.json`.
* clean up go.mod
* fix test
* fix test
* Update DEVELOPMENT.md
* fix tests
* address long console content without line breaks
* scan condition update
* fix test
* add missing comment for exported function
* Update pkg/command/command.go
Co-authored-by: Stephan Aßmus <stephan.assmus@sap.com>
Co-authored-by: Stephan Aßmus <stephan.assmus@sap.com>
Co-authored-by: Christopher Fenner <26137398+CCFenner@users.noreply.github.com>
66 lines
1.4 KiB
Go
66 lines
1.4 KiB
Go
package log
|
|
|
|
// ErrorCategory defines the category of a pipeline error
|
|
type ErrorCategory int
|
|
|
|
// Error categories which allow categorizing failures
|
|
const (
|
|
ErrorUndefined ErrorCategory = iota
|
|
ErrorBuild
|
|
ErrorCompliance
|
|
ErrorConfiguration
|
|
ErrorCustom
|
|
ErrorInfrastructure
|
|
ErrorService
|
|
ErrorTest
|
|
)
|
|
|
|
var errorCategory ErrorCategory = ErrorUndefined
|
|
|
|
func (e ErrorCategory) String() string {
|
|
return [...]string{
|
|
"undefined",
|
|
"build",
|
|
"compliance",
|
|
"config",
|
|
"custom",
|
|
"infrastructure",
|
|
"service",
|
|
"test",
|
|
}[e]
|
|
}
|
|
|
|
// ErrorCategoryByString returns the error category based on the category text
|
|
func ErrorCategoryByString(category string) ErrorCategory {
|
|
switch category {
|
|
case "build":
|
|
return ErrorBuild
|
|
case "compliance":
|
|
return ErrorCompliance
|
|
case "config":
|
|
return ErrorConfiguration
|
|
case "custom":
|
|
return ErrorCustom
|
|
case "infrastructure":
|
|
return ErrorInfrastructure
|
|
case "service":
|
|
return ErrorService
|
|
case "test":
|
|
return ErrorTest
|
|
}
|
|
return ErrorUndefined
|
|
}
|
|
|
|
// SetErrorCategory sets the error category
|
|
// This can be used later by calling log.GetErrorCategory()
|
|
// In addition it will be used when exiting the program with
|
|
// log.FatalError(err, message)
|
|
func SetErrorCategory(category ErrorCategory) {
|
|
errorCategory = category
|
|
}
|
|
|
|
// GetErrorCategory retrieves the error category which is currently known to the execution of a step
|
|
func GetErrorCategory() ErrorCategory {
|
|
return errorCategory
|
|
}
|