qa-docs: Migrate test_fim documentation to schema 2.0

[mdengra]

Description

This issue is created to migrate the test_fim documentation to the new qa-docs schema as part of the epic #1796.

In the QA Wiki there are two entries to help complete the tasks:

• Documenting tests using the qa-docs schema: This entry describes the steps needed to document the tests (schema to use, the position of blocks, allowed values for fields, etc.).
• Documentation generation with qa-docs tool: Here is a brief description of how the qa-docs tool works to verify that the changes made in the tests have been done correctly.

Main branch

master

Tasks

• Migrate tests:
  • test_files
    • qa-docs: Migrate test_fim/test_files/test_ambiguous_confs documentation to schema 2.0 #1914
    • qa-docs: Migrate test_fim/test_files/test_audit documentation to schema 2.0 #1918
    • qa-docs: Migrate test_fim/test_files/test_basic_usage documentation to schema 2.0 #1927
    • qa-docs: Migrate test_benchmark and test_checks of test_fim/test_files documentation to schema 2.0 #1936
    • qa-docs: Migrate test_env_variables and test_file_limit of test_fim/test_files documentation to schema 2.0 #1945
    • qa-docs: Migrate test_fim/test_files/test_follow_symbolic_link documentation to schema 2.0 #1948
    • qa-docs: Migrate test_ignore, test_inotify, and test_invalid of test_fim/test_files documentation to schema 2.0 #1970
    • qa-docs: Migrate test_max_eps, test_max_files_per_second, and test_moving_files of test_fim/test_files documentation to schema 2.0 #1980
    • qa-docs: Migrate test_multiple_dirs, test_nodiff, and test_prefilter_cmd of test_fim/test_files documentation to schema 2.0 #1992
    • qa-docs: Migrate test_process_priority, test_recursion_level, and test_restrict of test_fim/test_files documentation to schema 2.0 #2007
    • qa-docs: Migrate test_fim/test_files/test_report_changes documentation to schema 2.0 #1995
    • qa-docs: Migrate test_scan, test_skip, and test_stats_integrity_sync of test_fim/test_files documentation to schema 2.0 #2031
    • qa-docs: Migrate test_tags, test_timezone_changes, test_wildcards_complex, and test_windows_audit_interval of test_fim/test_files documentation to schema 2.0 #2039
  • test_registry
    • qa-docs: Migrate test_registry_ambiguous_confs of test_fim/test_registry documentation to schema 2.0 #2048
    • qa-docs: Migrate test_registry_basic_usage of test_fim/test_registry documentation to schema 2.0 #2062
    • qa-docs: Migrate test_registry_checks, test_registry_ignore, and test_registry_nodiff of test_fim/test_registry documentation to schema 2.0 #2073
    • qa-docs: Migrate test_registry_file_limit, test_registry_multiple_registries, and test_registry_recursion_level of test_fim/test_registry documentation to schema 2.0 #2078
    • qa-docs: Migrate test_registry_report_changes of test_fim/test_registry documentation to schema 2.0 #2086
  • test_synchronization
    • qa-docs: Migrate test_registry_restrict and test_registry_tags of test_fim/test_registry, and test_fim/test_synchronization documentation to schema 2.0 #2085
• Check PEP-8 style guide (pycodestyle --max-line-length=120)
• Merge issue sub-branches to master

[mdengra]

2021-09-20

Working branch: 1810-qadocs-migrate-test-fim

[mdengra]

2021-10-22

As this branch contains a lot of tests, some changes have been made to the schema while migrating its documentation. Therefore, I will update all tests with the latest proposed modifications. I will also merge the master branch over this one and resolve possible conflicts.

Tasks

• Update all FIM tests documentation.
• Merge the master branch with the working branch (1810-qadocs-migrate-test-fim)

[mdengra]

2021-10-26

To avoid extensive PRs, I added several test_fim branches with the latest changes to merge them into the master branch.

Working branchs: 1796-migrate-doc-test_fim*