Engine - Development of Test Creation and Execution Tool for Wazuh-Engine Helper Functions

[JcabreraC]

Wazuh version	Component	Install type	Install method	Platform
5.0.0	Engine	Manager	Packages/Sources	OS version

Description

Continuing from Stage 1A, this issue focuses on developing a tool that uses the enhanced YAML files created by the Stage 1A tool to automatically generate necessary testing assets and execute test cases for Wazuh-Engine helper functions. This tool will be crucial for validating the functionality and reliability of helper functions as described by the enhanced YAML configurations.

Objective

• Test Creation and Execution Tool: Develop a tool that reads enhanced YAML configurations and automates the execution of test cases.

Requirements

• Automated Test Generation: The tool should automatically read all necessary for testing each helper function, including input values and expected outcomes based on the enhanced YAML configurations (Output of stage 1A)
• Test Execution: Implement the capability to automatically run the test cases, capture results, and handle exceptions or errors during test execution. In case of error, unibocatively identifying the test case(s) with error(s) and the description of the error.
• Integration with Existing Systems: Ensure that the tool integrates smoothly with the existing Wazuh development environment and testing frameworks.

Tasks

• [x] Develop a tool that can parse enhanced YAML files generated in Stage 1A and create corresponding test assets, such as mock data, configuration files, and test scripts.
• [x] Implement functionality within the tool to execute these test cases, ensuring that each helper function is tested against its described behavior and expected results.
• [x] Create mechanisms within the tool to log test outcomes, track failures, and provide detailed reports on the test executions.
• [x] Ensure that the tool can update any necessary policy or asset configurations required for the proper testing of the helper functions.

Testing Criteria

• Comprehensive Test Coverage: Verify that the tool can generate and execute test cases that cover all described scenarios within the enhanced YAML files.
• Accuracy and Reliability: Ensure that the tool accurately executes tests and reliably reports outcomes, including handling edge cases and potential errors.
• Integration Validation: Test the integration of the tool with the existing Wazuh development and testing environments to ensure seamless operations and interactions.

Notes

Stage 1B is a critical component of our testing framework, as it directly impacts our ability to verify the functionality and reliability of Wazuh-Engine helper functions automatically. The development of this tool must focus on robustness, accuracy, and ease of integration to support continuous development and testing efforts effectively.

[NahuFigueroa97]

Update:

builder map:

• I build the environment to build test
• I build the environment to run test

[NahuFigueroa97]

Update:

builder filter and transformation:

• I build the environment to build test
• I build the environment to run test

[NahuFigueroa97]

Update:

• Change asset_create for update
• Add more tests cases
• Create PR