Move injectors to ManagedCredentialType #57
Conversation
Injectors are a bail-out mechanism for when you need to do something that the templating engine does not support, for a particular credential type. They are strongly tied to one and only one credential type. Before this change they lived far away from the ManagedCredentialType they are associated for. The link was the credential kind string was the same as the injector function name. This was a very loose coupling. This change is a tighter coupling.
There was a problem hiding this comment.
Putting this in my own words...
The custom logic like awx_plugins.credentials.injectors.aws already lived here, but there was no link in the plugin definition to the custom logic. So somehow that got referenced by a literal name like "aws".
My only gripe would be that post_injectors doesn't feel like a great name. Like, sure, maybe it runs after the other stuff (templates)? But it's usually an alternative to the templates, making that detail kind of irrelevant practically. It's more important that it runs custom python logic like a caveman, as opposed to any structured injector definition.
|
|
I'd lean towards (2) myself. |
|
I had an alternative idea with ansible/awx_plugins.interfaces#10 / #50 / ansible/awx#15595 FTR |
chrismeyersfsu
force-pushed
the
AAP-35749-move-inject-credential
branch
3 times, most recently
from
ce238b7
to
888f5b4
Compare
|
I slightly lean towards the sentiment @chrismeyersfsu expressed in ansible/awx#15595
But even if we did nothing, it wouldn't bother me that much, since they already live in the plugins repo. |
* Defining an injector as code is an override. The previous name made it sound like the template engine would run, then the custom injector. This is not the case. If the custom injector is defined then the templating engine doens't run.
chrismeyersfsu
force-pushed
the
AAP-35749-move-inject-credential
branch
from
888f5b4
to
8bf79b0
Compare
chrismeyersfsu
force-pushed
the
AAP-35749-move-inject-credential
branch
from
037a5c9
to
e56d661
Compare
for more information, see https://pre-commit.ci
|
@chrismeyersfsu typing change handling instructions:
|
| @@ -6,6 +6,9 @@ | |||
| import stat | |||
| import tempfile | |||
|
|
|||
| from awx_plugins.interfaces._temporary_private_api import ( # noqa: WPS436 | |||
There was a problem hiding this comment.
| from awx_plugins.interfaces._temporary_private_api import ( # noqa: WPS436 | |
| from awx_plugins.interfaces._temporary_private_credential_api import ( # noqa: WPS436 |
| @@ -16,7 +19,7 @@ | |||
| import yaml | |||
|
|
|||
|
|
|||
| def aws(cred, env, private_data_dir): | |||
| def aws(cred: Credential, env: dict, private_data_dir: str): | |||
There was a problem hiding this comment.
While on it, could you also mark the returned type for all of the functions in the module?
| def aws(cred: Credential, env: dict, private_data_dir: str): | |
| def aws(cred: Credential, env: dict, private_data_dir: str) -> None: |
| @@ -8,6 +8,16 @@ | |||
| gettext_noop, | |||
| ) | |||
|
|
|||
| from awx_plugins.credentials.injectors import ( | |||
There was a problem hiding this comment.
Always use relative imports for local modules:
| from awx_plugins.credentials.injectors import ( | |
| from .injectors import ( |
Injectors are a bail-out mechanism for when you need to do something that the templating engine does not support, for a particular credential type. They are strongly tied to one and only one credential type. Before this change they lived far away from the ManagedCredentialType they are associated for. The link was the credential kind string was the same as the injector function name. This was a very loose coupling. This change is a tighter coupling.