added Semver class

Author: Bilal Al

splitio/models/grammar/matchers/semver.py

@@ -0,0 +1,138 @@
+"""Semver matcher classes."""
+import abc
+
+class Semver(object, metaclass=abc.ABCMeta):
+    """Semver class."""
+
+    _METADATA_DELIMITER = "+"
+    _PRE_RELEASE_DELIMITER = "-"
+    _VALUE_DELIMITER = "."
+
+    def __init__(self, version):
+        """
+        Class Initializer
+
+        :param version: raw version as read from splitChanges response.
+        :type version: str
+        """
+        self._major = 0
+        self._minor = 0
+        self._patch = 0
+        self._pre_release = []
+        self._is_stable = False
+        self._old_version = version
+        self.parse()
+
+    def parse(self):
+        """
+        Parse the string in self._old_version to update the other internal variables
+        """
+        without_metadata = self.remove_metadata_if_exists()
+
+        index = without_metadata.find(self._PRE_RELEASE_DELIMITER)
+        if index == -1:
+            self._is_stable = True
+        else:
+            pre_release_data = without_metadata[index+1:]
+            without_metadata = without_metadata[:index]
+            self._pre_release = pre_release_data.split(self._VALUE_DELIMITER)
+
+        self.set_major_minor_and_patch(without_metadata)
+
+    def remove_metadata_if_exists(self):
+        """
+        Check if there is any metadata characters in self._old_version.
+
+        :returns: The semver string without the metadata
+        :rtype: str
+        """
+        index = self._old_version.find(self._METADATA_DELIMITER)
+        if index == -1:
+            return self._old_version
+
+        return  self._old_version[:index]
+
+    def set_major_minor_and_patch(self, version):
+        """
+        Set the major, minor and patch internal variables based on string passed.
+
+        :param version: raw version containing major.minor.patch numbers.
+        :type version: str
+        """
+
+        parts = version.split(self._VALUE_DELIMITER)
+        if len(parts) != 3 or not ( parts[0].isnumeric() and parts[1].isnumeric() and parts[2].isnumeric()):
+            raise RuntimeError("Unable to convert to Semver, incorrect format: " + version)
+
+        self._major = int(parts[0])
+        self._minor = int(parts[1])
+        self._patch = int(parts[2])
+
+    def compare(self, to_compare):
+        """
+        Compare the current Semver object to a given Semver object, return:
+            0: if self == passed
+            1: if self > passed
+            2: if self < passed
+
+        :param to_compare: a Semver object
+        :type to_compare: splitio.models.grammar.matchers.semver.Semver
+
+        :returns: integer based on comparison
+        :rtype: int
+        """
+        if self._old_version == to_compare._old_version:
+            return 0
+
+        # Compare major, minor, and patch versions numerically
+        result = self._compare_vars(self._major, to_compare._major)
+        if result != 0:
+            return result
+
+        result = self._compare_vars(self._minor, to_compare._minor)
+        if result != 0:
+            return result
+
+        result = self._compare_vars(self._patch, to_compare._patch)
+        if result != 0:
+            return result
+
+        if not self._is_stable and to_compare._is_stable:
+            return -1
+        elif self._is_stable and not to_compare._is_stable:
+            return 1
+
+        # Compare pre-release versions lexically
+        min_length = min(len(self._pre_release), len(to_compare._pre_release))
+        for i in range(min_length):
+            if self._pre_release[i] == to_compare._pre_release[i]:
+                continue
+
+            if self._pre_release[i].isnumeric() and to_compare._pre_release[i].isnumeric():
+                 return self._compare_vars(int(self._pre_release[i]), int(to_compare._pre_release[i]))
+
+            return self._compare_vars(self._pre_release[i], to_compare._pre_release[i])
+
+        # Compare lengths of pre-release versions
+        return self._compare_vars(len(self._pre_release), len(to_compare._pre_release))
+
+    def _compare_vars(self, var1, var2):
+        """
+        Compare 2 variables and return int as follows:
+            0: if var1 == var2
+            1: if var1 > var2
+            2: if var1 < var2
+
+        :param var1: any object accept ==, < or > operators
+        :type var1: str/int
+        :param var2: any object accept ==, < or > operators
+        :type var2: str/int
+
+        :returns: integer based on comparison
+        :rtype: int
+        """
+        if var1 == var2:
+            return 0
+        if var1 > var2:
+            return 1
+        return -1

tests/models/grammar/test_semver.py

