refact(decide-options): Added translate options method to be used by testapp and agent. (#311)

* Added translate options method to be used by testapp and agent.

* suggested changes made.

Author: yasirfolio3

pkg/decide/decide_options.go

@@ -1,5 +1,5 @@
 /****************************************************************************
- * Copyright 2020, Optimizely, Inc. and contributors                        *
+ * Copyright 2020-2021, 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.         *
@@ -14,23 +14,25 @@
  * limitations under the License.                                           *
  ***************************************************************************/
 
-// Package decide has option definitions for decide api
+// Package decide has option definitions and helper methods for decide api
 package decide
 
+import "errors"
+
 // OptimizelyDecideOptions controlling flag decisions.
-type OptimizelyDecideOptions int
+type OptimizelyDecideOptions string
 
 const (
 	// DisableDecisionEvent when set, disables decision event tracking.
-	DisableDecisionEvent OptimizelyDecideOptions = 1 + iota
+	DisableDecisionEvent OptimizelyDecideOptions = "DISABLE_DECISION_EVENT"
 	// EnabledFlagsOnly when set, returns decisions only for flags which are enabled.
-	EnabledFlagsOnly
+	EnabledFlagsOnly OptimizelyDecideOptions = "ENABLED_FLAGS_ONLY"
 	// IgnoreUserProfileService when set, skips user profile service for decision.
-	IgnoreUserProfileService
+	IgnoreUserProfileService OptimizelyDecideOptions = "IGNORE_USER_PROFILE_SERVICE"
 	// IncludeReasons when set, includes info and debug messages in the decision reasons.
-	IncludeReasons
+	IncludeReasons OptimizelyDecideOptions = "INCLUDE_REASONS"
 	// ExcludeVariables when set, excludes variable values from the decision result.
-	ExcludeVariables
+	ExcludeVariables OptimizelyDecideOptions = "EXCLUDE_VARIABLES"
 )
 
 // Options defines options for controlling flag decisions.
@@ -41,3 +43,25 @@ type Options struct {
 	IncludeReasons           bool
 	ExcludeVariables         bool
 }
+
+// TranslateOptions converts string options array to array of OptimizelyDecideOptions
+func TranslateOptions(options []string) ([]OptimizelyDecideOptions, error) {
+	decideOptions := []OptimizelyDecideOptions{}
+	for _, val := range options {
+		switch OptimizelyDecideOptions(val) {
+		case DisableDecisionEvent:
+			decideOptions = append(decideOptions, DisableDecisionEvent)
+		case EnabledFlagsOnly:
+			decideOptions = append(decideOptions, EnabledFlagsOnly)
+		case IgnoreUserProfileService:
+			decideOptions = append(decideOptions, IgnoreUserProfileService)
+		case ExcludeVariables:
+			decideOptions = append(decideOptions, ExcludeVariables)
+		case IncludeReasons:
+			decideOptions = append(decideOptions, IncludeReasons)
+		default:
+			return []OptimizelyDecideOptions{}, errors.New("invalid option: " + val)
+		}
+	}
+	return decideOptions, nil
+}

pkg/decide/decide_options_test.go

@@ -0,0 +1,70 @@
+/****************************************************************************
+ * Copyright 2021, 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 decide
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestTranslateOptionsValidCases(t *testing.T) {
+	// Checking nil options
+	translatedOptions, err := TranslateOptions(nil)
+	assert.NoError(t, err)
+	assert.Len(t, translatedOptions, 0)
+
+	// Checking empty options
+	options := []string{}
+	translatedOptions, err = TranslateOptions(options)
+	assert.NoError(t, err)
+	assert.Len(t, translatedOptions, 0)
+
+	// Checking correct options
+	options = []string{"DISABLE_DECISION_EVENT", "ENABLED_FLAGS_ONLY"}
+	translatedOptions, err = TranslateOptions(options)
+	assert.NoError(t, err)
+	assert.Len(t, translatedOptions, 2)
+	assert.Equal(t, DisableDecisionEvent, translatedOptions[0])
+	assert.Equal(t, EnabledFlagsOnly, translatedOptions[1])
+
+	// Checking after appending further options
+	options = append(options, "IGNORE_USER_PROFILE_SERVICE", "EXCLUDE_VARIABLES", "INCLUDE_REASONS")
+	translatedOptions, err = TranslateOptions(options)
+	assert.NoError(t, err)
+	assert.Len(t, translatedOptions, 5)
+	assert.Equal(t, IgnoreUserProfileService, translatedOptions[2])
+	assert.Equal(t, ExcludeVariables, translatedOptions[3])
+	assert.Equal(t, IncludeReasons, translatedOptions[4])
+}
+
+func TestTranslateOptionsInvalidCases(t *testing.T) {
+	// Checking empty value as option
+	options := []string{""}
+	translatedOptions, err := TranslateOptions(options)
+	assert.Error(t, err)
+	assert.Equal(t, fmt.Errorf("invalid option: %v", options[0]), err)
+	assert.Len(t, translatedOptions, 0)
+
+	// Checking invalid value as option
+	options[0] = "INVALID"
+	translatedOptions, err = TranslateOptions(options)
+	assert.Error(t, err)
+	assert.Equal(t, fmt.Errorf("invalid option: %v", options[0]), err)
+	assert.Len(t, translatedOptions, 0)
+}