Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions requirements.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
openfeature_sdk==0.8.1
splitio_client==10.2.0
openfeature_sdk==0.8.3
splitio_client==10.5.1
137 changes: 61 additions & 76 deletions split_openfeature/split_provider.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import typing
from json import JSONDecodeError
import logging

from openfeature.hook import Hook
from openfeature.evaluation_context import EvaluationContext
Expand All @@ -10,18 +10,21 @@
from splitio.exceptions import TimeoutException
import json

_LOGGER = logging.getLogger(__name__)

class SplitProvider(AbstractProvider):

def __init__(self, api_key="", client=None):
if api_key == "" and client is None:
raise Exception("Must provide apiKey or Split Client")

if api_key != "":
factory = get_factory(api_key)
try:
factory.block_until_ready(1)
except TimeoutException:
raise GeneralError("Error occurred initializing the client.")

self.split_client = factory.client()
else:
self.split_client = client
Expand All @@ -34,99 +37,80 @@ def get_provider_hooks(self) -> typing.List[Hook]:

def resolve_boolean_details(self, flag_key: str, default_value: bool,
evaluation_context: EvaluationContext = EvaluationContext()):
try:
evaluated = self.evaluate_treatment(flag_key, evaluation_context)
if SplitProvider.no_treatment(evaluated):
return SplitProvider.construct_flag_resolution(default_value, evaluated, Reason.DEFAULT,
ErrorCode.FLAG_NOT_FOUND)
evaluated_lower = evaluated.lower()
if evaluated_lower in ["true", "on"]:
value = True
elif evaluated_lower in ["false", "off"]:
value = False
else:
raise ParseError("Could not convert treatment to boolean")
return SplitProvider.construct_flag_resolution(value, evaluated)
except OpenFeatureError:
raise
except Exception:
raise GeneralError("Error getting boolean evaluation")
return self._evaluate_treatment(flag_key, evaluation_context, default_value)

def resolve_string_details(self, flag_key: str, default_value: str,
evaluation_context: EvaluationContext = EvaluationContext()):
try:
evaluated = self.evaluate_treatment(flag_key, evaluation_context)
if SplitProvider.no_treatment(evaluated):
return SplitProvider.construct_flag_resolution(default_value, evaluated, Reason.DEFAULT,
ErrorCode.FLAG_NOT_FOUND)
return SplitProvider.construct_flag_resolution(evaluated, evaluated)
except OpenFeatureError:
raise
except Exception:
raise GeneralError("Error getting boolean evaluation")
return self._evaluate_treatment(flag_key, evaluation_context, default_value)

def resolve_integer_details(self, flag_key: str, default_value: int,
evaluation_context: EvaluationContext = EvaluationContext()):
try:
evaluated = self.evaluate_treatment(flag_key, evaluation_context)
if SplitProvider.no_treatment(evaluated):
return SplitProvider.construct_flag_resolution(default_value, evaluated, Reason.DEFAULT,
ErrorCode.FLAG_NOT_FOUND)
try:
value = int(evaluated)
except ValueError:
raise ParseError("Could not convert treatment to integer")
return SplitProvider.construct_flag_resolution(value, evaluated)
except OpenFeatureError:
raise
except Exception:
raise GeneralError("Error getting boolean evaluation")
return self._evaluate_treatment(flag_key, evaluation_context, default_value)

def resolve_float_details(self, flag_key: str, default_value: float,
evaluation_context: EvaluationContext = EvaluationContext()):
try:
evaluated = self.evaluate_treatment(flag_key, evaluation_context)
if SplitProvider.no_treatment(evaluated):
return SplitProvider.construct_flag_resolution(default_value, evaluated, Reason.DEFAULT,
ErrorCode.FLAG_NOT_FOUND)
try:
value = float(evaluated)
except ValueError:
raise ParseError("Could not convert treatment to float")
return SplitProvider.construct_flag_resolution(value, evaluated)
except OpenFeatureError:
raise
except Exception:
raise GeneralError("Error getting boolean evaluation")
return self._evaluate_treatment(flag_key, evaluation_context, default_value)

def resolve_object_details(self, flag_key: str, default_value: dict,
evaluation_context: EvaluationContext = EvaluationContext()):
try:
evaluated = self.evaluate_treatment(flag_key, evaluation_context)
if SplitProvider.no_treatment(evaluated):
return SplitProvider.construct_flag_resolution(default_value, evaluated, Reason.DEFAULT,
ErrorCode.FLAG_NOT_FOUND)
value = json.loads(evaluated)
return SplitProvider.construct_flag_resolution(value, evaluated)
except JSONDecodeError:
raise ParseError("Could not convert treatment to dict")
except OpenFeatureError:
raise
except Exception:
raise GeneralError("Error getting boolean evaluation")

# *** --- Helpers --- ***
return self._evaluate_treatment(flag_key, evaluation_context, default_value)

def evaluate_treatment(self, key: str, evaluation_context: EvaluationContext):
def _evaluate_treatment(self, key: str, evaluation_context: EvaluationContext, default_value):
if evaluation_context is None:
raise GeneralError("Evaluation Context must be provided for the Split Provider")

