Prepare qa-ctl tool release v0.2

[jmv74211]

We want to release the v0.2 of the qa-ctl tool. For this purpose, it is proposed to make the last improvements to the tool and to proceed with the testing and the necessary checks to verify the correct operation.

Required tasks

• Update the qa-ctl documentation according to new changes.
• Finish the qa-ctl v0.2 development.
• Review PEP-8 code style
• Update qa-ctl changelog
• Review qa-ctl version and revision

Fixes

• Fix qa-ctl tool error execution #2182
• Fix qa-ctl windows manager error #2183
• Fix check host connection step error #2190

Run checks

Linux

• Automatic mode
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release
• Automatic mode with debug level 1
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release -d
• Automatic mode with debug level 2
  qa-ctl -r test_general_setting_enabled --qa-branch 2173-qa-ctl-v2-release -dd
• Automatic mode with persistent environment
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release -p
• Manual mode skipping deployment and provisioning
  qa-ctl -c config.yaml --qa-branch 2173-qa-ctl-v2-release --skip-deployment --skip-provisioning
• Manual mode with several instances and testing (Check parallelism).
  qa-ctl -c config.yaml --qa-branch 2173-qa-ctl-v2-release
• Automatic mode with custom Wazuh version
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release -v 4.2.0
• Dry-run mode
  qa-ctl -r test_general_settings_enabled --dry-run
• Launch a Windows test
  qa-ctl -r test_registry_restrict --qa-branch 2173-qa-ctl-v2-release
• Launch a test in centos and windows (multiple systems)
  qa-ctl -r test_basic_usage_move_file --qa-branch 2173-qa-ctl-v2-release --os centos windows

Note: For each of the above checks it is necessary to verify that the expected result is generated, the artifacts are correct and the logs show an execution according to the parameters entered.

Windows

• Automatic mode
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release
• Automatic mode with debug level 1
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release -d
• Automatic mode with debug level 2
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release -dd
• Automatic mode with persistent environment
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release -p
• Manual mode skipping deployment and provisioning
  qa-ctl -c config.yaml --qa-branch 2173-qa-ctl-v2-release --skip-deployment --skip-provisioning
• Manual mode with several instances and testing (Check parallelism).
  qa-ctl -c config.yaml --qa-branch 2173-qa-ctl-v2-release
• Automatic mode with custom Wazuh version
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release -v 4.2.0
• Dry-run mode
  qa-ctl -r test_general_settings_enabled --dry-run
• Launch a Windows test
  qa-ctl -r test_registry_restrict --qa-branch 2173-qa-ctl-v2-release
• Launch a test in centos and windows (multiple systems)
  qa-ctl -r test_basic_usage_move_file --qa-branch 2173-qa-ctl-v2-release --os centos windows

Note: For each of the above checks it is necessary to verify that the expected result is generated, the artifacts are correct and the logs show an execution according to the parameters entered.

Generic tests

• Run test_cors
qa-ctl -r test_cors --qa-branch 2173-qa-ctl-v2-release
• Run test_execd_restart
qa-ctl -r test_execd_restart --qa-branch 2173-qa-ctl-v2-release
• Run test_cache
qa-ctl -r test_cache --qa-branch 2173-qa-ctl-v2-release
• Run test_execd_firewall_drop
qa-ctl -r test_execd_firewall_drop --qa-branch 2173-qa-ctl-v2-release
• Run test_basic_usage_baseline_generation
qa-ctl -r test_basic_usage_baseline_generation --qa-branch 2173-qa-ctl-v2-release
• Run test_agentd_reconnection
qa-ctl -r test_agentd_reconnection --qa-branch 2173-qa-ctl-v2-release
• Run test_duplicate_entries
qa-ctl -r test_duplicate_entries --qa-branch 2173-qa-ctl-v2-release
• Run test_basic_usage_create_scheduled
qa-ctl -r test_basic_usage_create_scheduled --qa-branch 2173-qa-ctl-v2-release
• Run test_ignore
qa-ctl -r test_ignore --qa-branch 2173-qa-ctl-v2-release

Invalid qa-ctl script parameters

• Automatic and manual mode together
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release -c config.yaml
• --version parameter can be only run in automatic mode
  qa-ctl -c config.yaml --qa-branch 2173-qa-ctl-v2-release -v 4.2.2
• --dry-run parameter can only be used in automatic mode
  qa-ctl -c config.yaml --qa-branch 2173-qa-ctl-v2-release --dry-run
• --skip-deployment parameter can only be used in manual mode
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release --skip-deployment
• --skip-provisioning parameter can only be used in manual mode
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release --skip-provisioning
• --skip-testing parameter can only be used in manual mode
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release --skip-testing
• Bad --version format parameter.
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release --version 4.2
• Bad --version release parameter.
  qa-ctl -r test_general_settings_enabled --qa-branch 2173-qa-ctl-v2-release --version 4.1.10
• Bad --qa-branch parameter. It does not exists on remote repository.
  qa-ctl -r test_general_settings_enabled --qa-branch bad-branch
• Bad test name. It does not exists on remote repository.
  qa-ctl -r bad_test_name --qa-branch 2173-qa-ctl-v2-release
• Run a test in auto mode that is not documented
  qa-ctl -r test_wpk_manager --qa-branch 2173-qa-ctl-v2-release
• Run a manager test in Windows system
  qa-ctl -r test_wpk_manager --qa-branch 2173-qa-ctl-v2-release --os windows