Review the wazuh-tools repository for relevant code to migrate

[QU3B1M]

Main issue
#5527

Description

Analyze the content of the repository wazuh-tools, detect and document the code pertinent to migrate to the new QA repository.

Tasks

• Review the wazuh-tools repository
• Detect the code belonging to the QA team
• Identify relevant code for migration to the new QA repository
• Document a proposal for migration with a possible directory structure

Task Conclusion

Review the repository

wazuh-tools repository contains a lot of scripts and tools that belongs to different teams. The QA team has some outdated scripts and some that are still in use, this code must be migrated to the new QA repository.

Detect the code belonging to the QA team

The QA team only own a few directories in the wazuh-tools repository, so the mandatory migration from wazuh-tools to the new QA repo wont be a big task. The following is a list of directories owned by the QA team:

• footprint/sca: This directory contains the footprint tests owned by the QA team.
• documentation-scripts/: This directory contains the tests for the documentation redirects. The QA team does not fully own this.

Identify relevant code for migration to the new QA repository

As mentioned previously, only a few directories are owned by the QA team. But more directories could be useful for the QA team. The following is a list of directories owned by QA that must be migrated along with other directories that could be useful for the QA team, at least the idea of the approach:

Mandatories refactor and migration

• footprint/sca: Current sca footprint tests. Must be migrated alongside the rest of the stress tests used for footprint that resides on wazuh-jenkins

Possible content to use as a reference for new approaches.

• cluster_docker: This directory contains deployment tests for the wazuh-cluster. It is outdated but the tests can be used as a reference for the new QA repository.
• documentation-scripts/check-redirects: Tests for the documentation redirects. Outdated but could be refactored
• documentation-scripts/visual-test: Visual tests for the documentation, could be used as a reference for the new QA repository.
• indexer_benchmarks: Indexer benchmarks, it does not belong to QA, but we could implement something similar in our new QA repository.
• testing/performance: Performance tests owned by Core team. We could implement something similar in our new QA repository.
• utils/enrollment-bench.py: Enrollment benchmark, not owned by QA but the idea could be useful for the new QA repository.

Document a proposal for migration with a possible directory structure

The identified relevant code for a migration could be organized into two groups, non-functional tests and benchmarks (documentation tests could also be moved to a group of their own), taking this in mind, the following is a proposal for the new QA repository directory structure:

[qa-repo]
│
├── non_functional_tests
│   ├── stress_tests
│   │   └── sca_test
│   ├── performance_tests
│   └── documentation_tests
│       ├── redirects_test
│       └── visual_test
└── benchmarks
    ├── indexer_benchmark
    └── enrollment_benchmark

[QU3B1M]

Update report

• Review the wazuh-tools repository. Done
• Detect the code belonging to the QA team. Done
• Identify relevant code for migration to the new QA repository. Done
• Document a proposal for migration with a possible directory structure. WIP

[damarisg]

Review

According to what was analyzed and proposed, we should migrate only "footprint/sca" and improve it, but nothing about the rest. The proposed proposal will remain in the epic of definition.