Merge branch 'go-alpha' into pawel/OASIS-4943

# Conflicts:
#	optimizely/decision/experiment_targeting_service.go

Author: pawels-optimizely

README.md

@@ -1 +1,55 @@
 # Optimizely Go SDK
+
+## Command line interface
+A CLI has been provided to illustrate the functionality of the SDK. Simply run `go-sdk` for help.
+```$sh
+go-sdk provides cli access to your Optimizely fullstack project
+
+Usage:
+  go-sdk [command]
+
+Available Commands:
+  help               Help about any command
+  is_feature_enabled Is feature enabled?
+
+Flags:
+  -h, --help            help for go-sdk
+  -s, --sdkKey string   Optimizely project SDK key
+
+Use "go-sdk [command] --help" for more information about a command.
+```
+
+Each supported SDK API method is it's own [cobra](https://github.com/spf13/cobra) command and requires the
+input of an `--sdkKey`.
+
+### Installation
+Install the CLI from github:
+
+```$sh
+go install github.com/optimizely/go-sdk
+```
+
+Install the CLI from source:
+```$sh
+go get github.com/optimizely/go-sdk
+cd $GOPATH/src/github.com/optimizely/go-sdk
+go install
+```
+
+### Commands
+
+#### is_feature_enabled
+```
+Determines if a feature is enabled
+
+Usage:
+  go-sdk is_feature_enabled [flags]
+
+Flags:
+  -f, --featureKey string   feature key to enable
+  -h, --help                help for is_feature_enabled
+  -u, --userId string       user id
+
+Global Flags:
+  -s, --sdkKey string   Optimizely project SDK key
+  ```

cmd/is_feature_enabled.go

