common: Handle aliases correctly

[Akasurde]

SUMMARY

Fixed get_api_client API to handle aliases that
are passed via inventory configuration or module parameters.

Signed-off-by: Abhijeet Kasurde [email protected]

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

changelogs/fragments/honor_aliases.yml
molecule/default/tasks/full.yml
plugins/module_utils/common.py

[codecov]

Codecov Report

Merging #71 (8985fc5) into main (b68bf7c) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #71   +/-   ##
=======================================
  Coverage   23.17%   23.17%           
=======================================
  Files           1        1           
  Lines         151      151           
  Branches       24       24           
=======================================
  Hits           35       35           
  Misses        111      111           
  Partials        5        5           

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b68bf7c...8985fc5. Read the comment docs.

[gravesm]

I don't understand, shouldn't ansible already handle this? If I pass ssl_ca_cert and then do module.params.get('ca_cert'), won't it already work without this change? If I remove your changes, the tests still pass.

[abikouo]

I don't understand, shouldn't ansible already handle this? If I pass ssl_ca_cert and then do module.params.get('ca_cert'), won't it already work without this change? If I remove your changes, the tests still pass.

I don't understand, shouldn't ansible already handle this? If I pass ssl_ca_cert and then do module.params.get('ca_cert'), won't it already work without this change? If I remove your changes, the tests still pass.

I think using module it should work, assuming the core engine will convert argument from aliases to true name
but for inventory plugin, there is no such a conversion, so this has to be done manually.
We should add some inventory test cases

[abikouo]

we may need to cover all aliases cert_file, key_file, verify_ssl

[abikouo]

I would suggest some validation step to avoid having both alias and true name set as input, otherwise the behavior of the api will be undefined. for instance using

k8s:
  ...
  validate_certs: yes
  verify_ssl: no

the process will the k8s configuration item with the first value in alpha num ?

[fabianvf]

note: AUTH_ARG_MAP doesn't define aliases for ansible, it's used for mapping the Ansible keys to the proper property names in the kubernetes client. It was added because things like ssl_ca_cert were normalized across ansible modules, but that made it so that we couldn't just iterate over the auth_args and set the properties in the kubernetes.Configuration like we were before the normalization. So the true_name doesn't need to be exposed to the user, we just need to know what property in the kubernetes.Configuration object the keys that ansible is giving us map to.

Typing this all out, I'm feeling like maybe I should have left this as a comment way back when I added it 😅

[gravesm]

@Akasurde What do you think about adding some inventory test cases?