System Tests: Module (FIM) - FIM Files Events: System test for FIM synchronization process #2536

CamiRomero · 2022-02-01T18:46:37Z

Related issue
2434

Description

While developing wazuh/wazuh#9103 we are planning to develop some system tests to check that the FIM database agent and the manager database are synchronized.

The changes made are as follows:

Added new script to performe query to DB - path: tests/system/scripts/system_query_db.py
Added new function query_db in init.py to can executed scripts to DB inside the host
Added tests/system/test_fim/test_synchronization/data/delete_message.ymlto check expected outputs
Added tests/system/test_fim/test_synchronization/data/messages.yml to check expected outputs
Added tests/system/test_fim/test_synchronization/data/wait_fim_scan.yml to check expected outputs
Added tests/system/test_fim/test_synchronization/data/agent_initializing_synchronization.yml to check expected outputs
Added tests/system/test_fim/test_synchronization/data/manager_initializing_synchronization.yml to check expected outputs
Added tests/system/test_fim/test_synchronization/test_synchronization.py to performance de test described in 2434

Configuration options

In order to run the test, first the environment located in /test/system/provisioning/one_manager_agent must be enabled with:
sudo ansible-playbook -i inventory.yml playbook.yml --extra-vars='{"wazuh_branch": "4.2"}'

Logs example

Run	Results	Date	By
R1	🟢	01/02/2022	@CamiRomero
R2	🟢	01/02/2022	@CamiRomero
R3	🟢	01/02/2022	@CamiRomero

Tests

Proven that tests pass when they have to pass.
Proven that tests fail when they have to fail.

Python codebase satisfies PEP-8 style style guide. pycodestyle --max-line-length=120 --show-source --show-pep8 file.py.

…2434-fim-synchronizaton-agent-stopped

damarisg · 2022-02-02T18:57:00Z

tests/system/test_fim/test_files/test_files_cud.py

+type: system
+brief: Check that when FIM is activated, and the agent is running, the agent and manager are synchronization when
+a change is performed in a monitored folder.
+tier: 1


Suggested change

tier: 1

tier: 0

This is not part of this PR. I applied the change in 2443

damarisg · 2022-02-02T18:57:31Z

tests/system/test_fim/test_files/test_files_cud.py

+
+import pytest


Suggested change

import pytest

import pytest

This is not part of this PR. I applied the change in #2443

damarisg · 2022-02-02T19:15:52Z

tests/system/test_fim/test_files/test_files_cud.py

+    '''
+    The test will monitor a directory.
+    Finally, it will verify that the FIM event is generated
+    in agent and manager side.
+    '''


Add the comments as shown in the schema 2.0

