feat(tests): More faker options (#287)

This is so that we can remove most of the `cloudquery/faker` usage. See cloudquery/cloudquery#2726

Author: disq

faker/faker.go

@@ -5,18 +5,21 @@ import (
 	"math/rand"
 	"reflect"
 	"time"
+
+	"github.com/rs/zerolog"
 )
 
 type faker struct {
 	maxDepth int
+	logger   zerolog.Logger
 }
 
-type Option func(*faker)
+var errEFaceNotAllowed = fmt.Errorf("interface{} not allowed")
 
 func (f faker) getFakedValue(a interface{}) (reflect.Value, error) {
 	t := reflect.TypeOf(a)
 	if t == nil {
-		return reflect.Value{}, fmt.Errorf("interface{} not allowed")
+		return reflect.Value{}, errEFaceNotAllowed
 	}
 	f.maxDepth--
 	if f.maxDepth < 0 {
@@ -52,9 +55,12 @@ func (f faker) getFakedValue(a interface{}) (reflect.Value, error) {
 				}
 				val, err := f.getFakedValue(v.Field(i).Interface())
 				if err != nil {
-					fmt.Println(err)
+					if err == errEFaceNotAllowed { // skip empty interfaces
+						continue
+					}
+
+					f.logger.Err(err).Str("field_name", v.Type().Field(i).Name).Msg("faker: error while faking struct")
 					continue
-					// return reflect.Value{}, err
 				}
 				val = val.Convert(v.Field(i).Type())
 				v.Field(i).Set(val)
@@ -126,6 +132,7 @@ func (f faker) getFakedValue(a interface{}) (reflect.Value, error) {
 			if err != nil {
 				return reflect.Value{}, err
 			}
+			key = key.Convert(t.Key())
 
 			valueInstance := reflect.New(t.Elem()).Elem().Interface()
 			val, err := f.getFakedValue(valueInstance)
@@ -142,12 +149,6 @@ func (f faker) getFakedValue(a interface{}) (reflect.Value, error) {
 	}
 }
 
-func WithMaxDepth(depth int) Option {
-	return func(f *faker) {
-		f.maxDepth = depth
-	}
-}
-
 func FakeObject(obj interface{}, opts ...Option) error {
 	reflectType := reflect.TypeOf(obj)
 
@@ -160,6 +161,7 @@ func FakeObject(obj interface{}, opts ...Option) error {
 	}
 	f := &faker{
 		maxDepth: 12,
+		logger:   zerolog.Nop(),
 	}
 	for _, o := range opts {
 		o(f)

faker/faker_test.go

@@ -1,20 +1,45 @@
 package faker
 
 import (
-	"fmt"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 type testFakerStruct struct {
 	A int
 	B string
 	C *string
+	E interface{}
 }
 
 func TestFaker(t *testing.T) {
 	a := testFakerStruct{}
 	if err := FakeObject(&a); err != nil {
 		t.Fatal(err)
 	}
-	fmt.Println(a)
+	assert.NotEmpty(t, a.A)
+	assert.NotEmpty(t, a.B)
+	assert.NotEmpty(t, a.C)
+	assert.Empty(t, a.E) // empty interfaces are not faked
+}
+
+type customType string
+
+type fakerStructWithCustomType struct {
+	A customType
+	B map[string]customType
+	C map[customType]string
+	D []customType
+}
+
+func TestFakerWithCustomType(t *testing.T) {
+	a := fakerStructWithCustomType{}
+	if err := FakeObject(&a); err != nil {
+		t.Fatal(err)
+	}
+	assert.NotEmpty(t, a.A)
+	assert.NotEmpty(t, a.B)
+	assert.NotEmpty(t, a.C)
+	assert.NotEmpty(t, a.D)
 }

faker/options.go

@@ -0,0 +1,17 @@
+package faker
+
+import "github.com/rs/zerolog"
+
+type Option func(*faker)
+
+func WithMaxDepth(depth int) Option {
+	return func(f *faker) {
+		f.maxDepth = depth
+	}
+}
+
+func WithLogger(logger zerolog.Logger) Option {
+	return func(f *faker) {
+		f.logger = logger
+	}
+}