mirror of
https://github.com/SAP/jenkins-library.git
synced 2025-01-18 05:18:24 +02:00
aa3fb8adb4
* Add telemetry support * First round telemetry * Add telemetry flag * fix: move files to avoid import cycles * add noTelemetry as global config option * Respect telemetry configuration for reporting * add site id, swa endpoint * correct logger initialization * add http logic * rename init method * rename consts & types * convert struct to payload * convert data to payload string * move activation flag out of data structure * extract types to own file * build query using net/url * correct field mapping * extract notify coding to own file * cleanup parameter mapping * preare base data * fix codeclimate issue * correct test case * fill values from env * test all fields * untrack notify.go * ignore empty custom values * cleanup data.go * add test cases * cleanup * add usage reporting to karma step * add usage reporting to step generator * externalise siteID * correct custom field names * test env handling * simplify method signature * revert parameter negation * correct import * adjust golden file * inclease log level * ignore test case * Revert "inclease log level" This reverts commit 70cae0e0296afb2aa9e7d71e83ea70aa83d1a6d7. * add test case for envvars * remove duplicate reporting * remove duplicate reporting * correct format * regenerate checkmarx file * add log message on deactivation * rename function * add comments to understand SWA mapping Co-authored-by: Oliver Nocon <33484802+OliverNocon@users.noreply.github.com>
112 lines
2.5 KiB
Go
112 lines
2.5 KiB
Go
package telemetry
|
|
|
|
import (
|
|
"bytes"
|
|
"io"
|
|
"io/ioutil"
|
|
"net/http"
|
|
"os"
|
|
"testing"
|
|
|
|
piperhttp "github.com/SAP/jenkins-library/pkg/http"
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
type clientMock struct {
|
|
httpMethod string
|
|
urlsCalled string
|
|
}
|
|
|
|
func (c *clientMock) SetOptions(opts piperhttp.ClientOptions) {}
|
|
|
|
func (c *clientMock) SendRequest(method, url string, body io.Reader, header http.Header, cookies []*http.Cookie) (*http.Response, error) {
|
|
c.httpMethod = method
|
|
c.urlsCalled = url
|
|
|
|
return &http.Response{StatusCode: 200, Body: ioutil.NopCloser(bytes.NewReader([]byte("")))}, nil
|
|
}
|
|
|
|
var mock clientMock
|
|
|
|
func TestInitialise(t *testing.T) {
|
|
t.Run("with disabled telemetry", func(t *testing.T) {
|
|
// init
|
|
client = nil
|
|
// test
|
|
Initialize(true, "testStep")
|
|
// assert
|
|
assert.Equal(t, nil, client)
|
|
assert.Equal(t, BaseData{}, baseData)
|
|
})
|
|
|
|
t.Run("", func(t *testing.T) {
|
|
// init
|
|
client = nil
|
|
// test
|
|
Initialize(false, "testStep")
|
|
// assert
|
|
assert.NotEqual(t, nil, client)
|
|
assert.Equal(t, "testStep", baseData.StepName)
|
|
})
|
|
}
|
|
func TestSend(t *testing.T) {
|
|
t.Run("with disabled telemetry", func(t *testing.T) {
|
|
// init
|
|
mock = clientMock{}
|
|
client = &mock
|
|
disabled = true
|
|
// test
|
|
Send(&CustomData{})
|
|
// assert
|
|
assert.Equal(t, 0, len(mock.httpMethod))
|
|
assert.Equal(t, 0, len(mock.urlsCalled))
|
|
})
|
|
|
|
t.Run("", func(t *testing.T) {
|
|
// init
|
|
mock = clientMock{}
|
|
client = &mock
|
|
disabled = false
|
|
baseData = BaseData{
|
|
ActionName: "testAction",
|
|
}
|
|
// test
|
|
Send(&CustomData{
|
|
Custom1: "test",
|
|
Custom1Label: "label",
|
|
})
|
|
// assert
|
|
assert.Equal(t, "GET", mock.httpMethod)
|
|
assert.Contains(t, mock.urlsCalled, baseURL)
|
|
assert.Contains(t, mock.urlsCalled, "custom26=label")
|
|
assert.Contains(t, mock.urlsCalled, "e_26=test")
|
|
assert.Contains(t, mock.urlsCalled, "action_name=testAction")
|
|
})
|
|
}
|
|
func TestEnvVars(t *testing.T) {
|
|
t.Run("without values", func(t *testing.T) {
|
|
// init
|
|
client = nil
|
|
// test
|
|
Initialize(false, "testStep")
|
|
// assert
|
|
assert.Equal(t, "n/a", baseData.PipelineURLHash)
|
|
assert.Equal(t, "n/a", baseData.BuildURLHash)
|
|
})
|
|
|
|
t.Run("", func(t *testing.T) {
|
|
// init
|
|
os.Setenv("JOB_URL", "someValue")
|
|
os.Setenv("BUILD_URL", "someValue")
|
|
client = nil
|
|
// test
|
|
Initialize(false, "testStep")
|
|
// assert
|
|
assert.Equal(t, "c1353b55ce4db511684b8a3b7b5c4b3d99ee9dec", baseData.PipelineURLHash)
|
|
assert.Equal(t, "c1353b55ce4db511684b8a3b7b5c4b3d99ee9dec", baseData.BuildURLHash)
|
|
// cleanup
|
|
os.Unsetenv("JOB_URL")
|
|
os.Unsetenv("BUILD_URL")
|
|
})
|
|
}
|