logtest docs updated

wazuh · Jul 1, 2021 · e9d2e23 · e9d2e23
1 parent c40eaac
commit e9d2e23
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 78 deletions.
diff --git a/docs/tests/integration/test_logtest/index.md b/docs/tests/integration/test_logtest/index.md
@@ -38,24 +38,28 @@ Check if `wazuh-logtest` correctly detects and handles errors when using a token
 Check if `wazuh-logtest` correctly detects and removes the sessions under
 pre-defined scenarios.
 
+#### Test remove old sessions
+
+- **[Test remove old sessions](test_remove_old_sessions/test_remove_old_sessions.md)**:
+Check that `wazuh-logtest` correctly detects and handles the situation where trying
+to use more sessions than allowed and then the oldest session is released.
+
+- **[Test remove old session for inactivity](test_remove_old_sessions/test_remove_old_session_for_inactivity.md)**:
+Check that `wazuh-logtest` correctly detects and handles the situation where trying
+to use more sessions than allowed and then old sessions are released due to
+inactivity.
+
 #### Test rules decoders load
 
 - **[Test load rules decoders](test_rules_decoders_load/test_load_rules_decoders.md)**:
 Check if `wazuh-logtest` produce the correct rule/decoder matching.
 
 #### Test invalid rule decoders syntax
 
-- Check that `logtest` correctly detects and handles errors when processing a
+- **[Test invalid rules syntax](test_invalid_rule_decoders_syntax/test_invalid_rules_syntax.md)**:
+Check that `wazuh-logtest` correctly detects and handles errors when processing a
 rules file.
 
-- Check that `logtest` correctly detects and handles errors when processing a
+- **[Test invalid decoder syntax](test_invalid_rule_decoders_syntax/test_invalid_decoder_syntax.md)**:
+Check that `wazuh-logtest` correctly detects and handles errors when processing a
 decoders file.
-
-#### Test remove old sessions
-
-- Check that `logtest` correctly detects and handles the situation where trying
-to use more sessions than allowed and then the oldest session is released.
-
-- Check that `logtest` correctly detects and handles the situation where trying
-to use more sessions than allowed and then old sessions are released due to
-inactivity.
diff --git a/docs/tests/integration/test_logtest/test_invalid_rule_decoders_syntax/index.md b/docs/tests/integration/test_logtest/test_invalid_rule_decoders_syntax/index.md
diff --git a/...n/test_logtest/test_invalid_rule_decoders_syntax/test_invalid_decoder_syntax.md b/...n/test_logtest/test_invalid_rule_decoders_syntax/test_invalid_decoder_syntax.md
@@ -2,24 +2,21 @@
 
 ## Overview
 
-Checks if...
+Check if `wazuh-logtest` correctly detects and handles errors when processing a decoders file.
 
 ## Objective
 
-- 
+- Confirm that `wazuh-logtest` retrieves errors when the loaded decoders are invalid.
 
 ## General info
 
 |Tier | Total | Time spent |
 | :--:| :--: | :--: |
-| 0 | N | 999s |
-
+| 0 | 11 | 1s |
 
 ## Expected behavior
 
-- 
-- 
-- 
+- Fail if `wazuh-logtest` does not retrieve an error when it should.
 
 ## Code documentation
 

diff --git a/...ion/test_logtest/test_invalid_rule_decoders_syntax/test_invalid_rules_syntax.md b/...ion/test_logtest/test_invalid_rule_decoders_syntax/test_invalid_rules_syntax.md
@@ -2,25 +2,22 @@
 
 ## Overview
 
-Checks if...
+Check if `wazuh-logtest` correctly detects and handles errors when processing a rules file.
 
 ## Objective
 
-- 
+- Confirm that `wazuh-logtest` retrieves errors when the loaded rules are invalid.
 
 ## General info
 
 |Tier | Total | Time spent |
 | :--:| :--: | :--: |
-| 0 | N | 999s |
-
+| 0 | 15 | 9s |
 
 ## Expected behavior
 
-- 
-- 
-- 
+- Fail if `wazuh-logtest` does not retrieve an error when it should.
 
 ## Code documentation
 
-::: tests.integration.test_logtest.test_invalid_rule_decoders_syntax.test_invalid_rules_syntax
+::: tests.integration.test_logtest.test_invalid_rule_decoders_syntax.test_invalid_rules_syntax
diff --git a/docs/tests/integration/test_logtest/test_remove_old_sessions/index.md b/docs/tests/integration/test_logtest/test_remove_old_sessions/index.md
diff --git a/...test_logtest/test_remove_old_sessions/test_remove_old_session_for_inactivity.md b/...test_logtest/test_remove_old_sessions/test_remove_old_session_for_inactivity.md
@@ -2,24 +2,25 @@
 
 ## Overview
 
-Checks if...
+Check if `wazuh-logtest` correctly detects and handles the situation where trying
+to use more sessions than allowed and then old sessions are released due to
+inactivity.
 
 ## Objective
 
-- 
+- Confirm that `wazuh-logtest` removes the inactive sessions after a certain time.
 
 ## General info
 
 |Tier | Total | Time spent |
 | :--:| :--: | :--: |
-| 0 | N | 999s |
-
+| 0 | 1 | 1m 5s |
 
 ## Expected behavior
 
-- 
-- 
-- 
+- Fail if `wazuh-logtest` does not start.
+- Fail if `wazuh-logtest` can not create a new session.
+- Fail if `wazuh-logtest` old session is not removed.
 
 ## Code documentation
 

diff --git a/...s/integration/test_logtest/test_remove_old_sessions/test_remove_old_sessions.md b/...s/integration/test_logtest/test_remove_old_sessions/test_remove_old_sessions.md
@@ -2,24 +2,26 @@
 
 ## Overview
 
-Checks if...
+Check if `wazuh-logtest` correctly detects and handles the situation when trying
+to use more sessions than allowed and so, to make room, the oldest session is
+released.
 
 ## Objective
 
-- 
+- Confirm that `wazuh-logtest` releases the oldest session when a new session is
+opened and the number of active sessions reached its limit.
 
 ## General info
 
 |Tier | Total | Time spent |
 | :--:| :--: | :--: |
-| 0 | N | 999s |
-
+| 0 | 1 | 1m |
 
 ## Expected behavior
 
-- 
-- 
-- 
+- Fail if `wazuh-logtest` does not start.
+- Fail if `wazuh-logtest` can not create a new session.
+- Fail if `wazuh-logtest` oldest session is not removed.
 
 ## Code documentation