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>
324 lines
10 KiB
Go
324 lines
10 KiB
Go
package cmd
|
|
|
|
import (
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/SAP/jenkins-library/pkg/abaputils"
|
|
"github.com/SAP/jenkins-library/pkg/log"
|
|
"github.com/sirupsen/logrus/hooks/test"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestRunAbapEnvironmentCreateTag(t *testing.T) {
|
|
|
|
t.Run("happy path", func(t *testing.T) {
|
|
|
|
var autils = &abaputils.AUtilsMock{}
|
|
defer autils.Cleanup()
|
|
autils.ReturnedConnectionDetailsHTTP.Password = "password"
|
|
autils.ReturnedConnectionDetailsHTTP.User = "user"
|
|
autils.ReturnedConnectionDetailsHTTP.URL = "https://example.com"
|
|
autils.ReturnedConnectionDetailsHTTP.XCsrfToken = "xcsrftoken"
|
|
|
|
dir := t.TempDir()
|
|
oldCWD, _ := os.Getwd()
|
|
_ = os.Chdir(dir)
|
|
// clean up tmp dir
|
|
defer func() {
|
|
_ = os.Chdir(oldCWD)
|
|
}()
|
|
|
|
body := `---
|
|
addonVersion: "1.2.3"
|
|
addonProduct: "/DMO/PRODUCT"
|
|
repositories:
|
|
- name: /DMO/SWC
|
|
branch: main
|
|
commitID: 1234abcd
|
|
version: "4.5.6"
|
|
`
|
|
file, _ := os.Create("repo.yml")
|
|
_, err := file.Write([]byte(body))
|
|
assert.NoError(t, err)
|
|
config := &abapEnvironmentCreateTagOptions{
|
|
Username: "dummy",
|
|
Password: "dummy",
|
|
Host: "https://test.com",
|
|
Repositories: "repo.yml",
|
|
TagName: "tag",
|
|
TagDescription: "desc",
|
|
GenerateTagForAddonProductVersion: true,
|
|
GenerateTagForAddonComponentVersion: true,
|
|
}
|
|
client := &abaputils.ClientMock{
|
|
BodyList: []string{
|
|
`{"d" : { "Status" : "S" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "Status" : "S" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "Status" : "S" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "empty" : "body" } }`,
|
|
},
|
|
Token: "myToken",
|
|
StatusCode: 200,
|
|
}
|
|
|
|
_, hook := test.NewNullLogger()
|
|
log.RegisterHook(hook)
|
|
|
|
err = runAbapEnvironmentCreateTag(config, nil, autils, client)
|
|
|
|
assert.NoError(t, err, "Did not expect error")
|
|
assert.Equal(t, 3, len(hook.Entries), "Expected a different number of entries")
|
|
assert.Equal(t, `Created tag v4.5.6 for repository /DMO/SWC with commitID 1234abcd`, hook.AllEntries()[0].Message, "Expected a different message")
|
|
assert.Equal(t, `Created tag -DMO-PRODUCT-1.2.3 for repository /DMO/SWC with commitID 1234abcd`, hook.AllEntries()[1].Message, "Expected a different message")
|
|
assert.Equal(t, `Created tag tag for repository /DMO/SWC with commitID 1234abcd`, hook.AllEntries()[2].Message, "Expected a different message")
|
|
hook.Reset()
|
|
})
|
|
|
|
t.Run("backend error", func(t *testing.T) {
|
|
|
|
var autils = &abaputils.AUtilsMock{}
|
|
defer autils.Cleanup()
|
|
autils.ReturnedConnectionDetailsHTTP.Password = "password"
|
|
autils.ReturnedConnectionDetailsHTTP.User = "user"
|
|
autils.ReturnedConnectionDetailsHTTP.URL = "https://example.com"
|
|
autils.ReturnedConnectionDetailsHTTP.XCsrfToken = "xcsrftoken"
|
|
|
|
dir := t.TempDir()
|
|
oldCWD, _ := os.Getwd()
|
|
_ = os.Chdir(dir)
|
|
// clean up tmp dir
|
|
defer func() {
|
|
_ = os.Chdir(oldCWD)
|
|
}()
|
|
|
|
body := `---
|
|
addonVersion: "1.2.3"
|
|
addonProduct: "/DMO/PRODUCT"
|
|
repositories:
|
|
- name: /DMO/SWC
|
|
branch: main
|
|
commitID: 1234abcd
|
|
version: "4.5.6"
|
|
`
|
|
file, _ := os.Create("repo.yml")
|
|
_, err := file.Write([]byte(body))
|
|
assert.NoError(t, err)
|
|
config := &abapEnvironmentCreateTagOptions{
|
|
Username: "dummy",
|
|
Password: "dummy",
|
|
Host: "https://test.com",
|
|
Repositories: "repo.yml",
|
|
TagName: "tag",
|
|
TagDescription: "desc",
|
|
GenerateTagForAddonProductVersion: true,
|
|
GenerateTagForAddonComponentVersion: true,
|
|
}
|
|
client := &abaputils.ClientMock{
|
|
BodyList: []string{
|
|
`{"d" : { "Status" : "E" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "Status" : "E" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "Status" : "E" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "empty" : "body" } }`,
|
|
},
|
|
Token: "myToken",
|
|
StatusCode: 200,
|
|
}
|
|
|
|
_, hook := test.NewNullLogger()
|
|
log.RegisterHook(hook)
|
|
|
|
err = runAbapEnvironmentCreateTag(config, nil, autils, client)
|
|
|
|
assert.Error(t, err, "Did expect error")
|
|
assert.Equal(t, 4, len(hook.Entries), "Expected a different number of entries")
|
|
assert.Equal(t, `NOT created: Tag v4.5.6 for repository /DMO/SWC with commitID 1234abcd`, hook.AllEntries()[0].Message, "Expected a different message")
|
|
assert.Equal(t, `NOT created: Tag -DMO-PRODUCT-1.2.3 for repository /DMO/SWC with commitID 1234abcd`, hook.AllEntries()[1].Message, "Expected a different message")
|
|
assert.Equal(t, `NOT created: Tag tag for repository /DMO/SWC with commitID 1234abcd`, hook.AllEntries()[2].Message, "Expected a different message")
|
|
assert.Equal(t, `At least one tag has not been created`, hook.AllEntries()[3].Message, "Expected a different message")
|
|
hook.Reset()
|
|
|
|
})
|
|
|
|
}
|
|
|
|
func TestRunAbapEnvironmentCreateTagConfigurations(t *testing.T) {
|
|
|
|
t.Run("no repo.yml", func(t *testing.T) {
|
|
|
|
var autils = &abaputils.AUtilsMock{}
|
|
defer autils.Cleanup()
|
|
autils.ReturnedConnectionDetailsHTTP.Password = "password"
|
|
autils.ReturnedConnectionDetailsHTTP.User = "user"
|
|
autils.ReturnedConnectionDetailsHTTP.URL = "https://example.com"
|
|
autils.ReturnedConnectionDetailsHTTP.XCsrfToken = "xcsrftoken"
|
|
|
|
config := &abapEnvironmentCreateTagOptions{
|
|
Username: "dummy",
|
|
Password: "dummy",
|
|
Host: "https://test.com",
|
|
RepositoryName: "/DMO/SWC",
|
|
CommitID: "1234abcd",
|
|
TagName: "tag",
|
|
TagDescription: "desc",
|
|
GenerateTagForAddonProductVersion: true,
|
|
GenerateTagForAddonComponentVersion: true,
|
|
}
|
|
client := &abaputils.ClientMock{
|
|
BodyList: []string{
|
|
`{"d" : { "Status" : "S" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "empty" : "body" } }`,
|
|
},
|
|
Token: "myToken",
|
|
StatusCode: 200,
|
|
}
|
|
|
|
_, hook := test.NewNullLogger()
|
|
log.RegisterHook(hook)
|
|
|
|
err := runAbapEnvironmentCreateTag(config, nil, autils, client)
|
|
|
|
assert.NoError(t, err, "Did not expect error")
|
|
assert.Equal(t, 1, len(hook.Entries), "Expected a different number of entries")
|
|
assert.Equal(t, `Created tag tag for repository /DMO/SWC with commitID 1234abcd`, hook.AllEntries()[0].Message, "Expected a different message")
|
|
hook.Reset()
|
|
})
|
|
|
|
t.Run("backend error", func(t *testing.T) {
|
|
|
|
var autils = &abaputils.AUtilsMock{}
|
|
defer autils.Cleanup()
|
|
autils.ReturnedConnectionDetailsHTTP.Password = "password"
|
|
autils.ReturnedConnectionDetailsHTTP.User = "user"
|
|
autils.ReturnedConnectionDetailsHTTP.URL = "https://example.com"
|
|
autils.ReturnedConnectionDetailsHTTP.XCsrfToken = "xcsrftoken"
|
|
|
|
dir := t.TempDir()
|
|
oldCWD, _ := os.Getwd()
|
|
_ = os.Chdir(dir)
|
|
// clean up tmp dir
|
|
defer func() {
|
|
_ = os.Chdir(oldCWD)
|
|
}()
|
|
|
|
body := `---
|
|
addonVersion: "1.2.3"
|
|
addonProduct: "/DMO/PRODUCT"
|
|
repositories:
|
|
- name: /DMO/SWC
|
|
branch: main
|
|
commitID: 1234abcd
|
|
version: "4.5.6"
|
|
`
|
|
file, _ := os.Create("repo.yml")
|
|
_, err := file.Write([]byte(body))
|
|
assert.NoError(t, err)
|
|
config := &abapEnvironmentCreateTagOptions{
|
|
Username: "dummy",
|
|
Password: "dummy",
|
|
Host: "https://test.com",
|
|
Repositories: "repo.yml",
|
|
RepositoryName: "/DMO/SWC2",
|
|
CommitID: "1234abcde",
|
|
TagName: "tag",
|
|
TagDescription: "desc",
|
|
GenerateTagForAddonProductVersion: true,
|
|
GenerateTagForAddonComponentVersion: true,
|
|
}
|
|
client := &abaputils.ClientMock{
|
|
BodyList: []string{
|
|
`{"d" : { "Status" : "S" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "Status" : "S" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "Status" : "S" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "Status" : "S" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "Status" : "S" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "empty" : "body" } }`,
|
|
},
|
|
Token: "myToken",
|
|
StatusCode: 200,
|
|
}
|
|
|
|
err = runAbapEnvironmentCreateTag(config, nil, autils, client)
|
|
|
|
assert.Error(t, err, "Did expect error")
|
|
assert.Equal(t, "Something failed during the tag creation: Configuring the parameter repositories and the parameter repositoryName at the same time is not allowed", err.Error(), "Expected different error message")
|
|
|
|
})
|
|
|
|
t.Run("flags false", func(t *testing.T) {
|
|
|
|
var autils = &abaputils.AUtilsMock{}
|
|
defer autils.Cleanup()
|
|
autils.ReturnedConnectionDetailsHTTP.Password = "password"
|
|
autils.ReturnedConnectionDetailsHTTP.User = "user"
|
|
autils.ReturnedConnectionDetailsHTTP.URL = "https://example.com"
|
|
autils.ReturnedConnectionDetailsHTTP.XCsrfToken = "xcsrftoken"
|
|
|
|
dir := t.TempDir()
|
|
oldCWD, _ := os.Getwd()
|
|
_ = os.Chdir(dir)
|
|
// clean up tmp dir
|
|
defer func() {
|
|
_ = os.Chdir(oldCWD)
|
|
_ = os.RemoveAll(dir)
|
|
}()
|
|
|
|
body := `---
|
|
addonVersion: "1.2.3"
|
|
addonProduct: "/DMO/PRODUCT"
|
|
repositories:
|
|
- name: /DMO/SWC
|
|
branch: main
|
|
commitID: 1234abcd
|
|
version: "4.5.6"
|
|
`
|
|
file, _ := os.Create("repo.yml")
|
|
_, err := file.Write([]byte(body))
|
|
assert.NoError(t, err)
|
|
config := &abapEnvironmentCreateTagOptions{
|
|
Username: "dummy",
|
|
Password: "dummy",
|
|
Host: "https://test.com",
|
|
Repositories: "repo.yml",
|
|
TagName: "tag",
|
|
TagDescription: "desc",
|
|
GenerateTagForAddonProductVersion: false,
|
|
GenerateTagForAddonComponentVersion: false,
|
|
}
|
|
client := &abaputils.ClientMock{
|
|
BodyList: []string{
|
|
`{"d" : { "Status" : "S" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "Status" : "S" } }`,
|
|
`{"d" : { "uuid" : "abc" } }`,
|
|
`{"d" : { "empty" : "body" } }`,
|
|
},
|
|
Token: "myToken",
|
|
StatusCode: 200,
|
|
}
|
|
|
|
_, hook := test.NewNullLogger()
|
|
log.RegisterHook(hook)
|
|
|
|
err = runAbapEnvironmentCreateTag(config, nil, autils, client)
|
|
|
|
assert.NoError(t, err, "Did not expect error")
|
|
assert.Equal(t, 1, len(hook.Entries), "Expected a different number of entries")
|
|
assert.Equal(t, `Created tag tag for repository /DMO/SWC with commitID 1234abcd`, hook.AllEntries()[0].Message, "Expected a different message")
|
|
hook.Reset()
|
|
|
|
})
|
|
}
|