Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pluggable credential types #22995

Merged
merged 1 commit into from Apr 18, 2024
Merged

Conversation

nasark
Copy link
Member

@nasark nasark commented Apr 16, 2024

Originally credential types were hard coded in the Authentication class. With this change we can define credential types in the respective classes and then pull the info for the OPTIONS call from the new Authentication.credential_types method

Depends on:

@miq-bot assign @agrare
@miq-bot add_reviewer @agrare
@miq-bot add_labels enhancement

Comment on lines +4 to +7
def self.credential_type
"embedded_ansible_credential_types"
end

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NOTE I think once we get away from separate "embedded_workflows" and "embedded_ansible" controllers we can drop these "groups" of credential types, because you would just call OPTIONS and pass in a type like we do with ext_management_systems. So you would as for the credential types for the Workflows AutomationManager or the EmbeddedAnsible AutomationManager.

But for now this keeps compatibility without having to hard code all of the types 👍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't thin OPTIONS supports the collection_class, but it could.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Fryguy we pass in type=class_name to OPTIONS, that is how we get DDF params for a particular EMS once you've selected it in the dropdown

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh interesting - we probably should be passing in collection_class. The type filtering doesn't work with the "middle" classes, whereas collection_class does.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, clarification - type is fine for the purpose listed which is an EMS is selected and then we filter on that EMS. collection_class would be for other purposes.

@@ -1,6 +1,10 @@
class ManageIQ::Providers::EmbeddedAnsible::AutomationManager::Credential < ManageIQ::Providers::EmbeddedAutomationManager::Authentication
FRIENDLY_NAME = "Embedded Ansible Credential".freeze

def self.credential_type
"embedded_ansible_credential_types"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm wondering if we even need this method. It acts as a key into a hash that's presented over the API, but
a) maybe we don't need the key at all
b) if we do need some sort of key, just use the class name
c) if we do need the key and it can't be the class name, then just derive the key with something like "#{klass.name.gsub("::", "_").underscore}_credential_types

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note I'm fine merging as is, because it keeps the interface identical to how it was previously, but makes it pluggable, which is progress.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think https://github.com/ManageIQ/manageiq/pull/22995/files#r1567779476 answers this, we need it for now because of how the UI splits external / internal automation controllers up ignoring the actual EMS object and assuming there is only one of the internal types.

@nasark nasark force-pushed the pluggable_credential_types branch from 3e4c291 to e036c57 Compare April 17, 2024 14:47
@miq-bot
Copy link
Member

miq-bot commented Apr 17, 2024

Checked commit nasark@e036c57 with ruby 2.7.8, rubocop 1.56.3, haml-lint 0.51.0, and yamllint
3 files checked, 0 offenses detected
Everything looks fine. 🍰

@agrare agrare merged commit e9dbcc1 into ManageIQ:master Apr 18, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants