Merge pull request #513 from splitio/semver-inlist-matcher

added in list semver matcher

Author: chillaq

splitio/models/grammar/matchers/__init__.py

@@ -8,7 +8,8 @@
 from splitio.models.grammar.matchers.string import ContainsStringMatcher, \
     EndsWithMatcher, RegexMatcher, StartsWithMatcher, WhitelistMatcher
 from splitio.models.grammar.matchers.misc import BooleanMatcher, DependencyMatcher
-from splitio.models.grammar.matchers.semver import EqualToSemverMatcher, GreaterThanOrEqualToSemverMatcher, LessThanOrEqualToSemverMatcher, BetweenSemverMatcher
+from splitio.models.grammar.matchers.semver import EqualToSemverMatcher, GreaterThanOrEqualToSemverMatcher, LessThanOrEqualToSemverMatcher, \
+        BetweenSemverMatcher, InListSemverMatcher
 
 
 MATCHER_TYPE_ALL_KEYS = 'ALL_KEYS'
@@ -32,6 +33,8 @@
 MATCHER_GREATER_THAN_OR_EQUAL_TO_SEMVER = 'GREATER_THAN_OR_EQUAL_TO_SEMVER'
 MATCHER_LESS_THAN_OR_EQUAL_TO_SEMVER = 'LESS_THAN_OR_EQUAL_TO_SEMVER'
 MATCHER_BETWEEN_SEMVER = 'BETWEEN_SEMVER'
+MATCHER_INLIST_SEMVER = 'IN_LIST_SEMVER'
+
 
 _MATCHER_BUILDERS = {
     MATCHER_TYPE_ALL_KEYS: AllKeysMatcher,
@@ -54,7 +57,8 @@
     MATCHER_TYPE_EQUAL_TO_SEMVER: EqualToSemverMatcher,
     MATCHER_GREATER_THAN_OR_EQUAL_TO_SEMVER: GreaterThanOrEqualToSemverMatcher,
     MATCHER_LESS_THAN_OR_EQUAL_TO_SEMVER: LessThanOrEqualToSemverMatcher,
-    MATCHER_BETWEEN_SEMVER: BetweenSemverMatcher
+    MATCHER_BETWEEN_SEMVER: BetweenSemverMatcher,
+    MATCHER_INLIST_SEMVER: InListSemverMatcher
 }
 
 def from_raw(raw_matcher):

splitio/models/grammar/matchers/semver.py

@@ -43,8 +43,7 @@ def _parse(self, version):
         """
         Parse the string in self.version to update the other internal variables
         """
-        without_metadata = self.remove_metadata_if_exists(version)
-
+        without_metadata = self._remove_metadata_if_exists(version)
         index = without_metadata.find(self._PRE_RELEASE_DELIMITER)
         if index == -1:
             self._is_stable = True
@@ -56,9 +55,9 @@ def _parse(self, version):
             without_metadata = without_metadata[:index]
             self._pre_release = pre_release_data.split(self._VALUE_DELIMITER)
 
-        self.set_major_minor_and_patch(without_metadata)
+        self._set_major_minor_and_patch(without_metadata)
 
-    def remove_metadata_if_exists(self, version):
+    def _remove_metadata_if_exists(self, version):
         """
         Check if there is any metadata characters in self.version.
 
@@ -75,7 +74,7 @@ def remove_metadata_if_exists(self, version):
 
         return  version[:index]
 
-    def set_major_minor_and_patch(self, version):
+    def _set_major_minor_and_patch(self, version):
         """
         Set the major, minor and patch internal variables based on string passed.
 
@@ -362,3 +361,55 @@ def __str__(self):
     def _add_matcher_specific_properties_to_json(self):
         """Add matcher specific properties to base dict before returning it."""
         return {'matcherType': 'BETWEEN_SEMVER', 'betweenStringMatcherData': self._data}