This was worked in PR [2443](This is not part of this PR. 2443

damarisg · 2022-02-02T19:20:46Z

tests/system/test_fim/test_synchronization/test_synchronization.py

+type: system
+brief: Check that when FIM is activated, and the agent is running, the agent and manager are synchronization when
+a change is performed in a monitored folder.
+tier: 1


Suggested change

tier: 1

tier: 0

Done in commit 83482

damarisg · 2022-02-02T19:28:27Z

tests/system/test_fim/test_synchronization/test_synchronization.py

+    Description: The test will monitor a directory and apply changes when agent is stopped.
+    Finally, it will verify that the FIM 'Synchronization' event is generated
+    in agent and manager side.


The synchronization is when the agent and manager are running again, right?

Done in commit 71e04

damarisg · 2022-02-02T19:50:43Z

tests/system/test_fim/test_synchronization/test_synchronization.py

+@pytest.mark.parametrize('host', ['wazuh-agent1', 'wazuh-manager'])
+@pytest.mark.parametrize('case', ['add', 'modify', 'delete'])
+@pytest.mark.parametrize('folder_path', ['testdir1'])
+def test_Synchronization_create_file_agent_stopped(folder_path, case, host):


Suggested change

def test_Synchronization_create_file_agent_stopped(folder_path, case, host):

def test_synchronization_create_file_agent_stopped(folder_path, case, host):

Done in commit 7ae07

damarisg · 2022-02-02T20:06:05Z

tests/system/test_fim/test_files/test_files_cud.py

+testinfra_hosts = ["wazuh-manager", "wazuh-agent1"]
+


When do you use it?

damarisg · 2022-02-02T20:06:49Z

tests/system/test_fim/test_synchronization/test_synchronization.py

+
+
+# Hosts
+testinfra_hosts = ["wazuh-manager", "wazuh-agent1"]


When do you use it?

Done in commit 080c1

damarisg · 2022-02-02T20:11:21Z

tests/system/test_fim/test_synchronization/test_synchronization.py

+
+    clean_logs(host_manager)
+
+    # Stop agent


There are 2 cases: the agent stops and the manager stops.

Done in commit 1321a

damarisg · 2022-02-02T20:18:54Z

tests/system/test_fim/test_synchronization/test_synchronization.py

+@pytest.mark.parametrize('host', ['wazuh-agent1', 'wazuh-manager'])
+@pytest.mark.parametrize('case', ['add', 'modify', 'delete'])
+@pytest.mark.parametrize('folder_path', ['testdir1'])
+def test_Synchronization_create_file_agent_stopped(folder_path, case, host):


The name should be representative. It doesn't just create a file (it also modifies and deletes it) and, the description says that it is when the manager or agent stops (2 cases). However, the test name only talks about agent stopped.

Done in commit 7ae07

Deblintrake09 · 2022-02-02T20:24:17Z

Run	Results	Date	By
R1	🟢	02/02/2022	@Deblintrake09
R2	🟢	02/02/2022	@Deblintrake09
R3	🟢	02/02/2022	@Deblintrake09

…zuh/wazuh-qa into 2434-fim-synchronizaton-agent-stopped

damarisg · 2022-02-03T15:17:44Z

tests/system/test_fim/__init__.py

+def create_folder_file(host_manager, folder_path):
+    # Create folder
+    host_manager.run_command('wazuh-agent1', f'mkdir {folder_path}')
+
+    # Create file
+    host_manager.run_command('wazuh-agent1', f'touch {folder_path}/{folder_path}.txt')
+
+
+def wait_for_fim_scan_end(HostMonitor, inventory_path, messages_path, tmp_path):
+    HostMonitor(inventory_path=inventory_path,
+                messages_path=messages_path,
+                tmp_path=tmp_path).run()
+
+
+def clean_logs(host_manager):
+    host_manager.clear_file(host='wazuh-manager', file_path=os.path.join(WAZUH_LOGS_PATH, 'ossec.log'))
+    host_manager.clear_file(host='wazuh-agent1', file_path=os.path.join(WAZUH_LOGS_PATH, 'ossec.log'))
+
+
+def query_db(host_manager, script, db_path, query):
+    return host_manager.run_command('wazuh-manager', "python {} --db_path {} --query {}".format(script, db_path, query))


Comments are necessary for each method. Why don't you have them here?

…zuh/wazuh-qa into 2434-fim-synchronizaton-agent-stopped

CamiRomero · 2022-02-03T16:55:50Z

Run	Results	Date	By
R1	🟢	03/02/2022	@CamiRomero
R2	🟢	03/02/2022	@CamiRomero
R3	🟢	03/02/2022	@CamiRomero

Deblintrake09 · 2022-02-03T19:23:28Z

Run	Results	Date	By
R1	🟢	03/02/2022	@Deblintrake09
R2	🟢	03/02/2022	@Deblintrake09
R3	🟢	03/02/2022	@Deblintrake09

CamiRomero · 2022-02-11T18:13:23Z

Run	Results	Date	By
R1	🟢	11/02/2022	@CamiRomero
R2	🟢	11/02/2022	@CamiRomero
R3	🟢	11/02/2022	@CamiRomero

CamiRomero added 9 commits January 24, 2022 12:04

Merge branch '2389-System-test-for-fim-synchronization-process' into …

419e7a2

…2434-fim-synchronizaton-agent-stopped

Merge branch '2389-System-test-for-fim-synchronization-process' into …

257ba3d

…2434-fim-synchronizaton-agent-stopped

Addedd new test to check fim synchronization

8158003

Change de frequency of syscheck

49ffecf

Add script to execute query

c2df468

Add yml to check Synchronization

b609923

Add new function to execute query

264fbcd

Add test when manager is stopped

cfd7e64

modify test in order to not duplicate code

3457627

CamiRomero self-assigned this Feb 1, 2022

CamiRomero added the subteam/qa-storm label Feb 1, 2022

CamiRomero requested review from damarisg and Deblintrake09 February 1, 2022 18:47

CamiRomero linked an issue Feb 1, 2022 that may be closed by this pull request

FIM Files Events: System test for FIM synchronization process (2) #2434

Closed

Add documentation in order to respect Schema 2.0

7db4430

CamiRomero changed the title ~~2434 fim synchronizaton agent stopped~~ System Tests: Module (FIM) - FIM Files Events: System test for FIM synchronization process Feb 2, 2022

Merge branch 'master' into 2434-fim-synchronizaton-agent-stopped

af6be3b

damarisg requested changes Feb 2, 2022

View reviewed changes

CamiRomero and others added 7 commits February 3, 2022 08:20

Changed tier 0 to tier 2

83482f6

Fix test documentation

71e0450

Changed de name of the test in order to be more representative

7ae0720

Changed comment Stop agent to Stop host

1321a03

Merge branch '2434-fim-synchronizaton-agent-stopped' of github.com:wa…

1c9efec

…zuh/wazuh-qa into 2434-fim-synchronizaton-agent-stopped

remove unnecessary variables

080c12a

Update CHANGELOG.md

7e84250

damarisg requested changes Feb 3, 2022

View reviewed changes

CamiRomero added 2 commits February 3, 2022 13:51

Add: add comments to explain functions

4369f05

Merge branch '2434-fim-synchronizaton-agent-stopped' of github.com:wa…

7302810

…zuh/wazuh-qa into 2434-fim-synchronizaton-agent-stopped

Deblintrake09 previously approved these changes Feb 3, 2022

View reviewed changes

Merge branch 'master' into 2434-fim-synchronizaton-agent-stopped

96bad3e

CamiRomero dismissed Deblintrake09’s stale review via 96bad3e February 11, 2022 17:26

snaow merged commit b208963 into master Feb 22, 2022

snaow deleted the 2434-fim-synchronizaton-agent-stopped branch February 22, 2022 00:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

System Tests: Module (FIM) - FIM Files Events: System test for FIM synchronization process #2536

System Tests: Module (FIM) - FIM Files Events: System test for FIM synchronization process #2536

CamiRomero commented Feb 1, 2022 •

edited

Loading

damarisg Feb 2, 2022

CamiRomero Feb 3, 2022

damarisg Feb 2, 2022

CamiRomero Feb 3, 2022

damarisg Feb 2, 2022

CamiRomero Feb 3, 2022

damarisg Feb 2, 2022

CamiRomero Feb 3, 2022

damarisg Feb 2, 2022

CamiRomero Feb 3, 2022

damarisg Feb 2, 2022

CamiRomero Feb 3, 2022

damarisg Feb 2, 2022

damarisg Feb 2, 2022

CamiRomero Feb 3, 2022

damarisg Feb 2, 2022

CamiRomero Feb 3, 2022

damarisg Feb 2, 2022

CamiRomero Feb 3, 2022

Deblintrake09 commented Feb 2, 2022

damarisg Feb 3, 2022

CamiRomero commented Feb 3, 2022

Deblintrake09 commented Feb 3, 2022

CamiRomero commented Feb 11, 2022 •

edited

Loading

	def test_Synchronization_create_file_agent_stopped(folder_path, case, host):
	def test_synchronization_create_file_agent_stopped(folder_path, case, host):

System Tests: Module (FIM) - FIM Files Events: System test for FIM synchronization process #2536

System Tests: Module (FIM) - FIM Files Events: System test for FIM synchronization process #2536

Conversation

CamiRomero commented Feb 1, 2022 • edited Loading

Description

Configuration options

Logs example

Tests

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Deblintrake09 commented Feb 2, 2022

Choose a reason for hiding this comment

CamiRomero commented Feb 3, 2022

Deblintrake09 commented Feb 3, 2022

CamiRomero commented Feb 11, 2022 • edited Loading

CamiRomero commented Feb 1, 2022 •

edited

Loading

CamiRomero commented Feb 11, 2022 •

edited

Loading