@@ -0,0 +1,63 @@
+/****************************************************************************
+ * 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 cmd
+
+import (
+	"fmt"
+	"github.com/optimizely/go-sdk/optimizely/client"
+	"github.com/optimizely/go-sdk/optimizely/entities"
+	"github.com/spf13/cobra"
+)
+
+var (
+	userId string
+	featurekKey string
+)
+
+var isFeatureEnabledCmd = &cobra.Command{
+	Use:   "is_feature_enabled",
+	Short: "Is feature enabled?",
+	Long:  `Determines if a feature is enabled`,
+	Run: func(cmd *cobra.Command, args []string) {
+		optimizelyFactory := &client.OptimizelyFactory{
+			SDKKey: sdkKey,
+		}
+
+		client, err := optimizelyFactory.Client()
+
+		if err != nil {
+			fmt.Printf("Error instantiating client: %s\n", err)
+			return
+		}
+
+		user := entities.UserContext{
+			ID:         userId,
+			Attributes: entities.UserAttributes{},
+		}
+
+		enabled, _ := client.IsFeatureEnabled(featurekKey, user)
+		fmt.Printf("Is feature \"%s\" enabled for \"%s\"? %t\n", featurekKey, userId, enabled)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(isFeatureEnabledCmd)
+	isFeatureEnabledCmd.Flags().StringVarP(&userId, "userId", "u", "", "user id")
+	isFeatureEnabledCmd.MarkFlagRequired("userId")
+	isFeatureEnabledCmd.Flags().StringVarP(&featurekKey, "featureKey", "f", "", "feature key to enable")
+	isFeatureEnabledCmd.MarkFlagRequired("featureKey")
+}

cmd/root.go

@@ -0,0 +1,43 @@
+/****************************************************************************
+ * 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 cmd
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+var sdkKey string
+
+var rootCmd = &cobra.Command{
+	Use:   "go-sdk",
+	Short: "go-sdk provides cli access to your Optimizely fullstack project",
+}
+
+func Execute() {
+	if err := rootCmd.Execute(); err != nil {
+		fmt.Println(err)
+		os.Exit(1)
+	}
+}
+
+func init() {
+	rootCmd.PersistentFlags().StringVarP(&sdkKey, "sdkKey", "s", "", "Optimizely project SDK key")
+	rootCmd.MarkPersistentFlagRequired("sdkKey")
+}

examples/main.go

@@ -14,7 +14,12 @@ func main() {
 	optimizelyFactory := &client.OptimizelyFactory{
 		SDKKey: "ABC",
 	}
-	client := optimizelyFactory.Client()
+	client, err := optimizelyFactory.Client()
+
+	if err != nil {
+		fmt.Printf("Error instantiating client: %s", err)
+		return
+	}
 
 	user := entities.UserContext{
 		ID:         "mike ng",

main.go

@@ -0,0 +1,23 @@
+/****************************************************************************
+ * 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 main
+
+import "github.com/optimizely/go-sdk/cmd"
+
+func main() {
+	cmd.Execute()
+}

optimizely/client/client.go

@@ -19,7 +19,7 @@ package client
 import (
 	"errors"
 
-	"github.com/optimizely/go-sdk/optimizely/config"
+	"github.com/optimizely/go-sdk/optimizely"
 	"github.com/optimizely/go-sdk/optimizely/decision"
 	"github.com/optimizely/go-sdk/optimizely/entities"
 	"github.com/optimizely/go-sdk/optimizely/logging"
@@ -29,7 +29,7 @@ var logger = logging.GetLogger("Client")
 
 // OptimizelyClient is the entry point to the Optimizely SDK
 type OptimizelyClient struct {
-	configManager   config.ProjectConfigManager
+	configManager   optimizely.ProjectConfigManager
 	decisionService decision.DecisionService
 	isValid         bool
 }
@@ -44,14 +44,9 @@ func (o *OptimizelyClient) IsFeatureEnabled(featureKey string, userContext entit
 	}
 
 	projectConfig := o.configManager.GetConfig()
-	feature, err := projectConfig.GetFeatureByKey(featureKey)
-	if err != nil {
-		return false, err
-	}
-
-	// @TODO(mng): Include assigned group for mutex support
 	featureDecisionContext := decision.FeatureDecisionContext{
-		Feature: feature,
+		FeatureKey:    featureKey,
+		ProjectConfig: projectConfig,
 	}
 
 	featureDecision, err := o.decisionService.GetFeatureDecision(featureDecisionContext, userContext)
@@ -61,5 +56,5 @@ func (o *OptimizelyClient) IsFeatureEnabled(featureKey string, userContext entit
 	}
 
 	// @TODO(mng): send impression event
-	return featureDecision.FeatureEnabled, nil
+	return featureDecision.Variation.FeatureEnabled, nil
 }

optimizely/client/client_test.go

@@ -22,14 +22,14 @@ import (
 
 	"github.com/stretchr/testify/assert"
 
-	"github.com/optimizely/go-sdk/optimizely/config"
+	"github.com/optimizely/go-sdk/optimizely"
 	"github.com/optimizely/go-sdk/optimizely/decision"
 	"github.com/optimizely/go-sdk/optimizely/entities"
 	"github.com/stretchr/testify/mock"
 )
 
 type MockProjectConfig struct {
-	config.ProjectConfig
+	optimizely.ProjectConfig
 	mock.Mock
 }
 
@@ -42,9 +42,9 @@ type MockProjectConfigManager struct {
 	mock.Mock
 }
 
-func (p *MockProjectConfigManager) GetConfig() config.ProjectConfig {
+func (p *MockProjectConfigManager) GetConfig() optimizely.ProjectConfig {
 	args := p.Called()
-	return args.Get(0).(config.ProjectConfig)
+	return args.Get(0).(optimizely.ProjectConfig)
 }
 
 type MockDecisionService struct {
@@ -58,37 +58,31 @@ func (m *MockDecisionService) GetFeatureDecision(decisionContext decision.Featur
 
 func TestIsFeatureEnabled(t *testing.T) {
 	testUserContext := entities.UserContext{ID: "test_user_1"}
-	testFeatureKey := "test_feature_key"
-	testFeature := entities.Feature{
-		Key: testFeatureKey,
-		FeatureExperiments: []entities.Experiment{
-			entities.Experiment{
-				ID: "111111",
-				Variations: map[string]entities.Variation{
-					"22222": entities.Variation{
-						ID:             "22222",
-						Key:            "22222",
-						FeatureEnabled: true,
-					},
-				},
-			},
-		},
+	testVariation := entities.Variation{
+		ID:             "22222",
+		Key:            "22222",
+		FeatureEnabled: true,
 	}
+	testExperiment := entities.Experiment{
+		ID:         "111111",
+		Variations: map[string]entities.Variation{"22222": testVariation},
+	}
+	testFeatureKey := "test_feature_key"
 
 	// Test happy path
 	mockConfig := new(MockProjectConfig)
-	mockConfig.On("GetFeatureByKey", testFeatureKey).Return(testFeature, nil)
-
 	mockConfigManager := new(MockProjectConfigManager)
 	mockConfigManager.On("GetConfig").Return(mockConfig)
 
 	// Set up the mock decision service and its return value
 	testDecisionContext := decision.FeatureDecisionContext{
-		Feature: testFeature,
+		FeatureKey:    testFeatureKey,
+		ProjectConfig: mockConfig,
 	}
 
 	expectedFeatureDecision := decision.FeatureDecision{
-		FeatureEnabled: true,
+		Experiment: testExperiment,
+		Variation:  testVariation,
 		Decision: decision.Decision{
 			DecisionMade: true,
 		},
@@ -127,15 +121,19 @@ func TestIsFeatureEnabledErrorCases(t *testing.T) {
 	mockConfigManager.AssertNotCalled(t, "GetFeatureByKey")
 	mockDecisionService.AssertNotCalled(t, "GetFeatureDecision")
 
-	// Test invalid feature key
+	// Test decision serviceinvalid feature key
 	expectedError := errors.New("Invalid feature key")
 	mockConfig := new(MockProjectConfig)
-	mockConfig.On("GetFeatureByKey", testFeatureKey).Return(entities.Feature{}, expectedError)
 
 	mockConfigManager = new(MockProjectConfigManager)
 	mockConfigManager.On("GetConfig").Return(mockConfig)
-	mockDecisionService = new(MockDecisionService)
 
+	testFeatureDecisionContext := decision.FeatureDecisionContext{
+		FeatureKey:    testFeatureKey,
+		ProjectConfig: mockConfig,
+	}
+	mockDecisionService = new(MockDecisionService)
+	mockDecisionService.On("GetFeatureDecision", testFeatureDecisionContext, testUserContext).Return(decision.FeatureDecision{}, expectedError)
 	client = OptimizelyClient{
 		configManager:   mockConfigManager,
 		decisionService: mockDecisionService,
@@ -146,4 +144,6 @@ func TestIsFeatureEnabledErrorCases(t *testing.T) {
 		assert.Equal(t, expectedError, err)
 	}
 	assert.False(t, result)
+	mockConfigManager.AssertExpectations(t)
+	mockDecisionService.AssertExpectations(t)
 }