+
+ + wazuh-pipeline +
+
+ + Key Features • + How To Use • + What are the tests? • + Organizing Tests • + Test Syntax • + Related • + License +
+ +## Key Features + +* Test Decoders + - Verify that your decoders are extracting info from logs. + +* Test Rules + - Ensure that the correct rules alert on logs. + +* Maintain Rulesets Easily + +* Catch Errors Early + +* Prevent Regression + +## Quickstart (Public) + +1. Fork this repository and only copy the main branch + + + + + +2. Configure the three following Action secrets: + + * `DOCKER_IMAGE` - The docker image used for testing. Publicly supported docker image: `alexchristy/wazuh-test-pipeline` + * `DOCKER_USERNAME` - Username for the docker account pulling the docker image. Ex: `user@example.com` + * `DOCKER_PASSWORD` - Password for the docker account pulling the docker image. + + + +3. Enable GitHub Actions + + + +4. Done! + +You can now start creating pull requests or committing directly to main and see the tests run automatically. However, due to the nature of forked repositories, you repository will always be public. If this is an issue, follow the steps for a private repoistory setup. + +## Private Setup + +*This section is for the people people who need to run this pipeline in a private repository.* + + + +1. [Create a new private repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-new-repository) in GitHub. + + > **Note:** Ensure that the repository is **NOT** initialized with a README.md or any other files. + +2. Create a fine-grained [GitHub token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) for the next step. + + The token should only have access to the new private repository we just created. + + Required Repository permissions: + * Pull requests (Read-only) + * Metadata (Read-only) + * Contents (Read-only) + +3. Configure the GitHub Action secrets, from step 2 in the [Quickstart](#quickstart-public) and an additional secret called `TOKEN` with the value of the token created in the previous step. + +4. Clone this repository. + + ```bash + git clone --bare https://github.com/alexchristy/wazuh-pipeline + ``` + +5. Enter directory. + + ```bash + cd wazuh-pipeline.git + ``` + +5. Add a new remote + + ```bash + git remote add private {NEW_REPO_URL} + ``` + +6. Push main branch to new repository + + ```bash + git push private main + ``` + +7. Finished! + + Pushing the main branch will kick off the CI pipeline which should run the default tests. If it passes then the repository is ready for use. If it fails then the repository is not functional and an issue should be filed with the GitHub Action log. + + >**Note:** If this step is failing ensure that the account you are using has proper access to the new repository. + +## Related + +[wazuh-pipeline](https://github.com/alexchristy/wazuh-pipeline) - Wazuh CI pipeline that leverages this tool + +## License + +GNU General Public License v3.0 \ No newline at end of file