Add dump_auth_config management cmd (for SAML and LDAP) #14947

TheRealHaoLiu · 2024-03-04T20:06:22Z

SUMMARY

Dump SAML config from AWX to DAB authenticator config in json format
Dump LDAP config ...

ISSUE TYPE

New or Enhanced Feature

COMPONENT NAME

Other

AWX VERSION

awx: 23.9.1.dev8+gd6e63469cb

ADDITIONAL INFORMATION

- Dump SAML config from AWX to DAB authenticator config in json format

awx/main/tests/unit/commands/test_dump_auth_config.py

Co-authored-by: Hao Liu <44379968+TheRealHaoLiu@users.noreply.github.com>

… into pr/14947

TheRealHaoLiu · 2024-03-11T15:16:33Z

@jessicamack

[gw0] linux -- Python 3.9.18 /var/lib/awx/venv/awx/bin/python3.9
Traceback (most recent call last):
  File "/awx_devel/awx/main/management/commands/dump_auth_config.py", line 137, in handle
    self.format_config_data(
  File "/awx_devel/awx/main/management/commands/dump_auth_config.py", line 111, in format_config_data
    value = awx_settings["ENABLED_IDPS"][idp_name].get(key)
TypeError: string indices must be integers

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/lib64/python3.9/unittest/case.py", line 59, in testPartExecutor
    yield
  File "/usr/lib64/python3.9/unittest/case.py", line 592, in run
    self._callTestMethod(testMethod)
  File "/usr/lib64/python3.9/unittest/case.py", line 550, in _callTestMethod
    method()
  File "/awx_devel/awx/main/tests/unit/commands/test_dump_auth_config.py", line 79, in test_json_returned_from_cmd
    call_command("dump_auth_config", stdout=output)
  File "/var/lib/awx/venv/awx/lib64/python3.9/site-packages/django/core/management/__init__.py", line 194, in call_command
    return command.execute(*args, **defaults)
  File "/var/lib/awx/venv/awx/lib64/python3.9/site-packages/django/core/management/base.py", line 458, in execute
    output = self.handle(*args, **options)
  File "/awx_devel/awx/main/management/commands/dump_auth_config.py", line 179, in handle
    sys.exit(1)
SystemExit: 1

jessicamack · 2024-03-11T15:58:02Z

[gw0] linux -- Python 3.9.18 /var/lib/awx/venv/awx/bin/python3.9
Traceback (most recent call last):
  File "/awx_devel/awx/main/management/commands/dump_auth_config.py", line 137, in handle
    self.format_config_data(
  File "/awx_devel/awx/main/management/commands/dump_auth_config.py", line 111, in format_config_data
    value = awx_settings["ENABLED_IDPS"][idp_name].get(key)
TypeError: string indices must be integers

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/usr/lib64/python3.9/unittest/case.py", line 59, in testPartExecutor
    yield
  File "/usr/lib64/python3.9/unittest/case.py", line 592, in run
    self._callTestMethod(testMethod)
  File "/usr/lib64/python3.9/unittest/case.py", line 550, in _callTestMethod
    method()
  File "/awx_devel/awx/main/tests/unit/commands/test_dump_auth_config.py", line 79, in test_json_returned_from_cmd
    call_command("dump_auth_config", stdout=output)
  File "/var/lib/awx/venv/awx/lib64/python3.9/site-packages/django/core/management/__init__.py", line 194, in call_command
    return command.execute(*args, **defaults)
  File "/var/lib/awx/venv/awx/lib64/python3.9/site-packages/django/core/management/base.py", line 458, in execute
    output = self.handle(*args, **options)
  File "/awx_devel/awx/main/management/commands/dump_auth_config.py", line 179, in handle
    sys.exit(1)
SystemExit: 1

@TheRealHaoLiu can you share your SAML settings? I don't run into this error when I run the command

TheRealHaoLiu · 2024-03-12T13:22:29Z

@jessicamack its the failure in the github action CI https://github.com/ansible/awx/actions/runs/8234730114/job/22517140733?pr=14947

awx/main/management/commands/dump_auth_config.py

awx/main/tests/unit/commands/test_dump_auth_config.py

* Add dump_auth_config management cmd - Dump SAML config from AWX to DAB authenticator config in json format * Add dumping of LDAP settings * add test for command * Fix is_enabled * fix command name typo Co-authored-by: Hao Liu <44379968+TheRealHaoLiu@users.noreply.github.com> * add fields to config, add name to data * break out IDP values * change test fields and value comparison * edit help text, reformat settings --------- Co-authored-by: jessicamack <jmack@redhat.com>

TheRealHaoLiu requested a review from jbradberry March 4, 2024 20:06

github-actions bot added the component:api label Mar 4, 2024

TheRealHaoLiu requested review from fosterseth, chrismeyersfsu and john-westcott-iv March 4, 2024 20:07

TheRealHaoLiu force-pushed the dump-saml-config branch 3 times, most recently from 927d315 to b01fc20 Compare March 4, 2024 20:40

Add dump_auth_config management cmd

c4372ae

- Dump SAML config from AWX to DAB authenticator config in json format

TheRealHaoLiu force-pushed the dump-saml-config branch from b01fc20 to c4372ae Compare March 4, 2024 20:41

Add dumping of LDAP settings

dc49df2

TheRealHaoLiu changed the title ~~Add dump_auth_config management cmd (for SAML)~~ Add dump_auth_config management cmd (for SAML and LDAP) Mar 4, 2024

dmzoneill marked this pull request as draft March 5, 2024 13:02

add test for command

6710314

TheRealHaoLiu commented Mar 5, 2024

View reviewed changes

awx/main/tests/unit/commands/test_dump_auth_config.py Outdated Show resolved Hide resolved

Fix is_enabled

d5b2963

jbradberry approved these changes Mar 6, 2024

View reviewed changes

TheRealHaoLiu commented Mar 7, 2024

View reviewed changes

awx/main/tests/unit/commands/test_dump_auth_config.py Outdated Show resolved Hide resolved

jessicamack and others added 4 commits March 7, 2024 14:26

fix command name typo

04e81cc

Co-authored-by: Hao Liu <44379968+TheRealHaoLiu@users.noreply.github.com>

add fields to config, add name to data

e9af028

Merge branch 'dump-saml-config' of https://github.com/TheRealHaoLiu/awx…

47912a7

… into pr/14947

break out IDP values

9361b82

change test fields and value comparison

ec22efb

jessicamack marked this pull request as ready for review March 13, 2024 21:57

jessicamack requested a review from jbradberry March 15, 2024 16:24

fosterseth reviewed Mar 15, 2024

View reviewed changes

awx/main/management/commands/dump_auth_config.py Outdated Show resolved Hide resolved

fosterseth reviewed Mar 15, 2024

View reviewed changes

awx/main/tests/unit/commands/test_dump_auth_config.py Outdated Show resolved Hide resolved

fosterseth reviewed Mar 15, 2024

View reviewed changes

awx/main/tests/unit/commands/test_dump_auth_config.py Show resolved Hide resolved

edit help text, reformat settings

8c45a57

jessicamack requested a review from fosterseth March 15, 2024 17:29

fosterseth approved these changes Mar 15, 2024

View reviewed changes

jessicamack merged commit 8ff7260 into ansible:devel Mar 15, 2024
20 of 21 checks passed

TheRealHaoLiu deleted the dump-saml-config branch March 19, 2024 13:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add dump_auth_config management cmd (for SAML and LDAP) #14947

Add dump_auth_config management cmd (for SAML and LDAP) #14947

TheRealHaoLiu commented Mar 4, 2024 •

edited

Loading

TheRealHaoLiu commented Mar 11, 2024

jessicamack commented Mar 11, 2024 •

edited

Loading

TheRealHaoLiu commented Mar 12, 2024 •

edited

Loading

Add dump_auth_config management cmd (for SAML and LDAP) #14947

Add dump_auth_config management cmd (for SAML and LDAP) #14947

Conversation

TheRealHaoLiu commented Mar 4, 2024 • edited Loading

SUMMARY

ISSUE TYPE

COMPONENT NAME

AWX VERSION

ADDITIONAL INFORMATION

TheRealHaoLiu commented Mar 11, 2024

jessicamack commented Mar 11, 2024 • edited Loading

TheRealHaoLiu commented Mar 12, 2024 • edited Loading

TheRealHaoLiu commented Mar 4, 2024 •

edited

Loading

jessicamack commented Mar 11, 2024 •

edited

Loading

TheRealHaoLiu commented Mar 12, 2024 •

edited

Loading