fixes #37524 - feat: enable ansible events for webhooks

[gardar]

Enables the following events:

• ansible_variable_created.event.foreman
• ansible_variable_updated.event.foreman
• ansible_variable_destroyed.event.foreman
• ansible_role_created.event.foreman
• ansible_role_updated.event.foreman
• ansible_role_destroyed.event.foreman

Which can then be used with foreman_webhooks

https://projects.theforeman.org/issues/37524

[gardar]

cc @nofaralfasi

[nofaralfasi]

It's a bit challenging for me to review this PR due to the lack of tests and detailed steps to follow.
Also, should we add this to the available webhook events in the docs https://docs.theforeman.org/nightly/Administering_Project/index-foreman-el.html#webhooks-available-events_admin?

[nofaralfasi]

I found a community post that clarifies things a bit more: Adding New Custom Webhook Subscriptions.

[gardar]

Yes that's a post by me.

I'm fond of having CI tests for everything, but my knowledge of foreman and the tests done here are not deep enough for me to decide how and if this should be automatically tested.

But basically what this PR does is enabling events for updates to ansible roles or variables in foreman, those events can then be used with the foreman webhooks plugin.
As I mentioned in the forum post then I'm using the webhook when a ansible variable is updated/created in foreman (satellite actually) to trigger a pipeline in gitlab which then executes a script that exports the ansible variable override to a repository in gitlab.

[ofedoren]

Thanks, @gardar, I've tested it with foreman_webhooks and it works:

In case you want to add some test to cover this, you might inspire by https://github.com/theforeman/foreman/blob/develop/test/models/hosts/managed_test.rb#L126

[gardar]

Great, glad you were able to test it successfully!
I probably won't have any time to add any tests to cover this any time soon, unless it's a strict requirement for this PR moving forward.

[ofedoren]

unless it's a strict requirement for this PR moving forward.

I'd say it's not, but I'm not a maintainer here :)

[nofaralfasi]

I’m generally in favor of having tests, but we can skip them this time.

[nofaralfasi]

@gardar could you open a PR to update the docs https://docs.theforeman.org/nightly/Administering_Project/index-foreman-el.html#webhooks-available-events_admin?