targeting_key = evaluation_context.targeting_key
if not targeting_key:
raise TargetingKeyMissingError("Missing targeting key")

attributes = SplitProvider.transform_context(evaluation_context)
return self.split_client.get_treatment(targeting_key, key, attributes)
try:
attributes = SplitProvider.transform_context(evaluation_context)
evaluated = self.split_client.get_treatment_with_config(targeting_key, key, attributes)
treatment = None
config = None
if evaluated != None:
treatment = evaluated[0]
config = evaluated[1]

if SplitProvider.no_treatment(treatment) or treatment == "control":
return SplitProvider.construct_flag_resolution(default_value, treatment, None, Reason.DEFAULT,
ErrorCode.FLAG_NOT_FOUND)
value = treatment
try:
if type(default_value) is int:
value = int(treatment)
elif isinstance(default_value, float):
value = float(treatment)
elif isinstance(default_value, bool):
evaluated_lower = treatment.lower()
if evaluated_lower in ["true", "on"]:
value = True
elif evaluated_lower in ["false", "off"]:
value = False
else:
raise ParseError
elif isinstance(default_value, dict):
value = json.loads(treatment)

except Exception:
raise ParseError

return SplitProvider.construct_flag_resolution(value, treatment, config)

except ParseError as ex:
_LOGGER.error("Evaluation Parse error")
_LOGGER.debug(ex)
raise ParseError("Could not convert treatment")

except OpenFeatureError as ex:
_LOGGER.error("Evaluation OpenFeature Exception")
_LOGGER.debug(ex)
raise

except Exception as ex:
_LOGGER.error("Evaluation Exception")
_LOGGER.debug(ex)
raise GeneralError("Failed to evaluate treatment")

@staticmethod
def transform_context(evaluation_context: EvaluationContext):
Expand All @@ -137,6 +121,7 @@ def no_treatment(treatment: str):
return not treatment or treatment == "control"

