Merge pull request #509 from splitio/semver-equalto-matcher

Semver equalto matcher

Author: chillaq

splitio/models/grammar/matchers/__init__.py

@@ -8,6 +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
 
 
 MATCHER_TYPE_ALL_KEYS = 'ALL_KEYS'
@@ -27,6 +28,7 @@
 MATCHER_TYPE_IN_SPLIT_TREATMENT = 'IN_SPLIT_TREATMENT'
 MATCHER_TYPE_EQUAL_TO_BOOLEAN = 'EQUAL_TO_BOOLEAN'
 MATCHER_TYPE_MATCHES_STRING = 'MATCHES_STRING'
+MATCHER_TYPE_EQUAL_TO_SEMVER = 'EQUAL_TO_SEMVER'
 
 
 _MATCHER_BUILDERS = {
@@ -46,7 +48,9 @@
     MATCHER_TYPE_CONTAINS_STRING: ContainsStringMatcher,
     MATCHER_TYPE_IN_SPLIT_TREATMENT: DependencyMatcher,
     MATCHER_TYPE_EQUAL_TO_BOOLEAN: BooleanMatcher,
-    MATCHER_TYPE_MATCHES_STRING: RegexMatcher
+    MATCHER_TYPE_MATCHES_STRING: RegexMatcher,
+    MATCHER_TYPE_EQUAL_TO_SEMVER: EqualToSemverMatcher
+
 }
 
 

splitio/models/grammar/matchers/semver.py

@@ -1,6 +1,8 @@
 """Semver matcher classes."""
 import logging
-import pytest
+
+from splitio.models.grammar.matchers.base import Matcher
+from splitio.models.grammar.matchers.string import Sanitizer
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -163,3 +165,52 @@ def _compare_vars(self, var1, var2):
         if var1 > var2:
             return 1
         return -1
+
+class EqualToSemverMatcher(Matcher):
+    """A matcher for Semver equal to."""
+
+    def _build(self, raw_matcher):
+        """
+        Build an EqualToSemverMatcher.
+
+        :param raw_matcher: raw matcher as fetched from splitChanges response.
+        :type raw_matcher: dict
+        """
+        self._data = raw_matcher.get('stringMatcherData')
+        self._semver = Semver.build(self._data)
+
+    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 is None:
+            _LOGGER.error("stringMatcherData is required for EQUAL_TO_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.version == matching_semver.version
+
+    def __str__(self):
+        """Return string Representation."""
+        return 'equal 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': 'EQUAL_TO_SEMVER', 'stringMatcherData': self._data}

tests/models/grammar/test_matchers.py

@@ -10,6 +10,7 @@
 from datetime import datetime
 
 from splitio.models.grammar import matchers
+from splitio.models.grammar.matchers.semver import Semver
 from splitio.storage import SegmentStorage
 from splitio.engine.evaluator import Evaluator
 
@@ -884,3 +885,44 @@ def test_to_json(self):
         as_json = matchers.RegexMatcher(self.raw).to_json()
         assert as_json['matcherType'] == 'MATCHES_STRING'
         assert as_json['stringMatcherData'] == "^[a-z][A-Z][0-9]$"
+
+class EqualToSemverMatcherTests(MatcherTestsBase):
+    """Semver equalto matcher test cases."""
+
+    raw = {
+        'negate': False,
+        'matcherType': 'EQUAL_TO_SEMVER',
+        'stringMatcherData': "2.1.8"
+    }
+
+    def test_from_raw(self, mocker):
+        """Test parsing from raw json/dict."""
+        parsed = matchers.from_raw(self.raw)
+        assert isinstance(parsed, matchers.EqualToSemverMatcher)
+        assert parsed._data == "2.1.8"
+        assert isinstance(parsed._semver, Semver)
+        assert parsed._semver._major == 2
+        assert parsed._semver._minor == 1
+        assert parsed._semver._patch == 8
+        assert parsed._semver._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.5")
+        assert not parsed._match("2.1.5-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.EqualToSemverMatcher(self.raw).to_json()
+        assert as_json['matcherType'] == 'EQUAL_TO_SEMVER'
+        assert as_json['stringMatcherData'] == "2.1.8"
+
+    def test_to_str(self):
+        """Test that the object serializes to str properly."""
+        as_str = matchers.EqualToSemverMatcher(self.raw)
+        assert str(as_str) == "equal semver 2.1.8"