@@ -0,0 +1,91 @@
+"""Condition model tests module."""
+import pytest
+
+from splitio.models.grammar.matchers.semver import Semver
+
+class SemverTests(object):
+    """Test the semver object model."""
+
+    valid_versions = ["1.1.2", "1.1.1", "1.0.0", "1.0.0-rc.1", "1.0.0-beta.11", "1.0.0-beta.2",
+        "1.0.0-beta", "1.0.0-alpha.beta", "1.0.0-alpha.1", "1.0.0-alpha", "2.2.2-rc.2+metadata-lalala", "2.2.2-rc.1.2",
+        "1.2.3", "0.0.4", "1.1.2+meta", "1.1.2-prerelease+meta", "1.0.0-beta", "1.0.0-alpha", "1.0.0-alpha0.valid",
+        "1.0.0-alpha.0valid", "1.0.0-rc.1+build.1", "1.0.0-alpha-a.b-c-somethinglong+build.1-aef.1-its-okay",
+        "10.2.3-DEV-SNAPSHOT", "1.2.3-SNAPSHOT-123", "1.1.1-rc2", "1.0.0-0A.is.legal", "1.2.3----RC-SNAPSHOT.12.9.1--.12+788",
+        "1.2.3----R-S.12.9.1--.12+meta", "1.2.3----RC-SNAPSHOT.12.9.1--.12.88", "1.2.3----RC-SNAPSHOT.12.9.1--.12",
+        "9223372036854775807.9223372036854775807.9223372036854775807", "9223372036854775807.9223372036854775807.9223372036854775806",
+        "1.1.1-alpha.beta.rc.build.java.pr.support.10", "1.1.1-alpha.beta.rc.build.java.pr.support"]
+
+    def test_valid_versions(self):
+        major = [1, 1, 1, 1, 1, 1,
+                 1, 1, 1, 1, 2, 2,
+                 1, 0, 1, 1, 1, 1, 1,
+                 1, 1, 1,
+                 10, 1, 1, 1, 1,
+                 1, 1, 1,
+                 9223372036854775807, 9223372036854775807,
+                 1,1]
+        minor = [1, 1, 0, 0, 0, 0,
+                 0, 0, 0, 0, 2, 2,
+                 2, 0, 1, 1, 0, 0, 0,
+                 0, 0, 0,
+                 2, 2, 1, 0, 2,
+                 2, 2, 2,
+                 9223372036854775807, 9223372036854775807,
+                 1, 1]
+        patch = [2, 1, 0, 0, 0, 0,
+                 0, 0, 0, 0, 2, 2,
+                 3, 4, 2, 2, 0, 0, 0,
+                 0, 0, 0,
+                 3, 3, 1, 0, 3,
+                 3, 3, 3,
+                 9223372036854775807, 9223372036854775806,
+                 1, 1]
+        pre_release = [[], [], [], ["rc","1"], ["beta","11"],["beta","2"],
+        ["beta"], ["alpha","beta"], ["alpha","1"], ["alpha"], ["rc","2"], ["rc","1","2"],
+        [], [], [], ["prerelease"], ["beta"], ["alpha"], ["alpha0","valid"],
+        ["alpha","0valid"], ["rc","1"], ["alpha-a","b-c-somethinglong"],
+        ["DEV-SNAPSHOT"], ["SNAPSHOT-123"], ["rc2"], ["0A","is","legal"], ["---RC-SNAPSHOT","12","9","1--","12"],
+        ["---R-S","12","9","1--","12"], ["---RC-SNAPSHOT","12","9","1--","12","88"], ["---RC-SNAPSHOT","12","9","1--","12"],
+        [], [],
+        ["alpha","beta","rc","build","java","pr","support","10"], ["alpha","beta","rc","build","java","pr","support"]]
+
+        for i in range(len(major)-1):
+            semver = Semver(self.valid_versions[i])
+            self._verify_version(semver, major[i], minor[i], patch[i], pre_release[i], pre_release[i]==[])
+
+    def test_invalid_versions(self):
+        """Test parsing invalid versions."""
+        invalid_versions = [
+        "1", "1.2", "1.alpha.2", "+invalid", "-invalid", "-invalid+invalid", "+justmeta",
+        "-invalid.01", "alpha", "alpha.beta", "alpha.beta.1", "alpha.1", "alpha+beta",
+        "alpha_beta", "alpha.", "alpha..", "beta", "-alpha.", "1.2", "1.2.3.DEV", "-1.0.3-gamma+b7718",
+        "1.2-SNAPSHOT", "1.2.31.2.3----RC-SNAPSHOT.12.09.1--..12+788", "1.2-RC-SNAPSHOT"]
+#        "99999999999999999999999.999999999999999999.99999999999999999----RC-SNAPSHOT.12.09.1--------------------------------..12"]
+
+        for version in invalid_versions:
+            with pytest.raises(RuntimeError):
+                semver = Semver(version)
+                pass
+
+    def test_compare(self):
+        cnt = 0
+        for i in range(int(len(self.valid_versions)/2)):
+            assert Semver(self.valid_versions[cnt]).compare(Semver(self.valid_versions[cnt+1])) == 1
+            assert Semver(self.valid_versions[cnt+1]).compare(Semver(self.valid_versions[cnt])) == -1
+            assert Semver(self.valid_versions[cnt]).compare(Semver(self.valid_versions[cnt])) == 0
+            assert Semver(self.valid_versions[cnt+1]).compare(Semver(self.valid_versions[cnt+1])) == 0
+            cnt = cnt + 2
+
+        assert Semver("1.1.1").compare(Semver("1.1.1")) == 0
+        assert Semver("1.1.1").compare(Semver("1.1.1+metadata")) == 0
+        assert Semver("1.1.1").compare(Semver("1.1.1-rc.1")) == 1
+        assert Semver("88.88.88").compare(Semver("88.88.88")) == 0
+        assert Semver("1.2.3----RC-SNAPSHOT.12.9.1--.12").compare(Semver("1.2.3----RC-SNAPSHOT.12.9.1--.12")) == 0
+        assert Semver("10.2.3-DEV-SNAPSHOT").compare(Semver("10.2.3-SNAPSHOT-123")) == -1
+
+    def _verify_version(self, semver, major, minor, patch, pre_release="", is_stable=True):
+        assert semver._major == major
+        assert semver._minor == minor
+        assert semver._patch == patch
+        assert semver._pre_release == pre_release
+        assert semver._is_stable == is_stable