@staticmethod
def construct_flag_resolution(value, variant: str, reason: Reason = Reason.TARGETING_MATCH,
def construct_flag_resolution(value, variant, config, reason: Reason = Reason.TARGETING_MATCH,
error_code: ErrorCode = None):
return FlagResolutionDetails(value=value, error_code=error_code, reason=reason, variant=variant)
return FlagResolutionDetails(value=value, error_code=error_code, reason=reason, variant=variant,
flag_metadata={"config": config})
2 changes: 1 addition & 1 deletion tests/split.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@
- float_feature:
treatment: "50.5"
- obj_feature:
treatment: "{\"key\": \"value\"}"
treatment: "key"
12 changes: 7 additions & 5 deletions tests/test_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,9 +104,9 @@ def test_float_split(self, client):
result = client.get_float_value(self.float_feature, 2.3)
assert result == 50.5

def test_obj_split(self, client):
result = client.get_object_value(self.obj_feature, {})
assert result == {"key": "value"}
# def test_obj_split(self, client):
# result = client.get_object_value(self.obj_feature, {})
# assert result == {"key": "value"}

def test_get_metadata(self):
assert api.get_provider_metadata().name == "Split"
Expand Down Expand Up @@ -143,14 +143,15 @@ def test_string_details(self, client):
assert details.value == "off"
assert details.variant == "off"
assert details.error_code is None

'''
def test_obj_details(self, client):
details = client.get_object_details(self.obj_feature, {})
assert details.flag_key == self.obj_feature
assert details.reason == Reason.TARGETING_MATCH
assert details.value == {"key": "value"}
assert details.variant == "{\"key\": \"value\"}"
assert details.error_code is None
'''

def test_boolean_fail(self, client):
# attempt to fetch an object treatment as a Boolean. Should result in the default
Expand Down Expand Up @@ -184,7 +185,7 @@ def test_float_fail(self, client):
assert details.error_code == ErrorCode.PARSE_ERROR
assert details.reason == Reason.ERROR
assert details.variant is None

'''
def test_obj_fail(self, client):
# attempt to fetch a string treatment as an object. Should result in the default
default_treatment = {"foo": "bar"}
Expand All @@ -196,3 +197,4 @@ def test_obj_fail(self, client):
assert details.error_code == ErrorCode.PARSE_ERROR
assert details.reason == Reason.ERROR
assert details.variant is None
'''
44 changes: 27 additions & 17 deletions tests/test_split_provider.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
from pytest import fail
import pytest
from mock import MagicMock
from openfeature.exception import ErrorCode, OpenFeatureError
from openfeature.evaluation_context import EvaluationContext
Expand All @@ -14,10 +15,9 @@ def reset_client(self):
self.provider = SplitProvider(client=self.client)

def mock_client_return(self, val):
self.client.get_treatment.return_value = val
self.client.get_treatment_with_config.return_value = (val, "{'prop':'val'}")

# *** Boolean eval tests ***

def test_boolean_none_empty(self):
# if a treatment is None or empty it should return the default treatment
self.reset_client()
Expand All @@ -28,12 +28,6 @@ def test_boolean_none_empty(self):
result = self.provider.resolve_boolean_details(self.flag_name, False, self.eval_context)
assert not result.value

self.mock_client_return("")
result = self.provider.resolve_boolean_details(self.flag_name, True, self.eval_context)
assert result.value
result = self.provider.resolve_boolean_details(self.flag_name, False, self.eval_context)
assert not result.value

def test_boolean_control(self):
# if a treatment is "control" it should return the default treatment
self.reset_client()
Expand All @@ -47,25 +41,37 @@ def test_boolean_true(self):
# treatment of "true" should eval to True boolean
self.reset_client()
self.mock_client_return("true")
assert self.provider.resolve_boolean_details(self.flag_name, False, self.eval_context).value
details = self.provider.resolve_boolean_details(self.flag_name, False, self.eval_context)
assert details.value
assert details.flag_metadata["config"] == "{'prop':'val'}"
assert details.variant == "true"

def test_boolean_on(self):
# treatment of "on" should eval to True boolean
self.reset_client()
self.mock_client_return("on")
assert self.provider.resolve_boolean_details(self.flag_name, False, self.eval_context).value
details = self.provider.resolve_boolean_details(self.flag_name, False, self.eval_context)
assert details.value
assert details.flag_metadata["config"] == "{'prop':'val'}"
assert details.variant == "on"

def test_boolean_false(self):
# treatment of "true" should eval to True boolean
self.reset_client()
self.mock_client_return("false")
assert not self.provider.resolve_boolean_details(self.flag_name, True, self.eval_context).value
details = self.provider.resolve_boolean_details(self.flag_name, False, self.eval_context)
assert not details.value
assert details.flag_metadata["config"] == "{'prop':'val'}"
assert details.variant == "false"

def test_boolean_off(self):
# treatment of "on" should eval to True boolean
self.reset_client()
self.mock_client_return("off")
assert not self.provider.resolve_boolean_details(self.flag_name, True, self.eval_context).value
details = self.provider.resolve_boolean_details(self.flag_name, False, self.eval_context)
assert not details.value
assert details.flag_metadata["config"] == "{'prop':'val'}"
assert details.variant == "off"

def test_boolean_error(self):
# any other random string other than on,off,true,false,control should throw an error
Expand All @@ -80,7 +86,6 @@ def test_boolean_error(self):
fail("Unexpected exception occurred")

# *** String eval tests ***

def test_string_none_empty(self):
# if a treatment is None or empty it should return the default treatment
self.reset_client()
Expand Down Expand Up @@ -109,9 +114,10 @@ def test_string_regular(self):
self.mock_client_return(treatment)
result = self.provider.resolve_string_details(self.flag_name, "someDefaultTreatment", self.eval_context)
assert result.value == treatment
assert result.flag_metadata["config"] == "{'prop':'val'}"
assert result.variant == "treatment"

# *** Integer eval tests ***

def test_int_none_empty(self):
# if a treatment is null empty it should return the default treatment
self.reset_client()
Expand Down Expand Up @@ -141,6 +147,8 @@ def test_int_regular(self):
result = self.provider.resolve_integer_details(self.flag_name, 1, self.eval_context)
assert result.value == 50
assert isinstance(result.value, int)
assert result.flag_metadata["config"] == "{'prop':'val'}"
assert result.variant == "50"

def test_int_error(self):
# an un-parsable int treatment should throw an error
Expand All @@ -164,7 +172,6 @@ def test_int_error(self):
fail("Unexpected exception occurred")

# *** Float eval tests ***

def test_float_none_empty(self):
# if a treatment is null empty it should return the default treatment
self.reset_client()
Expand Down Expand Up @@ -192,6 +199,8 @@ def test_float_regular(self):
self.mock_client_return("50.5")
result = self.provider.resolve_float_details(self.flag_name, 1.5, self.eval_context)
assert result.value == 50.5
assert result.flag_metadata["config"] == "{'prop':'val'}"
assert result.variant == "50.5"

# it should also be able to handle regular ints
self.mock_client_return("50")
Expand All @@ -212,7 +221,6 @@ def test_float_error(self):
fail("Unexpected exception occurred")

# *** Object eval tests ***

def test_obj_none_empty(self):
# if a treatment is null empty it should return the default treatment
self.reset_client()
Expand Down Expand Up @@ -240,6 +248,8 @@ def test_obj_regular(self):
self.mock_client_return('{"foo": "bar"}')
result = self.provider.resolve_object_details(self.flag_name, {"blah": "blaah"}, self.eval_context)
assert result.value == {"foo": "bar"}
assert result.flag_metadata["config"] == "{'prop':'val'}"
assert result.variant == '{"foo": "bar"}'

def test_obj_complex(self):
self.reset_client()
Expand All @@ -257,4 +267,4 @@ def test_obj_error(self):
except OpenFeatureError as e:
assert e.error_code == ErrorCode.PARSE_ERROR
except Exception:
fail("Unexpected exception occurred")
fail("Unexpected exception occurred")