feat(gherkin-track): Added new steps and support for testing track API. (#156)

Author: yasirfolio3

tests/integration/main_test.go

@@ -69,4 +69,5 @@ func FeatureContext(s *godog.Suite) {
 	s.Step(`^the number of dispatched events is (\d+)$`, context.TheNumberOfDispatchedEventsIs)
 	s.Step(`^there are no dispatched events$`, context.ThereAreNoDispatchedEvents)
 	s.Step(`^dispatched events payloads include$`, context.DispatchedEventsPayloadsInclude)
+	s.Step(`^payloads of dispatched events don\'t include decisions$`, context.PayloadsOfDispatchedEventsDontIncludeDecisions)
 }

tests/integration/models/api_options.go

@@ -18,7 +18,8 @@ package models
 
 // APIOptions represents parameters for a scenario
 type APIOptions struct {
-	APIName   string
-	Arguments string
-	Listeners map[string]int
+	DatafileName string
+	APIName      string
+	Arguments    string
+	Listeners    map[string]int
 }

tests/integration/models/constants.go

@@ -59,6 +59,8 @@ const (
 	GetVariation SDKAPI = "get_variation"
 	// Activate - the api type is Activate
 	Activate SDKAPI = "activate"
+	// Track - the api type is Track
+	Track SDKAPI = "track"
 )
 
 // KeyListenerCalled - Key for listener called

tests/integration/models/get_enabled_features_params.go

@@ -16,8 +16,8 @@
 
 package models
 
-// GetEnabledFeaturesParams represents params required for GetEnabledFeatures API
-type GetEnabledFeaturesParams struct {
+// GetEnabledFeaturesRequestParams represents params required for GetEnabledFeatures API
+type GetEnabledFeaturesRequestParams struct {
 	UserID     string                 `yaml:"user_id"`
 	Attributes map[string]interface{} `yaml:"attributes"`
 }

tests/integration/models/get_feature_variable_params.go

@@ -16,8 +16,8 @@
 
 package models
 
-// GetFeatureVariableParams represents params required for GetFeatureVariable API's
-type GetFeatureVariableParams struct {
+// GetFeatureVariableRequestParams represents params required for GetFeatureVariable API's
+type GetFeatureVariableRequestParams struct {
 	FeatureKey  string                 `yaml:"feature_flag_key"`
 	VariableKey string                 `yaml:"variable_key"`
 	UserID      string                 `yaml:"user_id"`

tests/integration/models/is_feature_enabled_params.go

@@ -16,7 +16,7 @@
 
 package models
 
-// IsFeatureEnabledRequestParams represents params required for isFeatureEnabled API
+// IsFeatureEnabledRequestParams represents params required for IsFeatureEnabled API
 type IsFeatureEnabledRequestParams struct {
 	FeatureKey string                 `yaml:"feature_flag_key"`
 	UserID     string                 `yaml:"user_id"`

tests/integration/models/track_params.go

@@ -0,0 +1,25 @@
+/****************************************************************************
+ * Copyright 2019, Optimizely, Inc. and contributors                        *
+ *                                                                          *
+ * Licensed under the Apache License, Version 2.0 (the "License");          *
+ * you may not use this file except in compliance with the License.         *
+ * You may obtain a copy of the License at                                  *
+ *                                                                          *
+ *    http://www.apache.org/licenses/LICENSE-2.0                            *
+ *                                                                          *
+ * Unless required by applicable law or agreed to in writing, software      *
+ * distributed under the License is distributed on an "AS IS" BASIS,        *
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
+ * See the License for the specific language governing permissions and      *
+ * limitations under the License.                                           *
+ ***************************************************************************/
+
+package models
+
+// TrackRequestParams represents params required for Track API
+type TrackRequestParams struct {
+	EventKey   string                 `yaml:"event_key"`
+	UserID     string                 `yaml:"user_id"`
+	Attributes map[string]interface{} `yaml:"attributes"`
+	EventTags  map[string]interface{} `yaml:"event_tags,omitempty"`
+}

tests/integration/support/client_wrapper.go

@@ -33,15 +33,27 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
+// Map to hold clientwrapper instances against scenarioID
+var clientInstance *ClientWrapper
+
 // ClientWrapper - wrapper around the optimizely client that keeps track of various custom components used with the client
 type ClientWrapper struct {
 	Client          *client.OptimizelyClient
 	DecisionService decision.Service
 	EventDispatcher event.Dispatcher
 }
 
-// NewClientWrapper returns a new instance of the optly wrapper
-func NewClientWrapper(datafileName string) ClientWrapper {
+// DeleteInstance deletes cached instance of optly wrapper
+func DeleteInstance() {
+	clientInstance = nil
+}
+
+// GetInstance returns a cached or new instance of the optly wrapper
+func GetInstance(datafileName string) *ClientWrapper {
+
+	if clientInstance != nil {
+		return clientInstance
+	}
 
 	datafileDir := os.Getenv("DATAFILES_DIR")
 	datafile, err := ioutil.ReadFile(filepath.Clean(path.Join(datafileDir, datafileName)))
@@ -74,11 +86,12 @@ func NewClientWrapper(datafileName string) ClientWrapper {
 		log.Fatal(err)
 	}
 
-	return ClientWrapper{
+	clientInstance = &ClientWrapper{
 		Client:          client,
 		DecisionService: decisionService,
 		EventDispatcher: eventProcessor.EventDispatcher,
 	}
+	return clientInstance
 }
 
 // InvokeAPI processes request with arguments
@@ -116,6 +129,9 @@ func (c *ClientWrapper) InvokeAPI(request models.APIOptions) (models.APIResponse
 	case models.Activate:
 		response, err = c.activate(request)
 		break
+	case models.Track:
+		response, err = c.track(request)
+		break
 	default:
 		break
 	}
@@ -145,7 +161,7 @@ func (c *ClientWrapper) isFeatureEnabled(request models.APIOptions) (models.APIR
 }
 
 func (c *ClientWrapper) getFeatureVariable(request models.APIOptions) (models.APIResponse, error) {
-	var params models.GetFeatureVariableParams
+	var params models.GetFeatureVariableRequestParams
 	var response models.APIResponse
 	err := yaml.Unmarshal([]byte(request.Arguments), &params)
 	if err == nil {
@@ -163,7 +179,7 @@ func (c *ClientWrapper) getFeatureVariable(request models.APIOptions) (models.AP
 }
 
 func (c *ClientWrapper) getFeatureVariableInteger(request models.APIOptions) (models.APIResponse, error) {
-	var params models.GetFeatureVariableParams
+	var params models.GetFeatureVariableRequestParams
 	var response models.APIResponse
 	err := yaml.Unmarshal([]byte(request.Arguments), &params)
 	if err == nil {
@@ -180,7 +196,7 @@ func (c *ClientWrapper) getFeatureVariableInteger(request models.APIOptions) (mo
 }
 
 func (c *ClientWrapper) getFeatureVariableDouble(request models.APIOptions) (models.APIResponse, error) {
-	var params models.GetFeatureVariableParams
+	var params models.GetFeatureVariableRequestParams
 	var response models.APIResponse
 	err := yaml.Unmarshal([]byte(request.Arguments), &params)
 	if err == nil {
@@ -197,7 +213,7 @@ func (c *ClientWrapper) getFeatureVariableDouble(request models.APIOptions) (mod
 }
 
 func (c *ClientWrapper) getFeatureVariableBoolean(request models.APIOptions) (models.APIResponse, error) {
-	var params models.GetFeatureVariableParams
+	var params models.GetFeatureVariableRequestParams
 	var response models.APIResponse
 	err := yaml.Unmarshal([]byte(request.Arguments), &params)
 	if err == nil {
@@ -214,7 +230,7 @@ func (c *ClientWrapper) getFeatureVariableBoolean(request models.APIOptions) (mo
 }
 
 func (c *ClientWrapper) getFeatureVariableString(request models.APIOptions) (models.APIResponse, error) {
-	var params models.GetFeatureVariableParams
+	var params models.GetFeatureVariableRequestParams
 	var response models.APIResponse
 	err := yaml.Unmarshal([]byte(request.Arguments), &params)
 	if err == nil {
@@ -231,7 +247,7 @@ func (c *ClientWrapper) getFeatureVariableString(request models.APIOptions) (mod
 }
 
 func (c *ClientWrapper) getEnabledFeatures(request models.APIOptions) (models.APIResponse, error) {
-	var params models.GetEnabledFeaturesParams
+	var params models.GetEnabledFeaturesRequestParams
 	var response models.APIResponse
 	err := yaml.Unmarshal([]byte(request.Arguments), &params)
 	if err == nil {
@@ -281,3 +297,18 @@ func (c *ClientWrapper) activate(request models.APIOptions) (models.APIResponse,
 	}
 	return response, err
 }
+
+func (c *ClientWrapper) track(request models.APIOptions) (models.APIResponse, error) {
+	var params models.TrackRequestParams
+	var response models.APIResponse
+	err := yaml.Unmarshal([]byte(request.Arguments), &params)
+	if err == nil {
+		user := entities.UserContext{
+			ID:         params.UserID,
+			Attributes: params.Attributes,
+		}
+		err = c.Client.Track(params.EventKey, user, params.EventTags)
+	}
+	response.Result = "NULL"
+	return response, err
+}

tests/integration/support/steps.go

@@ -23,6 +23,7 @@ import (
 	"strings"
 
 	"github.com/DATA-DOG/godog/gherkin"
+	"github.com/google/uuid"
 	"github.com/optimizely/go-sdk/pkg/entities"
 	"github.com/optimizely/go-sdk/tests/integration/models"
 	"github.com/optimizely/go-sdk/tests/integration/optlyplugins"
@@ -32,14 +33,15 @@ import (
 
 // ScenarioCtx holds both apiOptions and apiResponse for a scenario.
 type ScenarioCtx struct {
+	scenarioID    string
 	apiOptions    models.APIOptions
 	apiResponse   models.APIResponse
-	clientWrapper ClientWrapper
+	clientWrapper *ClientWrapper
 }
 
 // TheDatafileIs defines a datafileName to initialize the client with.
 func (c *ScenarioCtx) TheDatafileIs(datafileName string) error {
-	c.clientWrapper = NewClientWrapper(datafileName)
+	c.apiOptions.DatafileName = datafileName
 	return nil
 }
 
@@ -56,6 +58,10 @@ func (c *ScenarioCtx) ListenerIsAdded(numberOfListeners int, ListenerName string
 func (c *ScenarioCtx) IsCalledWithArguments(apiName string, arguments *gherkin.DocString) error {
 	c.apiOptions.APIName = apiName
 	c.apiOptions.Arguments = arguments.Content
+
+	// Clearing old state of response, eventdispatcher and decision service
+	c.apiResponse = models.APIResponse{}
+	c.clientWrapper = GetInstance(c.apiOptions.DatafileName)
 	response, err := c.clientWrapper.InvokeAPI(c.apiOptions)
 	c.apiResponse = response
 	//Reset listeners so that same listener is not added twice for a scenario
@@ -136,8 +142,13 @@ func (c *ScenarioCtx) TheResultShouldBeBoolean() error {
 // TheResultShouldMatchList checks that the result equals to the provided list.
 func (c *ScenarioCtx) TheResultShouldMatchList(list string) error {
 	expectedList := strings.Split(list, ",")
-	if actualList, ok := c.apiResponse.Result.([]string); ok && compareStringSlice(expectedList, actualList) {
-		return nil
+	if len(expectedList) == 1 && expectedList[0] == "[]" {
+		expectedList = []string{}
+	}
+	if actualList, ok := c.apiResponse.Result.([]string); ok {
+		if compareStringSlice(expectedList, actualList) {
+			return nil
+		}
 	}
 	return fmt.Errorf("incorrect result")
 }
@@ -211,7 +222,21 @@ func (c *ScenarioCtx) InTheResponseShouldHaveEachOneOfThese(argumentType string,
 		if err := yaml.Unmarshal([]byte(value.Content), &requestListenersCalled); err != nil {
 			break
 		}
-		if subset.Check(requestListenersCalled, c.apiResponse.ListenerCalled) {
+
+		found := false
+		for _, expectedListener := range requestListenersCalled {
+			found = false
+			for _, actualListener := range c.apiResponse.ListenerCalled {
+				if subset.Check(expectedListener, actualListener) {
+					found = true
+					break
+				}
+			}
+			if !found {
+				break
+			}
+		}
+		if found {
 			return nil
 		}
 		// @TODO: Revert this to test listener called
@@ -267,9 +292,29 @@ func (c *ScenarioCtx) DispatchedEventsPayloadsInclude(value *gherkin.DocString)
 	return fmt.Errorf("DispatchedEvents not equal")
 }
 
-// Reset clears all data before each scenario
+// PayloadsOfDispatchedEventsDontIncludeDecisions checks dispatched events to contain no decisions.
+func (c *ScenarioCtx) PayloadsOfDispatchedEventsDontIncludeDecisions() error {
+	dispatchedEvents := c.clientWrapper.EventDispatcher.(optlyplugins.EventReceiver).GetEvents()
+
+	for _, event := range dispatchedEvents {
+		for _, visitor := range event.Visitors {
+			for _, snapshot := range visitor.Snapshots {
+				if len(snapshot.Decisions) > 0 {
+					return fmt.Errorf("dispatched events should not include decisions")
+				}
+			}
+		}
+	}
+	return nil
+}
+
+// Reset clears all data before each scenario, assigns new scenarioID and sets session as false
 func (c *ScenarioCtx) Reset() {
+	// Delete cached optly wrapper instance
+	DeleteInstance()
+	// Clear scenario context and generate a new scenarioID
 	c.apiOptions = models.APIOptions{}
 	c.apiResponse = models.APIResponse{}
-	c.clientWrapper = ClientWrapper{}
+	c.clientWrapper = nil
+	c.scenarioID = uuid.New().String()
 }