mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-12 10:55:20 +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>
86 lines
2.2 KiB
Go
86 lines
2.2 KiB
Go
package log
|
|
|
|
import (
|
|
"io/ioutil"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/sirupsen/logrus"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestFatalHookLevels(t *testing.T) {
|
|
hook := FatalHook{}
|
|
assert.Equal(t, []logrus.Level{logrus.FatalLevel}, hook.Levels())
|
|
}
|
|
|
|
func TestFatalHookFire(t *testing.T) {
|
|
workspace, err := ioutil.TempDir("", "")
|
|
if err != nil {
|
|
t.Fatal("Failed to create temporary workspace directory")
|
|
}
|
|
// clean up tmp dir
|
|
defer os.RemoveAll(workspace)
|
|
|
|
t.Run("with step name", func(t *testing.T) {
|
|
hook := FatalHook{
|
|
Path: workspace,
|
|
CorrelationID: "https://build.url",
|
|
}
|
|
entry := logrus.Entry{
|
|
Data: logrus.Fields{
|
|
"category": "testCategory",
|
|
"stepName": "testStep",
|
|
},
|
|
Message: "the error message",
|
|
}
|
|
|
|
err := hook.Fire(&entry)
|
|
|
|
assert.NoError(t, err)
|
|
fileContent, err := ioutil.ReadFile(filepath.Join(workspace, "testStep_errorDetails.json"))
|
|
assert.NoError(t, err)
|
|
assert.NotContains(t, string(fileContent), `"category":"testCategory"`)
|
|
assert.Contains(t, string(fileContent), `"correlationId":"https://build.url"`)
|
|
assert.Contains(t, string(fileContent), `"message":"the error message"`)
|
|
})
|
|
|
|
t.Run("no step name", func(t *testing.T) {
|
|
hook := FatalHook{
|
|
Path: workspace,
|
|
CorrelationID: "https://build.url",
|
|
}
|
|
entry := logrus.Entry{
|
|
Data: logrus.Fields{
|
|
"category": "testCategory",
|
|
},
|
|
Message: "the error message",
|
|
}
|
|
|
|
err := hook.Fire(&entry)
|
|
|
|
assert.NoError(t, err)
|
|
fileContent, err := ioutil.ReadFile(filepath.Join(workspace, "errorDetails.json"))
|
|
assert.NoError(t, err)
|
|
assert.NotContains(t, string(fileContent), `"category":"testCategory"`)
|
|
assert.Contains(t, string(fileContent), `"correlationId":"https://build.url"`)
|
|
assert.Contains(t, string(fileContent), `"message":"the error message"`)
|
|
})
|
|
|
|
t.Run("file exists", func(t *testing.T) {
|
|
hook := FatalHook{}
|
|
entry := logrus.Entry{
|
|
Message: "the new error message",
|
|
}
|
|
|
|
err := hook.Fire(&entry)
|
|
|
|
assert.NoError(t, err)
|
|
fileContent, err := ioutil.ReadFile(filepath.Join(workspace, "errorDetails.json"))
|
|
assert.NoError(t, err)
|
|
|
|
assert.Contains(t, string(fileContent), `"message":"the error message"`)
|
|
})
|
|
}
|