Merge pull request #243 from asmacdo/split-distribution

Add detail python distribution

Author: asmacdo

docs/_scripts/distribution.sh

@@ -1,6 +1,6 @@
 # Distributions are created asynchronously. Create one, and specify the publication that will
 # be served at the base path specified.
-export TASK_URL=$(http POST $BASE_ADDR/pulp/api/v3/distributions/ \
+export TASK_URL=$(http POST $BASE_ADDR/pulp/api/v3/distributions/python/pypi/ \
   name='baz' \
   base_path='foo' \
   publication=$PUBLICATION_HREF | jq -r '.task')

docs/_static/api.json

@@ -41,20 +41,17 @@ demonstrated in :ref:`using distributions<using-distributions>`.
 Distribution GET Response::
 
   {
-      "_created": "2019-04-29T15:58:07.586250Z",
-      "_href": "/pulp/api/v3/distributions/63d532cc-94ea-402c-bb6d-2340242c6df8/",
+      "_created": "2019-05-13T12:39:48.698103Z",
+      "_href": "/pulp/api/v3/distributions/python/pypi/682d64c3-fee1-411c-a3af-3f74cab56c5e/",
       "base_path": "foo",
       "base_url": "localhost:24816/pulp/content/foo",
       "content_guard": null,
       "name": "baz",
-      "publication": "/pulp/api/v3/publications/python/pypi/4cc1ddbb-64ff-4795-894a-09d5ca372774/",
-      "publisher": null,
-      "remote": null,
-      "repository": null
+      "publication": "/pulp/api/v3/publications/python/pypi/23f4c6fb-204b-45b6-8826-f61d4d38748d/",
+      "remote": null
   }
 
-Reference (pulpcore): `Distribution API Usage
-<https://docs.pulpproject.org/en/3.0/nightly/restapi.html#tag/distributions>`_
+Reference: `Python Distribution Usage <../restapi.html#tag/distributions>`_
 
 .. _using-distributions:
 

docs/workflows/publish-host.rst

@@ -2,7 +2,7 @@
 
 from django.db import models
 
-from pulpcore.plugin.models import Content, Model, Publication, Remote
+from pulpcore.plugin.models import Content, Model, Publication, PublicationDistribution, Remote
 
 log = getLogger(__name__)
 
@@ -83,6 +83,14 @@ class Meta:
         unique_together = ('name', 'version_specifier', 'exclude', 'remote')
 
 
+class PythonDistribution(PublicationDistribution):
+    """
+    Distribution for 'Python' Content.
+    """
+
+    TYPE = 'python'
+
+
 class PythonPackageContent(Content):
     """
     A Content Type representing Python's Distribution Package.

pulp_python/app/models.py

@@ -56,6 +56,17 @@ class Meta:
         fields = ('name', 'version_specifier')
 
 
+class PythonDistributionSerializer(core_serializers.PublicationDistributionSerializer):
+    """
+    Serializer for Pulp distributions for the Python type.
+
+    """
+
+    class Meta:
+        fields = core_serializers.PublicationDistributionSerializer.Meta.fields
+        model = python_models.PythonDistribution
+
+
 class PythonPackageContentSerializer(core_serializers.SingleArtifactContentSerializer):
     """
     A Serializer for PythonPackageContent.
@@ -334,6 +345,14 @@ class PythonPublicationSerializer(core_serializers.PublicationSerializer):
     A Serializer for PythonPublication.
     """
 
+    distributions = core_serializers.DetailRelatedField(
+        help_text=_('This publication is currently being hosted as configured by these '
+                    'distributions.'),
+        source="pythondistribution_set",
+        many=True,
+        read_only=True,
+    )
+
     class Meta:
-        fields = core_serializers.PublicationSerializer.Meta.fields
+        fields = core_serializers.PublicationSerializer.Meta.fields + ('distributions',)
         model = python_models.PythonPublication

pulp_python/app/serializers.py

@@ -40,6 +40,21 @@
 }
 
 
+class PythonDistributionViewSet(platform.BaseDistributionViewSet):
+    """
+    <!-- User-facing documentation, rendered as html-->
+    Pulp Python Distributions are used to distribute
+    <a href="../restapi.html#tag/publications">Python Publications.</a> <b> Pulp Python
+    Distributions should not be confused with "Python Distribution" as defined by the Python
+    community.</b> In Pulp usage, Python content is refered to as <a
+    href="../restapi.html#tag/content">Python Package Content.</a>
+    """
+
+    endpoint_name = 'pypi'
+    queryset = python_models.PythonDistribution.objects.all()
+    serializer_class = python_serializers.PythonDistributionSerializer
+
+
 class PythonPackageContentFilter(platform.ContentFilter):
     """
     FilterSet for PythonPackageContent.

pulp_python/app/viewsets.py

@@ -4,7 +4,7 @@
 from urllib.parse import urljoin
 
 from pulp_smash import api, config, utils
-from pulp_smash.pulp3.constants import DISTRIBUTION_PATH, REPO_PATH
+from pulp_smash.pulp3.constants import REPO_PATH
 from pulp_smash.pulp3.utils import (
     download_content_unit,
     gen_distribution,
@@ -15,6 +15,7 @@
 from pulp_python.tests.functional.constants import (
     PYTHON_FIXTURES_URL,
     PYTHON_REMOTE_PATH,
+    PYTHON_DISTRIBUTION_PATH,
 )
 from pulp_python.tests.functional.utils import (
     get_python_content_paths,
@@ -77,7 +78,7 @@ def test_all(self):
         body = gen_distribution()
         body['publication'] = publication['_href']
         distribution = client.using_handler(api.task_handler).post(
-            DISTRIBUTION_PATH,
+            PYTHON_DISTRIBUTION_PATH,
             body
         )
         self.addCleanup(client.delete, distribution['_href'])

pulp_python/tests/functional/api/test_download_content.py

@@ -2,23 +2,26 @@
 
 from pulp_smash.constants import PULP_FIXTURES_BASE_URL
 from pulp_smash.pulp3.constants import (
+    BASE_DISTRIBUTION_PATH,
     BASE_PUBLICATION_PATH,
     BASE_REMOTE_PATH,
     CONTENT_PATH
 )
 
 
+PYPI_URL = "https://pypi.org/"
+
 PYTHON_CONTENT_NAME = 'python.python'
 
 PYTHON_CONTENT_PATH = urljoin(CONTENT_PATH, 'python/packages/')
 
-PYTHON_REMOTE_PATH = urljoin(BASE_REMOTE_PATH, 'python/python/')
-
-PYTHON_PUBLICATION_PATH = urljoin(BASE_PUBLICATION_PATH, 'python/pypi/')
+PYTHON_DISTRIBUTION_PATH = urljoin(BASE_DISTRIBUTION_PATH, 'python/pypi/')
 
 PYTHON_FIXTURES_URL = urljoin(PULP_FIXTURES_BASE_URL, 'python-pypi/')
 
-PYPI_URL = "https://pypi.org/"
+PYTHON_PUBLICATION_PATH = urljoin(BASE_PUBLICATION_PATH, 'python/pypi/')
+
+PYTHON_REMOTE_PATH = urljoin(BASE_REMOTE_PATH, 'python/python/')
 
 
 # Specifier for testing empty syncs, or no excludes