Move publish to task, deployed by viewset

closes #3296 https://pulp.plan.io/issues/3296
pulp · Jan 23, 2018 · 8749025 · 8749025
1 parent 916bea7
commit 8749025
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 84 deletions.
diff --git a/README.rst b/README.rst
@@ -162,9 +162,9 @@ Add a ``file`` Publisher to repository ``foo``
 ``$ export PUBLISHER_HREF=$(http :8000/api/v3/publishers/file/ | jq -r '.results[] | select(.name == "bar") | ._href')``
 
 
-Create a Publication for Publisher ``bar``
-------------------------------------------
-``$ http POST http://localhost:8000/api/v3/publications/ publisher=$PUBLISHER_HREF``
+Use the ``bar`` Publisher to create a Publication
+-------------------------------------------------
+``$ http POST $PUBLISHER_HREF'publish/'``
 
 .. code:: json
 

diff --git a/pulp_file/app/tasks.py b/pulp_file/app/tasks.py
@@ -11,21 +11,18 @@
 from django.db import transaction
 from django.db.models import Q
 from pulpcore.plugin import models
-from pulpcore.plugin.tasks import working_dir_context, UserFacingTask
-
 from pulpcore.plugin.changeset import (
     BatchIterator,
     ChangeSet,
     PendingArtifact,
     PendingContent,
-    PublishedMetadata,
-    PublishedArtifact,
-    RemoteArtifact,
     SizedIterable,
 )
+from pulpcore.plugin.tasks import working_dir_context, UserFacingTask
 
 from pulp_file.app import models as file_models
-from pulp_file.manifest import Manifest, Entry
+from pulp_file.manifest import Entry, Manifest
+
 
 log = logging.getLogger(__name__)
 
@@ -34,19 +31,24 @@
 Key = namedtuple('Key', ('path', 'digest'))
 
 
-def _publish(publisher):
+def _publish(publication):
     """
-    Create published artifacts and yield the manifest entry for each.
+    Create published artifacts and yield a Manifest Entry for each.
+
+    Args:
+        publication (pulpcore.plugin.models.Publication): The Publication being created.
 
     Yields:
         Entry: The manifest entry.
     """
-    for content in publisher.publication.repository_version.content():
+    # Each ContentUnit in the RepositoryVersion
+    for content in publication.repository_version.content():
+        # Each Artifact that is a part of the ContentUnit
         for content_artifact in content.contentartifact_set.all():
