Coding style fixed and comments added

tests/integration/test_logtest/test_log_process_options/data/rules_verbose.yaml

@@ -1,72 +1,72 @@
 ---
 -
-  name: "Omited rule debug"
+  name: 'The rules_debug field is omitted'
   rule_file: 'rules_verbose.xml'
   rule_id: '880002'
   input: '{"version":1,"origin":{"name":"Integration Test","module":"api"},"command":"log_processing","parameters":{"event": "{\"it_logtest\" : \"rules_verbose\", \"test\": \"last_match\", \"test_child\" : \"ok\"}","log_format": "syslog","location": "master->/var/log/syslog"}}'
 -
-  name: "Rule debug true"
+  name: 'The rules_debug field is set to true'
   rule_file: 'rules_verbose.xml'
   rule_id: '880001'
   input: '{"version":1,"origin":{"name":"Integration Test","module":"api"},"command":"log_processing","parameters":{"event": "{\"it_logtest\" : \"rules_verbose\", \"test\": \"last_match\"}","log_format": "syslog","location": "master->/var/log/syslog","options":{"rules_debug":true}}}'
   verbose_mode: True
 -
-  name: "Rule debug false"
+  name: 'The rules_debug field is set to false'
   rule_file: 'rules_verbose.xml'
   rule_id: '880001'
   input: '{"version":1,"origin":{"name":"Integration Test","module":"api"},"command":"log_processing","parameters":{"event": "{\"it_logtest\" : \"rules_verbose\", \"test\": \"last_match\"}","log_format": "syslog","location": "master->/var/log/syslog","options":{"rules_debug":false}}}'
   verbose_mode: False
 -
-  name: "Rule debug bad type (string)"
+  name: 'The rules_debug field is set to a bad type (string)'
   rule_file: 'rules_verbose.xml'
   rule_id: '880001'
   input: '{"version":1,"origin":{"name":"Integration Test","module":"api"},"command":"log_processing","parameters":{"event": "{\"it_logtest\" : \"rules_verbose\", \"test\": \"last_match\"}","log_format": "syslog","location": "master->/var/log/syslog","options":{"rules_debug":"true"}}}'
   verbose_mode: False
   warning_message: "WARNING: \\(\\d+\\): 'rules_debug' field must be a boolean. The parameter will be ignored"
 -
-  name: "Rule debug bad type (number)"
+  name: 'The rules_debug field is set to a bad type (number)'
   rule_file: 'rules_verbose.xml'
   rule_id: '880001'
   input: '{"version":1,"origin":{"name":"Integration Test","module":"api"},"command":"log_processing","parameters":{"event": "{\"it_logtest\" : \"rules_verbose\", \"test\": \"last_match\"}","log_format": "syslog","location": "master->/var/log/syslog","options":{"rules_debug":123}}}'
   verbose_mode: False
   warning_message: "WARNING: \\(\\d+\\): 'rules_debug' field must be a boolean. The parameter will be ignored"
 -
-  name: "Rule debug bad type (object)"
+  name: 'The rules_debug field is set to a bad type (object)'
   rule_file: 'rules_verbose.xml'
   rule_id: '880001'
   input: '{"version":1,"origin":{"name":"Integration Test","module":"api"},"command":"log_processing","parameters":{"event": "{\"it_logtest\" : \"rules_verbose\", \"test\": \"last_match\"}","log_format": "syslog","location": "master->/var/log/syslog","options":{"rules_debug":{"test":"true"}}}}'
   verbose_mode: False
   warning_message: "WARNING: \\(\\d+\\): 'rules_debug' field must be a boolean. The parameter will be ignored"
 -
-  name: "Rule debug bad type (array)"
+  name: 'The rules_debug field is set to a bad type (array)'
   rule_file: 'rules_verbose.xml'
   rule_id: '880001'
   input: '{"version":1,"origin":{"name":"Integration Test","module":"api"},"command":"log_processing","parameters":{"event": "{\"it_logtest\" : \"rules_verbose\", \"test\": \"last_match\"}","log_format": "syslog","location": "master->/var/log/syslog","options":{"rules_debug":["true", "false"]}}}'
   verbose_mode: False
   warning_message: "WARNING: \\(\\d+\\): 'rules_debug' field must be a boolean. The parameter will be ignored"
 -
-  name: "options bad type (boolean)"
+  name: 'The options field is set to a bad type (boolean)'
   rule_file: 'rules_verbose.xml'
   rule_id: '880001'
   input: '{"version":1,"origin":{"name":"Integration Test","module":"api"},"command":"log_processing","parameters":{"event": "{\"it_logtest\" : \"rules_verbose\", \"test\": \"last_match\"}","log_format": "syslog","location": "master->/var/log/syslog","options":true}}'
   verbose_mode: False
   warning_message: "WARNING: \\(\\d+\\): 'options' field must be a JSON object. The parameter will be ignored"
 -
