add util tests

Signed-off-by: Frank Jogeleit <frank.jogeleit@lovoo.com>

pkg/config/target_factory.go

@@ -22,6 +22,8 @@ import (
 	"github.com/kyverno/policy-reporter/pkg/target/http"
 	"github.com/kyverno/policy-reporter/pkg/target/kinesis"
 	"github.com/kyverno/policy-reporter/pkg/target/loki"
+	"github.com/kyverno/policy-reporter/pkg/target/provider/aws"
+	gs "github.com/kyverno/policy-reporter/pkg/target/provider/gcs"
 	"github.com/kyverno/policy-reporter/pkg/target/s3"
 	"github.com/kyverno/policy-reporter/pkg/target/securityhub"
 	"github.com/kyverno/policy-reporter/pkg/target/slack"
@@ -431,14 +433,14 @@ func (f *TargetFactory) createS3Client(config, parent *Target[S3Options]) target
 
 	config.MapBaseParent(parent)
 
-	s3Client := helper.NewS3Client(
+	s3Client := aws.NewS3Client(
 		config.Config.AccessKeyID,
 		config.Config.SecretAccessKey,
 		config.Config.Region,
 		config.Config.Endpoint,
 		config.Config.Bucket,
 		config.Config.PathStyle,
-		helper.WithKMS(config.Config.BucketKeyEnabled, &config.Config.KmsKeyID, &config.Config.ServerSideEncryption),
+		aws.WithKMS(config.Config.BucketKeyEnabled, &config.Config.KmsKeyID, &config.Config.ServerSideEncryption),
 	)
 
 	sugar.Infof("%s configured", config.Name)
@@ -485,7 +487,7 @@ func (f *TargetFactory) createKinesisClient(config, parent *Target[KinesisOption
 
 	config.MapBaseParent(parent)
 
-	kinesisClient := helper.NewKinesisClient(
+	kinesisClient := aws.NewKinesisClient(
 		config.Config.AccessKeyID,
 		config.Config.SecretAccessKey,
 		config.Config.Region,
@@ -533,7 +535,7 @@ func (f *TargetFactory) createSecurityHub(config, parent *Target[SecurityHubOpti
 
 	setInt(&config.Config.DelayInSeconds, parent.Config.DelayInSeconds)
 
-	client := helper.NewHubClient(
+	client := aws.NewHubClient(
 		config.Config.AccessKeyID,
 		config.Config.SecretAccessKey,
 		config.Config.Region,
@@ -584,7 +586,7 @@ func (f *TargetFactory) createGCSClient(config, parent *Target[GCSOptions]) targ
 
 	config.MapBaseParent(parent)
 
-	gcsClient := helper.NewGCSClient(
+	gcsClient := gs.NewClient(
 		context.Background(),
 		config.Config.Credentials,
 		config.Config.Bucket,

pkg/helper/http_test.go

@@ -0,0 +1,42 @@
+package helper_test
+
+import (
+	"encoding/json"
+	"errors"
+	"net/http"
+	"net/http/httptest"
+	"testing"
+
+	"github.com/kyverno/policy-reporter/pkg/helper"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSendJSONResponse(t *testing.T) {
+	t.Run("success response", func(t *testing.T) {
+		w := httptest.NewRecorder()
+
+		helper.SendJSONResponse(w, []string{"default", "user"}, nil)
+
+		assert.Equal(t, http.StatusOK, w.Code)
+
+		resp := make([]string, 0, 2)
+
+		json.NewDecoder(w.Body).Decode(&resp)
+
+		assert.Equal(t, []string{"default", "user"}, resp)
+	})
+
+	t.Run("error response", func(t *testing.T) {
+		w := httptest.NewRecorder()
+
+		helper.SendJSONResponse(w, nil, errors.New("error"))
+
+		assert.Equal(t, http.StatusInternalServerError, w.Code)
+
+		resp := make(map[string]string, 0)
+
+		json.NewDecoder(w.Body).Decode(&resp)
+
+		assert.Equal(t, map[string]string{"message": "error"}, resp)
+	})
+}

pkg/helper/utils.go

@@ -1,7 +1,6 @@
 package helper
 
 import (
-	"encoding/json"
 	"strings"
 )
 
@@ -24,19 +23,6 @@ func ToList[T any, R comparable](mapping map[R]T) []T {
 	return list
 }
 
-func Merge[T comparable, R any](first, second map[T]R) map[T]R {
-	merged := make(map[T]R, len(first)+len(second))
-
-	for k, v := range first {
-		merged[k] = v
-	}
-	for k, v := range second {
-		merged[k] = v
-	}
-
-	return merged
-}
-
 func Map[T any, R any](source []T, cb func(T) R) []R {
 	list := make([]R, 0, len(source))
 	for _, i := range source {
@@ -46,17 +32,6 @@ func Map[T any, R any](source []T, cb func(T) R) []R {
 	return list
 }
 
-func ConvertJSONToMap(s string) map[string]string {
-	m := make(map[string]string)
-	if s == "" {
-		return m
-	}
-
-	_ = json.Unmarshal([]byte(s), &m)
-
-	return m
-}
-
 func ConvertMap(m map[string]any) map[string]string {
 	n := make(map[string]string, len(m))
 	for k, v := range m {
@@ -75,3 +50,7 @@ func Defaults(s, f string) string {
 
 	return f
 }
+
+func ToPointer[T any](s T) *T {
+	return &s
+}

pkg/helper/utils_test.go

@@ -0,0 +1,48 @@
+package helper_test
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/kyverno/policy-reporter/pkg/helper"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestContains(t *testing.T) {
+	assert.True(t, helper.Contains("kyverno", []string{"test", "kyverno", "trivy"}))
+	assert.False(t, helper.Contains("kube-bench", []string{"test", "kyverno", "trivy"}))
+}
+
+func TestToList(t *testing.T) {
+	assert.Equal(t, []string{"kyverno", "trivy"}, helper.ToList(map[string]string{
+		"first":  "kyverno",
+		"second": "trivy",
+	}))
+}
+
+func TestMap(t *testing.T) {
+	assert.Equal(t, []string{"kyverno", "trivy"}, helper.Map([]string{"source_kyverno", "source_trivy"}, func(value string) string {
+		return strings.TrimPrefix(value, "source_")
+	}))
+}
+
+func TestConvertMap(t *testing.T) {
+	assert.Equal(t, map[string]string{"first": "kyverno", "second": "trivy"}, helper.ConvertMap(map[string]any{
+		"first":  "kyverno",
+		"second": "trivy",
+		"third":  3,
+	}))
+}
+
+func TestDetauls(t *testing.T) {
+	assert.Equal(t, "fallback", helper.Defaults("", "fallback"))
+	assert.Equal(t, "value", helper.Defaults("value", "fallback"))
+}
+
+func TestToPointer(t *testing.T) {
+	value := "test"
+	number := 5
+
+	assert.Equal(t, &value, helper.ToPointer(value))
+	assert.Equal(t, &number, helper.ToPointer(number))
+}

pkg/target/gcs/gcs.go

@@ -10,23 +10,23 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/kyverno/policy-reporter/pkg/crd/api/policyreport/v1alpha2"
-	"github.com/kyverno/policy-reporter/pkg/helper"
 	"github.com/kyverno/policy-reporter/pkg/target"
 	"github.com/kyverno/policy-reporter/pkg/target/http"
+	"github.com/kyverno/policy-reporter/pkg/target/provider/gcs"
 )
 
 // Options to configure the GCS target
 type Options struct {
 	target.ClientOptions
 	CustomFields map[string]string
-	Client       helper.GCPClient
+	Client       gcs.Client
 	Prefix       string
 }
 
 type client struct {
 	target.BaseClient
 	customFields map[string]string
-	client       helper.GCPClient
+	client       gcs.Client
 	prefix       string
 }
 

pkg/target/kinesis/kinesis.go

@@ -10,22 +10,22 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/kyverno/policy-reporter/pkg/crd/api/policyreport/v1alpha2"
-	"github.com/kyverno/policy-reporter/pkg/helper"
 	"github.com/kyverno/policy-reporter/pkg/target"
 	"github.com/kyverno/policy-reporter/pkg/target/http"
+	"github.com/kyverno/policy-reporter/pkg/target/provider/aws"
 )
 
 // Options to configure the Kinesis target
 type Options struct {
 	target.ClientOptions
 	CustomFields map[string]string
-	Kinesis      helper.AWSClient
+	Kinesis      aws.Client
 }
 
 type client struct {
 	target.BaseClient
 	customFields map[string]string
-	kinesis      helper.AWSClient
+	kinesis      aws.Client
 }
 
 func (c *client) Send(result v1alpha2.PolicyReportResult) {

pkg/helper/aws.go → pkg/target/provider/aws/aws.go

@@ -1,4 +1,4 @@
-package helper
+package aws
 
 import (
 	"bytes"
@@ -21,7 +21,7 @@ import (
 
 var enable = true
 
-type AWSClient interface {
+type Client interface {
 	// Upload given Data the configured AWS storage
 	Upload(body *bytes.Buffer, key string) error
 }
@@ -62,7 +62,7 @@ func (s *s3Client) Upload(body *bytes.Buffer, key string) error {
 }
 
 // NewS3Client creates a new S3.client to send Results to S3
-func NewS3Client(accessKeyID, secretAccessKey, region, endpoint, bucket string, pathStyle bool, opts ...Options) AWSClient {
+func NewS3Client(accessKeyID, secretAccessKey, region, endpoint, bucket string, pathStyle bool, opts ...Options) Client {
 	config, err := createConfig(accessKeyID, secretAccessKey, region)
 	if err != nil {
 		zap.L().Error("error while creating config", zap.Error(err))
@@ -111,7 +111,7 @@ func (k *kinesisClient) Upload(body *bytes.Buffer, key string) error {
 }
 
 // NewKinesisClient creates a new S3.client to send Results to S3
-func NewKinesisClient(accessKeyID, secretAccessKey, region, endpoint, streamName string) AWSClient {
+func NewKinesisClient(accessKeyID, secretAccessKey, region, endpoint, streamName string) Client {
 	config, err := createConfig(accessKeyID, secretAccessKey, region)
 	if err != nil {
 		zap.L().Error("error while creating config", zap.Error(err))

pkg/target/provider/aws/aws_test.go

@@ -0,0 +1,27 @@
+package aws_test
+
+import (
+	"testing"
+
+	"github.com/kyverno/policy-reporter/pkg/helper"
+	"github.com/kyverno/policy-reporter/pkg/target/provider/aws"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestS3Client(t *testing.T) {
+	client := aws.NewS3Client("access", "secret", "eu-central-1", "http://s3.aws.com", "policy-reporter", false, aws.WithKMS(true, helper.ToPointer("kms"), helper.ToPointer("encryption")))
+
+	assert.NotNil(t, client)
+}
+
+func TestKinesisClient(t *testing.T) {
+	client := aws.NewKinesisClient("access", "secret", "eu-central-1", "http://kinesis.aws.com", "policy-reporter")
+
+	assert.NotNil(t, client)
+}
+
+func TestSecurityHubClient(t *testing.T) {
+	client := aws.NewHubClient("access", "secret", "eu-central-1", "http://securityhub.aws.com")
+
+	assert.NotNil(t, client)
+}

pkg/helper/gcp.go → pkg/target/provider/gcs/gcs.go

@@ -1,4 +1,4 @@
-package helper
+package gcs
 
 import (
 	"bytes"
@@ -10,17 +10,17 @@ import (
 	"google.golang.org/api/option"
 )
 
-type GCPClient interface {
+type Client interface {
 	// Upload given Data the configured AWS storage
 	Upload(body *bytes.Buffer, key string) error
 }
 
-type gcsClient struct {
+type client struct {
 	bucket string
 	client *storage.Client
 }
 
-func (c *gcsClient) Upload(body *bytes.Buffer, key string) error {
+func (c *client) Upload(body *bytes.Buffer, key string) error {
 	object := c.client.Bucket(c.bucket).Object(key)
 
 	writer := object.NewWriter(context.Background())
@@ -34,22 +34,22 @@ func (c *gcsClient) Upload(body *bytes.Buffer, key string) error {
 	return writer.Close()
 }
 
-// NewGCSClient creates a new GCS.client to send Results to GCS Bucket
-func NewGCSClient(ctx context.Context, credentials, bucket string) GCPClient {
+// NewClient creates a new GCS.client to send Results to GCS Bucket
+func NewClient(ctx context.Context, credentials, bucket string) Client {
 	cred, err := google.CredentialsFromJSON(ctx, []byte(credentials), storage.ScopeReadWrite)
 	if err != nil {
 		zap.L().Error("error while creating GCS credentials", zap.Error(err))
 		return nil
 	}
 
-	client, err := storage.NewClient(ctx, option.WithCredentials(cred))
+	baseClient, err := storage.NewClient(ctx, option.WithCredentials(cred))
 	if err != nil {
 		zap.L().Error("error while creating GCS client", zap.Error(err))
 		return nil
 	}
 
-	return &gcsClient{
+	return &client{
 		bucket,
-		client,
+		baseClient,
 	}
 }

pkg/target/s3/s3.go

@@ -10,23 +10,23 @@ import (
 	"go.uber.org/zap"
 
 	"github.com/kyverno/policy-reporter/pkg/crd/api/policyreport/v1alpha2"
-	"github.com/kyverno/policy-reporter/pkg/helper"
 	"github.com/kyverno/policy-reporter/pkg/target"
 	"github.com/kyverno/policy-reporter/pkg/target/http"
+	"github.com/kyverno/policy-reporter/pkg/target/provider/aws"
 )
 
 // Options to configure the S3 target
 type Options struct {
 	target.ClientOptions
 	CustomFields map[string]string
-	S3           helper.AWSClient
+	S3           aws.Client
 	Prefix       string
 }
 
 type client struct {
 	target.BaseClient
 	customFields map[string]string
-	s3           helper.AWSClient
+	s3           aws.Client
 	prefix       string
 }