feat: Semantic Versioning implementation

pkg/decision/evaluator/condition_test.go

@@ -81,3 +81,24 @@ func TestCustomAttributeConditionEvaluatorWithoutMatchType(t *testing.T) {
 	result, _ = conditionEvaluator.Evaluate(condition, condTreeParams)
 	assert.Equal(t, result, false)
 }
+
+func TestCustomAttributeConditionEvaluatorForSemver(t *testing.T) {
+	conditionEvaluator := CustomAttributeConditionEvaluator{}
+	condition := entities.Condition{
+		Match: "semver_ge",
+		Value: "2.9",
+		Name:  "string_foo",
+		Type:  "custom_attribute",
+	}
+
+	// Test condition passes
+	user := entities.UserContext{
+		Attributes: map[string]interface{}{
+			"string_foo": "2.9.1",
+		},
+	}
+
+	condTreeParams := entities.NewTreeParameters(&user, map[string]entities.Audience{})
+	result, _ := conditionEvaluator.Evaluate(condition, condTreeParams)
+	assert.Equal(t, result, true)
+}

pkg/decision/evaluator/matchers/registry.go

@@ -37,14 +37,29 @@ const (
 	GtMatchType = "gt"
 	// SubstringMatchType name for the "substring" matcher
 	SubstringMatchType = "substring"
+	// SemverEqMatchType name for the semver_eq matcher
+	SemverEqMatchType = "semver_eq"
+	// SemverLtMatchType name for the semver_eq matcher
+	SemverLtMatchType = "semver_lt"
+	// SemverLeMatchType name for the semver_eq matcher
+	SemverLeMatchType = "semver_le"
+	// SemverGtMatchType name for the semver_eq matcher
+	SemverGtMatchType = "semver_gt"
+	// SemverGeMatchType name for the semver_eq matcher
+	SemverGeMatchType = "semver_ge"
 )
 
 var registry = map[string]Matcher{
-	ExactMatchType: ExactMatcher,
-	ExistsMatchType: ExistsMatcher,
-	LtMatchType: LtMatcher,
-	GtMatchType: GtMatcher,
+	ExactMatchType:     ExactMatcher,
+	ExistsMatchType:    ExistsMatcher,
+	LtMatchType:        LtMatcher,
+	GtMatchType:        GtMatcher,
 	SubstringMatchType: SubstringMatcher,
+	SemverEqMatchType:  SemverEqMatcher,
+	SemverLtMatchType:  SemverLtMatcher,
+	SemverLeMatchType:  SemverLeMatcher,
+	SemverGtMatchType:  SemverGtMatcher,
+	SemverGeMatchType:  SemverGeMatcher,
 }
 
 var lock = sync.RWMutex{}

pkg/decision/evaluator/matchers/semver.go

