mirror of
https://github.com/SAP/jenkins-library.git
synced 2024-12-14 11:03:09 +02:00
a46f796bcd
* chore: cleanup reporting & some incorrect file usage in tests * cleanup interface * chore: remove comment * preserve error handling * Rename FileUtils.go to fileUtils.go * clean up formatting * chore: address static check findings * fix brittle test * chore: cleanup formatting
93 lines
3.4 KiB
Go
93 lines
3.4 KiB
Go
package cmd
|
|
|
|
import (
|
|
"testing"
|
|
|
|
"github.com/SAP/jenkins-library/pkg/hadolint/mocks"
|
|
piperMocks "github.com/SAP/jenkins-library/pkg/mock"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/mock"
|
|
)
|
|
|
|
func TestRunHadolintExecute(t *testing.T) {
|
|
t.Run("default", func(t *testing.T) {
|
|
// init
|
|
fileMock := &mocks.HadolintPiperFileUtils{}
|
|
clientMock := &mocks.HadolintClient{}
|
|
runnerMock := &piperMocks.ExecMockRunner{}
|
|
config := hadolintExecuteOptions{
|
|
DockerFile: "./Dockerfile", // default
|
|
ConfigurationFile: ".hadolint.yaml", // default
|
|
}
|
|
|
|
fileMock.
|
|
On("FileExists", config.ConfigurationFile).Return(false, nil).
|
|
On("WriteFile", "hadolintExecute_reports.json", mock.Anything, mock.Anything).Return(nil).
|
|
On("WriteFile", "hadolintExecute_links.json", mock.Anything, mock.Anything).Return(nil)
|
|
|
|
// test
|
|
err := runHadolint(config, hadolintUtils{
|
|
HadolintPiperFileUtils: fileMock,
|
|
HadolintClient: clientMock,
|
|
hadolintRunner: runnerMock,
|
|
})
|
|
// assert
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, runnerMock.Calls, 1) {
|
|
assert.Equal(t, "hadolint", runnerMock.Calls[0].Exec)
|
|
assert.Contains(t, runnerMock.Calls[0].Params, config.DockerFile)
|
|
assert.Contains(t, runnerMock.Calls[0].Params, "--format")
|
|
assert.Contains(t, runnerMock.Calls[0].Params, "checkstyle")
|
|
assert.NotContains(t, runnerMock.Calls[0].Params, "--config")
|
|
assert.NotContains(t, runnerMock.Calls[0].Params, config.ConfigurationFile)
|
|
}
|
|
// assert that mocks are called as previously defined
|
|
fileMock.AssertExpectations(t)
|
|
clientMock.AssertExpectations(t)
|
|
})
|
|
|
|
t.Run("with remote config", func(t *testing.T) {
|
|
// init
|
|
fileMock := &mocks.HadolintPiperFileUtils{}
|
|
clientMock := &mocks.HadolintClient{}
|
|
runnerMock := &piperMocks.ExecMockRunner{}
|
|
config := hadolintExecuteOptions{
|
|
DockerFile: "./Dockerfile", // default
|
|
ConfigurationFile: ".hadolint.yaml", // default
|
|
ConfigurationURL: "https://myconfig",
|
|
}
|
|
|
|
clientMock.
|
|
On("SetOptions", mock.Anything).
|
|
On("DownloadFile", config.ConfigurationURL, config.ConfigurationFile, mock.Anything, mock.Anything).Return(nil)
|
|
fileMock.
|
|
// checks if config exists before downloading
|
|
On("FileExists", config.ConfigurationFile).Return(false, nil).Once().
|
|
// checks again but config is now downloaded
|
|
On("FileExists", config.ConfigurationFile).Return(true, nil).
|
|
On("WriteFile", "hadolintExecute_reports.json", mock.Anything, mock.Anything).Return(nil).
|
|
On("WriteFile", "hadolintExecute_links.json", mock.Anything, mock.Anything).Return(nil)
|
|
|
|
//m.On("Do", MatchedBy(func(req *http.Request) bool { return req.Host == "example.com" }))
|
|
// test
|
|
err := runHadolint(config, hadolintUtils{
|
|
HadolintPiperFileUtils: fileMock,
|
|
HadolintClient: clientMock,
|
|
hadolintRunner: runnerMock,
|
|
})
|
|
// assert
|
|
assert.NoError(t, err)
|
|
if assert.Len(t, runnerMock.Calls, 1) {
|
|
assert.Equal(t, "hadolint", runnerMock.Calls[0].Exec)
|
|
assert.Contains(t, runnerMock.Calls[0].Params, config.DockerFile)
|
|
assert.Contains(t, runnerMock.Calls[0].Params, "--format")
|
|
assert.Contains(t, runnerMock.Calls[0].Params, "checkstyle")
|
|
assert.Contains(t, runnerMock.Calls[0].Params, "--config")
|
|
assert.Contains(t, runnerMock.Calls[0].Params, config.ConfigurationFile)
|
|
}
|
|
// assert that mocks are called as previously defined
|
|
fileMock.AssertExpectations(t)
|
|
clientMock.AssertExpectations(t)
|
|
})
|
|
}
|