Add Domains compatibility and refactor some tests to pytest style.

Closes #273

- Add new fixtures and translate other tests. Tests passing, but still some skip.
- Remove custom code used to deal with package metadata and package content.
- Translate a test that checks the download policies.
- Finish translating tests to pytest style and remove pulp-smash.
- Update template files.
- Add a new pytest dependency.
- Add a last test for package search.

Author: decko

.github/template_gitref

@@ -1 +1 @@
-2021.08.26-421-g204a709
+2021.08.26-422-g3b31aa3

.github/workflows/docs.yml

@@ -13,7 +13,7 @@ on:
 jobs:
   test:
     if: "endsWith(github.base_ref, 'main')"
-    runs-on: "ubuntu-20.04"
+    runs-on: "ubuntu-latest"
     defaults:
       run:
         working-directory: "pulp_npm"
@@ -48,7 +48,7 @@ jobs:
 
   no-test:
     if: "!endsWith(github.base_ref, 'main')"
-    runs-on: "ubuntu-20.04"
+    runs-on: "ubuntu-latest"
     steps:
       - run: |
           echo "Skip docs testing on non-main branches."

.github/workflows/scripts/install.sh

@@ -75,7 +75,7 @@ VARSYAML
 
 cat >> vars/main.yaml << VARSYAML
 pulp_env: {}
-pulp_settings: null
+pulp_settings: {"orphan_protection_time": 0}
 pulp_scheme: https
 pulp_default_container: ghcr.io/pulp/pulp-ci-centos9:latest
 VARSYAML
@@ -93,7 +93,7 @@ if [ "$TEST" = "s3" ]; then
   sed -i -e '$a s3_test: true\
 minio_access_key: "'$MINIO_ACCESS_KEY'"\
 minio_secret_key: "'$MINIO_SECRET_KEY'"\
-pulp_scenario_settings: null\
+pulp_scenario_settings: {"domain_enabled": true}\
 pulp_scenario_env: {}\
 test_storages_compat_layer: false\
 ' vars/main.yaml
@@ -108,7 +108,7 @@ if [ "$TEST" = "azure" ]; then
       - ./azurite:/etc/pulp\
     command: "azurite-blob --blobHost 0.0.0.0"' vars/main.yaml
   sed -i -e '$a azure_test: true\
-pulp_scenario_settings: null\
+pulp_scenario_settings: {"domain_enabled": true}\
 pulp_scenario_env: {}\
 ' vars/main.yaml
 fi

CHANGES/273.feature

@@ -0,0 +1 @@
+Added Domains compatibility.

dev_requirements.txt

@@ -2,9 +2,6 @@ check-manifest
 coverage
 black
 flake8
-
 flake8-black
-
-
 flake8-tuple
 flake8-quotes

functest_requirements.txt

@@ -1,4 +1,4 @@
-git+https://github.com/pulp/pulp-smash.git#egg=pulp-smash
 pytest<8
 pytest-xdist
 pytest-timeout
+pytest-custom_exit_code

pulp_npm/app/__init__.py

@@ -8,3 +8,4 @@ class PulpNpmPluginAppConfig(PulpPluginAppConfig):
     label = "npm"
     version = "0.1.0a5.dev"
     python_package_name = "pulp-npm"
+    domain_compatible = True

pulp_npm/app/content/__init__.py

@@ -0,0 +1,29 @@
+# Generated by Django 4.2.19 on 2025-02-11 21:03
+
+from django.db import migrations, models
+import django.db.models.deletion
+import pulpcore.app.util
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0126_remoteartifact_failed_at'),
+        ('npm', '0003_alter_npmdistribution_distribution_ptr_and_more'),
+    ]
+
+    operations = [
+        migrations.AlterUniqueTogether(
+            name='package',
+            unique_together=set(),
+        ),
+        migrations.AddField(
+            model_name='package',
+            name='_pulp_domain',
+            field=models.ForeignKey(default=pulpcore.app.util.get_domain_pk, on_delete=django.db.models.deletion.PROTECT, to='core.domain'),
+        ),
+        migrations.AlterUniqueTogether(
+            name='package',
+            unique_together={('name', 'version', '_pulp_domain')},
+        ),
+    ]

pulp_npm/app/content/handler.py

