John6797/sc 7792/add raw data to validmind library tests

[johnwalz97]

Internal Notes for Reviewers

Adds raw data to all tests. Also updates test unit tests to expect the new raw data in the tuple returned by the test.

External Release Notes

Adding raw data storage across all of our test library. Every ValidMind test now returns a RawData object which can be used in post-processing functions to recreate any test output. This feature continues the trend towards more flexibility and customizability.

[juanmleng]

Really cool and extremely useful job @johnwalz97! Just left a minor comment. Otherwise looks good to go from my side.

[AnilSorathiya]

Thanks John. LGTM!

[github-actions]

PR Summary

This pull request introduces significant changes to the AI test scripts and unit tests within the project. The primary focus of these changes is the integration of a new RawData mechanism, which allows for the storage and retrieval of intermediate data used in test functions. This enhancement is aimed at improving the post-processing capabilities and providing more detailed insights into the test results.

Key Changes:

1. Removal of add_test_description.py:

   • The script add_test_description.py has been removed, indicating a shift in how test descriptions are managed or generated.

2. Introduction of bulk_ai_test_updates.py:

   • A new script bulk_ai_test_updates.py has been added, which facilitates bulk updates on test files using AI. This script supports actions like adding descriptions and raw data to test files.

3. Enhancements in Test Scripts:

   • Many test scripts have been updated to include the RawData class, which is used to store intermediate data that can be useful for regenerating test results during post-processing.
   • The RawData class is now imported and utilized across various test scripts, ensuring that raw data is captured and returned alongside traditional test outputs like figures and tables.

4. Unit Test Updates:

   • Unit tests have been updated to accommodate the changes in test scripts, particularly the addition of RawData. This includes checking for the presence of RawData in test results and verifying its contents.
   • New unit tests have been added to ensure the correct functionality of the RawData integration.

5. Refactoring and Code Quality Improvements:

   • The codebase has undergone refactoring to improve readability and maintainability. This includes reorganization of imports, removal of redundant code, and adherence to coding standards.

6. Security and Dependency Management:

   • The changes include updates to ensure that all necessary dependencies are correctly imported and utilized, reducing the risk of runtime errors and improving the overall security posture of the codebase.

Test Suggestions

• Verify that all test scripts correctly return RawData objects where applicable.
• Ensure that unit tests for each modified test script check for the presence and correctness of RawData.
• Run integration tests to confirm that the new bulk_ai_test_updates.py script functions as expected for different actions.
• Test the removal of add_test_description.py to ensure no functionality is broken.
• Check for any performance impacts due to the addition of RawData in test scripts.