Skip to content

Commit

Permalink
Issue 5642 - Build fails against setuptools 67.0.0
Browse files Browse the repository at this point in the history
Bug Description:
`setuptools` 67.0.0 vendors `packaging` 23.0 which dropped `LegacyVersion`.

Fix Description:
Replace `LegacyVersion` with `DSVersion` to compare version strings that are
not compatible with PEP 440 and PEP 508.

Reviewed by: @mreynolds389, @progier389

Fixes: #5642
  • Loading branch information
vashirov committed Jan 26, 2024
1 parent 35d473f commit 2cea6b2
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 18 deletions.
12 changes: 2 additions & 10 deletions src/lib389/lib389/nss_ssl.py
Expand Up @@ -23,15 +23,7 @@
from lib389.passwd import password_generate
from lib389._mapped_object_lint import DSLint
from lib389.lint import DSCERTLE0001, DSCERTLE0002
from lib389.utils import ensure_str, format_cmd_list, cert_is_ca


# Setuptools ships with 'packaging' module, let's use it from there
try:
from pkg_resources.extern.packaging.version import LegacyVersion
# Fallback to a normal 'packaging' module in case 'setuptools' is stripped
except:
from packaging.version import LegacyVersion
from lib389.utils import ensure_str, format_cmd_list, cert_is_ca, DSVersion

KEYBITS = 4096
CA_NAME = 'Self-Signed-CA'
Expand Down Expand Up @@ -238,7 +230,7 @@ def openssl_rehash(self, certdir):
openssl_version = check_output(['/usr/bin/openssl', 'version']).decode('utf-8').strip()
except subprocess.CalledProcessError as e:
raise ValueError(e.output.decode('utf-8').rstrip())
rehash_available = LegacyVersion(openssl_version.split(' ')[1]) >= LegacyVersion('1.1.0')
rehash_available = DSVersion(openssl_version.split(' ')[1]) >= DSVersion('1.1.0')

if rehash_available:
cmd = ['/usr/bin/openssl', 'rehash', certdir]
Expand Down
12 changes: 12 additions & 0 deletions src/lib389/lib389/tests/dsversion_test.py
@@ -0,0 +1,12 @@
from lib389.utils import DSVersion
import pytest

versions = [('1.3.10.1', '1.3.2.1'),
('2.3.2', '1.4.4.4'),
('2.3.2.202302121950git1b4f5a5bf', '2.3.2'),
('1.1.0a', '1.1.0')]

@pytest.mark.parametrize("x,y", versions)
def test_dsversion(x, y):
assert DSVersion(x) > DSVersion(y)

80 changes: 72 additions & 8 deletions src/lib389/lib389/utils.py
Expand Up @@ -41,12 +41,6 @@ def wait(self):
import operator
import subprocess
import math
# Setuptools ships with 'packaging' module, let's use it from there
try:
from pkg_resources.extern.packaging.version import LegacyVersion
# Fallback to a normal 'packaging' module in case 'setuptools' is stripped
except:
from packaging.version import LegacyVersion
from socket import getfqdn
from ldapurl import LDAPUrl
from contextlib import closing
Expand Down Expand Up @@ -1234,6 +1228,76 @@ def generate_ds_params(inst_num, role=ReplicaRole.STANDALONE):

return instance_data

class DSVersion():
def __init__(self, version):
self._version = str(version)
self._key = _cmpkey(self._version)

def __str__(self):
return self._version

def __repr__(self):
return f"<DSVersion('{self}')>"

def __hash__(self):
return hash(self._key)

def __lt__(self, other):
if not isinstance(other, DSVersion):
return NotImplemented

return self._key < other._key

def __le__(self, other):
if not isinstance(other, DSVersion):
return NotImplemented

return self._key <= other._key

def __eq__(self, other):
if not isinstance(other, DSVersion):
return NotImplemented

return self._key == other._key

def __ge__(self, other):
if not isinstance(other, DSVersion):
return NotImplemented

return self._key >= other._key

def __gt__(self, other):
if not isinstance(other, DSVersion):
return NotImplemented

return self._key > other._key

def __ne__(self, other):
if not isinstance(other, DSVersion):
return NotImplemented

return self._key != other._key


def _parse_version_parts(s):
for part in re.compile(r"(\d+ | [a-z]+ | \. | -)", re.VERBOSE).split(s):

if not part or part == ".":
continue

if part[:1] in "0123456789":
# pad for numeric comparison
yield part.zfill(8)
else:
yield "*" + part

def _cmpkey(version):
parts = []
for part in _parse_version_parts(version.lower()):
parts.append(part)

return tuple(parts)


def get_ds_version(paths=None):
"""
Expand Down Expand Up @@ -1261,9 +1325,9 @@ def ds_is_related(relation, *ver, instance=None):
if len(ver) > 1:
for cmp_ver in ver:
if cmp_ver.startswith(ds_ver[:3]):
return ops[relation](LegacyVersion(ds_ver),LegacyVersion(cmp_ver))
return ops[relation](DSVersion(ds_ver), DSVersion(cmp_ver))
else:
return ops[relation](LegacyVersion(ds_ver), LegacyVersion(ver[0]))
return ops[relation](DSVersion(ds_ver), DSVersion(ver[0]))


def ds_is_older(*ver, instance=None):
Expand Down

0 comments on commit 2cea6b2

Please sign in to comment.