added version property

Bilal Al · Bilal Al · commit 1cc462f476fd · 2024-04-17T11:24:54.000-07:00
diff --git a/setup.py b/setup.py
@@ -7,7 +7,7 @@
 TESTS_REQUIRES = [
     'flake8',
     'pytest==7.0.1',
-    'pytest-mock>=3.5.1',
+    'pytest-mock==3.13.0',
     'coverage==6.2',
     'pytest-cov',
     'importlib-metadata==4.2',
diff --git a/splitio/models/grammar/matchers/semver.py b/splitio/models/grammar/matchers/semver.py
@@ -1,7 +1,9 @@
 """Semver matcher classes."""
-import abc
+import logging
 
-class Semver(object, metaclass=abc.ABCMeta):
+_LOGGER = logging.getLogger(__name__)
+
+class Semver(object):
     """Semver class."""
 
     _METADATA_DELIMITER = "+"
@@ -20,14 +22,25 @@ def __init__(self, version):
         self._patch = 0
         self._pre_release = []
         self._is_stable = False
-        self._old_version = version
-        self._parse()
+        self.version = ""
+        self._metadata = ""
+        self._parse(version)
+
+    @classmethod
+    def build(cls, version):
+        try:
+            self = cls(version)
+        except RuntimeError as e:
+            _LOGGER.error("Failed to parse Semver data, incorrect data type:  %s", e)
+            return None
 
-    def _parse(self):
+        return self
+
+    def _parse(self, version):
         """
-        Parse the string in self._old_version to update the other internal variables
+        Parse the string in self.version to update the other internal variables
         """
-        without_metadata = self.remove_metadata_if_exists()
+        without_metadata = self.remove_metadata_if_exists(version)
 
         index = without_metadata.find(self._PRE_RELEASE_DELIMITER)
         if index == -1:
@@ -39,18 +52,19 @@ def _parse(self):
 
         self.set_major_minor_and_patch(without_metadata)
 
-    def remove_metadata_if_exists(self):
+    def remove_metadata_if_exists(self, version):
         """
-        Check if there is any metadata characters in self._old_version.
+        Check if there is any metadata characters in self.version.
 
         :returns: The semver string without the metadata
         :rtype: str
         """
-        index = self._old_version.find(self._METADATA_DELIMITER)
+        index = version.find(self._METADATA_DELIMITER)
         if index == -1:
-            return self._old_version
+            return version
 
-        return  self._old_version[:index]
+        self._metadata = version[index:]
+        return  version[:index]
 
     def set_major_minor_and_patch(self, version):
         """
@@ -68,6 +82,12 @@ def set_major_minor_and_patch(self, version):
         self._minor = int(parts[1])
         self._patch = int(parts[2])
 
+        self.version = "{major}{DELIMITER}{minor}{DELIMITER}{patch}".format(major = self._major, DELIMITER = self._VALUE_DELIMITER,
+                    minor = self._minor, patch = self._patch)
+        self.version += "{DELIMITER}{pre_release}".format(DELIMITER=self._PRE_RELEASE_DELIMITER,
+                    pre_release = '.'.join(self._pre_release)) if len(self._pre_release) > 0 else ""
+        self.version += "{DELIMITER}{metadata}".format(DELIMITER=self._METADATA_DELIMITER, metadata = self._metadata) if self._metadata != "" else ""
+
     def compare(self, to_compare):
         """
         Compare the current Semver object to a given Semver object, return:
@@ -81,7 +101,7 @@ def compare(self, to_compare):
         :returns: integer based on comparison
         :rtype: int
         """
-        if self._old_version == to_compare._old_version:
+        if self.version == to_compare.version:
             return 0
 
         # Compare major, minor, and patch versions numerically
diff --git a/tests/models/grammar/files/between-semver.csv b/tests/models/grammar/files/between-semver.csv
@@ -0,0 +1,18 @@
+version1,version2,version3,expected
+1.1.1,2.2.2,3.3.3,true
+1.1.1-rc.1,1.1.1-rc.2,1.1.1-rc.3,true
+1.0.0-alpha,1.0.0-alpha.1,1.0.0-alpha.beta,true
+1.0.0-alpha.1,1.0.0-alpha.beta,1.0.0-beta,true
+1.0.0-alpha.beta,1.0.0-beta,1.0.0-beta.2,true
+1.0.0-beta,1.0.0-beta.2,1.0.0-beta.11,true
+1.0.0-beta.2,1.0.0-beta.11,1.0.0-rc.1,true
+1.0.0-beta.11,1.0.0-rc.1,1.0.0,true
+1.1.2,1.1.3,1.1.4,true
+1.2.1,1.3.1,1.4.1,true
+2.0.0,3.0.0,4.0.0,true
+2.2.2,2.2.3-rc1,2.2.3,true
+2.2.2,2.3.2-rc100,2.3.3,true
+1.0.0-rc.1+build.1,1.2.3-beta,1.2.3-rc.1+build.123,true
+3.3.3,3.3.3-alpha,3.3.4,false
+2.2.2-rc.1,2.2.2+metadata,2.2.2-rc.10,false
+1.1.1-rc.1,1.1.1-rc.3,1.1.1-rc.2,false
diff --git a/tests/models/grammar/files/equal-to-semver.csv b/tests/models/grammar/files/equal-to-semver.csv
@@ -0,0 +1,7 @@
+version1,version2,equals
+1.1.1,1.1.1,true
+1.1.1,1.1.1+metadata,false
+1.1.1,1.1.1-rc.1,false
+88.88.88,88.88.88,true
+1.2.3----RC-SNAPSHOT.12.9.1--.12,1.2.3----RC-SNAPSHOT.12.9.1--.12,true
+10.2.3-DEV-SNAPSHOT,10.2.3-SNAPSHOT-123,false
diff --git a/tests/models/grammar/files/invalid-semantic-versions.csv b/tests/models/grammar/files/invalid-semantic-versions.csv
@@ -0,0 +1,26 @@
+invalid
+1
+1.2
+1.alpha.2
++invalid
+-invalid
+-invalid+invalid
+-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.2-SNAPSHOT
+1.2.31.2.3----RC-SNAPSHOT.12.09.1--..12+788
+1.2-RC-SNAPSHOT
+-1.0.3-gamma+b7718
++justmeta
+#99999999999999999999999.999999999999999999.99999999999999999----RC-SNAPSHOT.12.09.1--------------------------------..12
diff --git a/tests/models/grammar/files/valid-semantic-versions.csv b/tests/models/grammar/files/valid-semantic-versions.csv
@@ -0,0 +1,25 @@
+higher,lower
+1.1.2,1.1.1
+1.0.0,1.0.0-rc.1
+1.1.0-rc.1,1.0.0-beta.11
+1.0.0-beta.11,1.0.0-beta.2
+1.0.0-beta.2,1.0.0-beta
+1.0.0-beta,1.0.0-alpha.beta
+1.0.0-alpha.beta,1.0.0-alpha.1
+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
+1.1.2,1.1.1
+1.2.1,1.1.1
+2.1.1,1.1.1
+1.1.1-rc.1,1.1.1-rc.0
diff --git a/tests/models/grammar/test_semver.py b/tests/models/grammar/test_semver.py
@@ -1,91 +1,55 @@
 """Condition model tests module."""
 import pytest
+import csv
+import os
 
 from splitio.models.grammar.matchers.semver import Semver
 
+valid_versions = os.path.join(os.path.dirname(__file__), 'files', 'valid-semantic-versions.csv')
+invalid_versions = os.path.join(os.path.dirname(__file__), 'files', 'invalid-semantic-versions.csv')
+equalto_versions = os.path.join(os.path.dirname(__file__), 'files', 'equal-to-semver.csv')
+between_versions = os.path.join(os.path.dirname(__file__), 'files', 'between-semver.csv')
+
 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]==[])
+        with open(valid_versions) as csvfile:
+            reader = csv.DictReader(csvfile)
+            for row in reader:
+                assert Semver.build(row['higher']) is not None
+                assert Semver.build(row['lower']) is not None
 
     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
+        with open(invalid_versions) as csvfile:
+            reader = csv.DictReader(csvfile)
+            for row in reader:
+                assert Semver.build(row['invalid']) is None
 
     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
+        with open(valid_versions) as csvfile:
+            reader = csv.DictReader(csvfile)
+            for row in reader:
+                assert Semver.build(row['higher']).compare(Semver.build(row['lower'])) == 1
+                assert Semver.build(row['lower']).compare(Semver.build(row['higher'])) == -1
+
+        with open(equalto_versions) as csvfile:
+            reader = csv.DictReader(csvfile)
+            for row in reader:
+                version1 = Semver.build(row['version1'])
+                version2 = Semver.build(row['version2'])
+                if row['equals'] == "true":
+                    assert version1.version == version2.version
+                else:
+                    assert version1.version != version2.version
+
+        with open(between_versions) as csvfile:
+            reader = csv.DictReader(csvfile)
+            for row in reader:
+                version1 = Semver.build(row['version1'])
+                version2 = Semver.build(row['version2'])
+                version3 = Semver.build(row['version3'])
+                if row['expected'] == "true":
+                    assert version2.compare(version1) >= 0 and version3.compare(version2) >= 0
+                else:
+                    assert version2.compare(version1) < 0 or version3.compare(version2) < 0
