Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Engine - Integration of Automated Tests with GitHub Actions for Wazuh-Engine Helper Functions #23404

Closed
4 of 5 tasks
JcabreraC opened this issue May 14, 2024 · 2 comments · Fixed by #23424
Closed
4 of 5 tasks

Comments

@JcabreraC
Copy link
Member

JcabreraC commented May 14, 2024

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

Description

This issue is the next critical step in our multi-stage effort to enhance the testing framework for Wazuh-Engine's helper functions. Following the development of test generation and execution tools in Stages 1A and 1B, Stage 2 focuses on automating the execution of these tests through GitHub Actions. This integration aims to streamline the testing process, ensuring continuous validation and feedback during the development lifecycle.

Objective

  • Continuous Integration Setup: Configure GitHub Actions to automatically run the tests developed in the previous stages, providing timely feedback on code changes and maintaining code quality.

Requirements

  • Automation of Test Execution: Set up GitHub Actions to trigger the automated test suite whenever changes are pushed to the repository.
  • Result Reporting: Configure the CI process to report test results, making them easily accessible to developers for review.
  • Resilience and Scalability: Ensure the GitHub Actions setup is robust and scalable to handle a potentially large number of tests and integrate smoothly with future enhancements.

Tasks

  • Create GitHub Actions workflows that trigger on code commits and pull requests to key branches of the repository.
  • Configure the workflows to utilize the test generation and execution tool developed in Stage 1B, ensuring all helper function tests are run.
  • Set up mechanisms within the workflows to capture and report test results, including successes, failures, and logs.
  • Implement error handling within the GitHub Actions to manage test failures and other exceptions gracefully.
  • Document the setup and configuration of the GitHub Actions workflows, providing guidelines for future modifications and enhancements.

Testing Criteria

  • Reliability of Workflows: Ensure that the GitHub Actions workflows reliably start upon code commits and pull requests.
  • Accuracy of Execution: Verify that the tests are executed correctly and that the results reflect the true state of the code.
  • Effectiveness of Reporting: Confirm that test results are reported clearly and accessibly, allowing developers to easily understand and act on the feedback.
  • Error Handling: Test the error-handling capabilities of the workflows to ensure that exceptions and failures are managed appropriately.

Notes

The successful integration of GitHub Actions is a foundational component of our strategy to enforce quality and efficiency in the development process. This stage not only automates the execution of tests but also enhances the feedback loop to developers, crucial for maintaining high standards in code quality and functionality.

@JcabreraC JcabreraC changed the title Engine Stage 2: Integration of Automated Tests with GitHub Actions for Wazuh-Engine Helper Functions Engine - Stage 2: Integration of Automated Tests with GitHub Actions for Wazuh-Engine Helper Functions May 14, 2024
@JcabreraC JcabreraC changed the title Engine - Stage 2: Integration of Automated Tests with GitHub Actions for Wazuh-Engine Helper Functions Engine - Integration of Automated Tests with GitHub Actions for Wazuh-Engine Helper Functions May 14, 2024
@NahuFigueroa97
Copy link
Member

Update:

  • Add helpers functions tests to github actions
  • Add more inputs files for helpers of type map, filter and transform

@NahuFigueroa97
Copy link
Member

Update:

  • Fix helper functions tests for success running in github actions
  • PR in review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants