chore: absorb extracted test suite (#143)

* chore: absorb extracted test suite

Signed-off-by: Skye Gill <[email protected]>

* add flagd test module to readme

Signed-off-by: Skye Gill <[email protected]>

---------

Signed-off-by: Skye Gill <[email protected]>

Author: skyerus

README.md

@@ -105,7 +105,7 @@ Run unit tests with `make test`.
 
 #### Integration tests
 
-The continuous integration runs a set of [gherkin integration tests](https://github.com/open-feature/test-harness/blob/main/features) using the [flagd provider](https://github.com/open-feature/go-sdk-contrib/tree/main/providers/flagd) and [flagd](https://github.com/open-feature/flagd).
+The continuous integration runs a set of [gherkin integration tests](https://github.com/open-feature/test-harness/blob/main/features) using the [flagd provider](https://github.com/open-feature/go-sdk-contrib/tree/main/providers/flagd), [flagd](https://github.com/open-feature/flagd) and [the flagd test module](https://github.com/open-feature/go-sdk-contrib/tree/main/tests/flagd).
 If you'd like to run them locally, first pull the `test-harness` git submodule
 ```
 git submodule update --init --recursive

go.mod

@@ -6,9 +6,8 @@ require (
 	github.com/cucumber/godog v0.12.6
 	github.com/go-logr/logr v1.2.3
 	github.com/golang/mock v1.6.0
-	github.com/golang/protobuf v1.5.2
-	github.com/open-feature/flagd v0.3.4
 	github.com/open-feature/go-sdk-contrib/providers/flagd v0.1.4
+	github.com/open-feature/go-sdk-contrib/tests/flagd v1.0.1
 	golang.org/x/text v0.6.0
 )
 
@@ -22,6 +21,7 @@ require (
 	github.com/cucumber/messages-go/v16 v16.0.1 // indirect
 	github.com/diegoholiveira/jsonlogic/v3 v3.2.7 // indirect
 	github.com/gofrs/uuid v4.2.0+incompatible // indirect
+	github.com/golang/protobuf v1.5.2 // indirect
 	github.com/hashicorp/go-immutable-radix v1.3.1 // indirect
 	github.com/hashicorp/go-memdb v1.3.2 // indirect
 	github.com/hashicorp/golang-lru v0.5.4 // indirect
@@ -30,6 +30,7 @@ require (
 	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
 	github.com/mitchellh/copystructure v1.2.0 // indirect
 	github.com/mitchellh/reflectwalk v1.0.2 // indirect
+	github.com/open-feature/flagd v0.3.4 // indirect
 	github.com/open-feature/schemas v0.2.8 // indirect
 	github.com/prometheus/client_golang v1.14.0 // indirect
 	github.com/prometheus/client_model v0.3.0 // indirect

go.sum

@@ -49,8 +49,6 @@ github.com/beorn7/perks v0.0.0-20180321164747-3a771d992973/go.mod h1:Dwedo/Wpr24
 github.com/beorn7/perks v1.0.0/go.mod h1:KWe93zE9D1o94FZ5RNwFwVgaQK1VOXiVxmqh+CedLV8=
 github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
 github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
-github.com/bufbuild/connect-go v1.4.1 h1:6usL3JGjKhxQpvDlizP7u8VfjAr1JkckcAUbrdcbgNY=
-github.com/bufbuild/connect-go v1.4.1/go.mod h1:9iNvh/NOsfhNBUH5CtvXeVUskQO1xsrEviH7ZArwZ3I=
 github.com/bufbuild/connect-go v1.5.0 h1:IfbgbzzaaZvF+OM3SfxO2EjtvNJarNAz2DIRuuNjAgc=
 github.com/bufbuild/connect-go v1.5.0/go.mod h1:9iNvh/NOsfhNBUH5CtvXeVUskQO1xsrEviH7ZArwZ3I=
 github.com/census-instrumentation/opencensus-proto v0.2.1/go.mod h1:f6KPmirojxKA12rnyqOA5BBL4O983OfeGPqjHWSTneU=
@@ -207,12 +205,12 @@ github.com/modern-go/reflect2 v1.0.1/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3Rllmb
 github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjYzDa0/r8luk=
 github.com/mwitkow/go-conntrack v0.0.0-20161129095857-cc309e4a2223/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
 github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
-github.com/open-feature/flagd v0.3.2 h1:Xfmtd8z2LQ80ux2nwymNx8GrLebsLfbtDF3bFC1nVVM=
-github.com/open-feature/flagd v0.3.2/go.mod h1:Xlle3jks+TBtZ6MKl/AiAeSB5FocSEwdq5CjO1O5eUs=
 github.com/open-feature/flagd v0.3.4 h1:EeEzMgRGzyyrpsvk3fZgK1dDa8+7zxLBJV5fXii6si0=
 github.com/open-feature/flagd v0.3.4/go.mod h1:JOIpaTkqYfAoUCCbVdSGoxKTJr2SV4FGuKmGjRfaQq8=
 github.com/open-feature/go-sdk-contrib/providers/flagd v0.1.4 h1:AkaY+pqcjHQe8W/ZFdfJpsPGsxoLyPRYHpTMIhiboAw=
 github.com/open-feature/go-sdk-contrib/providers/flagd v0.1.4/go.mod h1:5U1Ry0iFy4j466JafVdK210E7wo6YODKnoaREyhCiHo=
+github.com/open-feature/go-sdk-contrib/tests/flagd v1.0.1 h1:FATKM2T7O4OBeVF7pjJldwegbGm1JXhX11f5ffldbFA=
+github.com/open-feature/go-sdk-contrib/tests/flagd v1.0.1/go.mod h1:Oo6p7XjTcMHbiWrU/UwxN6Uguo0lHGfMsTYksEs/cKE=
 github.com/open-feature/schemas v0.2.8 h1:oA75hJXpOd9SFgmNI2IAxWZkwzQPUDm7Jyyh3q489wM=
 github.com/open-feature/schemas v0.2.8/go.mod h1:vj+rfTsOLlh5PtGGkAbitnJmFPYuTHXTjOy13kzNgKQ=
 github.com/pkg/errors v0.8.0/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=

integration/caching_test.go

@@ -1,283 +1,28 @@
 package integration_test
 
 import (
-	"context"
-	"encoding/json"
-	"errors"
-	"fmt"
-	"os"
 	"testing"
-	"time"
+
+	"github.com/open-feature/go-sdk-contrib/tests/flagd/pkg/integration"
 
 	"github.com/cucumber/godog"
-	"github.com/open-feature/flagd/pkg/eval"
-	flagd "github.com/open-feature/go-sdk-contrib/providers/flagd/pkg"
-	"github.com/open-feature/go-sdk/pkg/openfeature"
 )
 
 const flagConfigurationPath = "../test-harness/testing-flags.json"
 
-var testingFlags eval.Flags
-
-func loadFlagConfiguration(path string) (eval.Flags, error) {
-	file, err := os.Open(path)
-	if err != nil {
-		return eval.Flags{}, err
-	}
-
-	var flags eval.Flags
-	err = json.NewDecoder(file).Decode(&flags)
-	if err != nil {
-		return eval.Flags{}, fmt.Errorf("decode %s: %v", path, err)
-	}
-
-	return flags, nil
-}
-
-func theFlagsConfigurationWithKeyIsUpdatedToDefaultVariant(flagKey, defaultVariant string) error {
-	file, err := os.Create(flagConfigurationPath)
-	if err != nil {
-		return fmt.Errorf("open flag configuration: %w", err)
-	}
-
-	flags := copyFlags(testingFlags)
-	flagConfig := flags.Flags[flagKey]
-	flagConfig.DefaultVariant = defaultVariant
-	flags.Flags[flagKey] = flagConfig
-
-	err = json.NewEncoder(file).Encode(flags)
-	if err != nil {
-		return fmt.Errorf("write flag configuration to file: %w", err)
-	}
-
-	return nil
-}
-
-func theResolvedBooleanDetailsReasonOfFlagWithKeyShouldBe(ctx context.Context, flagkey, reason string) error {
-	store, ok := ctx.Value(ctxStorageKey{}).(map[string]openfeature.BooleanEvaluationDetails)
-	if !ok {
-		return errors.New("no flag resolution result")
-	}
-
-	got, ok := store[flagkey]
-	if !ok {
-		return fmt.Errorf("flag result with key %s not found", flagkey)
-	}
-
-	if string(got.Reason) != reason {
-		return fmt.Errorf("expected reason to be %s, got %s", reason, got.Reason)
-	}
-
-	return nil
-}
-
-func theResolvedStringDetailsReasonOfFlagWithKeyShouldBe(ctx context.Context, flagkey, reason string) error {
-	store, ok := ctx.Value(ctxStorageKey{}).(map[string]openfeature.StringEvaluationDetails)
-	if !ok {
-		return errors.New("no flag resolution result")
-	}
-
-	got, ok := store[flagkey]
-	if !ok {
-		return fmt.Errorf("flag result with key %s not found", flagkey)
-	}
-
-	if string(got.Reason) != reason {
-		return fmt.Errorf("expected reason to be %s, got %s", reason, got.Reason)
-	}
-
-	return nil
-}
-
-func theResolvedIntegerDetailsReasonOfFlagWithKeyShouldBe(ctx context.Context, flagkey, reason string) error {
-	store, ok := ctx.Value(ctxStorageKey{}).(map[string]openfeature.IntEvaluationDetails)
-	if !ok {
-		return errors.New("no flag resolution result")
-	}
-
-	got, ok := store[flagkey]
-	if !ok {
-		return fmt.Errorf("flag result with key %s not found", flagkey)
-	}
-
-	if string(got.Reason) != reason {
-		return fmt.Errorf("expected reason to be %s, got %s", reason, got.Reason)
-	}
-
-	return nil
-}
-
-func theResolvedFloatDetailsReasonOfFlagWithKeyShouldBe(ctx context.Context, flagkey, reason string) error {
-	store, ok := ctx.Value(ctxStorageKey{}).(map[string]openfeature.FloatEvaluationDetails)
-	if !ok {
-		return errors.New("no flag resolution result")
-	}
-
-	got, ok := store[flagkey]
-	if !ok {
-		return fmt.Errorf("flag result with key %s not found", flagkey)
-	}
-
-	if string(got.Reason) != reason {
-		return fmt.Errorf("expected reason to be %s, got %s", reason, got.Reason)
-	}
-
-	return nil
-}
-
-func theResolvedObjectDetailsReasonOfFlagWithKeyShouldBe(ctx context.Context, flagkey, reason string) error {
-	store, ok := ctx.Value(ctxStorageKey{}).(map[string]openfeature.InterfaceEvaluationDetails)
-	if !ok {
-		return errors.New("no flag resolution result")
-	}
-
-	got, ok := store[flagkey]
-	if !ok {
-		return fmt.Errorf("flag result with key %s not found", flagkey)
-	}
-
-	if string(got.Reason) != reason {
-		return fmt.Errorf("expected reason to be %s, got %s", reason, got.Reason)
-	}
-
-	return nil
-}
-
-func theResolvedBooleanDetailsReasonShouldBe(ctx context.Context, reason string) error {
-	got, err := firstBooleanEvaluationDetails(ctx)
-	if err != nil {
-		return err
-	}
-
-	if string(got.Reason) != reason {
-		return fmt.Errorf("expected reason to be %s, got %s", reason, got.Reason)
-	}
-
-	return nil
-}
-
-func theResolvedStringDetailsReasonShouldBe(ctx context.Context, reason string) error {
-	got, err := firstStringEvaluationDetails(ctx)
-	if err != nil {
-		return err
-	}
-
-	if string(got.Reason) != reason {
-		return fmt.Errorf("expected reason to be %s, got %s", reason, got.Reason)
-	}
-
-	return nil
-}
-
-func theResolvedIntegerDetailsReasonShouldBe(ctx context.Context, reason string) error {
-	got, err := firstIntegerEvaluationDetails(ctx)
-	if err != nil {
-		return err
-	}
-
-	if string(got.Reason) != reason {
-		return fmt.Errorf("expected reason to be %s, got %s", reason, got.Reason)
-	}
-
-	return nil
-}
-
-func theResolvedFloatDetailsReasonShouldBe(ctx context.Context, reason string) error {
-	got, err := firstFloatEvaluationDetails(ctx)
-	if err != nil {
-		return err
-	}
-
-	if string(got.Reason) != reason {
-		return fmt.Errorf("expected reason to be %s, got %s", reason, got.Reason)
-	}
-
-	return nil
-}
-
-func theResolvedObjectDetailsReasonShouldBe(ctx context.Context, reason string) error {
-	got, err := firstInterfaceEvaluationDetails(ctx)
-	if err != nil {
-		return err
-	}
-
-	if string(got.Reason) != reason {
-		return fmt.Errorf("expected reason to be %s, got %s", reason, got.Reason)
-	}
-
-	return nil
-}
-
-func sleepForMilliseconds(milliseconds int64) error {
-	time.Sleep(time.Duration(milliseconds) * time.Millisecond)
-	return nil
-}
-
-func resetState(ctx context.Context, sc *godog.Scenario) (context.Context, error) {
-	file, err := os.Create(flagConfigurationPath)
-	if err != nil {
-		return ctx, fmt.Errorf("open flag configuration: %w", err)
-	}
-
-	err = json.NewEncoder(file).Encode(testingFlags)
-	if err != nil {
-		return ctx, fmt.Errorf("write flag configuration to file: %w", err)
-	}
-
-	return ctx, nil
-}
-
-func aProviderIsRegisteredWithCacheEnabled(ctx context.Context) (context.Context, error) {
-	provider := flagd.NewProvider(flagd.WithPort(8013))
-	openfeature.SetProvider(provider)
-	client := openfeature.NewClient("caching tests")
-
-	select {
-	case <-provider.IsReady():
-	case <-time.After(500 * time.Millisecond):
-		return ctx, errors.New("provider not ready after 500 milliseconds")
-	}
-
-	return context.WithValue(ctx, ctxClientKey{}, client), nil
-}
-
-func InitializeCachingScenario(ctx *godog.ScenarioContext) {
-	ctx.Step(`^a boolean flag with key "([^"]*)" is evaluated with details and default value "([^"]*)"$`, aBooleanFlagWithKeyIsEvaluatedWithDetailsAndDefaultValue)
-	ctx.Step(`^a float flag with key "([^"]*)" is evaluated with details and default value (\d+)\.(\d+)$`, aFloatFlagWithKeyIsEvaluatedWithDetailsAndDefaultValue)
-	ctx.Step(`^a string flag with key "([^"]*)" is evaluated with details and default value "([^"]*)"$`, aStringFlagWithKeyIsEvaluatedWithDetailsAndDefaultValue)
-	ctx.Step(`^an integer flag with key "([^"]*)" is evaluated with details and default value (\d+)$`, anIntegerFlagWithKeyIsEvaluatedWithDetailsAndDefaultValue)
-	ctx.Step(`^an object flag with key "([^"]*)" is evaluated with details and a null default value$`, anObjectFlagWithKeyIsEvaluatedWithDetailsAndANullDefaultValue)
-	ctx.Step(`^a provider is registered with cache enabled$`, aProviderIsRegisteredWithCacheEnabled)
-	ctx.Step(`^sleep for (\d+) milliseconds$`, sleepForMilliseconds)
-	ctx.Step(`^the flag\'s configuration with key "([^"]*)" is updated to defaultVariant "([^"]*)"$`, theFlagsConfigurationWithKeyIsUpdatedToDefaultVariant)
-	ctx.Step(`^the resolved boolean details reason of flag with key "([^"]*)" should be "([^"]*)"$`, theResolvedBooleanDetailsReasonOfFlagWithKeyShouldBe)
-	ctx.Step(`^the resolved boolean details reason should be "([^"]*)"$`, theResolvedBooleanDetailsReasonShouldBe)
-	ctx.Step(`^the resolved float details reason of flag with key "([^"]*)" should be "([^"]*)"$`, theResolvedFloatDetailsReasonOfFlagWithKeyShouldBe)
-	ctx.Step(`^the resolved float details reason should be "([^"]*)"$`, theResolvedFloatDetailsReasonShouldBe)
-	ctx.Step(`^the resolved integer details reason of flag with key "([^"]*)" should be "([^"]*)"$`, theResolvedIntegerDetailsReasonOfFlagWithKeyShouldBe)
-	ctx.Step(`^the resolved integer details reason should be "([^"]*)"$`, theResolvedIntegerDetailsReasonShouldBe)
-	ctx.Step(`^the resolved object details reason of flag with key "([^"]*)" should be "([^"]*)"$`, theResolvedObjectDetailsReasonOfFlagWithKeyShouldBe)
-	ctx.Step(`^the resolved object details reason should be "([^"]*)"$`, theResolvedObjectDetailsReasonShouldBe)
-	ctx.Step(`^the resolved string details reason of flag with key "([^"]*)" should be "([^"]*)"$`, theResolvedStringDetailsReasonOfFlagWithKeyShouldBe)
-	ctx.Step(`^the resolved string details reason should be "([^"]*)"$`, theResolvedStringDetailsReasonShouldBe)
-
-	ctx.Before(resetState)
-}
-
 func TestCaching(t *testing.T) {
 	if testing.Short() {
 		t.Skip()
 	}
 
-	var err error
-	testingFlags, err = loadFlagConfiguration(flagConfigurationPath)
+	initializeCachingScenario, err := integration.InitializeCachingScenario(flagConfigurationPath)
 	if err != nil {
 		t.Fatal(err)
 	}
 
 	suite := godog.TestSuite{
 		Name:                "caching.feature",
-		ScenarioInitializer: InitializeCachingScenario,
+		ScenarioInitializer: initializeCachingScenario,
 		Options: &godog.Options{
 			Format:   "pretty",
 			Paths:    []string{"../test-harness/features/caching.feature"},
@@ -289,13 +34,3 @@ func TestCaching(t *testing.T) {
 		t.Fatal("non-zero status returned, failed to run caching tests")
 	}
 }
-
-func copyFlags(flags eval.Flags) eval.Flags {
-	f := eval.Flags{Flags: map[string]eval.Flag{}}
-
-	for key, flag := range flags.Flags {
-		f.Flags[key] = flag
-	}
-
-	return f
-}