Add support for 'version_wild' dependency constraints

colcon_package_information/package_augmentation/check_dependency_constraint.py

@@ -2,6 +2,7 @@
 # Licensed under the Apache License, Version 2.0
 
 import operator
+import re
 
 from colcon_core.package_augmentation import logger as \
     package_augmentation_logger
@@ -12,6 +13,12 @@
 logger = package_augmentation_logger.getChild('check_dependency_constraint')
 
 
+def _wildcard_to_regex(pattern):
+    pattern = re.escape(pattern)
+    pattern = pattern.replace(r'\*', '.*')
+    return re.compile(f'^{pattern}$')
+
+
 class CheckDependencyConstraintPackageAugmentation(
     PackageAugmentationExtensionPoint
 ):
@@ -57,21 +64,25 @@ def lte(a, b):
         def gte(a, b):
             return operator.gt(a, b) or operator.eq(a, b)
 
+        def wild(a, b):
+            return bool(b.match(str(a)))
+
         operators = {
-            'version_lt': (operator.lt, 'less than'),
-            'version_lte': (lte, 'less than or equal to'),
-            'version_eq': (operator.eq, 'equal to'),
-            'version_neq': (operator.ne, 'not equal to'),
-            'version_gte': (gte, 'greater than or equal to'),
-            'version_gt': (operator.gt, 'greater than'),
+            'version_lt': (operator.lt, 'less than', Version),
+            'version_lte': (lte, 'less than or equal to', Version),
+            'version_eq': (operator.eq, 'equal to', Version),
+            'version_neq': (operator.ne, 'not equal to', Version),
+            'version_gte': (gte, 'greater than or equal to', Version),
+            'version_gt': (operator.gt, 'greater than', Version),
+            'version_wild': (wild, 'a mismatch for', _wildcard_to_regex),
         }
         for key, value in dep.metadata.items():
             # only consider version operator metadata
             if key not in operators:
                 continue
-            op, msg = operators[key]
+            op, msg, conversion = operators[key]
             try:
-                version_constraint = Version(value)
+                version_constraint = conversion(value)
             except Exception:  # noqa: B902
                 logger.error(
                     "Failed to parse version '" + value + "' with " +

test/spell_check.words

@@ -28,3 +28,4 @@ subgraph
 thomas
 tpng
 unittest
+wildcard

test/test_check_dependency_constraint.py

@@ -116,3 +116,38 @@ def test_dependency_invalid_version_operator():
 
     extension = CheckDependencyConstraintPackageAugmentation()
     extension.augment_packages({pkg_a, pkg_b})
+
+
+@pytest.mark.parametrize(
+    'pattern,expect_mismatch', [
+        (None,      0),
+        ('1.2.3',   0),
+        ('1.2.4',   1),
+        ('1.2.4.1', 1),
+        ('1.2.*',   0),
+        ('1.3.*',   1),
+        ('1.*.3',   0),
+        ('1.*.4',   1),
+    ])
+def test_dependency_wild(pattern, expect_mismatch):
+    pkg_a = PackageDescriptor('/tmp/pkg_a')
+    pkg_a.name = 'pkg_a'
+    pkg_a.metadata['version'] = '1.2.3'
+
+    pkg_a_dep = DependencyDescriptor('pkg_a')
+    if pattern is not None:
+        pkg_a_dep.metadata['version_wild'] = pattern
+
+    pkg_b = PackageDescriptor('/tmp/pkg_b')
+    pkg_b.name = 'pkg_b'
+    pkg_b.dependencies['build'] = {pkg_a_dep}
+
+    extension = CheckDependencyConstraintPackageAugmentation()
+
+    with patch(
+        'colcon_package_information.package_augmentation.'
+        'check_dependency_constraint.logger.warning'
+    ) as warning:
+        extension.augment_packages({pkg_a, pkg_b})
+        assert expect_mismatch == warning.call_count
+        warning.reset_mock()