mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
0f4e30e9db
This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The
directory created by `t.TempDir` is automatically removed when the test
and all its subtests complete.
Prior to this commit, temporary directory created using `ioutil.TempDir`
needs to be removed manually by calling `os.RemoveAll`, which is omitted
in some tests. The error handling boilerplate e.g.
defer func() {
if err := os.RemoveAll(dir); err != nil {
t.Fatal(err)
}
}
is also tedious, but `t.TempDir` handles this for us nicely.
Reference: https://pkg.go.dev/testing#T.TempDir
Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
Co-authored-by: Oliver Nocon <33484802+OliverNocon@users.noreply.github.com>
80 lines
2.0 KiB
Go
80 lines
2.0 KiB
Go
package log
|
|
|
|
import (
|
|
"io/ioutil"
|
|
"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 := t.TempDir()
|
|
|
|
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"`)
|
|
})
|
|
}
|