docs: modify changelog and test cases descriptions

wazuh · Aug 14, 2023 · bcc8e01 · bcc8e01
1 parent 522cdcf
commit bcc8e01
Show file tree

Hide file tree

Showing 5 changed files with 38 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ Release report: TBD
 
 ### Added
 
+- Add new test cases for the `discard_regex` functionality of `CloudWatchLogs` and `Inspector` services. ([#4278](https://github.com/wazuh/wazuh-qa/pull/4278)) \- (Tests)
 - Add Windows location wildcards tests ([#4263](https://github.com/wazuh/wazuh-qa/pull/4263)) \- (Tests + Framework)
 - New 'SCA' test suite and framework. ([#3566](https://github.com/wazuh/wazuh-qa/pull/3566)) \- (Framework + Tests)
 - Add integration tests for AWS module. ([#3911](https://github.com/wazuh/wazuh-qa/pull/3911)) \- (Framework + Tests + Documentation)
@@ -23,7 +24,6 @@ Release report: TBD
 - Add new module to support migration tool. ([#3837](https://github.com/wazuh/wazuh-qa/pull/3837))
 - Add IT tests FIM registry monitoring using wildcards. ([#4270](https://github.com/wazuh/wazuh-qa/pull/4270)) \- (Framework + Tests)
 - Update schema database version ([#4128](https://github.com/wazuh/wazuh-qa/pull/4128)) \- (Tests)
-- Add new test cases for the `discard_regex` functionality of `CloudWatchLogs` and `Inspector` services. ([#4278](https://github.com/wazuh/wazuh-qa/pull/4278)) - (Tests)
 
 ### Changed
 

diff --git a/...st_aws/data/test_cases/discard_regex_test_module/cases_cloudwatch_discard_regex_json.yaml b/...st_aws/data/test_cases/discard_regex_test_module/cases_cloudwatch_discard_regex_json.yaml
@@ -1,5 +1,7 @@
 - name: cloudwatch_discard_regex_json
-  description: CloudWatch discard regex configuration for JSON logs
+  description: >
+    CloudWatch configuration for an event being discarded when the regex matches
+    the content in the specified field inside the incoming JSON log
   configuration_parameters:
     SERVICE_TYPE: cloudwatchlogs
     LOG_GROUP_NAME: wazuh-cloudwatchlogs-integration-tests

diff --git a/...data/test_cases/discard_regex_test_module/cases_cloudwatch_discard_regex_simple_text.yaml b/...data/test_cases/discard_regex_test_module/cases_cloudwatch_discard_regex_simple_text.yaml
@@ -1,5 +1,7 @@
 - name: cloudwatch_discard_regex_simple_text
-  description: CloudWatch discard regex configuration for simple text logs
+  description: >
+    CloudWatch configuration for an event being discarded when the regex matches
+    the content inside the incoming simple text log
   configuration_parameters:
     SERVICE_TYPE: cloudwatchlogs
     LOG_GROUP_NAME: wazuh-cloudwatchlogs-integration-tests

diff --git a/...ion/test_aws/data/test_cases/discard_regex_test_module/cases_inspector_discard_regex.yaml b/...ion/test_aws/data/test_cases/discard_regex_test_module/cases_inspector_discard_regex.yaml
@@ -1,5 +1,7 @@
 - name: inspector_discard_regex
-  description: Inspector discard regex configurations
+  description: >
+    Inspector configuration for an event being discarded when the regex matches
+    the content in the specified field inside the incoming JSON log
   configuration_parameters:
     SERVICE_TYPE: inspector
     REGIONS: us-east-1

diff --git a/tests/integration/test_aws/test_discard_regex.py b/tests/integration/test_aws/test_discard_regex.py
@@ -34,7 +34,9 @@ def test_bucket_discard_regex(
         configure_local_internal_options_function, truncate_monitored_files, restart_wazuh_function, file_monitoring,
 ):
     """
-    description: Fetch logs excluding the ones that match with the regex.
+    description: Check that some bucket logs are excluded when the regex and field defined in <discard_regex>
+                 match an event.
+
     test_phases:
         - setup:
             - Load Wazuh light configuration.
@@ -51,7 +53,9 @@ def test_bucket_discard_regex(
             - Truncate wazuh logs.
             - Restore initial configuration, both ossec.conf and local_internal_options.conf.
             - Delete the uploaded file
+
     wazuh_min_version: 4.6.0
+
     parameters:
         - configuration:
             type: dict
@@ -80,10 +84,12 @@ def test_bucket_discard_regex(
         - file_monitoring:
             type: fixture
             brief: Handle the monitoring of a specified file.
+
     assertions:
         - Check in the log that the module was called with correct parameters.
         - Check the expected number of events were forwarded to analysisd.
         - Check the database was created and updated accordingly.
+
     input_description:
         - The `configuration_bucket_discard_regex` file provides the module configuration for this test.
         - The `cases_bucket_discard_regex` file provides the test cases.
@@ -159,7 +165,9 @@ def test_cloudwatch_discard_regex_json(
         configure_local_internal_options_function, truncate_monitored_files, restart_wazuh_function, file_monitoring,
 ):
     """
-    description: Fetch logs excluding the ones that match with the regex.
+    description: Check that some CloudWatch JSON logs are excluded when the regex and field defined in <discard_regex>
+                 match an event.
+
     test_phases:
         - setup:
             - Load Wazuh light configuration.
@@ -176,7 +184,9 @@ def test_cloudwatch_discard_regex_json(
             - Truncate wazuh logs.
             - Restore initial configuration, both ossec.conf and local_internal_options.conf.
             - Delete the uploaded file
+
     wazuh_min_version: 4.6.0
+
     parameters:
         - configuration:
             type: dict
@@ -205,10 +215,12 @@ def test_cloudwatch_discard_regex_json(
         - file_monitoring:
             type: fixture
             brief: Handle the monitoring of a specified file.
+
     assertions:
         - Check in the log that the module was called with correct parameters.
         - Check the expected number of events were forwarded to analysisd.
         - Check the database was created and updated accordingly.
+
     input_description:
         - The `configuration_cloudwatch_discard_regex` file provides the module configuration for this test.
         - The `cases_cloudwatch_discard_regex` file provides the test cases.
@@ -280,7 +292,9 @@ def test_cloudwatch_discard_regex_simple_text(
         configure_local_internal_options_function, truncate_monitored_files, restart_wazuh_function, file_monitoring,
 ):
     """
-    description: Fetch logs excluding the ones that match with the regex.
+    description: Check that some CloudWatch simple text logs are excluded when the regex defined in <discard_regex>
+                 matches an event.
+
     test_phases:
         - setup:
             - Load Wazuh light configuration.
@@ -297,7 +311,9 @@ def test_cloudwatch_discard_regex_simple_text(
             - Truncate wazuh logs.
             - Restore initial configuration, both ossec.conf and local_internal_options.conf.
             - Delete the uploaded file
+
     wazuh_min_version: 4.6.0
+
     parameters:
         - configuration:
             type: dict
@@ -326,10 +342,12 @@ def test_cloudwatch_discard_regex_simple_text(
         - file_monitoring:
             type: fixture
             brief: Handle the monitoring of a specified file.
+
     assertions:
         - Check in the log that the module was called with correct parameters.
         - Check the expected number of events were forwarded to analysisd.
         - Check the database was created and updated accordingly.
+
     input_description:
         - The `configuration_cloudwatch_discard_regex_simple_text` file provides
         the module configuration for this test.
@@ -399,7 +417,9 @@ def test_inspector_discard_regex(
         configure_local_internal_options_function, truncate_monitored_files, restart_wazuh_function, file_monitoring,
 ):
     """
-    description: Fetch logs excluding the ones that match with the regex.
+    description: Check that some Inspector logs are excluded when the regex and field defined in <discard_regex>
+                 match an event.
+
     test_phases:
         - setup:
             - Load Wazuh light configuration.
@@ -416,7 +436,9 @@ def test_inspector_discard_regex(
             - Truncate wazuh logs.
             - Restore initial configuration, both ossec.conf and local_internal_options.conf.
             - Delete the uploaded file
+
     wazuh_min_version: 4.6.0
+
     parameters:
         - configuration:
             type: dict
@@ -445,10 +467,12 @@ def test_inspector_discard_regex(
         - file_monitoring:
             type: fixture
             brief: Handle the monitoring of a specified file.
+
     assertions:
         - Check in the log that the module was called with correct parameters.
         - Check the expected number of events were forwarded to analysisd.
         - Check the database was created and updated accordingly.
+
     input_description:
         - The `configuration_inspector_discard_regex` file provides the module configuration for this test.
         - The `cases_inspector_discard_regex` file provides the test cases.