-            artifact = _find_artifact(content_artifact)
-            published_artifact = PublishedArtifact(
+            artifact = _find_artifact(content_artifact, publication.repository_version.repository)
+            published_artifact = models.PublishedArtifact(
                 relative_path=content_artifact.relative_path,
-                publication=publisher.publication,
+                publication=publication,
                 content_artifact=content_artifact)
             published_artifact.save()
             entry = Entry(
@@ -56,73 +58,65 @@ def _publish(publisher):
             yield entry
 
 
-def _find_artifact(repository, content_artifact):
+def _find_artifact(content_artifact, repository):
     """
-    Find the artifact referenced by a ContentArtifact.
+    Return the Artifact (or RemoteArtifact) referenced by a ContentArtifact.
 
     Args:
         content_artifact (pulpcore.plugin.models.ContentArtifact): A content artifact.
+        repository (pulpcore.plugin.models.Repository): Used to retrieve Artifacts that have not
+            been downloaded yet.
 
     Returns:
         Artifact: When the artifact exists.
         RemoteArtifact: When the artifact does not exist.
     """
     artifact = content_artifact.artifact
     if not artifact:
-        artifact = RemoteArtifact.objects.get(
+        artifact = models.RemoteArtifact.objects.get(
             content_artifact=content_artifact,
             importer__repository=repository)
     return artifact
 
 
 @shared_task(base=UserFacingTask)
-def publish(publisher_pk, repository_pk, repository_version_pk):
+def publish(publisher_pk, repository_pk):
     """
-    Call publish on the publisher defined by a plugin.
-
-    A working directory is prepared, the plugin's publish is called, and then
-    working directory is removed.
+    Use provided publisher to create a Publication based on a RepositoryVersion.
 
     Args:
-        publisher_pk (str): The publisher PK.
-        repository_pk (str): The repository PK.
-        repository_version_pk (str): The repository version PK.
+        publisher_pk (str): Use the publish settings provided by this publisher.
+        repository_pk (str): Create a Publication from the latest version of this Repository.
     """
     publisher = file_models.FilePublisher.objects.get(pk=publisher_pk)
-    if repository_version_pk:
-        repository_version = models.RepositoryVersion.objects.get(pk=repository_version_pk)
-    else:
-        repository_version = models.Repository.objects.get(pk=repository_pk).versions.exclude(
-            complete=False).latest()
+    repository = models.Repository.objects.get(pk=repository_pk)
+    repository_version = repository.versions.exclude(complete=False).latest()
 
     log.info(
         _('Publishing: repository=%(repository)s, version=%(version)d, publisher=%(publisher)s'),
         {
-            'repository': repository_version.repository.name,
+            'repository': repository.name,
             'publisher': publisher.name,
             'version': repository_version.number,
         })
 
     with transaction.atomic():
-        publication = models.Publication(publisher=publisher,
-                                         repository_version=repository_version)
-        publisher.publication = publication
+        publication = models.Publication(publisher=publisher, repository_version=repository_version)
         publication.save()
-        created = models.CreatedResource(content_object=publication)
-        created.save()
-        with working_dir_context() as working_dir:
-            publisher.working_dir = working_dir
-            manifest = Manifest('PULP_MANIFEST')
-            manifest.write(_publish(publisher))
-            metadata = PublishedMetadata(
-                relative_path=os.path.basename(manifest.path),
-                publication=publisher.publication,
-                file=File(publisher(manifest.path, 'rb')))
-            metadata.save()
-            publisher.last_published = datetime.utcnow()
-            publisher.save()
-            distributions = models.Distribution.objects.filter(publisher=publisher)
-            distributions.update(publication=publication)
+        created_resource = models.CreatedResource(content_object=publication)
+        created_resource.save()
+        with working_dir_context():
+            try:
+                manifest = Manifest('PULP_MANIFEST')
+                manifest.write(_publish(publication))
+                metadata = models.PublishedMetadata(
+                    relative_path=os.path.basename(manifest.path),
+                    publication=publication,
+                    file=File(open(manifest.path, 'rb')))
+                metadata.save()
+            except Exception as e:
+                publication.delete()
+                created_resource.delete()
 
     log.info(
         _('Publication: %(publication)s created'),

diff --git a/pulp_file/app/viewsets.py b/pulp_file/app/viewsets.py
@@ -47,40 +47,11 @@ class FilePublisherViewSet(viewsets.PublisherViewSet):
 
     @decorators.detail_route(methods=('post',))
     def publish(self, request, pk):
-        request.data
-        publisher_pk = str(self.get_object().pk)
-        repository_pk = None
-        repository_version_pk = None
-        if 'repository' in request.data:
-            repository_url = request.data['repository']
-            repository_field = drf_serializers.HyperlinkedRelatedField(
-                view_name='repositories-detail',
-                queryset=pulpcore_models.Repository.objects.all(),
-                source='*', initial=repository_url)
-            try:
-                repository_field.run_validation(data=repository_url)
-                repository_pk = str(repository_field.queryset[0].pk)
-            except ValidationError as e:
-                # Append the URL of missing Repository to the error message
-                e.detail[0] = "%s %s" % (e.detail[0], repository_url)
-                raise e
-        if 'repository_version' in request.data:
-            repository_version_url = request.data['repository_version']
-            repository_version_field = drf_serializers.HyperlinkedRelatedField(
-                view_name='repository-version-detail',
-                queryset=pulpcore_models.Repository.objects.all(),
-                source='*', initial=repository_version_url)
-            try:
-                repository_version_field.run_validation(data=repository_version_url)
-                repository_version_pk = str(repository_field.queryset[0].pk)
-            except ValidationError as e:
-                # Append the URL of missing Repository to the error message
-                e.detail[0] = "%s %s" % (e.detail[0], repository_version_url)
-                raise e
+        publisher = self.get_object()
+        repository_pk = str(publisher.repository.pk)
         async_result = tasks.publish.apply_async_with_reservation(
             viewsets.tags.RESOURCE_REPOSITORY_TYPE, repository_pk,
-            kwargs={'publisher_pk': publisher_pk,
-                    'repository_pk': repository_pk,
-                    'repository_version_pk': repository_version_pk}
+            kwargs={'publisher_pk': str(publisher.pk),
+                    'repository_pk': repository_pk}
         )
-        return viewsets.OperationPostponedResponse([async_result], request)
+        return viewsets.OperationPostponedResponse([async_result], request)