+
+class InListSemverMatcher(Matcher):
+    """A matcher for Semver in list."""
+
+    def _build(self, raw_matcher):
+        """
+        Build a InListSemverMatcher.
+
+        :param raw_matcher: raw matcher as fetched from splitChanges response.
+        :type raw_matcher: dict
+        """
+        self._data = raw_matcher.get('whitelistMatcherData')
+        if self._data is not None:
+            self._data = self._data.get('whitelist')
+
+        self._semver_list = [Semver.build(item) if item is not None else None for item in self._data] if self._data is not None else []
+
+    def _match(self, key, attributes=None, context=None):
+        """
+        Evaluate user input against a matcher and return whether the match is successful.
+
+        :param key: User key.
+        :type key: str.
+        :param attributes: Custom user attributes.
+        :type attributes: dict.
+        :param context: Evaluation context
+        :type context: dict
+
+        :returns: Wheter the match is successful.
+        :rtype: bool
+        """
+        if self._data is None:
+            _LOGGER.error("whitelistMatcherData is required for IN_LIST_SEMVER matcher type")
+            return False
+
+        matching_data = Sanitizer.ensure_string(self._get_matcher_input(key, attributes))
+        if matching_data is None:
+            return False
+
+        matching_semver = Semver.build(matching_data)
+        if matching_semver is None:
+            return False
+
+        return any([item.version == matching_semver.version if item is not None else False for item in self._semver_list])
+
+    def __str__(self):
+        """Return string Representation."""
+        return 'in list semver {data}'.format(data=self._data)
+
+    def _add_matcher_specific_properties_to_json(self):
+        """Add matcher specific properties to base dict before returning it."""
+        return {'matcherType': 'IN_LIST_SEMVER', 'whitelistMatcherData': {'whitelist': self._data}}

tests/models/grammar/test_matchers.py

@@ -1058,3 +1058,50 @@ def test_to_str(self):
         """Test that the object serializes to str properly."""
         as_str = matchers.BetweenSemverMatcher(self.raw)
         assert str(as_str) == "between semver 2.1.8 and 2.1.11"
+
+class InListSemverMatcherTests(MatcherTestsBase):
+    """Semver inlist matcher test cases."""
+
+    raw = {
+        'negate': False,
+        'matcherType': 'IN_LIST_SEMVER',
+        'whitelistMatcherData': {"whitelist": ["2.1.8", "2.1.11"]}
+    }
+
+    def test_from_raw(self, mocker):
+        """Test parsing from raw json/dict."""
+        parsed = matchers.from_raw(self.raw)
+        assert isinstance(parsed, matchers.InListSemverMatcher)
+        assert parsed._data == ["2.1.8", "2.1.11"]
+        assert [isinstance(item, Semver) for item in parsed._semver_list]
+        assert parsed._semver_list[0]._major == 2
+        assert parsed._semver_list[0]._minor == 1
+        assert parsed._semver_list[0]._patch == 8
+        assert parsed._semver_list[0]._pre_release == []
+
+        assert parsed._semver_list[1]._major == 2
+        assert parsed._semver_list[1]._minor == 1
+        assert parsed._semver_list[1]._patch == 11
+        assert parsed._semver_list[1]._pre_release == []
+
+    def test_matcher_behaviour(self, mocker):
+        """Test if the matcher works properly."""
+        parsed = matchers.from_raw(self.raw)
+        assert not parsed._match("2.1.8+rc")
+        assert parsed._match("2.1.8")
+        assert not parsed._match("2.1.11-rc12")
+        assert parsed._match("2.1.11")
+        assert not parsed._match("2.1.7")
+        assert not parsed._match(None)
+        assert not parsed._match("semver")
+
+    def test_to_json(self):
+        """Test that the object serializes to JSON properly."""
+        as_json = matchers.InListSemverMatcher(self.raw).to_json()
+        assert as_json['matcherType'] == 'IN_LIST_SEMVER'
+        assert as_json['whitelistMatcherData'] == {"whitelist": ["2.1.8", "2.1.11"]}
+
+    def test_to_str(self):
+        """Test that the object serializes to str properly."""
+        as_str = matchers.InListSemverMatcher(self.raw)
+        assert str(as_str) == "in list semver ['2.1.8', '2.1.11']"