@@ -5,17 +5,24 @@
     http://docs.pulpproject.org/en/3.0/nightly/plugins/plugin-writer/index.html
 """
 
+import json
 from logging import getLogger
 
+from aiohttp.web_response import Response
+from django.conf import settings
 from django.db import models
 
+
 from pulpcore.plugin.models import (
     Content,
     Remote,
     Repository,
     Distribution,
 )
 
+from pulpcore.plugin.util import get_domain_pk
+from .utils import urlpath_sanitize
+
 logger = getLogger(__name__)
 
 
@@ -42,6 +49,7 @@ class Meta:
 
     name = models.CharField(max_length=214)
     version = models.CharField(max_length=16)
+    _pulp_domain = models.ForeignKey("core.Domain", default=get_domain_pk, on_delete=models.PROTECT)
 
     @property
     def relative_path(self):
@@ -52,7 +60,7 @@ def relative_path(self):
 
     class Meta:
         default_related_name = "%(app_label)s_%(model_name)s"
-        unique_together = ("name", "version")
+        unique_together = ("name", "version", "_pulp_domain")
 
 
 class NpmRemote(Remote):
@@ -93,3 +101,55 @@ class NpmDistribution(Distribution):
 
     class Meta:
         default_related_name = "%(app_label)s_%(model_name)s"
+
+    def content_handler(self, path):
+        data = {}
+
+        repository_version = self.repository_version
+        if not repository_version:
+            repository_version = self.repository.latest_version()
+
+        content = repository_version.content
+        packages = Package.objects.filter(name=path, pk__in=content)
+
+        if not packages:
+            return None
+
+        data["name"] = path
+        data["versions"] = {}
+        versions = []
+
+        if settings.DOMAIN_ENABLED:
+            prefix_url = "{}/".format(
+                urlpath_sanitize(
+                    settings.CONTENT_ORIGIN,
+                    settings.CONTENT_PATH_PREFIX,
+                    self.pulp_domain.name,
+                    self.base_path,
+                )
+            )
+        else:
+            prefix_url = "{}/".format(
+                urlpath_sanitize(
+                    settings.CONTENT_ORIGIN,
+                    settings.CONTENT_PATH_PREFIX,
+                    self.base_path,
+                )
+            )
+
+        for package in packages:
+            tarball_url = f"{prefix_url}{package.relative_path.split('/')[-1]}"
+
+            version = {
+                package.version: {
+                    "_id": f"{package.name}@{package.version}",
+                    "dist": {"tarball": tarball_url},
+                }
+            }
+            versions.append(package.version)
+            data["versions"].update(version)
+
+        data["dist-tags"] = {"latest": max(versions)}
+
+        serialized_data = json.dumps(data)
+        return Response(body=serialized_data)

pulp_npm/app/migrations/0004_alter_package_unique_together_package__pulp_domain_and_more.py

@@ -1,19 +1,8 @@
-"""
-Check `Plugin Writer's Guide`_ for more details.
-
-.. _Plugin Writer's Guide:
-    http://docs.pulpproject.org/en/3.0/nightly/plugins/plugin-writer/index.html
-"""
-
-from gettext import gettext as _
-
-from django.conf import settings
 from rest_framework import serializers
 
 from pulpcore.plugin import models as core_models
 from pulpcore.plugin import serializers as platform
 
-from .utils import pulp_npm_content_path
 from . import models
 
 
@@ -79,7 +68,7 @@ class Meta:
         help_text="The policy to use when downloading content. The possible values include: "
         "'immediate', 'on_demand', and 'streamed'. 'immediate' is the default.",
         choices=core_models.Remote.POLICY_CHOICES,
-        default=core_models.Remote.IMMEDIATE,
+        required=False,
     )
 
     class Meta:
@@ -106,32 +95,11 @@ class Meta:
         model = models.NpmRepository
 
 
-class NpmBaseURLField(serializers.CharField):
-    """
-    Field for the base_url field pointing to the npm content app.
-    """
-
-    def to_representation(self, value):
-        """
-        Field representation.
-        """
-        base_path = value
-        origin = settings.CONTENT_ORIGIN
-        prefix = pulp_npm_content_path()
-        return "/".join((origin.strip("/"), prefix.strip("/"), base_path.lstrip("/")))
-
-
 class NpmDistributionSerializer(platform.DistributionSerializer):
     """
     Serializer for NPM Distributions.
     """
 
-    base_url = NpmBaseURLField(
-        source="base_path",
-        read_only=True,
-        help_text=_("The URL for accessing the universe API as defined by this distribution."),
-    )
-
     class Meta:
         fields = platform.DistributionSerializer.Meta.fields
         model = models.NpmDistribution

pulp_npm/app/models.py

@@ -1,6 +0,0 @@
-"""
-Check `Plugin Writer's Guide`_ for more details.
-
-.. _Plugin Writer's Guide:
-    http://docs.pulpproject.org/en/3.0/nightly/plugins/plugin-writer/index.html
-"""

pulp_npm/app/serializers.py

@@ -1,9 +1 @@
-from django.conf import settings
-from django.urls import path
-
-from pulp_npm.app.viewsets import PublishedPackageViewSet
-
-
-PACKAGE_API_ROOT = getattr(settings, "PACKAGE_API_ROOT", "pulp_npm/packages/<path:name>/")
-
-urlpatterns = [path(PACKAGE_API_ROOT, PublishedPackageViewSet.as_view())]
+urlpatterns = []

pulp_npm/app/settings.py

@@ -1,8 +1,17 @@
-from django.conf import settings
+def urlpath_sanitize(*args):
+    """
+    Join an arbitrary number of strings into a /-separated path.
 
+    Replaces uses of urljoin() that don't want/need urljoin's subtle semantics.
 
-def pulp_npm_content_path():
-    """Get base cotent path from configuration."""
-    components = settings.CONTENT_PATH_PREFIX.split("/")
-    components[1] = "pulp_npm"
-    return "/".join(components)
+    Returns: single string provided arguments separated by single-slashes
+
+    Args:
+        Arbitrary list of arguments to be join()ed
+    """
+    segments = []
+    for a in args + ("",):
+        stripped = a.strip("/")
+        if stripped:
+            segments.append(stripped)
+    return "/".join(segments)