Merge branch 'master' into yasir/odp-segement-apimanager

optimizely · msohailhussain · Nov 16, 2022 · Oct 5, 2022 · Oct 5, 2022 · Oct 17, 2022
commit 9e82b099da4ee47f48c5b79dcd8bedb307a01e4d
diff --git a/pkg/odp/segment_manager_test.go b/pkg/odp/segment_manager_test.go
@@ -0,0 +1,144 @@
+/****************************************************************************
+ * Copyright 2022, 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 odp //
+package odp
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/optimizely/go-sdk/pkg/odp/utils"
+	"github.com/stretchr/testify/mock"
+	"github.com/stretchr/testify/suite"
+)
+
+type SegmentManagerTestSuite struct {
+	suite.Suite
+	segmentManager     *SegmentManager
+	config             *Config
+	segmentAPIManager  *MockSegmentAPIManager
+	userValue, userKey string
+}
+
+func (s *SegmentManagerTestSuite) SetupTest() {
+	s.segmentAPIManager = &MockSegmentAPIManager{}
+	s.config = NewConfig("", "", nil)
+	s.segmentManager = NewSegmentManager(10, 10, s.config, s.segmentAPIManager)
+	s.userValue = "test-user"
+	s.userKey = "vuid"
+}
+
+func (s *SegmentManagerTestSuite) TestNewSegmentManagerNilParameters() {
+	segmentManager := NewSegmentManager(0, 0, nil, nil)
+	s.NotNil(segmentManager.segmentAPIManager)
+	s.NotNil(segmentManager.segmentsCache)
+	s.NotNil(segmentManager.odpConfig)
+}
+
+func (s *SegmentManagerTestSuite) TestFetchSegmentsNilConfig() {
+	segmentManager := NewSegmentManager(0, 0, nil, nil)
+	segments, err := segmentManager.FetchQualifiedSegments(s.userKey, s.userValue, nil)
+	s.Nil(segments)
+	s.Error(err)
+}
+
+func (s *SegmentManagerTestSuite) TestFetchSegmentsNoSegmentsToCheckInConfig() {
+	segmentManager := NewSegmentManager(0, 0, NewConfig("a", "b", nil), nil)
+	segments, err := segmentManager.FetchQualifiedSegments(s.userKey, s.userValue, nil)
+	s.Empty(segments)
+	s.Nil(err)
+}
+
+func (s *SegmentManagerTestSuite) TestFetchSegmentsSuccessCacheMiss() {
+	expectedSegments := []string{"new-customer"}
+	s.config.Update("valid", "host", expectedSegments)
+	s.setCache(s.userKey, "123", []string{"a"})
+	s.segmentAPIManager.On("FetchSegments", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(nil, nil)
+
+	segments, err := s.segmentManager.FetchQualifiedSegments(s.userKey, s.userValue, nil)
+	s.Nil(err)
+	s.Equal(expectedSegments, segments)
+}
+
+func (s *SegmentManagerTestSuite) TestFetchSegmentsSuccessCacheHit() {
+	expectedSegments := []string{"a"}
+	s.config.Update("valid", "host", []string{"new-customer"})
+	s.setCache(s.userKey, s.userValue, expectedSegments)
+	s.segmentAPIManager.On("FetchSegments", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(nil, nil)
+
+	segments, err := s.segmentManager.FetchQualifiedSegments(s.userKey, s.userValue, nil)
+	s.Nil(err)
+	s.Equal(expectedSegments, segments)
+}
+
+func (s *SegmentManagerTestSuite) TestFetchSegmentsSegmentsError() {
+	s.config.Update("invalid-key", "host", []string{"new-customer"})
+	s.segmentAPIManager.On("FetchSegments", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(nil, nil)
+
+	segments, err := s.segmentManager.FetchQualifiedSegments(s.userKey, s.userValue, nil)
+	s.Error(err)
+	s.Nil(segments)
+}
+
+func (s *SegmentManagerTestSuite) TestOptionsIgnoreCache() {
+	expectedSegments := []string{"new-customer"}
+	s.config.Update("valid", "host", expectedSegments)
+	s.setCache(s.userKey, s.userValue, []string{"a"})
+	s.segmentAPIManager.On("FetchSegments", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(nil, nil)
+
+	segments, err := s.segmentManager.FetchQualifiedSegments(s.userKey, s.userValue, []SegmentOption{IgnoreCache})
+	s.Nil(err)
+	s.Equal(expectedSegments, segments)
+}
+
+func (s *SegmentManagerTestSuite) TestOptionsResetCache() {
+	expectedSegments := []string{"new-customer"}
+	s.config.Update("valid", "host", expectedSegments)
+	s.setCache(s.userKey, s.userValue, []string{"a"})
+	s.setCache(s.userKey, "123", []string{"a"})
+	s.setCache(s.userKey, "456", []string{"a"})
+	s.segmentAPIManager.On("FetchSegments", mock.Anything, mock.Anything, mock.Anything, mock.Anything).Return(nil, nil)
+
+	segments, err := s.segmentManager.FetchQualifiedSegments(s.userKey, s.userValue, []SegmentOption{ResetCache})
+	s.Nil(err)
+	s.Equal(expectedSegments, segments)
+}
+
+func (s *SegmentManagerTestSuite) TestMakeCacheKey() {
+	s.Equal("vuid-$-test-user", utils.MakeCacheKey(s.userKey, s.userValue))
+}
+
+// Helper methods
+func (s *SegmentManagerTestSuite) setCache(userKey, userValue string, value []string) {
+	cacheKey := utils.MakeCacheKey(userKey, userValue)
+	s.segmentManager.segmentsCache.Save(cacheKey, value)
+}
+
+type MockSegmentAPIManager struct {
+	mock.Mock
+}
+
+func (s *MockSegmentAPIManager) FetchSegments(apiKey, apiHost, userKey, userValue string, segmentsToCheck []string) ([]string, error) {
+	if apiKey == "invalid-key" {
+		return nil, fmt.Errorf(fetchSegmentsFailedError, "403 Forbidden")
+	}
+	return segmentsToCheck, nil
+}
+
+func TestSegmentManagerTestSuite(t *testing.T) {
+	suite.Run(t, new(SegmentManagerTestSuite))
+}