add DeliverGetRate, PublishedToDeliveredRatio and ExpectedQueueConsumptionTime trigger modes to RabbitMQ scaler

[mgs2]

Introduced three additional trigger modes for RabbitMQ scaler, as proposed in #7071:

• DeliverGetRate, which will activate, when given messages delivery rate will be reached
• PublishedToDeliveredRatio, which will activate, when scaler hits certain level of published to delivered messages ratio
• ExpectedQueueConsumptionTime, which will be activated when the total estimated waiting time for delivery of all messages available in the queue at a given moment (with the current capacity of consumers) reaches the indicated value.

Checklist

• When introducing a new scaler, I agree with the scaling governance policy
• I have verified that my change is according to the deprecations & breaking changes policy
• Tests have been added
• Changelog has been updated and is aligned with our changelog requirements
• A PR is opened to update our Helm chart (repo) (if applicable, ie. when deployment manifests are modified)
• A PR is opened to update the documentation on (repo) (if applicable)
• Commits are signed with Developer Certificate of Origin (DCO - learn more)

Documentation update: kedacore/keda-docs#1601

Additional references:

• add DeliverGetRate, PublishedToDeliveredRatio and ExpectedQueueConsumptionTime trigger modes to RabbitMQ scaler #7071
• Allow for continuous publishing of messages to RabbitMQ test queue in selected intervals test-tools#226

[SpiritZhou]

Could you add some e2e tests under /test/rabbitmq?

[mgs2]

Could you add some e2e tests under /test/rabbitmq?

Will do, once I'll get a hold on some free time. BTW it seems that I'll have to slightly extend send/receive functionalities in Docker image used in e2e tests for RabbitMQ scaler. Is there any contribution guide for https://github.com/kedacore/test-tools/ repo?

[SpiritZhou]

Currently, there is no contribution guide, but we plan to add one soon. The Docker image is written in Go and is designed to be simple and easy to use. https://github.com/kedacore/test-tools/tree/main/e2e/images/rabbitmq

[zroubalik]

Thanks a lot for the contribution, this is really great. A couple of nits from my side:

• e2e test would be really great to have
• please create a new issue with the problem description and refrence in the changelog
• in the documentation PR could you please add a new paragraph with an explanation of all trigger modes we have, ie when to use what - it doesn't have to be super complex, but something along the description you put here in the PR, see the comment there: https://github.com/kedacore/keda-docs/pull/1601/files#r2300363424

[semgrep-app]

Semgrep found 6 db-connection-string findings:

• tests/scalers/rabbitmq/rabbitmq_queue_http_eqct/rabbitmq_queue_http_eqct_test.go
  • L36 - Triage
  • L37 - Triage
• tests/scalers/rabbitmq/rabbitmq_queue_http_dpratio/rabbitmq_queue_http_dpratio_test.go
  • L36 - Triage
  • L37 - Triage
• tests/scalers/rabbitmq/rabbitmq_queue_http_dget/rabbitmq_queue_http_dget_test.go
  • L36 - Triage
  • L37 - Triage

Semgrep found a possible database connection string built with string concatenation. Check for proper encoding/escaping of components to prevent parse errors and injection vulnerabilities.

[mgs2]

e2e test would be really great to have

E2E tests have been added.

Note however, that they'll work only with updated tests-rabbitmq Docker image (see kedacore/test-tools#226).

please create a new issue with the problem description and refrence in the changelog

Done (#7071).

• in the documentation PR could you please add a new paragraph with an explanation of all trigger modes we have, ie when to use what - it doesn't have to be super complex, but something along the description you put here in the PR, see the comment there: https://github.com/kedacore/keda-docs/pull/1601/files#r2300363424

Done.

[Copilot]

Pull Request Overview

This PR adds three new trigger modes to the RabbitMQ scaler: DeliverGetRate, PublishedToDeliveredRatio, and ExpectedQueueConsumptionTime. These new modes provide more granular scaling capabilities based on message delivery rates and queue consumption patterns.

• Updates RabbitMQ scaler to support delivery rate monitoring and ratio-based scaling
• Adds comprehensive test coverage for the new trigger modes with dedicated test files
• Improves error messages and code maintainability throughout the scaler implementation

Reviewed Changes

Copilot reviewed 18 out of 18 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
pkg/scalers/rabbitmq_scaler.go	Core implementation of new trigger modes and updated scaler logic
pkg/scalers/rabbitmq_scaler_test.go	Updated unit tests with new trigger mode test data
tests/scalers/rabbitmq/rabbitmq_helper.go	Enhanced helper functions for message publishing/consuming with rate control
tests/scalers/rabbitmq/rabbitmq_queue_http_*_test.go	Integration tests for each new trigger mode
CHANGELOG.md	Documentation of the new feature

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[zroubalik]

/run-e2e rabbit
Update: You can check the progress here

[wozniakjan]

/run-e2e rabbit
Update: You can check the progress here

[wozniakjan]

tests timeout when setting up strimzi

=== RUN   TestSetUpStrimzi
    setup_test.go:***5***: --- installing kafka operator ---
    helper.go:***60: deleting namespace strimzi
    helper.go:***4: waiting for namespace strimzi deletion
    helper.go:***47: Creating namespace - strimzi
    setup_test.go:***67: 
        	Error Trace:	/__w/keda/keda/tests/utils/setup_test.go:***67
        	Error:      	Received unexpected error:
        	            	Error: context deadline exceeded
        	Test:       	TestSetUpStrimzi
        	Messages:   	cannot execute command - Error: context deadline exceeded
    setup_test.go:***69: --- kafka operator installed ---
--- FAIL: TestSetUpStrimzi (***4.9***s)

maybe related to #6929?

[wozniakjan]

/run-e2e rabbit
Update: You can check the progress here

[wozniakjan]

all tests passed, lgtm

Passed tests:
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_http_dpratio/rabbitmq_queue_http_dpratio_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_http_regex/rabbitmq_queue_http_regex_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_http_regex_aad_wi/rabbitmq_queue_http_regex_aad_wi_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_http_vhost/rabbitmq_queue_http_vhost_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_http_aad_wi/rabbitmq_queue_http_aad_wi_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_http_eqct/rabbitmq_queue_http_eqct_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_http/rabbitmq_queue_http_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_http_regex_vhost/rabbitmq_queue_http_regex_vhost_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_http_dget/rabbitmq_queue_http_dget_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_amqp/rabbitmq_queue_amqp_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_amqp_vhost/rabbitmq_queue_amqp_vhost_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_amqp_auth/rabbitmq_queue_amqp_auth_test.go, has passed after "one" attempts
	Execution of tests/scalers/rabbitmq/rabbitmq_queue_http_auth/rabbitmq_queue_http_auth_test.go, has passed after "one" attempts

[wozniakjan]

/run-e2e rabbit
Update: You can check the progress here

[mgs2]

@zroubalik, @wozniakjan,
While this feature got merged into upstream some time ago, the docs regarding RabbitMQ scaler are still out of date. Can any of you take a look at kedacore/keda-docs#1601, please?

[JorTurFer]

Thanks for the heads up, I think that my colleagues missed the docs part, sorry :(

Could you rebase docs and apply the change also to v2.19?