Merge pull request #10382 from AlanCoding/downstream_waterslide

Handle inventory types where Automation Hub collection names differ

Some collections will be moving, which is #10323
Yet, other collections will change name, which this is intended to address.

Reviewed-by: Alan Rominger <arominge@redhat.com>
Reviewed-by: Sarabraj Singh <singh.sarabraj@gmail.com>
Reviewed-by: Elijah DeLee <kdelee@redhat.com>

awx/main/models/inventory.py

@@ -51,6 +51,7 @@ from awx.main.models.credential.injectors import _openstack_data
 from awx.main.utils import _inventory_updates
 from awx.main.utils.safe_yaml import sanitize_jinja
 from awx.main.utils.execution_environments import to_container_path
+from awx.main.utils.licensing import server_product_name
 
 
 __all__ = ['Inventory', 'Host', 'Group', 'InventorySource', 'InventoryUpdate', 'SmartInventoryMembership']
@@ -1336,6 +1337,7 @@ class PluginFileInjector(object):
     namespace = None
     collection = None
     collection_migration = '2.9'  # Starting with this version, we use collections
+    use_fqcn = False  # plugin: name versus plugin: namespace.collection.name
 
     # TODO: delete this method and update unit tests
     @classmethod
@@ -1362,7 +1364,12 @@ class PluginFileInjector(object):
         Note that a plugin value of '' should still be overridden.
         '''
         if self.plugin_name is not None:
-            source_vars['plugin'] = self.plugin_name
+            if hasattr(self, 'downstream_namespace') and server_product_name() != 'AWX':
+                source_vars['plugin'] = f'{self.downstream_namespace}.{self.downstream_collection}.{self.plugin_name}'
+            elif self.use_fqcn:
+                source_vars['plugin'] = f'{self.namespace}.{self.collection}.{self.plugin_name}'
+            else:
+                source_vars['plugin'] = self.plugin_name
         return source_vars
 
     def build_env(self, inventory_update, env, private_data_dir, private_data_files):
@@ -1510,12 +1517,17 @@ class rhv(PluginFileInjector):
     initial_version = '2.9'
     namespace = 'ovirt'
     collection = 'ovirt'
+    downstream_namespace = 'redhat'
+    downstream_collection = 'rhv'
 
 
 class satellite6(PluginFileInjector):
     plugin_name = 'foreman'
     namespace = 'theforeman'
     collection = 'foreman'
+    downstream_namespace = 'redhat'
+    downstream_collection = 'satellite'
+    use_fqcn = True
 
     def get_plugin_env(self, inventory_update, private_data_dir, private_data_files):
         # this assumes that this is merged
@@ -1528,18 +1540,14 @@ class satellite6(PluginFileInjector):
             ret['FOREMAN_PASSWORD'] = credential.get_input('password', default='')
         return ret
 
-    def inventory_as_dict(self, inventory_update, private_data_dir):
-        ret = super(satellite6, self).inventory_as_dict(inventory_update, private_data_dir)
-        # this inventory plugin requires the fully qualified inventory plugin name
-        ret['plugin'] = f'{self.namespace}.{self.collection}.{self.plugin_name}'
-        return ret
-
 
 class tower(PluginFileInjector):
     plugin_name = 'tower'
     base_injector = 'template'
     namespace = 'awx'
     collection = 'awx'
+    downstream_namespace = 'ansible'
+    downstream_collection = 'controller'
 
 
 class insights(PluginFileInjector):

awx/main/utils/__init__.py

@@ -11,3 +11,4 @@ from awx.main.utils.encryption import (  # noqa
     decrypt_value,
     encrypt_dict,
 )
+from awx.main.utils.licensing import get_licenser  # noqa

awx/main/utils/common.py

@@ -51,7 +51,6 @@ __all__ = [
     'underscore_to_camelcase',
     'memoize',
     'memoize_delete',
-    'get_licenser',
     'get_awx_http_client_headers',
     'get_awx_version',
     'update_scm_url',
@@ -255,18 +254,6 @@ def get_awx_http_client_headers():
     return headers
 
 
-def get_licenser(*args, **kwargs):
-    from awx.main.utils.licensing import Licenser, OpenLicense
-
-    try:
-        if os.path.exists('/var/lib/awx/.tower_version'):
-            return Licenser(*args, **kwargs)
-        else:
-            return OpenLicense()
-    except Exception as e:
-        raise ValueError(_('Error importing License: %s') % e)
-
-
 def update_scm_url(scm_type, url, username=True, password=True, check_special_cases=True, scp_format=False):
     """
     Update the given SCM URL to add/replace/remove the username/password. When

awx/main/utils/licensing.py

@@ -15,6 +15,7 @@ from datetime import datetime, timezone
 import collections
 import copy
 import io
+import os
 import json
 import logging
 import re
@@ -34,8 +35,6 @@ from cryptography import x509
 from django.conf import settings
 from django.utils.translation import ugettext_lazy as _
 
-# AWX
-from awx.main.models import Host, HostMetric, Instance
 
 MAX_INSTANCES = 9999999
 
@@ -379,10 +378,9 @@ class Licenser(object):
             return attrs
         attrs['valid_key'] = True
 
-        if Host:
-            current_instances = Host.objects.active_count()
-        else:
-            current_instances = 0
+        from awx.main.models import Host, HostMetric, Instance
+
+        current_instances = Host.objects.active_count()
         license_date = int(attrs.get('license_date', 0) or 0)
         automated_instances = HostMetric.objects.count()
         first_host = HostMetric.objects.only('first_automation').order_by('first_automation').first()
@@ -408,3 +406,19 @@ class Licenser(object):
         attrs['date_warning'] = bool(time_remaining < self.SUBSCRIPTION_TIMEOUT)
         attrs['date_expired'] = bool(time_remaining <= 0)
         return attrs
+
+
+def get_licenser(*args, **kwargs):
+    from awx.main.utils.licensing import Licenser, OpenLicense
+
+    try:
+        if os.path.exists('/var/lib/awx/.tower_version'):
+            return Licenser(*args, **kwargs)
+        else:
+            return OpenLicense()
+    except Exception as e:
+        raise ValueError(_('Error importing License: %s') % e)
+
+
+def server_product_name():
+    return 'AWX' if isinstance(get_licenser(), OpenLicense) else 'Red Hat Ansible Automation Platform'