-  name: "options bad type (array)"
+  name: 'The options field is set to a bad type (array)'
   rule_file: 'rules_verbose.xml'
   rule_id: '880001'
   input: '{"version":1,"origin":{"name":"Integration Test","module":"api"},"command":"log_processing","parameters":{"event": "{\"it_logtest\" : \"rules_verbose\", \"test\": \"last_match\"}","log_format": "syslog","location": "master->/var/log/syslog","options":["true", "false"]}}'
   verbose_mode: False
   warning_message: "WARNING: \\(\\d+\\): 'options' field must be a JSON object. The parameter will be ignored"
 -
-  name: "options bad type (number)"
+  name: 'The options field is set to a bad type (number)'
   rule_file: 'rules_verbose.xml'
   rule_id: '880001'
   input: '{"version":1,"origin":{"name":"Integration Test","module":"api"},"command":"log_processing","parameters":{"event": "{\"it_logtest\" : \"rules_verbose\", \"test\": \"last_match\"}","log_format": "syslog","location": "master->/var/log/syslog","options":123456}}'
   verbose_mode: False
   warning_message: "WARNING: \\(\\d+\\): 'options' field must be a JSON object. The parameter will be ignored"
 -
-  name: "options bad type (string)"
+  name: 'The options field is set to a bad type (string)'
   rule_file: 'rules_verbose.xml'
   rule_id: '880001'
   input: '{"version":1,"origin":{"name":"Integration Test","module":"api"},"command":"log_processing","parameters":{"event": "{\"it_logtest\" : \"rules_verbose\", \"test\": \"last_match\"}","log_format": "syslog","location": "master->/var/log/syslog","options":"true"}}'

tests/integration/test_logtest/test_log_process_options/test_rules_verbose.py

@@ -10,8 +10,6 @@
 import pytest
 import yaml
 from wazuh_testing.tools import WAZUH_PATH
-from wazuh_testing.tools.configuration import set_section_wazuh_conf
-import wazuh_testing.tools.configuration as conf
 
 
 # Marks
@@ -37,8 +35,7 @@ def configure_rules_list(get_configuration, request):
     """
 
     # save current rules
-    shutil.copy('/var/ossec/etc/rules/local_rules.xml',
-                '/var/ossec/etc/rules/local_rules.xml.cpy')
+    shutil.copy('/var/ossec/etc/rules/local_rules.xml', '/var/ossec/etc/rules/local_rules.xml.cpy')
 
     file_test = get_configuration['rule_file']
     # copy test rules
@@ -60,8 +57,11 @@ def get_configuration(request):
 
 # Tests
 def test_rules_verbose(get_configuration, configure_rules_list, connect_to_sockets_function):
-    """Check that every test case run on logtest generates the adequate output """
+    """
+    Check that every input message in logtest socket generates the adequate output
 
+    This tests is designed to verify the correct logtest behaviour related to the 'rules_debug' request field
+    """
     # send the logtest request
     receiver_sockets[0].send(get_configuration['input'], size=True)
 
@@ -74,20 +74,20 @@ def test_rules_verbose(get_configuration, configure_rules_list, connect_to_socke
 
     if 'verbose_mode' in get_configuration and get_configuration['verbose_mode'] is True:
         if 'rules_debug' in result['data']:
-            assert result['data']['rules_debug'][-7] == "Trying rule: 880000 - Parent rules verbose"
-            assert result['data']['rules_debug'][-6] == "*Rule 880000 matched"
-            assert result['data']['rules_debug'][-5] == "*Trying child rules"
-            assert result['data']['rules_debug'][-4] == "Trying rule: 880001 - test last_match"
-            assert result['data']['rules_debug'][-3] == "*Rule 880001 matched"
-            assert result['data']['rules_debug'][-2] == "*Trying child rules"
-            assert result['data']['rules_debug'][-1] == "Trying rule: 880002 - test_child test_child"
+            assert result['data']['rules_debug'][-7] == 'Trying rule: 880000 - Parent rules verbose'
+            assert result['data']['rules_debug'][-6] == '*Rule 880000 matched'
+            assert result['data']['rules_debug'][-5] == '*Trying child rules'
+            assert result['data']['rules_debug'][-4] == 'Trying rule: 880001 - test last_match'
+            assert result['data']['rules_debug'][-3] == '*Rule 880001 matched'
+            assert result['data']['rules_debug'][-2] == '*Trying child rules'
+            assert result['data']['rules_debug'][-1] == 'Trying rule: 880002 - test_child test_child'
         else:
-            assert False, "The rules_debug filed was not found in the response data"
+            assert False, 'The rules_debug filed was not found in the response data'
 
     else:
         assert 'rules_debug' not in result['data']
 
     if 'warning_message' in get_configuration:
         r = re.compile(get_configuration['warning_message'])
         match_list = list(filter(r.match, result['data']['messages']))
-        assert match_list
+        assert match_list, 'The warning message was not found in the response'