feat(anta): Limit concurrency

[carl-baillargeon]

Description

This PR improves the test runner by introducing a generator-based approach for managing test coroutines and setting a configurable limit on the number of concurrent tests.

• Instead of loading all test coroutines into a list, the runner now uses a generator to yield tests. This approach prevents memory overload and improves performance when dealing with a large number of tests.

• A limit on the number of concurrent tests is introduced to avoid overwhelming the runner. This limit is configurable with an environement variable (hidden).

Implementation:
The generator yields test coroutines, ensuring that only a limited number of tests are scheduled and run concurrently.
Upon reaching the concurrency limit, the runner waits for some tests to complete before scheduling new ones from the generator.

Checklist:

• Update FAQ to reference Scaling ANTA documentation
• Update Scaling ANTA documentation - Add numbers @dlobato
• Add section on JSON catalogs vs YAML (faster)
• Need to retest on digital twin @dlobato
• Update benchmark + unit tests
• ci: add codspeed to benchmark ANTA #826
• Confirm that the number of open file descriptors never exceed device * max_connections (100 by default)

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.

[github-actions]

Conflicts have been resolved. A maintainer will review the pull request shortly.

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
84.8% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.

[github-actions]

Conflicts have been resolved. A maintainer will review the pull request shortly.

[codspeed-hq]

CodSpeed Performance Report

Merging #680 will not alter performance

_{Comparing carl-baillargeon:refactor/runner_limit (0919b20) with main (ec31346)}

Summary

✅ 4 untouched benchmarks

🆕 2 new benchmarks
⁉️ 4 dropped benchmarks

⚠️ Please fix the performance issues or acknowledge them on CodSpeed.

Benchmarks breakdown

	Benchmark	main	carl-baillargeon:refactor/runner_limit	Change
⁉️	test_get_coroutines[1-device]	47.6 ms	N/A	N/A
⁉️	test_get_coroutines[2-devices]	94.2 ms	N/A	N/A
⁉️	test_prepare_tests[1-device]	12.1 ms	N/A	N/A
⁉️	test_prepare_tests[2-devices]	12.2 ms	N/A	N/A
🆕	test_setup_tests[1-device]	N/A	12.1 ms	N/A
🆕	test_setup_tests[2-devices]	N/A	12.1 ms	N/A

[github-actions]

This pull request has conflicts, please resolve those before we can evaluate the pull request.

[github-actions]

Conflicts have been resolved. A maintainer will review the pull request shortly.

[sonarcloud]

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
88.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud