making the cli use AWXKIT_CREDENTIAL_FILE

[sezanzeb]

SUMMARY

• https://github.com/ansible/awx/blob/devel/awxkit/awxkit/config.py loads AWXKIT_CREDENTIAL_FILE, which modifies config.credentials
• https://github.com/ansible/awx/blob/devel/awxkit/awxkit/cli/format.py ignores that, it only looks at the cli args, TOWER_USERNAME and TOWER_PASSWORD
• config.credentials might not be defined, so hasattr is used to check if it exists
• cli args > TOWER_USERNAME and TOWER_PASSWORD > AWXKIT_CREDENTIAL_FILE
• added 3 tests

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

• CLI

AWX VERSION

awx: 17.0.1

ADDITIONAL INFORMATION

setup:

> nano /awx_credentials.json
> export AWXKIT_CREDENTIAL_FILE=/awx_credentials.json
> cat /awx_credentials.json 
{
  "default": {
    "username": "testuser",
    "password": "testpassword"
  }
}

before:

> awx login
...
Error retrieving an OAuth2.0 token (<class 'awxkit.exceptions.Unauthorized'>).

after:

> awx login
{
     "token": "***"
}

[softwarefactory-project-zuul]

Build failed.

• awx-api-lint : SUCCESS in 5m 04s
• awx-api : FAILURE in 11m 26s
• awx-ui : SUCCESS in 12m 51s
• awx-swagger : SUCCESS in 10m 06s
• awx-detect-schema-change : SUCCESS in 12m 57s (non-voting)
• awx-ansible-modules : SUCCESS in 8m 07s

[softwarefactory-project-zuul]

Build succeeded.

• awx-api-lint : SUCCESS in 2m 55s
• awx-api : SUCCESS in 7m 16s
• awx-ui : SUCCESS in 10m 38s
• awx-swagger : SUCCESS in 8m 04s
• awx-detect-schema-change : SUCCESS in 7m 20s (non-voting)
• awx-ansible-modules : SUCCESS in 4m 59s

[jakemcdermott]

@unlikelyzero @tiagodread This addresses a bug with the awxkit config precedence. (CLI args would now override config file vars).

That's probably (?) the expected behavior but it's possible that some test suites and other tooling might implicitly rely on the unexpected (current) behavior. Can you give this a run to make sure it all still works?

[sezanzeb]

tooling might implicitly rely on the unexpected (current) behavior

at least for awx login the default cli values "admin" and "password" overwrote anything stored in there, so no tooling would have been able to use the configuration file at the moment via that command as far as I can tell.

[sezanzeb]

Any updates?

@jakemcdermott

as already mentioned, AWXKIT_CREDENTIAL_FILE did not have any effect prior to this PR, it was completely ignored. The precedence is not the issue here.

[shanemcd]

Hello. If you could please rebase this and resolve the conflicts, we'll get this merged.

[sezanzeb]

Thanks for getting back to this. Should be good to go now, the changes still seem to work

[sezanzeb]

@shanemcd

[sezanzeb]

tower-cli used to support config files. This merge request has unittests so that it doesn't break again, yet it has been open for 4 months now. I even merged the conflicts in on the same day of your request. To be honest, this is somewhat discouraging me to help the project out in the future... I'm not trying to be rude, but maintaining our AWX setup has caused us/me a lot of work, which adds to the frustration a bit. sorry

[sezanzeb]

Take care to make sure no merge commits are in the submission, and use git rebase vs. git merge for this reason. (readme)

Whoops, sorry for that. I'll just squash all commits later, should be a fresh single-commit merge request afterwards

[sezanzeb]

here you are, the PR is now a single commit (also with --signoff)

[AlanCoding]

the default won't show in the help text, will it?

(sorry for the surface-level question, I'm just starting to go over this)

[sezanzeb]

no, not as long argparse.ArgumentDefaultsHelpFormatter is not used

[shanemcd]

Thanks for the contribution!