Add headers option is aiohttp client session

CHANGES/8083.feature

@@ -0,0 +1 @@
+Added optional headers field to the aiohttp ClientSession.

pulpcore/app/migrations/0053_remote_headers.py

@@ -0,0 +1,19 @@
+# Generated by Django 2.2.17 on 2021-01-20 14:34
+
+import django.contrib.postgres.fields.jsonb
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0052_tasking_logging_cid'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='remote',
+            name='headers',
+            field=django.contrib.postgres.fields.jsonb.JSONField(blank=True, null=True),
+        ),
+    ]

pulpcore/app/models/repository.py

@@ -19,6 +19,8 @@
 from .content import Artifact, Content
 from .task import CreatedResource, Task
 
+from django.contrib.postgres.fields import JSONField
+
 
 _logger = logging.getLogger(__name__)
 
@@ -266,6 +268,7 @@ class Remote(MasterModel):
     sock_read_timeout = models.FloatField(
         null=True, validators=[MinValueValidator(0.0, "Timeout must be >= 0")]
     )
+    headers = JSONField(blank=True, null=True)
 
     @property
     def download_factory(self):

pulpcore/app/serializers/repository.py

@@ -137,6 +137,10 @@ class RemoteSerializer(ModelSerializer):
         help_text="aiohttp.ClientTimeout.sock_read (q.v.) for download-connections.",
         min_value=0.0,
     )
+    headers = serializers.ListField(
+        child=serializers.DictField(),
+        help_text=_("Headers for aiohttp.Clientsession"),
+    )
 
     def validate_url(self, value):
         """

pulpcore/download/factory.py

@@ -15,7 +15,14 @@
 from .http import HttpDownloader
 from .file import FileDownloader
 
-PROTOCOL_MAP = {"http": HttpDownloader, "https": HttpDownloader, "file": FileDownloader}
+import json
+
+
+PROTOCOL_MAP = {
+    "http": HttpDownloader,
+    "https": HttpDownloader,
+    "file": FileDownloader,
+}
 
 
 def user_agent():
@@ -118,6 +125,8 @@ def _make_aiohttp_session_from_remote(self):
             tcp_conn_opts["ssl_context"] = sslcontext
 
         headers = {"User-Agent": user_agent()}
+        if self._remote.headers is not None:
+            headers.update(json.loads(self._remote.headers))
 
         conn = aiohttp.TCPConnector(**tcp_conn_opts)
         total = self._remote.total_timeout

pulpcore/download/http.py

@@ -119,6 +119,7 @@ def __init__(
         proxy=None,
         proxy_auth=None,
         headers_ready_callback=None,
+        headers=None,
         **kwargs,
     ):
         """
@@ -134,6 +135,7 @@ def __init__(
                 as its argument. The callback will be called when the response headers are
                 available. The dictionary passed has the header names as the keys and header values
                 as its values. e.g. `{'Transfer-Encoding': 'chunked'}`
+            headers (dict): Headers to be submitted with the request.
             kwargs (dict): This accepts the parameters of
                 :class:`~pulpcore.plugin.download.BaseDownloader`.
         """
@@ -143,7 +145,7 @@ def __init__(
         else:
             timeout = aiohttp.ClientTimeout(total=None, sock_connect=600, sock_read=600)
             conn = aiohttp.TCPConnector({"force_close": True})
-            self.session = aiohttp.ClientSession(connector=conn, timeout=timeout)
+            self.session = aiohttp.ClientSession(connector=conn, timeout=timeout, headers=headers)
             self._close_session_on_finalize = True
         self.auth = auth
         self.proxy = proxy