Pulp

I talked to @jsherrill about this and they use it to set a few options that aren't currently available[0] in pulp 3. Moreover the options are only relevant to pulp_rpm so we agreed to set this to a P2 instead of a P1.

Agreed that this needs more design work. I had only considered the FirstStage and not the artifact download stage. We'll need a way to pass these options on.

Removing from sprint and ungrooming.

[0] https://git.io/fxzXY

With the current design of import/export, katello no longer needs one time sync options.

This work is being de-prioritized out of 3.0 due to no stakeholder or user still requesting it.

Here's the diff of the pulpcore branch code that was partially working in case this gets developed in the future:

commit 33ae16fb24be8abd809db303ac8b6c9ec0a99c39
Author: Brian Bouterse <bbouters@redhat.com>
Date:   Mon Jul 8 16:59:21 2019 -0400

    Add one-time remote options at sync time

    The sync serializer now accepts Remote attributes to override the Remote
    attributres saved on the Remote for syncing. Plugins will need to enable
    this functionality to use it.

    https://pulp.plan.io/issues/3802
    closes #3802

diff --git a/CHANGES/3802.feature b/CHANGES/3802.feature
new file mode 100644
index 000000000..eded72d6c
--- /dev/null
+++ b/CHANGES/3802.feature
@@ -0,0 +1,3 @@
+Enable plugins writers to add one-time remote options at sync time. If a plugin is compatible, the
+sync call will accept Remote attributes, e.g. ``url`` or ``download_concurrency`` and override the
+Remote's saved options which remain unchanged.
diff --git a/pulpcore/app/serializers/repository.py b/pulpcore/app/serializers/repository.py
index 1492f4e47..6e1719378 100644
--- a/pulpcore/app/serializers/repository.py
+++ b/pulpcore/app/serializers/repository.py
@@ -42,12 +42,12 @@ class RepositorySerializer(ModelSerializer):
                                                 'description')


-class RemoteSerializer(MasterModelSerializer):
+class RemoteSerializerMixin:
     """
-    Every remote defined by a plugin should have a Remote serializer that inherits from this
-    class. Please import from `pulpcore.plugin.serializers` rather than from this module directly.
+    A mixin that defines all of the fields used by the RemoteSerializer.
+
+    This allows reuse with the RepositorySyncURLSerializer.
     """
-    _href = DetailIdentityField()
     name = serializers.CharField(
         help_text=_('A unique name for this remote.'),
         validators=[UniqueValidator(queryset=models.Remote.objects.all())],
@@ -114,6 +114,14 @@ class RemoteSerializer(MasterModelSerializer):
         default=models.Remote.IMMEDIATE
     )

+
+class RemoteSerializer(MasterModelSerializer, RemoteSerializerMixin):
+    """
+    Every remote defined by a plugin should have a Remote serializer that inherits from this
+    class. Please import from `pulpcore.plugin.serializers` rather than from this module directly.
+    """
+    _href = DetailIdentityField()
+
     class Meta:
         abstract = True
         model = models.Remote
@@ -124,7 +132,7 @@ class RemoteSerializer(MasterModelSerializer):
         )


-class RepositorySyncURLSerializer(serializers.Serializer):
+class RepositorySyncURLSerializer(serializers.Serializer, RemoteSerializerMixin):
     repository = serializers.HyperlinkedRelatedField(
         required=True,
         help_text=_('A URI of the repository to be synchronized.'),
@@ -143,6 +151,13 @@ class RepositorySyncURLSerializer(serializers.Serializer):
                     'the remote repository. If ``False``, sync will be additive only.')
     )

+    class Meta:
+        fields = (
+            'name', 'url', 'ssl_ca_certificate', 'ssl_client_certificate', 'ssl_client_key',
+            'ssl_validation', 'proxy_url', 'username', 'password', '_last_updated',
+            'download_concurrency', 'policy'
+        ) + ('repository', 'mirror')
+

 class PublisherSerializer(MasterModelSerializer):
     """
diff --git a/pulpcore/app/viewsets/repository.py b/pulpcore/app/viewsets/repository.py
index 4d81d0a63..f37fc8376 100644
--- a/pulpcore/app/viewsets/repository.py
+++ b/pulpcore/app/viewsets/repository.py
@@ -293,6 +293,19 @@ class RemoteViewSet(NamedModelViewSet,
     queryset = Remote.objects.all()
     filterset_class = RemoteFilter

+    def get_remote_with_one_time_options(self):
+        """
+        Returns the detail remote overridden with the one-time options.
+        """
+        import pydevd_pycharm
+        pydevd_pycharm.settrace('localhost', port=29438, stdoutToServer=True, stderrToServer=True)
+        remote = super().get_object()
+        serializer = self.get_serializer(remote, data=self.request.data)
+        serializer.is_valid(raise_exception=True)
+        print(serializer.validated_data)
+        return remote
+
+

 class PublisherFilter(BaseFilterSet):
     """

Users should create a new remote and use that remote for a one time sync.