Merge pull request #512 from splitio/semver-between-matcher

added semver between matcher

Author: chillaq

setup.cfg

@@ -13,7 +13,7 @@ test=pytest
 
 [tool:pytest]
 ignore_glob=./splitio/_OLD/*
-addopts = --verbose --cov=splitio --cov-report xml
+addopts = --verbose --cov=splitio --cov-report xml -k BetweenSemverMatcherTests
 python_classes=*Tests
 
 [build_sphinx]

splitio/models/grammar/matchers/__init__.py

@@ -8,7 +8,7 @@
 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
+from splitio.models.grammar.matchers.semver import EqualToSemverMatcher, GreaterThanOrEqualToSemverMatcher, LessThanOrEqualToSemverMatcher, BetweenSemverMatcher
 
 
 MATCHER_TYPE_ALL_KEYS = 'ALL_KEYS'
@@ -31,6 +31,7 @@
 MATCHER_TYPE_EQUAL_TO_SEMVER = 'EQUAL_TO_SEMVER'
 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_BUILDERS = {
     MATCHER_TYPE_ALL_KEYS: AllKeysMatcher,
@@ -52,7 +53,8 @@
     MATCHER_TYPE_MATCHES_STRING: RegexMatcher,
     MATCHER_TYPE_EQUAL_TO_SEMVER: EqualToSemverMatcher,
     MATCHER_GREATER_THAN_OR_EQUAL_TO_SEMVER: GreaterThanOrEqualToSemverMatcher,
-    MATCHER_LESS_THAN_OR_EQUAL_TO_SEMVER: LessThanOrEqualToSemverMatcher
+    MATCHER_LESS_THAN_OR_EQUAL_TO_SEMVER: LessThanOrEqualToSemverMatcher,
+    MATCHER_BETWEEN_SEMVER: BetweenSemverMatcher
 }
 
 def from_raw(raw_matcher):

splitio/models/grammar/matchers/semver.py

@@ -312,3 +312,53 @@ def __str__(self):
     def _add_matcher_specific_properties_to_json(self):
         """Add matcher specific properties to base dict before returning it."""
         return {'matcherType': 'LESS_THAN_OR_EQUAL_TO_SEMVER', 'stringMatcherData': self._data}
+
+class BetweenSemverMatcher(Matcher):
+    """A matcher for Semver between."""
+
+    def _build(self, raw_matcher):
+        """
+        Build a BetweenSemverMatcher.
+
+        :param raw_matcher: raw matcher as fetched from splitChanges response.
+        :type raw_matcher: dict
+        """
+        self._data = raw_matcher.get('betweenStringMatcherData')
+        self._semver_start = Semver.build(self._data['start']) if self._data.get('start') is not None else None
+        self._semver_end = Semver.build(self._data['end']) if self._data.get('end') is not None else None
+
+    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 or self._semver_start is None or self._semver_end is None:
+            _LOGGER.error("betweenStringMatcherData is required for BETWEEN_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 (self._semver_start.compare(matching_semver) in [0, -1]) and (self._semver_end.compare(matching_semver) in [0, 1])
+
+    def __str__(self):
+        """Return string Representation."""
+        return 'between semver {start} and {end}'.format(start=self._data.get('start'), end=self._data.get('end'))
+
+    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}

tests/models/grammar/test_matchers.py

@@ -1010,3 +1010,51 @@ def test_to_str(self):
         """Test that the object serializes to str properly."""
         as_str = matchers.LessThanOrEqualToSemverMatcher(self.raw)
         assert str(as_str) == "less than or equal to semver 2.1.8"
+
+class BetweenSemverMatcherTests(MatcherTestsBase):
+    """Semver between matcher test cases."""
+
+    raw = {
+        'negate': False,
+        'matcherType': 'BETWEEN_SEMVER',
+        'betweenStringMatcherData': {"start": "2.1.8", "end": "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.BetweenSemverMatcher)
+        assert parsed._data == {"start": "2.1.8", "end": "2.1.11"}
+        assert isinstance(parsed._semver_start, Semver)
+        assert isinstance(parsed._semver_end, Semver)
+        assert parsed._semver_start._major == 2
+        assert parsed._semver_start._minor == 1
+        assert parsed._semver_start._patch == 8
+        assert parsed._semver_start._pre_release == []
+
+        assert parsed._semver_end._major == 2
+        assert parsed._semver_end._minor == 1
+        assert parsed._semver_end._patch == 11
+        assert parsed._semver_end._pre_release == []
+
+    def test_matcher_behaviour(self, mocker):
+        """Test if the matcher works properly."""
+        parsed = matchers.from_raw(self.raw)
+        assert parsed._match("2.1.8+rc")
+        assert parsed._match("2.1.9")
+        assert parsed._match("2.1.11-rc12")
+        assert not parsed._match("2.1.5")
+        assert not parsed._match("2.1.12-rc1")
+        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.BetweenSemverMatcher(self.raw).to_json()
+        assert as_json['matcherType'] == 'BETWEEN_SEMVER'
+        assert as_json['betweenStringMatcherData'] == {"start": "2.1.8", "end": "2.1.11"}
+
+    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"