@@ -0,0 +1,163 @@
+/****************************************************************************
+ * Copyright 2020, 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 matchers //
+package matchers
+
+import (
+	"fmt"
+	"regexp"
+	"strconv"
+	"strings"
+
+	"github.com/optimizely/go-sdk/pkg/decision/reasons"
+	"github.com/optimizely/go-sdk/pkg/entities"
+
+	"github.com/pkg/errors"
+)
+
+// SemanticVersion defines the class
+type SemanticVersion struct {
+	Condition string // condition is always a string here
+}
+
+func (sv SemanticVersion) compareVersion(attribute string) (int, error) {
+
+	targetedVersionParts, err := sv.splitSemanticVersion(sv.Condition)
+	if err != nil {
+		return 0, err
+	}
+	versionParts, e := sv.splitSemanticVersion(attribute)
+	if e != nil {
+		return 0, e
+	}
+
+	// Up to the precision of targetedVersion, expect version to match exactly.
+	for idx := range targetedVersionParts {
+
+		switch {
+		case len(versionParts) <= idx:
+			return -1, nil
+		case !sv.isNumber(versionParts[idx]):
+			// Compare strings
+			if versionParts[idx] < targetedVersionParts[idx] {
+				return -1, nil
+			} else if versionParts[idx] > targetedVersionParts[idx] {
+				return 1, nil
+			}
+		case sv.isNumber(targetedVersionParts[idx]): // both targetedVersionParts and versionParts are digits
+			if sv.toInt(versionParts[idx]) < sv.toInt(targetedVersionParts[idx]) {
+				return -1, nil
+			} else if sv.toInt(versionParts[idx]) > sv.toInt(targetedVersionParts[idx]) {
+				return 1, nil
+			}
+		default:
+			return -1, nil
+		}
+	}
+
+	if sv.isPreRelease(attribute) && !sv.isPreRelease(sv.Condition) {
+		return -1, nil
+	}
+
+	return 0, nil
+}
+
+func (sv SemanticVersion) splitSemanticVersion(targetedVersion string) ([]string, error) {
+
+	if sv.hasWhiteSpace(targetedVersion) {
+		return []string{}, errors.New(string(reasons.AttributeFormatInvalid))
+	}
+
+	splitBy := ""
+	if sv.isBuild(targetedVersion) {
+		splitBy = sv.buildSeperator()
+	} else if sv.isPreRelease(targetedVersion) {
+		splitBy = sv.preReleaseSeperator()
+	}
+	targetParts := strings.Split(targetedVersion, splitBy)
+	if len(targetParts) == 0 {
+		return []string{}, errors.New(string(reasons.AttributeFormatInvalid))
+	}
+
+	targetPrefix := targetParts[0]
+	targetSuffix := targetParts[1:]
+
+	// Expect a version string of the form x.y.z
+	targetedVersionParts := strings.Split(targetPrefix, ".")
+
+	if len(targetedVersionParts) > 3 {
+		return []string{}, errors.New(string(reasons.AttributeFormatInvalid))
+	}
+
+	if len(targetedVersionParts) == 0 {
+		return []string{}, errors.New(string(reasons.AttributeFormatInvalid))
+	}
+
+	targetedVersionParts = append(targetedVersionParts, targetSuffix...)
+	return targetedVersionParts, nil
+}
+
+func (sv SemanticVersion) isNumber(str string) bool {
+	var digitCheck = regexp.MustCompile(`^[0-9]+$`)
+	return (digitCheck.MatchString(str))
+}
+
+func (sv SemanticVersion) toInt(str string) int {
+	i, e := strconv.Atoi(str)
+	if e != nil {
+		return 0
+	}
+	return i
+}
+
+func (sv SemanticVersion) isPreRelease(str string) bool {
+	return strings.Contains(str, "-")
+}
+
+func (sv SemanticVersion) isBuild(str string) bool {
+	return strings.Contains(str, "+")
+}
+
+func (sv SemanticVersion) hasWhiteSpace(str string) bool {
+	return strings.Contains(str, " ")
+}
+
+func (sv SemanticVersion) buildSeperator() string {
+	return "+"
+}
+
+func (sv SemanticVersion) preReleaseSeperator() string {
+	return "-"
+}
+
+// SemverEvaluator is a help function to wrap a common evaluation code
+func SemverEvaluator(cond entities.Condition, user entities.UserContext) (int, error) {
+
+	if stringValue, ok := cond.Value.(string); ok {
+		attributeValue, err := user.GetStringAttribute(cond.Name)
+		if err != nil {
+			return 0, err
+		}
+		semVer := SemanticVersion{stringValue}
+		comparison, e := semVer.compareVersion(attributeValue)
+		if e != nil {
+			return 0, e
+		}
+		return comparison, nil
+	}
+	return 0, fmt.Errorf("audience condition %s evaluated to NULL because the condition value type is not supported", cond.Name)
+}

pkg/decision/evaluator/matchers/semver_eq.go

@@ -0,0 +1,31 @@
+/****************************************************************************
+ * Copyright 2020, 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 matchers //
+package matchers
+
+import (
+	"github.com/optimizely/go-sdk/pkg/entities"
+)
+
+// SemverEqMatcher returns true if the user's semver attribute is equal to the semver condition value
+func SemverEqMatcher(condition entities.Condition, user entities.UserContext) (bool, error) {
+	comparison, err := SemverEvaluator(condition, user)
+	if err != nil {
+		return false, err
+	}
+	return comparison == 0, nil
+}

pkg/decision/evaluator/matchers/semver_eq_test.go

@@ -0,0 +1,98 @@
+/****************************************************************************
+ * Copyright 2020, 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 matchers
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/optimizely/go-sdk/pkg/entities"
+)
+
+func TestSemverEqMatcher(t *testing.T) {
+
+	condition := entities.Condition{
+		Match: "semver_eq",
+		Value: "2.0",
+		Name:  "version",
+	}
+
+	user := entities.UserContext{
+		Attributes: map[string]interface{}{
+			"version": "2.0.0",
+		},
+	}
+	result, err := SemverEqMatcher(condition, user)
+	assert.NoError(t, err)
+	assert.True(t, result)
+
+	user = entities.UserContext{
+		Attributes: map[string]interface{}{
+			"version": "2.9",
+		},
+	}
+
+	result, err = SemverEqMatcher(condition, user)
+	assert.NoError(t, err)
+	assert.False(t, result)
+
+	user = entities.UserContext{
+		Attributes: map[string]interface{}{
+			"version": "1.9",
+		},
+	}
+
+	result, err = SemverEqMatcher(condition, user)
+	assert.NoError(t, err)
+	assert.False(t, result)
+
+	// Test attribute not found
+	user = entities.UserContext{
+		Attributes: map[string]interface{}{
+			"version1": "2.0",
+		},
+	}
+
+	_, err = SemverEqMatcher(condition, user)
+	assert.Error(t, err)
+}
+
+func TestSemverEqMatcherInvalidType(t *testing.T) {
+	condition := entities.Condition{
+		Match: "semver_eq",
+		Value: "2.0",
+		Name:  "version",
+	}
+
+	user := entities.UserContext{
+		Attributes: map[string]interface{}{
+			"version": true,
+		},
+	}
+	_, err := SemverEqMatcher(condition, user)
+	assert.Error(t, err)
+
+	user = entities.UserContext{
+		Attributes: map[string]interface{}{
+			"version": 37,
+		},
+	}
+
+	_, err = SemverEqMatcher(condition, user)
+	assert.Error(t, err)
+}

pkg/decision/evaluator/matchers/semver_ge.go

@@ -0,0 +1,31 @@
+/****************************************************************************
+ * Copyright 2020, 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 matchers //
+package matchers
+
+import (
+	"github.com/optimizely/go-sdk/pkg/entities"
+)
+
+// SemverGeMatcher returns true if the user's semver attribute is greater or equal to the semver condition value
+func SemverGeMatcher(condition entities.Condition, user entities.UserContext) (bool, error) {
+	comparison, err := SemverEvaluator(condition, user)
+	if err != nil {
+		return false, err
+	}
+	return comparison >= 0, nil
+}