Make export version check more resilient

[noissue]

Author: mdellweg

pulpcore/app/importexport.py

@@ -91,7 +91,7 @@ def export_versions(export, version_info):
 
     Args:
         export (django.db.models.PulpExport): export instance that's doing the export
-        version_info (set): set of (distribution-label,version) tuples for repos in this export
+        version_info (set): iterable of (distribution-label,version) tuples for repos in this export
     """
     # build the version-list from the distributions for each component
     versions = [{"component": label, "version": version} for (label, version) in version_info]

pulpcore/app/tasks/export.py

@@ -9,10 +9,10 @@
 from gettext import gettext as _
 from glob import glob
 from pathlib import Path
-from pkg_resources import get_distribution
 
 from django.conf import settings
 
+from pulpcore.app.apps import get_plugin_config
 from pulpcore.app.models import (
     CreatedResource,
     ExportedResource,
@@ -21,13 +21,14 @@
     Publication,
     PulpExport,
     PulpExporter,
+    Repository,
     RepositoryVersion,
     Task,
 )
 from pulpcore.app.models.content import Artifact, ContentArtifact
 from pulpcore.app.serializers import PulpExportSerializer
 
-from pulpcore.app.util import compute_file_hash, get_version_from_model, Crc32Hasher
+from pulpcore.app.util import compute_file_hash, Crc32Hasher
 from pulpcore.app.importexport import (
     export_versions,
     export_artifacts,
@@ -318,17 +319,12 @@ def _get_versions_info(the_exporter):
     """
     Return plugin-version-info based on plugins are responsible for exporter-repositories.
     """
-    repositories = the_exporter.repositories.all()
-
     # extract plugin-version-info based on the repositories we're exporting from
-    vers_info = set()
-    # We always need to know what version of pulpcore was in place
-    vers_info.add(("pulpcore", get_distribution("pulpcore").version))
-    # for each repository being exported, get the version-info for the plugin that
-    # owns/controls that kind-of repository
-    for r in repositories:
-        vers_info.add(get_version_from_model(r.cast()))
-
+    repositories = the_exporter.repositories.all()
+    repo_types = {r.pulp_type for r in repositories}
+    app_labels = {Repository.get_model_for_pulp_type(rt)._meta.app_label for rt in repo_types}
+    app_labels.add("core")
+    vers_info = [(app_label, get_plugin_config(app_label).version) for app_label in app_labels]
     return vers_info
 
 

pulpcore/app/tasks/importer.py

@@ -12,10 +12,10 @@
 from django.core.files.storage import default_storage
 from django.db.models import F
 from io import StringIO
-from pkg_resources import DistributionNotFound, get_distribution
 from rest_framework.serializers import ValidationError
 from tablib import Dataset
 
+from pulpcore.exceptions.plugin import MissingPlugin
 from pulpcore.app.apps import get_plugin_config
 from pulpcore.app.models import (
     Artifact,
@@ -282,8 +282,8 @@ def _check_versions(version_json):
     error_messages = []
     for component in version_json:
         try:
-            version = get_distribution(component["component"]).version
-        except DistributionNotFound:
+            version = get_plugin_config(component["component"]).version
+        except MissingPlugin:
             error_messages.append(
                 _("Export uses {} which is not installed.").format(component["component"])
             )
@@ -363,8 +363,8 @@ def import_repository_version(
                         mapping = json.load(mapping_file)
 
         # Content
-        plugin_name = src_repo_type.split(".")[0]
-        cfg = get_plugin_config(plugin_name)
+        app_label = src_repo_type.split(".")[0]
+        cfg = get_plugin_config(app_label)
 
         resulting_content_ids = []
         for res_class in cfg.exportable_classes:

pulpcore/app/util.py

@@ -13,10 +13,7 @@
 import gnupg
 
 from django.conf import settings
-from django.apps import apps
 from django.urls import Resolver404, resolve, reverse
-from django.contrib.contenttypes.models import ContentType
-from pkg_resources import get_distribution
 from rest_framework.serializers import ValidationError
 
 from pulpcore.app.loggers import deprecation_logger
@@ -199,23 +196,6 @@ def batch_qs(qs, batch_size=1000):
         yield qs[start:end]
 
 
-def get_version_from_model(in_model):
-    """
-    Return a tuple (dist-label, version) for the distribution that 'owns' the model
-
-    Args:
-        in_model (models.Model): model whose owning-plugin-version we need
-
-    Returns:
-        (str, str): tuple containing owning-plugin's (distribution, version)
-    """
-    app_label = ContentType.objects.get_for_model(in_model, for_concrete_model=False).app_label
-    app_config_module = apps.get_app_config(app_label).name
-    maybe_the_distribution_name = app_config_module.split(".")[0]
-    version = get_distribution(maybe_the_distribution_name).version  # hope for the best!
-    return maybe_the_distribution_name, version
-
-
 def get_view_urlpattern(view):
     """
     Get a full urlpattern for a view which includes a parent urlpattern if it exists.

pulpcore/tests/unit/test_import_checks.py

@@ -2,26 +2,52 @@
 
 from rest_framework.serializers import ValidationError
 
-import pulpcore.app.tasks.importer
+import pulpcore.app.apps
 from pulpcore.app.tasks.importer import _check_versions
 
 
-class TestObject:
-    version = "1.2.3"  # Every component is vers 1.2.3
+def _pulp_plugin_configs():
+    for _label, _version in [("123", "1.2.3"), ("215", "2.1.5")]:
+
+        class _AppConfigMock:
+            label = _label
+            version = _version  # Every component is vers 1.2.3
+
+        yield _AppConfigMock
 
 
 def test_vers_check(monkeypatch):
-    monkeypatch.setattr(pulpcore.app.tasks.importer, "get_distribution", lambda _: TestObject())
-    export_json = [{"component": "xyz", "version": "1.2.3"}]
+    monkeypatch.setattr(pulpcore.app.apps, "pulp_plugin_configs", _pulp_plugin_configs)
+    export_json = [{"component": "123", "version": "1.2.3"}]
+    _check_versions(export_json)
+
+    export_json = [{"component": "123", "version": "1.2"}]
+    _check_versions(export_json)
+
+    export_json = [{"component": "123", "version": "1.2.7"}]
     _check_versions(export_json)
 
-    export_json = [{"component": "xy", "version": "1.2"}]
+    export_json = [
+        {"component": "123", "version": "1.2.0"},
+        {"component": "215", "version": "2.1.9"},
+    ]
     _check_versions(export_json)
 
-    export_json = [{"component": "x_noty_z", "version": "1.4.3"}]
+    export_json = [{"component": "123", "version": "1.4.3"}]
+    with pytest.raises(ValidationError):
+        _check_versions(export_json)
+
+    export_json = [{"component": "123", "version": "2.2.3"}]
+    with pytest.raises(ValidationError):
+        _check_versions(export_json)
+
+    export_json = [{"component": "non_existent", "version": "1.2.3"}]
     with pytest.raises(ValidationError):
         _check_versions(export_json)
 
-    export_json = [{"component": "notx_y_z", "version": "2.2.3"}]
+    export_json = [
+        {"component": "123", "version": "1.2.3"},
+        {"component": "non_existent", "version": "1.2.3"},
+    ]
     with pytest.raises(ValidationError):
         _check_versions(export_json)