Introduce CONTENT_ORIGIN setting

This also adds a check that the user specified CONTENT_ORIGIN at
startup. Pulp refuses to start if it is not set with an error message
for the user.

Required PR: pulp/pulp-smash#1227
Required PR: pulp/pulp_installer#185
Required PR: pulp/pulp_file#303

https://pulp.plan.io/issues/5629
re #5629

.travis/install.sh

@@ -92,7 +92,8 @@ spec:
     password: pulp
     admin_password: pulp
   pulp_settings:
-     content_host: $(hostname):24816
+     content_origin: http://$(hostname):24816
+    
 CRYAML
 
 # Install k3s, lightweight Kubernetes

.travis/script.sh

@@ -20,6 +20,10 @@ export FUNC_TEST_SCRIPT=$TRAVIS_BUILD_DIR/.travis/func_test_script.sh
 export DJANGO_SETTINGS_MODULE=pulpcore.app.settings
 
 if [ "$TEST" = 'docs' ]; then
+
+    export PULP_CONTENT_ORIGIN=http://$(hostname):24816
+
+
   cd docs
   make html
   cd ..

CHANGES/5629.feature

@@ -0,0 +1 @@
+Added ``CONTENT_ORIGIN`` setting, which is now required.

CHANGES/plugin_api/5629.feature

@@ -0,0 +1,2 @@
+Added the ``CONTENT_ORIGIN`` setting which can be used to reliably know the scheme+host+port to the
+pulp content app.

docs/installation/configuration.rst

@@ -209,6 +209,15 @@ CONTENT_HOST
    This defaults to ``None`` which returns relative urls.
 
 
+CONTENT_ORIGIN
+^^^^^^^^^^^^^^
+
+   A required string containing the protocol, fqdn, and port where the content app is reachable by
+   users. This is used by ``pulpcore`` and various plugins when referring users to the content app.
+   For example if the API should refer users to content at using http to pulp.example.com on port
+   24816, (the content default port), you would set: ``https://pulp.example.com:24816``.
+
+
 .. _content-path-prefix:
 
 CONTENT_PATH_PREFIX

pulpcore/app/serializers/fields.py

@@ -241,11 +241,11 @@ class BaseURLField(serializers.CharField):
 
     def to_representation(self, value):
         base_path = value
-        host = settings.CONTENT_HOST
+        origin = settings.CONTENT_ORIGIN
         prefix = settings.CONTENT_PATH_PREFIX
         return '/'.join(
             (
-                host.strip('/'),
+                origin.strip('/'),
                 prefix.strip('/'),
                 base_path.lstrip('/')
             ))

pulpcore/app/settings.py

@@ -10,9 +10,13 @@
 
 import os
 from contextlib import suppress
+from gettext import gettext as _
 from importlib import import_module
 from pkg_resources import iter_entry_points
 
+from django.core.exceptions import ImproperlyConfigured
+
+
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 BASE_DIR = os.path.dirname(os.path.abspath(__file__))
 
@@ -234,3 +238,9 @@
     ENVVAR_FOR_DYNACONF='PULP_SETTINGS',
 )
 # HERE ENDS DYNACONF EXTENSION LOAD (No more code below this line)
+
+
+try:
+    CONTENT_ORIGIN
+except NameError:
+    raise ImproperlyConfigured(_('You must specify the CONTENT_ORIGIN setting.'))

pulpcore/tests/functional/api/using_plugin/test_content_promotion.py

@@ -79,8 +79,7 @@ def test_all(self):
         unit_urls = []
         unit_path = get_added_content(repo)[FILE_CONTENT_NAME][0]['relative_path']
         for distribution in distributions:
-            unit_url = cfg.get_hosts('api')[0].roles['api']['scheme']
-            unit_url += '://' + distribution['base_url'] + '/'
+            unit_url = distribution['base_url'] + '/'
             unit_urls.append(urljoin(unit_url, unit_path))
 
         client.response_handler = api.safe_handler

pulpcore/tests/functional/api/using_plugin/test_distributions.py

@@ -305,12 +305,11 @@ def test_content_served(self):
 
         added_content = get_added_content(repo)
         unit_path = added_content[FILE_CONTENT_NAME][0]['relative_path']
-        unit_url = self.cfg.get_hosts('api')[0].roles['api']['scheme']
-        unit_url += '://' + distribution['base_url'] + '/'
+        unit_url = distribution['base_url'] + '/'
         unit_url = urljoin(unit_url, unit_path)
 
         pulp_hash = hashlib.sha256(
-            self.client.using_handler(api.safe_handler).get(unit_url).content
+            self.client.get(unit_url).content
         ).hexdigest()
         fixtures_hash = hashlib.sha256(
             utils.http_get(urljoin(FILE_URL, unit_path))
@@ -323,12 +322,10 @@ def download_pulp_manifest(self, distribution):
         unit_url = reduce(
             urljoin,
             (
-                self.cfg.get_content_host_base_url(),
-                '//' + distribution['base_url'] + '/',
-                'PULP_MANIFEST'
+                distribution['base_url'] + '/', 'PULP_MANIFEST'
             ),
         )
-        return self.client.using_handler(api.safe_handler).get(unit_url)
+        return self.client.get(unit_url)
 
 
 def parse_pulp_manifest(pulp_manifest):

template_config.yml

@@ -21,7 +21,7 @@ plugin_dash_short: pulpcore
 plugin_name: pulpcore
 plugin_snake: pulpcore
 pulp_settings:
-  content_host: $(hostname):24816
+  content_origin: http://$(hostname):24816
 pydocstyle: true
 pypi_username: pulp
 test_bindings: true