[SC-8240] Add warning message for unregistered tests in template

[juanmleng]

Internal Notes for Reviewers

Added a new method _check_result_id_exists() that scans all sections in the documentation template to verify if a test result ID already exists anywhere in the document. This helper method:

• Checks for duplicate test results across all sections
• Logs an info message when a test result ID is not found in any section

External Release Notes

[cachafla]

Nice 👌

[github-actions]

PR Summary

This pull request introduces enhancements to the TestResult class in the validmind library. The key changes include:

1. Client Config Caching: A new class-level attribute _client_config_cache is added to cache the client configuration. The method _get_client_config is introduced to manage this cache. It reloads the API client and caches the client configuration if it is not already cached. This method also includes validation to ensure the client configuration is correctly loaded and contains the necessary attributes.

2. Result ID Existence Check: A new method check_result_id_exist is added to verify if a result_id exists in any test block across all sections of the client configuration's documentation template. This method logs an informational message if the result_id does not exist.

3. Integration with Existing Methods: The log method now calls check_result_id_exist to ensure the result_id is validated before proceeding with logging operations.

These changes aim to improve the efficiency and reliability of the TestResult class by reducing redundant API client reloads and ensuring the integrity of result logging.

Test Suggestions

• Test the caching mechanism by calling _get_client_config multiple times and ensure the API client is reloaded only once.
• Verify that check_result_id_exist correctly identifies existing and non-existing result_id values in the client configuration.
• Test the log method to ensure it correctly integrates the check_result_id_exist method and handles both valid and invalid result_id scenarios.
• Ensure that exceptions are raised appropriately when the client configuration is invalid or missing required attributes.