diff --git a/Makefile b/Makefile
index 149f9718b0..bbb213b157 100644
--- a/Makefile
+++ b/Makefile
@@ -1,6 +1,7 @@
-include awx/ui_next/Makefile
PYTHON ?= python3.9
+DOCKER_COMPOSE ?= docker-compose
OFFICIAL ?= no
NODE ?= node
NPM_BIN ?= npm
@@ -497,20 +498,20 @@ docker-compose-sources: .git/hooks/pre-commit
-e enable_grafana=$(GRAFANA) $(EXTRA_SOURCES_ANSIBLE_OPTS)
docker-compose: awx/projects docker-compose-sources
- docker-compose -f tools/docker-compose/_sources/docker-compose.yml $(COMPOSE_OPTS) up $(COMPOSE_UP_OPTS) --remove-orphans
+ $(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml $(COMPOSE_OPTS) up $(COMPOSE_UP_OPTS) --remove-orphans
docker-compose-credential-plugins: awx/projects docker-compose-sources
echo -e "\033[0;31mTo generate a CyberArk Conjur API key: docker exec -it tools_conjur_1 conjurctl account create quick-start\033[0m"
- docker-compose -f tools/docker-compose/_sources/docker-compose.yml -f tools/docker-credential-plugins-override.yml up --no-recreate awx_1 --remove-orphans
+ $(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml -f tools/docker-credential-plugins-override.yml up --no-recreate awx_1 --remove-orphans
docker-compose-test: awx/projects docker-compose-sources
- docker-compose -f tools/docker-compose/_sources/docker-compose.yml run --rm --service-ports awx_1 /bin/bash
+ $(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml run --rm --service-ports awx_1 /bin/bash
docker-compose-runtest: awx/projects docker-compose-sources
- docker-compose -f tools/docker-compose/_sources/docker-compose.yml run --rm --service-ports awx_1 /start_tests.sh
+ $(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml run --rm --service-ports awx_1 /start_tests.sh
docker-compose-build-swagger: awx/projects docker-compose-sources
- docker-compose -f tools/docker-compose/_sources/docker-compose.yml run --rm --service-ports --no-deps awx_1 /start_tests.sh swagger
+ $(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml run --rm --service-ports --no-deps awx_1 /start_tests.sh swagger
SCHEMA_DIFF_BASE_BRANCH ?= devel
detect-schema-change: genschema
@@ -519,7 +520,7 @@ detect-schema-change: genschema
diff -u -b reference-schema.json schema.json
docker-compose-clean: awx/projects
- docker-compose -f tools/docker-compose/_sources/docker-compose.yml rm -sf
+ $(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml rm -sf
docker-compose-container-group-clean:
@if [ -f "tools/docker-compose-minikube/_sources/minikube" ]; then \
@@ -547,10 +548,10 @@ docker-refresh: docker-clean docker-compose
## Docker Development Environment with Elastic Stack Connected
docker-compose-elk: awx/projects docker-compose-sources
- docker-compose -f tools/docker-compose/_sources/docker-compose.yml -f tools/elastic/docker-compose.logstash-link.yml -f tools/elastic/docker-compose.elastic-override.yml up --no-recreate
+ $(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml -f tools/elastic/docker-compose.logstash-link.yml -f tools/elastic/docker-compose.elastic-override.yml up --no-recreate
docker-compose-cluster-elk: awx/projects docker-compose-sources
- docker-compose -f tools/docker-compose/_sources/docker-compose.yml -f tools/elastic/docker-compose.logstash-link-cluster.yml -f tools/elastic/docker-compose.elastic-override.yml up --no-recreate
+ $(DOCKER_COMPOSE) -f tools/docker-compose/_sources/docker-compose.yml -f tools/elastic/docker-compose.logstash-link-cluster.yml -f tools/elastic/docker-compose.elastic-override.yml up --no-recreate
docker-compose-container-group:
MINIKUBE_CONTAINER_GROUP=true make docker-compose
diff --git a/awx/api/conf.py b/awx/api/conf.py
index b9c2ee701a..0697f40c56 100644
--- a/awx/api/conf.py
+++ b/awx/api/conf.py
@@ -1,5 +1,4 @@
# Django
-from django.conf import settings
from django.utils.translation import gettext_lazy as _
# Django REST Framework
@@ -9,6 +8,7 @@ from rest_framework import serializers
from awx.conf import fields, register, register_validate
from awx.api.fields import OAuth2ProviderField
from oauth2_provider.settings import oauth2_settings
+from awx.sso.common import is_remote_auth_enabled
register(
@@ -108,19 +108,8 @@ register(
def authentication_validate(serializer, attrs):
- remote_auth_settings = [
- 'AUTH_LDAP_SERVER_URI',
- 'SOCIAL_AUTH_GOOGLE_OAUTH2_KEY',
- 'SOCIAL_AUTH_GITHUB_KEY',
- 'SOCIAL_AUTH_GITHUB_ORG_KEY',
- 'SOCIAL_AUTH_GITHUB_TEAM_KEY',
- 'SOCIAL_AUTH_SAML_ENABLED_IDPS',
- 'RADIUS_SERVER',
- 'TACACSPLUS_HOST',
- ]
- if attrs.get('DISABLE_LOCAL_AUTH', False):
- if not any(getattr(settings, s, None) for s in remote_auth_settings):
- raise serializers.ValidationError(_("There are no remote authentication systems configured."))
+ if attrs.get('DISABLE_LOCAL_AUTH', False) and not is_remote_auth_enabled():
+ raise serializers.ValidationError(_("There are no remote authentication systems configured."))
return attrs
diff --git a/awx/api/filters.py b/awx/api/filters.py
index a40006d670..1a6e3eb90e 100644
--- a/awx/api/filters.py
+++ b/awx/api/filters.py
@@ -155,7 +155,7 @@ class FieldLookupBackend(BaseFilterBackend):
'search',
)
- # A list of fields that we know can be filtered on without the possiblity
+ # A list of fields that we know can be filtered on without the possibility
# of introducing duplicates
NO_DUPLICATES_ALLOW_LIST = (CharField, IntegerField, BooleanField, TextField)
@@ -268,7 +268,7 @@ class FieldLookupBackend(BaseFilterBackend):
continue
# HACK: make `created` available via API for the Django User ORM model
- # so it keep compatiblity with other objects which exposes the `created` attr.
+ # so it keep compatibility with other objects which exposes the `created` attr.
if queryset.model._meta.object_name == 'User' and key.startswith('created'):
key = key.replace('created', 'date_joined')
diff --git a/awx/api/generics.py b/awx/api/generics.py
index 361506c605..c86639ab95 100644
--- a/awx/api/generics.py
+++ b/awx/api/generics.py
@@ -674,7 +674,7 @@ class SubListCreateAttachDetachAPIView(SubListCreateAPIView):
location = None
created = True
- # Retrive the sub object (whether created or by ID).
+ # Retrieve the sub object (whether created or by ID).
sub = get_object_or_400(self.model, pk=sub_id)
# Verify we have permission to attach.
diff --git a/awx/api/renderers.py b/awx/api/renderers.py
index 613d2c9fda..b6078c189c 100644
--- a/awx/api/renderers.py
+++ b/awx/api/renderers.py
@@ -60,7 +60,7 @@ class BrowsableAPIRenderer(renderers.BrowsableAPIRenderer):
delattr(renderer_context['view'], '_request')
def get_raw_data_form(self, data, view, method, request):
- # Set a flag on the view to indiciate to the view/serializer that we're
+ # Set a flag on the view to indicate to the view/serializer that we're
# creating a raw data form for the browsable API. Store the original
# request method to determine how to populate the raw data form.
if request.method in {'OPTIONS', 'DELETE'}:
diff --git a/awx/api/serializers.py b/awx/api/serializers.py
index be87a50a82..6e23f3298f 100644
--- a/awx/api/serializers.py
+++ b/awx/api/serializers.py
@@ -108,7 +108,6 @@ from awx.main.utils import (
extract_ansible_vars,
encrypt_dict,
prefetch_page_capabilities,
- get_external_account,
truncate_stdout,
)
from awx.main.utils.filters import SmartFilter
@@ -124,6 +123,8 @@ from awx.api.fields import BooleanNullField, CharNullField, ChoiceNullField, Ver
# AWX Utils
from awx.api.validators import HostnameRegexValidator
+from awx.sso.common import get_external_account
+
logger = logging.getLogger('awx.api.serializers')
# Fields that should be summarized regardless of object type.
@@ -536,7 +537,7 @@ class BaseSerializer(serializers.ModelSerializer, metaclass=BaseSerializerMetacl
#
# This logic is to force rendering choice's on an uneditable field.
# Note: Consider expanding this rendering for more than just choices fields
- # Note: This logic works in conjuction with
+ # Note: This logic works in conjunction with
if hasattr(model_field, 'choices') and model_field.choices:
was_editable = model_field.editable
model_field.editable = True
@@ -987,23 +988,8 @@ class UserSerializer(BaseSerializer):
def _update_password(self, obj, new_password):
# For now we're not raising an error, just not saving password for
# users managed by LDAP who already have an unusable password set.
- if getattr(settings, 'AUTH_LDAP_SERVER_URI', None):
- try:
- if obj.pk and obj.profile.ldap_dn and not obj.has_usable_password():
- new_password = None
- except AttributeError:
- pass
- if (
- getattr(settings, 'SOCIAL_AUTH_GOOGLE_OAUTH2_KEY', None)
- or getattr(settings, 'SOCIAL_AUTH_GITHUB_KEY', None)
- or getattr(settings, 'SOCIAL_AUTH_GITHUB_ORG_KEY', None)
- or getattr(settings, 'SOCIAL_AUTH_GITHUB_TEAM_KEY', None)
- or getattr(settings, 'SOCIAL_AUTH_SAML_ENABLED_IDPS', None)
- ) and obj.social_auth.all():
- new_password = None
- if (getattr(settings, 'RADIUS_SERVER', None) or getattr(settings, 'TACACSPLUS_HOST', None)) and obj.enterprise_auth.all():
- new_password = None
- if new_password:
+ # Get external password will return something like ldap or enterprise or None if the user isn't external. We only want to allow a password update for a None option
+ if new_password and not self.get_external_account(obj):
obj.set_password(new_password)
obj.save(update_fields=['password'])
@@ -3997,7 +3983,7 @@ class JobEventSerializer(BaseSerializer):
# Show full stdout for playbook_on_* events.
if obj and obj.event.startswith('playbook_on'):
return data
- # If the view logic says to not trunctate (request was to the detail view or a param was used)
+ # If the view logic says to not truncate (request was to the detail view or a param was used)
if self.context.get('no_truncate', False):
return data
max_bytes = settings.EVENT_STDOUT_MAX_BYTES_DISPLAY
@@ -4028,7 +4014,7 @@ class ProjectUpdateEventSerializer(JobEventSerializer):
# raw SCM URLs in their stdout (which *could* contain passwords)
# attempt to detect and filter HTTP basic auth passwords in the stdout
# of these types of events
- if obj.event_data.get('task_action') in ('git', 'svn'):
+ if obj.event_data.get('task_action') in ('git', 'svn', 'ansible.builtin.git', 'ansible.builtin.svn'):
try:
return json.loads(UriCleaner.remove_sensitive(json.dumps(obj.event_data)))
except Exception:
@@ -4072,7 +4058,7 @@ class AdHocCommandEventSerializer(BaseSerializer):
def to_representation(self, obj):
data = super(AdHocCommandEventSerializer, self).to_representation(obj)
- # If the view logic says to not trunctate (request was to the detail view or a param was used)
+ # If the view logic says to not truncate (request was to the detail view or a param was used)
if self.context.get('no_truncate', False):
return data
max_bytes = settings.EVENT_STDOUT_MAX_BYTES_DISPLAY
@@ -4765,7 +4751,7 @@ class ScheduleSerializer(LaunchConfigurationBaseSerializer, SchedulePreviewSeria
),
)
until = serializers.SerializerMethodField(
- help_text=_('The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an emptry string will be returned'),
+ help_text=_('The date this schedule will end. This field is computed from the RRULE. If the schedule does not end an empty string will be returned'),
)
class Meta:
diff --git a/awx/api/templates/api/dashboard_inventory_graph_view.md b/awx/api/templates/api/dashboard_inventory_graph_view.md
index 7353bf5006..aff5c06325 100644
--- a/awx/api/templates/api/dashboard_inventory_graph_view.md
+++ b/awx/api/templates/api/dashboard_inventory_graph_view.md
@@ -3,7 +3,7 @@ Make a GET request to this resource to retrieve aggregate statistics about inven
Including fetching the number of total hosts tracked by Tower over an amount of time and the current success or
failed status of hosts which have run jobs within an Inventory.
-## Parmeters and Filtering
+## Parameters and Filtering
The `period` of the data can be adjusted with:
@@ -24,7 +24,7 @@ Data about the number of hosts will be returned in the following format:
Each element contains an epoch timestamp represented in seconds and a numerical value indicating
the number of hosts that exist at a given moment
-Data about failed and successfull hosts by inventory will be given as:
+Data about failed and successful hosts by inventory will be given as:
{
"sources": [
diff --git a/awx/api/templates/api/dashboard_jobs_graph_view.md b/awx/api/templates/api/dashboard_jobs_graph_view.md
index baadd4d561..05437c17e1 100644
--- a/awx/api/templates/api/dashboard_jobs_graph_view.md
+++ b/awx/api/templates/api/dashboard_jobs_graph_view.md
@@ -2,7 +2,7 @@
Make a GET request to this resource to retrieve aggregate statistics about job runs suitable for graphing.
-## Parmeters and Filtering
+## Parameters and Filtering
The `period` of the data can be adjusted with:
diff --git a/awx/api/templates/api/inventory_inventory_sources_update.md b/awx/api/templates/api/inventory_inventory_sources_update.md
index edf17a27ce..3ca3e0f328 100644
--- a/awx/api/templates/api/inventory_inventory_sources_update.md
+++ b/awx/api/templates/api/inventory_inventory_sources_update.md
@@ -18,7 +18,7 @@ inventory sources:
* `inventory_update`: ID of the inventory update job that was started.
(integer, read-only)
* `project_update`: ID of the project update job that was started if this inventory source is an SCM source.
- (interger, read-only, optional)
+ (integer, read-only, optional)
Note: All manual inventory sources (source="") will be ignored by the update_inventory_sources endpoint. This endpoint will not update inventory sources for Smart Inventories.
diff --git a/awx/api/views/__init__.py b/awx/api/views/__init__.py
index 609e88e155..4d5f98d2c2 100644
--- a/awx/api/views/__init__.py
+++ b/awx/api/views/__init__.py
@@ -152,7 +152,7 @@ def api_exception_handler(exc, context):
if 'awx.named_url_rewritten' in req.environ and not str(getattr(exc, 'status_code', 0)).startswith('2'):
# if the URL was rewritten, and it's not a 2xx level status code,
# revert the request.path to its original value to avoid leaking
- # any context about the existance of resources
+ # any context about the existence of resources
req.path = req.environ['awx.named_url_rewritten']
if exc.status_code == 403:
exc = NotFound(detail=_('Not found.'))
@@ -172,7 +172,7 @@ class DashboardView(APIView):
user_inventory = get_user_queryset(request.user, models.Inventory)
inventory_with_failed_hosts = user_inventory.filter(hosts_with_active_failures__gt=0)
user_inventory_external = user_inventory.filter(has_inventory_sources=True)
- # if there are *zero* inventories, this aggregrate query will be None, fall back to 0
+ # if there are *zero* inventories, this aggregate query will be None, fall back to 0
failed_inventory = user_inventory.aggregate(Sum('inventory_sources_with_failures'))['inventory_sources_with_failures__sum'] or 0
data['inventories'] = {
'url': reverse('api:inventory_list', request=request),
@@ -1667,7 +1667,7 @@ class GroupList(ListCreateAPIView):
class EnforceParentRelationshipMixin(object):
"""
- Useful when you have a self-refering ManyToManyRelationship.
+ Useful when you have a self-referring ManyToManyRelationship.
* Tower uses a shallow (2-deep only) url pattern. For example:
When an object hangs off of a parent object you would have the url of the
@@ -2415,7 +2415,7 @@ class JobTemplateSurveySpec(GenericAPIView):
status=status.HTTP_400_BAD_REQUEST,
)
# if it's a multiselect or multiple choice, it must have coices listed
- # choices and defualts must come in as strings seperated by /n characters.
+ # choices and defaults must come in as strings separated by /n characters.
if qtype == 'multiselect' or qtype == 'multiplechoice':
if 'choices' in survey_item:
if isinstance(survey_item['choices'], str):
@@ -3430,7 +3430,7 @@ class JobCreateSchedule(RetrieveAPIView):
config = obj.launch_config
- # Make up a name for the schedule, guarentee that it is unique
+ # Make up a name for the schedule, guarantee that it is unique
name = 'Auto-generated schedule from job {}'.format(obj.id)
existing_names = models.Schedule.objects.filter(name__startswith=name).values_list('name', flat=True)
if name in existing_names:
@@ -3621,7 +3621,7 @@ class JobJobEventsChildrenSummary(APIView):
# key is counter of meta events (i.e. verbose), value is uuid of the assigned parent
map_meta_counter_nested_uuid = {}
- # collapsable tree view in the UI only makes sense for tree-like
+ # collapsible tree view in the UI only makes sense for tree-like
# hierarchy. If ansible is ran with a strategy like free or host_pinned, then
# events can be out of sequential order, and no longer follow a tree structure
# E1
diff --git a/awx/conf/fields.py b/awx/conf/fields.py
index 0073e473fd..fee4573745 100644
--- a/awx/conf/fields.py
+++ b/awx/conf/fields.py
@@ -21,7 +21,7 @@ logger = logging.getLogger('awx.conf.fields')
# Use DRF fields to convert/validate settings:
# - to_representation(obj) should convert a native Python object to a primitive
# serializable type. This primitive type will be what is presented in the API
-# and stored in the JSON field in the datbase.
+# and stored in the JSON field in the database.
# - to_internal_value(data) should convert the primitive type back into the
# appropriate Python type to be used in settings.
diff --git a/awx/conf/views.py b/awx/conf/views.py
index f7190737fa..5231cd86bd 100644
--- a/awx/conf/views.py
+++ b/awx/conf/views.py
@@ -180,7 +180,7 @@ class SettingLoggingTest(GenericAPIView):
if not port:
return Response({'error': 'Port required for ' + protocol}, status=status.HTTP_400_BAD_REQUEST)
else:
- # if http/https by this point, domain is reacheable
+ # if http/https by this point, domain is reachable
return Response(status=status.HTTP_202_ACCEPTED)
if protocol == 'udp':
diff --git a/awx/locale/en-us/LC_MESSAGES/django.po b/awx/locale/en-us/LC_MESSAGES/django.po
index 97dd6807a8..8dc82f230a 100644
--- a/awx/locale/en-us/LC_MESSAGES/django.po
+++ b/awx/locale/en-us/LC_MESSAGES/django.po
@@ -1972,7 +1972,7 @@ msgid ""
"HTTP headers and meta keys to search to determine remote host name or IP. "
"Add additional items to this list, such as \"HTTP_X_FORWARDED_FOR\", if "
"behind a reverse proxy. See the \"Proxy Support\" section of the "
-"Adminstrator guide for more details."
+"Administrator guide for more details."
msgstr ""
#: awx/main/conf.py:85
@@ -2457,7 +2457,7 @@ msgid ""
msgstr ""
#: awx/main/conf.py:631
-msgid "Maximum disk persistance for external log aggregation (in GB)"
+msgid "Maximum disk persistence for external log aggregation (in GB)"
msgstr ""
#: awx/main/conf.py:633
@@ -2548,7 +2548,7 @@ msgid "Enable"
msgstr ""
#: awx/main/constants.py:27
-msgid "Doas"
+msgid "Does"
msgstr ""
#: awx/main/constants.py:28
@@ -4801,7 +4801,7 @@ msgstr ""
#: awx/main/models/workflow.py:251
msgid ""
-"An identifier coresponding to the workflow job template node that this node "
+"An identifier corresponding to the workflow job template node that this node "
"was created from."
msgstr ""
@@ -5521,7 +5521,7 @@ msgstr ""
#: awx/sso/conf.py:606
msgid ""
"Extra arguments for Google OAuth2 login. You can restrict it to only allow a "
-"single domain to authenticate, even if the user is logged in with multple "
+"single domain to authenticate, even if the user is logged in with multiple "
"Google accounts. Refer to the documentation for more detail."
msgstr ""
@@ -5905,7 +5905,7 @@ msgstr ""
#: awx/sso/conf.py:1290
msgid ""
-"Create a keypair to use as a service provider (SP) and include the "
+"Create a key pair to use as a service provider (SP) and include the "
"certificate content here."
msgstr ""
@@ -5915,7 +5915,7 @@ msgstr ""
#: awx/sso/conf.py:1302
msgid ""
-"Create a keypair to use as a service provider (SP) and include the private "
+"Create a key pair to use as a service provider (SP) and include the private "
"key content here."
msgstr ""
diff --git a/awx/locale/es/LC_MESSAGES/django.po b/awx/locale/es/LC_MESSAGES/django.po
index ec51ee8347..cd47f1e581 100644
--- a/awx/locale/es/LC_MESSAGES/django.po
+++ b/awx/locale/es/LC_MESSAGES/django.po
@@ -1971,7 +1971,7 @@ msgid ""
"HTTP headers and meta keys to search to determine remote host name or IP. "
"Add additional items to this list, such as \"HTTP_X_FORWARDED_FOR\", if "
"behind a reverse proxy. See the \"Proxy Support\" section of the "
-"Adminstrator guide for more details."
+"Administrator guide for more details."
msgstr "Los encabezados HTTP y las llaves de activación para buscar y determinar el nombre de host remoto o IP. Añada elementos adicionales a esta lista, como \"HTTP_X_FORWARDED_FOR\", si está detrás de un proxy inverso. Consulte la sección \"Soporte de proxy\" de la guía del adminstrador para obtener más información."
#: awx/main/conf.py:85
@@ -4804,7 +4804,7 @@ msgstr "Indica que un trabajo no se creará cuando es sea True. La semántica de
#: awx/main/models/workflow.py:251
msgid ""
-"An identifier coresponding to the workflow job template node that this node "
+"An identifier corresponding to the workflow job template node that this node "
"was created from."
msgstr "Un identificador que corresponde al nodo de plantilla de tarea del flujo de trabajo a partir del cual se creó este nodo."
@@ -5526,7 +5526,7 @@ msgstr "Argumentos adicionales para Google OAuth2"
#: awx/sso/conf.py:606
msgid ""
"Extra arguments for Google OAuth2 login. You can restrict it to only allow a "
-"single domain to authenticate, even if the user is logged in with multple "
+"single domain to authenticate, even if the user is logged in with multiple "
"Google accounts. Refer to the documentation for more detail."
msgstr "Argumentos adicionales para el inicio de sesión en Google OAuth2. Puede limitarlo para permitir la autenticación de un solo dominio, incluso si el usuario ha iniciado sesión con varias cuentas de Google. Consulte la documentación para obtener información detallada."
@@ -5910,7 +5910,7 @@ msgstr "Certificado público del proveedor de servicio SAML"
#: awx/sso/conf.py:1290
msgid ""
-"Create a keypair to use as a service provider (SP) and include the "
+"Create a key pair to use as a service provider (SP) and include the "
"certificate content here."
msgstr "Crear un par de claves para usar como proveedor de servicio (SP) e incluir el contenido del certificado aquí."
@@ -5920,7 +5920,7 @@ msgstr "Clave privada del proveedor de servicio SAML"
#: awx/sso/conf.py:1302
msgid ""
-"Create a keypair to use as a service provider (SP) and include the private "
+"Create a key pair to use as a service provider (SP) and include the private "
"key content here."
msgstr "Crear un par de claves para usar como proveedor de servicio (SP) e incluir el contenido de la clave privada aquí."
diff --git a/awx/main/conf.py b/awx/main/conf.py
index dab0543a1a..2dbf5e127e 100644
--- a/awx/main/conf.py
+++ b/awx/main/conf.py
@@ -282,6 +282,16 @@ register(
placeholder={'HTTP_PROXY': 'myproxy.local:8080'},
)
+register(
+ 'AWX_RUNNER_KEEPALIVE_SECONDS',
+ field_class=fields.IntegerField,
+ label=_('K8S Ansible Runner Keep-Alive Message Interval'),
+ help_text=_('Only applies to jobs running in a Container Group. If not 0, send a message every so-many seconds to keep connection open.'),
+ category=_('Jobs'),
+ category_slug='jobs',
+ placeholder=240, # intended to be under common 5 minute idle timeout
+)
+
register(
'GALAXY_TASK_ENV',
field_class=fields.KeyValueField,
diff --git a/awx/main/credential_plugins/aim.py b/awx/main/credential_plugins/aim.py
index 96487dcced..e72fe285f4 100644
--- a/awx/main/credential_plugins/aim.py
+++ b/awx/main/credential_plugins/aim.py
@@ -70,7 +70,7 @@ def aim_backend(**kwargs):
client_cert = kwargs.get('client_cert', None)
client_key = kwargs.get('client_key', None)
verify = kwargs['verify']
- webservice_id = kwargs['webservice_id']
+ webservice_id = kwargs.get('webservice_id', '')
app_id = kwargs['app_id']
object_query = kwargs['object_query']
object_query_format = kwargs['object_query_format']
diff --git a/awx/main/management/commands/disable_instance.py b/awx/main/management/commands/disable_instance.py
new file mode 100644
index 0000000000..054e47974b
--- /dev/null
+++ b/awx/main/management/commands/disable_instance.py
@@ -0,0 +1,143 @@
+import time
+from urllib.parse import urljoin
+
+from argparse import ArgumentTypeError
+
+from django.conf import settings
+from django.core.management.base import BaseCommand, CommandError
+from django.db.models import Q
+from django.utils.timezone import now
+
+from awx.main.models import Instance, UnifiedJob
+
+
+class AWXInstance:
+ def __init__(self, **filter):
+ self.filter = filter
+ self.get_instance()
+
+ def get_instance(self):
+ filter = self.filter if self.filter is not None else dict(hostname=settings.CLUSTER_HOST_ID)
+ qs = Instance.objects.filter(**filter)
+ if not qs.exists():
+ raise ValueError(f"No AWX instance found with {filter} parameters")
+ self.instance = qs.first()
+
+ def disable(self):
+ if self.instance.enabled:
+ self.instance.enabled = False
+ self.instance.save()
+ return True
+
+ def enable(self):
+ if not self.instance.enabled:
+ self.instance.enabled = True
+ self.instance.save()
+ return True
+
+ def jobs(self):
+ return UnifiedJob.objects.filter(
+ Q(controller_node=self.instance.hostname) | Q(execution_node=self.instance.hostname), status__in=("running", "waiting")
+ )
+
+ def jobs_pretty(self):
+ jobs = []
+ for j in self.jobs():
+ job_started = j.started if j.started else now()
+ # similar calculation of `elapsed` as the corresponding serializer
+ # does
+ td = now() - job_started
+ elapsed = (td.microseconds + (td.seconds + td.days * 24 * 3600) * 10**6) / (10**6 * 1.0)
+ elapsed = float(elapsed)
+ details = dict(
+ name=j.name,
+ url=j.get_ui_url(),
+ elapsed=elapsed,
+ )
+ jobs.append(details)
+
+ jobs = sorted(jobs, reverse=True, key=lambda j: j["elapsed"])
+
+ return ", ".join([f"[\"{j['name']}\"]({j['url']})" for j in jobs])
+
+ def instance_pretty(self):
+ instance = (
+ self.instance.hostname,
+ urljoin(settings.TOWER_URL_BASE, f"/#/instances/{self.instance.pk}/details"),
+ )
+ return f"[\"{instance[0]}\"]({instance[1]})"
+
+
+class Command(BaseCommand):
+ help = "Disable instance, optionally waiting for all its managed jobs to finish."
+
+ @staticmethod
+ def ge_1(arg):
+ if arg == "inf":
+ return float("inf")
+
+ int_arg = int(arg)
+ if int_arg < 1:
+ raise ArgumentTypeError(f"The value must be a positive number >= 1. Provided: \"{arg}\"")
+ return int_arg
+
+ def add_arguments(self, parser):
+ filter_group = parser.add_mutually_exclusive_group()
+
+ filter_group.add_argument(
+ "--hostname",
+ type=str,
+ default=settings.CLUSTER_HOST_ID,
+ help=f"{Instance.hostname.field.help_text} Defaults to the hostname of the machine where the Python interpreter is currently executing".strip(),
+ )
+ filter_group.add_argument("--id", type=self.ge_1, help=Instance.id.field.help_text)
+
+ parser.add_argument(
+ "--wait",
+ action="store_true",
+ help="Wait for jobs managed by the instance to finish. With default retry arguments waits ~1h",
+ )
+
+ parser.add_argument(
+ "--retry",
+ type=self.ge_1,
+ default=120,
+ help="Number of retries when waiting for jobs to finish. Default: 120. Also accepts \"inf\" to wait indefinitely",
+ )
+
+ parser.add_argument(
+ "--retry_sleep",
+ type=self.ge_1,
+ default=30,
+ help="Number of seconds to sleep before consequtive retries when waiting. Default: 30",
+ )
+
+ def handle(self, *args, **options):
+ try:
+ filter = dict(id=options["id"]) if options["id"] is not None else dict(hostname=options["hostname"])
+ instance = AWXInstance(**filter)
+ except ValueError as e:
+ raise CommandError(e)
+
+ if instance.disable():
+ self.stdout.write(self.style.SUCCESS(f"Instance {instance.instance_pretty()} has been disabled"))
+ else:
+ self.stdout.write(f"Instance {instance.instance_pretty()} has already been disabled")
+
+ if not options["wait"]:
+ return
+
+ rc = 1
+ while instance.jobs().count() > 0:
+ if rc < options["retry"]:
+ self.stdout.write(
+ f"{rc}/{options['retry']}: Waiting {options['retry_sleep']}s before the next attempt to see if the following instance' managed jobs have finished: {instance.jobs_pretty()}"
+ )
+ rc += 1
+ time.sleep(options["retry_sleep"])
+ else:
+ raise CommandError(
+ f"{rc}/{options['retry']}: No more retry attempts left, but the instance still has associated managed jobs: {instance.jobs_pretty()}"
+ )
+ else:
+ self.stdout.write(self.style.SUCCESS("Done waiting for instance' managed jobs to finish!"))
diff --git a/awx/main/models/oauth.py b/awx/main/models/oauth.py
index c9927f78bd..fbd7772119 100644
--- a/awx/main/models/oauth.py
+++ b/awx/main/models/oauth.py
@@ -14,7 +14,7 @@ from oauth2_provider.models import AbstractApplication, AbstractAccessToken
from oauth2_provider.generators import generate_client_secret
from oauthlib import oauth2
-from awx.main.utils import get_external_account
+from awx.sso.common import get_external_account
from awx.main.fields import OAuth2ClientSecretField
diff --git a/awx/main/routing.py b/awx/main/routing.py
index c96505b7e1..100347f64e 100644
--- a/awx/main/routing.py
+++ b/awx/main/routing.py
@@ -27,8 +27,8 @@ class AWXProtocolTypeRouter(ProtocolTypeRouter):
websocket_urlpatterns = [
- re_path(r'websocket/', consumers.EventConsumer.as_asgi()),
- re_path(r'websocket/broadcast/', consumers.BroadcastConsumer.as_asgi()),
+ re_path(r'websocket/$', consumers.EventConsumer.as_asgi()),
+ re_path(r'websocket/broadcast/$', consumers.BroadcastConsumer.as_asgi()),
]
application = AWXProtocolTypeRouter(
diff --git a/awx/main/tasks/callback.py b/awx/main/tasks/callback.py
index 92bfc40368..719488caa4 100644
--- a/awx/main/tasks/callback.py
+++ b/awx/main/tasks/callback.py
@@ -85,6 +85,8 @@ class RunnerCallback:
# which generate job events from two 'streams':
# ansible-inventory and the awx.main.commands.inventory_import
# logger
+ if event_data.get('event') == 'keepalive':
+ return
if event_data.get(self.event_data_key, None):
if self.event_data_key != 'job_id':
@@ -116,7 +118,7 @@ class RunnerCallback:
# so it *should* have a negligible performance impact
task = event_data.get('event_data', {}).get('task_action')
try:
- if task in ('git', 'svn'):
+ if task in ('git', 'svn', 'ansible.builtin.git', 'ansible.builtin.svn'):
event_data_json = json.dumps(event_data)
event_data_json = UriCleaner.remove_sensitive(event_data_json)
event_data = json.loads(event_data_json)
@@ -219,7 +221,7 @@ class RunnerCallbackForProjectUpdate(RunnerCallback):
def event_handler(self, event_data):
super_return_value = super(RunnerCallbackForProjectUpdate, self).event_handler(event_data)
returned_data = event_data.get('event_data', {})
- if returned_data.get('task_action', '') == 'set_fact':
+ if returned_data.get('task_action', '') in ('set_fact', 'ansible.builtin.set_fact'):
returned_facts = returned_data.get('res', {}).get('ansible_facts', {})
if 'scm_version' in returned_facts:
self.playbook_new_revision = returned_facts['scm_version']
diff --git a/awx/main/tasks/receptor.py b/awx/main/tasks/receptor.py
index 006c805943..9cb4d49efe 100644
--- a/awx/main/tasks/receptor.py
+++ b/awx/main/tasks/receptor.py
@@ -526,6 +526,10 @@ class AWXReceptorJob:
pod_spec['spec']['containers'][0]['image'] = ee.image
pod_spec['spec']['containers'][0]['args'] = ['ansible-runner', 'worker', '--private-data-dir=/runner']
+ if settings.AWX_RUNNER_KEEPALIVE_SECONDS:
+ pod_spec['spec']['containers'][0].setdefault('env', [])
+ pod_spec['spec']['containers'][0]['env'].append({'name': 'ANSIBLE_RUNNER_KEEPALIVE_SECONDS', 'value': str(settings.AWX_RUNNER_KEEPALIVE_SECONDS)})
+
# Enforce EE Pull Policy
pull_options = {"always": "Always", "missing": "IfNotPresent", "never": "Never"}
if self.task and self.task.instance.execution_environment:
diff --git a/awx/main/utils/common.py b/awx/main/utils/common.py
index dedd02f995..26920535dc 100644
--- a/awx/main/utils/common.py
+++ b/awx/main/utils/common.py
@@ -80,7 +80,6 @@ __all__ = [
'set_environ',
'IllegalArgumentError',
'get_custom_venv_choices',
- 'get_external_account',
'ScheduleTaskManager',
'ScheduleDependencyManager',
'ScheduleWorkflowManager',
@@ -1089,29 +1088,6 @@ def has_model_field_prefetched(model_obj, field_name):
return getattr(getattr(model_obj, field_name, None), 'prefetch_cache_name', '') in getattr(model_obj, '_prefetched_objects_cache', {})
-def get_external_account(user):
- from django.conf import settings
-
- account_type = None
- if getattr(settings, 'AUTH_LDAP_SERVER_URI', None):
- try:
- if user.pk and user.profile.ldap_dn and not user.has_usable_password():
- account_type = "ldap"
- except AttributeError:
- pass
- if (
- getattr(settings, 'SOCIAL_AUTH_GOOGLE_OAUTH2_KEY', None)
- or getattr(settings, 'SOCIAL_AUTH_GITHUB_KEY', None)
- or getattr(settings, 'SOCIAL_AUTH_GITHUB_ORG_KEY', None)
- or getattr(settings, 'SOCIAL_AUTH_GITHUB_TEAM_KEY', None)
- or getattr(settings, 'SOCIAL_AUTH_SAML_ENABLED_IDPS', None)
- ) and user.social_auth.all():
- account_type = "social"
- if (getattr(settings, 'RADIUS_SERVER', None) or getattr(settings, 'TACACSPLUS_HOST', None)) and user.enterprise_auth.all():
- account_type = "enterprise"
- return account_type
-
-
class classproperty:
def __init__(self, fget=None, fset=None, fdel=None, doc=None):
self.fget = fget
diff --git a/awx/playbooks/project_update.yml b/awx/playbooks/project_update.yml
index 2067e76043..125b5ef312 100644
--- a/awx/playbooks/project_update.yml
+++ b/awx/playbooks/project_update.yml
@@ -25,42 +25,47 @@
connection: local
name: Update source tree if necessary
tasks:
-
- - name: delete project directory before update
- command: "find -delete" # volume mounted, cannot delete folder itself
+ - name: Delete project directory before update
+ ansible.builtin.shell: set -o pipefail && find . -delete -print | tail -2 # volume mounted, cannot delete folder itself
+ register: reg
+ changed_when: reg.stdout_lines | length > 1
args:
chdir: "{{ project_path }}"
tags:
- delete
- - block:
- - name: update project using git
- git:
- dest: "{{project_path|quote}}"
- repo: "{{scm_url}}"
- version: "{{scm_branch|quote}}"
- refspec: "{{scm_refspec|default(omit)}}"
- force: "{{scm_clean}}"
- track_submodules: "{{scm_track_submodules|default(omit)}}"
- accept_hostkey: "{{scm_accept_hostkey|default(omit)}}"
+ - name: Update project using git
+ tags:
+ - update_git
+ block:
+ - name: Update project using git
+ ansible.builtin.git:
+ dest: "{{ project_path | quote }}"
+ repo: "{{ scm_url }}"
+ version: "{{ scm_branch | quote }}"
+ refspec: "{{ scm_refspec | default(omit) }}"
+ force: "{{ scm_clean }}"
+ track_submodules: "{{ scm_track_submodules | default(omit) }}"
+ accept_hostkey: "{{ scm_accept_hostkey | default(omit) }}"
register: git_result
- name: Set the git repository version
- set_fact:
+ ansible.builtin.set_fact:
scm_version: "{{ git_result['after'] }}"
when: "'after' in git_result"
- tags:
- - update_git
- - block:
- - name: update project using svn
- subversion:
- dest: "{{project_path|quote}}"
- repo: "{{scm_url|quote}}"
- revision: "{{scm_branch|quote}}"
- force: "{{scm_clean}}"
- username: "{{scm_username|default(omit)}}"
- password: "{{scm_password|default(omit)}}"
+ - name: Update project using svn
+ tags:
+ - update_svn
+ block:
+ - name: Update project using svn
+ ansible.builtin.subversion:
+ dest: "{{ project_path | quote }}"
+ repo: "{{ scm_url | quote }}"
+ revision: "{{ scm_branch | quote }}"
+ force: "{{ scm_clean }}"
+ username: "{{ scm_username | default(omit) }}"
+ password: "{{ scm_password | default(omit) }}"
# must be in_place because folder pre-existing, because it is mounted
in_place: true
environment:
@@ -68,85 +73,90 @@
register: svn_result
- name: Set the svn repository version
- set_fact:
+ ansible.builtin.set_fact:
scm_version: "{{ svn_result['after'] }}"
when: "'after' in svn_result"
- - name: parse subversion version string properly
- set_fact:
- scm_version: "{{scm_version|regex_replace('^.*Revision: ([0-9]+).*$', '\\1')}}"
- tags:
- - update_svn
+ - name: Parse subversion version string properly
+ ansible.builtin.set_fact:
+ scm_version: "{{ scm_version | regex_replace('^.*Revision: ([0-9]+).*$', '\\1') }}"
- - block:
+
+ - name: Project update for Insights
+ tags:
+ - update_insights
+ block:
- name: Ensure the project directory is present
- file:
- dest: "{{project_path|quote}}"
+ ansible.builtin.file:
+ dest: "{{ project_path | quote }}"
state: directory
+ mode: '0755'
- name: Fetch Insights Playbook(s)
insights:
- insights_url: "{{insights_url}}"
- username: "{{scm_username}}"
- password: "{{scm_password}}"
- project_path: "{{project_path}}"
- awx_license_type: "{{awx_license_type}}"
- awx_version: "{{awx_version}}"
+ insights_url: "{{ insights_url }}"
+ username: "{{ scm_username }}"
+ password: "{{ scm_password }}"
+ project_path: "{{ project_path }}"
+ awx_license_type: "{{ awx_license_type }}"
+ awx_version: "{{ awx_version }}"
register: results
- name: Save Insights Version
- set_fact:
- scm_version: "{{results.version}}"
+ ansible.builtin.set_fact:
+ scm_version: "{{ results.version }}"
when: results is defined
- tags:
- - update_insights
- - block:
+
+ - name: Update project using archive
+ tags:
+ - update_archive
+ block:
- name: Ensure the project archive directory is present
- file:
- dest: "{{ project_path|quote }}/.archive"
+ ansible.builtin.file:
+ dest: "{{ project_path | quote }}/.archive"
state: directory
+ mode: '0755'
- name: Get archive from url
- get_url:
- url: "{{ scm_url|quote }}"
- dest: "{{ project_path|quote }}/.archive/"
- url_username: "{{ scm_username|default(omit) }}"
- url_password: "{{ scm_password|default(omit) }}"
+ ansible.builtin.get_url:
+ url: "{{ scm_url | quote }}"
+ dest: "{{ project_path | quote }}/.archive/"
+ url_username: "{{ scm_username | default(omit) }}"
+ url_password: "{{ scm_password | default(omit) }}"
force_basic_auth: true
+ mode: '0755'
register: get_archive
- name: Unpack archive
project_archive:
src: "{{ get_archive.dest }}"
- project_path: "{{ project_path|quote }}"
+ project_path: "{{ project_path | quote }}"
force: "{{ scm_clean }}"
when: get_archive.changed or scm_clean
register: unarchived
- name: Find previous archives
- find:
- paths: "{{ project_path|quote }}/.archive/"
+ ansible.builtin.find:
+ paths: "{{ project_path | quote }}/.archive/"
excludes:
- - "{{ get_archive.dest|basename }}"
+ - "{{ get_archive.dest | basename }}"
when: unarchived.changed
register: previous_archive
- name: Remove previous archives
- file:
+ ansible.builtin.file:
path: "{{ item.path }}"
state: absent
loop: "{{ previous_archive.files }}"
- when: previous_archive.files|default([])
+ when: previous_archive.files | default([])
- name: Set scm_version to archive sha1 checksum
- set_fact:
+ ansible.builtin.set_fact:
scm_version: "{{ get_archive.checksum_src }}"
- tags:
- - update_archive
- name: Repository Version
- debug:
+ ansible.builtin.debug:
msg: "Repository Version {{ scm_version }}"
tags:
- update_git
@@ -183,60 +193,59 @@
additional_collections_env:
# These environment variables are used for installing collections, in addition to galaxy_task_env
# setting the collections paths silences warnings
- ANSIBLE_COLLECTIONS_PATHS: "{{projects_root}}/.__awx_cache/{{local_path}}/stage/requirements_collections"
+ ANSIBLE_COLLECTIONS_PATHS: "{{ projects_root }}/.__awx_cache/{{ local_path }}/stage/requirements_collections"
# Put the local tmp directory in same volume as collection destination
# otherwise, files cannot be moved accross volumes and will cause error
- ANSIBLE_LOCAL_TEMP: "{{projects_root}}/.__awx_cache/{{local_path}}/stage/tmp"
+ ANSIBLE_LOCAL_TEMP: "{{ projects_root }}/.__awx_cache/{{ local_path }}/stage/tmp"
tasks:
-
- name: Check content sync settings
- block:
- - debug:
- msg: >
- Collection and role syncing disabled. Check the AWX_ROLES_ENABLED and
- AWX_COLLECTIONS_ENABLED settings and Galaxy credentials on the project's organization.
-
- - meta: end_play
-
- when: not roles_enabled|bool and not collections_enabled|bool
+ when: not roles_enabled | bool and not collections_enabled | bool
tags:
- install_roles
- install_collections
+ block:
+ - name: Warn about disabled content sync
+ ansible.builtin.debug:
+ msg: >
+ Collection and role syncing disabled. Check the AWX_ROLES_ENABLED and
+ AWX_COLLECTIONS_ENABLED settings and Galaxy credentials on the project's organization.
+ - name: End play due to disabled content sync
+ ansible.builtin.meta: end_play
- - name: fetch galaxy roles from requirements.(yml/yaml)
- command: >
+ - name: Fetch galaxy roles from requirements.(yml/yaml)
+ ansible.builtin.command: >
ansible-galaxy role install -r {{ item }}
- --roles-path {{projects_root}}/.__awx_cache/{{local_path}}/stage/requirements_roles
+ --roles-path {{ projects_root }}/.__awx_cache/{{ local_path }}/stage/requirements_roles
{{ ' -' + 'v' * ansible_verbosity if ansible_verbosity else '' }}
args:
- chdir: "{{project_path|quote}}"
+ chdir: "{{ project_path | quote }}"
register: galaxy_result
with_fileglob:
- - "{{project_path|quote}}/roles/requirements.yaml"
- - "{{project_path|quote}}/roles/requirements.yml"
+ - "{{ project_path | quote }}/roles/requirements.yaml"
+ - "{{ project_path | quote }}/roles/requirements.yml"
changed_when: "'was installed successfully' in galaxy_result.stdout"
environment: "{{ galaxy_task_env }}"
- when: roles_enabled|bool
+ when: roles_enabled | bool
tags:
- install_roles
- - name: fetch galaxy collections from collections/requirements.(yml/yaml)
- command: >
+ - name: Fetch galaxy collections from collections/requirements.(yml/yaml)
+ ansible.builtin.command: >
ansible-galaxy collection install -r {{ item }}
- --collections-path {{projects_root}}/.__awx_cache/{{local_path}}/stage/requirements_collections
+ --collections-path {{ projects_root }}/.__awx_cache/{{ local_path }}/stage/requirements_collections
{{ ' -' + 'v' * ansible_verbosity if ansible_verbosity else '' }}
args:
- chdir: "{{project_path|quote}}"
+ chdir: "{{ project_path | quote }}"
register: galaxy_collection_result
with_fileglob:
- - "{{project_path|quote}}/collections/requirements.yaml"
- - "{{project_path|quote}}/collections/requirements.yml"
- - "{{project_path|quote}}/requirements.yaml"
- - "{{project_path|quote}}/requirements.yml"
+ - "{{ project_path | quote }}/collections/requirements.yaml"
+ - "{{ project_path | quote }}/collections/requirements.yml"
+ - "{{ project_path | quote }}/requirements.yaml"
+ - "{{ project_path | quote }}/requirements.yml"
changed_when: "'Installing ' in galaxy_collection_result.stdout"
environment: "{{ additional_collections_env | combine(galaxy_task_env) }}"
when:
- "ansible_version.full is version_compare('2.9', '>=')"
- - collections_enabled|bool
+ - collections_enabled | bool
tags:
- install_collections
diff --git a/awx/settings/defaults.py b/awx/settings/defaults.py
index 974169ff53..c9bef813d0 100644
--- a/awx/settings/defaults.py
+++ b/awx/settings/defaults.py
@@ -938,6 +938,11 @@ AWX_RUNNER_OMIT_ENV_FILES = True
# Allow ansible-runner to save ansible output (may cause performance issues)
AWX_RUNNER_SUPPRESS_OUTPUT_FILE = True
+# https://github.com/ansible/ansible-runner/pull/1191/files
+# Interval in seconds between the last message and keep-alive messages that
+# ansible-runner will send
+AWX_RUNNER_KEEPALIVE_SECONDS = 0
+
# Delete completed work units in receptor
RECEPTOR_RELEASE_WORK = True
diff --git a/awx/sso/common.py b/awx/sso/common.py
index 4d601bb22e..99abc51d5a 100644
--- a/awx/sso/common.py
+++ b/awx/sso/common.py
@@ -169,3 +169,45 @@ def get_or_create_org_with_default_galaxy_cred(**kwargs):
else:
logger.debug("Could not find default Ansible Galaxy credential to add to org")
return org
+
+
+def get_external_account(user):
+ account_type = None
+
+ # Previously this method also checked for active configuration which meant that if a user logged in from LDAP
+ # and then LDAP was no longer configured it would "convert" the user from an LDAP account_type to none.
+ # This did have one benefit that if a login type was removed intentionally the user could be given a username password.
+ # But it had a limitation that the user would have to have an active session (or an admin would have to go set a temp password).
+ # It also lead to the side affect that if LDAP was ever reconfigured the user would convert back to LDAP but still have a local password.
+ # That local password could then be used to bypass LDAP authentication.
+ try:
+ if user.pk and user.profile.ldap_dn and not user.has_usable_password():
+ account_type = "ldap"
+ except AttributeError:
+ pass
+
+ if user.social_auth.all():
+ account_type = "social"
+
+ if user.enterprise_auth.all():
+ account_type = "enterprise"
+
+ return account_type
+
+
+def is_remote_auth_enabled():
+ from django.conf import settings
+
+ # Append LDAP, Radius, TACACS+ and SAML options
+ settings_that_turn_on_remote_auth = [
+ 'AUTH_LDAP_SERVER_URI',
+ 'SOCIAL_AUTH_SAML_ENABLED_IDPS',
+ 'RADIUS_SERVER',
+ 'TACACSPLUS_HOST',
+ ]
+ # Also include any SOCAIL_AUTH_*KEY (except SAML)
+ for social_auth_key in dir(settings):
+ if social_auth_key.startswith('SOCIAL_AUTH_') and social_auth_key.endswith('_KEY') and 'SAML' not in social_auth_key:
+ settings_that_turn_on_remote_auth.append(social_auth_key)
+
+ return any(getattr(settings, s, None) for s in settings_that_turn_on_remote_auth)
diff --git a/awx/sso/tests/functional/test_common.py b/awx/sso/tests/functional/test_common.py
index 4fc3edd841..f2b3e5781d 100644
--- a/awx/sso/tests/functional/test_common.py
+++ b/awx/sso/tests/functional/test_common.py
@@ -2,9 +2,22 @@ import pytest
from collections import Counter
from django.core.exceptions import FieldError
from django.utils.timezone import now
+from django.test.utils import override_settings
from awx.main.models import Credential, CredentialType, Organization, Team, User
-from awx.sso.common import get_orgs_by_ids, reconcile_users_org_team_mappings, create_org_and_teams, get_or_create_org_with_default_galaxy_cred
+from awx.sso.common import (
+ get_orgs_by_ids,
+ reconcile_users_org_team_mappings,
+ create_org_and_teams,
+ get_or_create_org_with_default_galaxy_cred,
+ is_remote_auth_enabled,
+ get_external_account,
+)
+
+
+class MicroMockObject(object):
+ def all(self):
+ return True
@pytest.mark.django_db
@@ -278,3 +291,87 @@ class TestCommonFunctions:
for o in Organization.objects.all():
assert o.galaxy_credentials.count() == 0
+
+ @pytest.mark.parametrize(
+ "enable_ldap, enable_social, enable_enterprise, expected_results",
+ [
+ (False, False, False, None),
+ (True, False, False, 'ldap'),
+ (True, True, False, 'social'),
+ (True, True, True, 'enterprise'),
+ (False, True, True, 'enterprise'),
+ (False, False, True, 'enterprise'),
+ (False, True, False, 'social'),
+ ],
+ )
+ def test_get_external_account(self, enable_ldap, enable_social, enable_enterprise, expected_results):
+ try:
+ user = User.objects.get(username="external_tester")
+ except User.DoesNotExist:
+ user = User(username="external_tester")
+ user.set_unusable_password()
+ user.save()
+
+ if enable_ldap:
+ user.profile.ldap_dn = 'test.dn'
+ if enable_social:
+ from social_django.models import UserSocialAuth
+
+ social_auth, _ = UserSocialAuth.objects.get_or_create(
+ uid='667ec049-cdf3-45d0-a4dc-0465f7505954',
+ provider='oidc',
+ extra_data={},
+ user_id=user.id,
+ )
+ user.social_auth.set([social_auth])
+ if enable_enterprise:
+ from awx.sso.models import UserEnterpriseAuth
+
+ enterprise_auth = UserEnterpriseAuth(user=user, provider='tacacs+')
+ enterprise_auth.save()
+
+ assert get_external_account(user) == expected_results
+
+ @pytest.mark.parametrize(
+ "setting, expected",
+ [
+ # Set none of the social auth settings
+ ('JUNK_SETTING', False),
+ # Set the hard coded settings
+ ('AUTH_LDAP_SERVER_URI', True),
+ ('SOCIAL_AUTH_SAML_ENABLED_IDPS', True),
+ ('RADIUS_SERVER', True),
+ ('TACACSPLUS_HOST', True),
+ # Set some SOCIAL_SOCIAL_AUTH_OIDC_KEYAUTH_*_KEY settings
+ ('SOCIAL_AUTH_AZUREAD_OAUTH2_KEY', True),
+ ('SOCIAL_AUTH_GITHUB_ENTERPRISE_KEY', True),
+ ('SOCIAL_AUTH_GITHUB_ENTERPRISE_ORG_KEY', True),
+ ('SOCIAL_AUTH_GITHUB_ENTERPRISE_TEAM_KEY', True),
+ ('SOCIAL_AUTH_GITHUB_KEY', True),
+ ('SOCIAL_AUTH_GITHUB_ORG_KEY', True),
+ ('SOCIAL_AUTH_GITHUB_TEAM_KEY', True),
+ ('SOCIAL_AUTH_GOOGLE_OAUTH2_KEY', True),
+ ('SOCIAL_AUTH_OIDC_KEY', True),
+ # Try a hypothetical future one
+ ('SOCIAL_AUTH_GIBBERISH_KEY', True),
+ # Do a SAML one
+ ('SOCIAL_AUTH_SAML_SP_PRIVATE_KEY', False),
+ ],
+ )
+ def test_is_remote_auth_enabled(self, setting, expected):
+ with override_settings(**{setting: True}):
+ assert is_remote_auth_enabled() == expected
+
+ @pytest.mark.parametrize(
+ "key_one, key_one_value, key_two, key_two_value, expected",
+ [
+ ('JUNK_SETTING', True, 'JUNK2_SETTING', True, False),
+ ('AUTH_LDAP_SERVER_URI', True, 'SOCIAL_AUTH_AZUREAD_OAUTH2_KEY', True, True),
+ ('JUNK_SETTING', True, 'SOCIAL_AUTH_AZUREAD_OAUTH2_KEY', True, True),
+ ('AUTH_LDAP_SERVER_URI', False, 'SOCIAL_AUTH_AZUREAD_OAUTH2_KEY', False, False),
+ ],
+ )
+ def test_is_remote_auth_enabled_multiple_keys(self, key_one, key_one_value, key_two, key_two_value, expected):
+ with override_settings(**{key_one: key_one_value}):
+ with override_settings(**{key_two: key_two_value}):
+ assert is_remote_auth_enabled() == expected
diff --git a/awx/ui/src/screens/Credential/Credential.js b/awx/ui/src/screens/Credential/Credential.js
index ce0509146d..79c766a2d8 100644
--- a/awx/ui/src/screens/Credential/Credential.js
+++ b/awx/ui/src/screens/Credential/Credential.js
@@ -22,14 +22,19 @@ import { CredentialsAPI } from 'api';
import CredentialDetail from './CredentialDetail';
import CredentialEdit from './CredentialEdit';
-const jobTemplateCredentialTypes = [
- 'machine',
- 'cloud',
- 'net',
- 'ssh',
- 'vault',
- 'kubernetes',
- 'cryptography',
+const unacceptableCredentialTypes = [
+ 'centrify_vault_kv',
+ 'aim',
+ 'conjur',
+ 'hashivault_kv',
+ 'hashivault_ssh',
+ 'azure_kv',
+ 'thycotic_dsv',
+ 'thycotic_tss',
+ 'galaxy_api_token',
+ 'insights',
+ 'registry',
+ 'scm',
];
function Credential({ setBreadcrumb }) {
@@ -86,7 +91,10 @@ function Credential({ setBreadcrumb }) {
id: 1,
},
];
- if (jobTemplateCredentialTypes.includes(credential?.kind)) {
+ if (
+ !unacceptableCredentialTypes.includes(credential?.kind) &&
+ credential !== null
+ ) {
tabsArray.push({
name: t`Job Templates`,
link: `/credentials/${id}/job_templates`,
@@ -115,12 +123,14 @@ function Credential({ setBreadcrumb }) {
);
}
+ if (hasContentLoading) {
+ return ;
+ }
return (
{showCardHeader && }
- {hasContentLoading && }
{!hasContentLoading && credential && (
({
describe('', () => {
let wrapper;
+ afterEach(() => {
+ jest.clearAllMocks();
+
+ wrapper.unmount();
+ });
test('initially renders user-based machine credential successfully', async () => {
CredentialsAPI.readDetail.mockResolvedValueOnce({
@@ -61,6 +67,19 @@ describe('', () => {
});
});
+ test('should not render job template tab', async () => {
+ CredentialsAPI.readDetail.mockResolvedValueOnce({
+ data: { ...mockCyberArkCredential, kind: 'registry' },
+ });
+ const expectedTabs = ['Back to Credentials', 'Details', 'Access'];
+ await act(async () => {
+ wrapper = mountWithContexts( {}} />);
+ });
+ wrapper.find('RoutedTabs li').forEach((tab, index) => {
+ expect(tab.text()).toEqual(expectedTabs[index]);
+ });
+ });
+
test('should show content error when user attempts to navigate to erroneous route', async () => {
const history = createMemoryHistory({
initialEntries: ['/credentials/2/foobar'],
@@ -85,3 +104,4 @@ describe('', () => {
await waitForElement(wrapper, 'ContentError', (el) => el.length === 1);
});
});
+describe(' should not show job template tab', () => {});
diff --git a/awx/ui/src/screens/Setting/Jobs/JobsEdit/JobsEdit.js b/awx/ui/src/screens/Setting/Jobs/JobsEdit/JobsEdit.js
index 52e216e41e..d258fdec46 100644
--- a/awx/ui/src/screens/Setting/Jobs/JobsEdit/JobsEdit.js
+++ b/awx/ui/src/screens/Setting/Jobs/JobsEdit/JobsEdit.js
@@ -150,6 +150,11 @@ function JobsEdit() {
type={options?.SCHEDULE_MAX_JOBS ? 'number' : undefined}
isRequired={Boolean(options?.SCHEDULE_MAX_JOBS)}
/>
+