diff --git a/src/engine/test/helper_tests/README.md b/src/engine/test/helper_tests/README.md index 1c3b56a9e28..0853a778f20 100644 --- a/src/engine/test/helper_tests/README.md +++ b/src/engine/test/helper_tests/README.md @@ -7,6 +7,7 @@ 1. [engine-helper-test-validator](#engine-helper-test-validator) 1. [engine-helper-test-generator](#engine-helper-test-generator) 1. [engine-helper-test-generate-runner](#engine-helper-test-generate-runner) + 1. [engine-helper-test-documentation](#engine-helper-test-documentation) 1. [How to run all the tests](#how-to-run-all-the-tests) 1. [How to create an output in particular and in general](#how-to-create-an-output-in-particular-and-in-general) 1. [Create an output for a given helper function](#create-an-output-for-a-given-helper-function) @@ -24,6 +25,10 @@ 4. [Target field property](#target-field-property) 5. [Skipped property](#skipped-property) 6. [Test property](#test-property) +1. [How generate helper functions documentation](#how-generate-helper-functions-documentation) + 1. [Generate documentation for a particular helper function](#generate-documentation-for-a-particular-helper-function) + 2. [Generate documentation for a particular type of helper function](#generate-documentation-for-a-particular-type-of-helper-function) + 3. [Generate documentation for all helper functions](#generate-documentation-for-all-helper-functions) # End to end tests for helper functions @@ -67,6 +72,15 @@ helper/ | └── template.py | └── test_data.py | └── validator.py +| └── documentation_generator +| └── __init__.py +| └── __main__.py +| └── documentation.py +| └── exporter.py +| └── html_generator.py +| └── mark_down_generator.py +| └── pdf_generator.py +| └── types.py | └── .gitignore | └── pyproject.toml | └── setup.cfg @@ -186,6 +200,23 @@ optional arguments: Absolute or relative path where the test cases were generated ``` +## engine-helper-test-documentation +```bash +usage: engine-helper-test-documentation [-h] [--input_file_path INPUT_FILE_PATH] [--folder_path FOLDER_PATH] [--exporter EXPORTER] [-o OUTPUT_PATH] + +Generates files containing documentation for a given helper + +options: + -h, --help show this help message and exit + --input_file_path INPUT_FILE_PATH + Absolute or relative path where the description of the helper function is located + --folder_path FOLDER_PATH + Absolute or relative path where the directory that contains the descriptions of the auxiliary functions is located + --exporter EXPORTER Absolute or relative path of the directory where the generated test files will be located + -o OUTPUT_PATH, --output_path OUTPUT_PATH + Absolute or relative path of the directory where the generated documentation files will be located +``` + # How to run all the tests After completing the installation, you must run the setupEnvironment.py that builds the environment in a certain location. @@ -430,3 +461,27 @@ test: expected: any_value description: any description ``` + +# How generate helper functions documentation +By default, if a directory is not specified to store the created documentation, it will be saved in `/tmp/documentation`. +Likewise, the default exporter type if one is not specified will be `markdown`. +The commands below use absolute paths to the engine directory. + +## Generate documentation for a particular helper function +```bash +engine-helper-test-documentation --input_file_path test/helper_tests/helpers_description/map/int_calculate.yml -o test/helper_tests/documentation +``` +## Generate documentation for a particular type of helper function +```bash +engine-helper-test-documentation --folder_path test/helper_tests/helpers_description/map -o test/helper_tests/documentation +``` +```bash +engine-helper-test-documentation --folder_path test/helper_tests/helpers_description/filter -o test/helper_tests/documentation +``` +```bash +engine-helper-test-documentation --folder_path test/helper_tests/helpers_description/transformation -o test/helper_tests/documentation +``` +## Generate documentation for all helper functions +```bash +engine-helper-test-documentation --folder_path test/helper_tests/helpers_description/ -o test/helper_tests/documentation +``` diff --git a/src/engine/test/helper_tests/engine_helper_test/src/documentation_generator/__main__.py b/src/engine/test/helper_tests/engine_helper_test/src/documentation_generator/__main__.py index e98ae283000..f02c7f1d76d 100644 --- a/src/engine/test/helper_tests/engine_helper_test/src/documentation_generator/__main__.py +++ b/src/engine/test/helper_tests/engine_helper_test/src/documentation_generator/__main__.py @@ -7,12 +7,11 @@ from .documentation import * from .exporter import IExporter from .types import * -import tempfile import subprocess def parse_arguments() -> argparse.Namespace: - arg_parser = argparse.ArgumentParser(description="Generates files containing test cases for a given helper") + arg_parser = argparse.ArgumentParser(description="Generates files containing documentation for a given helper") arg_parser.add_argument( "--input_file_path", help="Absolute or relative path where the description of the helper function is located", @@ -28,7 +27,7 @@ def parse_arguments() -> argparse.Namespace: arg_parser.add_argument( "-o", "--output_path", - help="Absolute or relative path of the directory where the generated test files will be located", + help="Absolute or relative path of the directory where the generated documentation files will be located", ) args = arg_parser.parse_args() @@ -39,26 +38,18 @@ def parse_arguments() -> argparse.Namespace: return args -def is_temp_path(path: Path): - path = path.resolve() - temp_dir = Path(tempfile.gettempdir()).resolve() - return str(path).startswith(str(temp_dir)) - - -def generate_documentation(parser: Parser, exporter: IExporter, file: Path, output_dir: Path): +def generate_documentation(parser: Parser, exporter: IExporter, file: Path, output_path: Path): parser.load_yaml_from_file(file) documentation = parse_yaml_to_documentation(parser) exporter.create_document(documentation) - exporter.save(output_dir) + exporter.save(output_path) def main(): args = parse_arguments() parser = Parser() exporter_type = args.exporter if args.exporter else "mark_down" - output_dir = Path(args.output_path if args.output_path else "/tmp/documentation") - if not is_temp_path(output_dir): - sys.exit("the output directory must be a temporary one") + output_path = Path(args.output_path if args.output_path else "/tmp/documentation") exporter = ExporterFactory.get_exporter(exporter_type) if args.input_file_path: command = f'engine-helper-test-validator --input_file_path {args.input_file_path}' @@ -66,15 +57,22 @@ def main(): subprocess.run(command, check=True, shell=True, stdout=subprocess.PIPE) except subprocess.CalledProcessError as e: sys.exit(e.stderr) - generate_documentation(parser, exporter, Path(args.input_file_path), output_dir) + generate_documentation(parser, exporter, Path(args.input_file_path), output_path) elif args.folder_path: - for file in Path(args.folder_path).iterdir(): - if file.is_file() and (file.suffix in ['.yml', '.yaml']): - command = f'engine-helper-test-validator --folder_path {args.folder_path}' - try: - subprocess.run(command, check=True, shell=True, stdout=subprocess.PIPE) - except subprocess.CalledProcessError as e: - sys.exit(e.stderr) - generate_documentation(parser, exporter, file, output_dir) + folder_path = Path(args.folder_path) + yaml_files = folder_path.rglob('*.yml') + yaml_files = list(yaml_files) + list(folder_path.rglob('*.yaml')) + + if not yaml_files: + sys.exit("No YAML files found in the specified directory.") + + for file in yaml_files: + command = f'engine-helper-test-validator --input_file_path {file}' + try: + subprocess.run(command, check=True, shell=True, stdout=subprocess.PIPE) + except subprocess.CalledProcessError as e: + sys.exit(e.stderr) + generate_documentation(parser, exporter, file, output_path) + else: sys.exit("It is necessary to indicate a file or directory that contains a configuration yaml") diff --git a/src/engine/test/helper_tests/engine_helper_test/src/documentation_generator/mark_down_generator.py b/src/engine/test/helper_tests/engine_helper_test/src/documentation_generator/mark_down_generator.py index 9d72fd945c9..26605aa441d 100644 --- a/src/engine/test/helper_tests/engine_helper_test/src/documentation_generator/mark_down_generator.py +++ b/src/engine/test/helper_tests/engine_helper_test/src/documentation_generator/mark_down_generator.py @@ -1,10 +1,12 @@ from .types import Documentation from .exporter import * +from collections import defaultdict class MarkdownGenerator(IExporter): def __init__(self): self.content = [] + self.all_contents = defaultdict(lambda: defaultdict(list)) # Structure to organize by type and keyword self.helper_name = "" def create_signature(self, doc: Documentation): @@ -159,7 +161,33 @@ def create_document(self, doc: Documentation): # self.content.append(f" - **Expected**: `{example.expected}`") # self.content.append(f" - **Description**: {example.description}\n") + # Organiza el contenido por tipo de helper y luego por keyword + for keyword in doc.keywords: + self.all_contents[doc.helper_type][keyword].append('\n'.join(self.content)) + def save(self, output_dir: Path): output_dir.mkdir(parents=True, exist_ok=True) - with open((output_dir / self.helper_name).as_posix() + ".md", 'w') as file: - file.write('\n'.join(self.content)) + + home_file = output_dir / "index.md" + with open(home_file, 'w') as file: + file.write("# Helper Types\n") + for helper_type in sorted(self.all_contents.keys()): + file.write(f"- [{helper_type}](./{helper_type}/index.md)\n") + + for helper_type, keywords in self.all_contents.items(): + type_dir = output_dir / helper_type + type_dir.mkdir(parents=True, exist_ok=True) + + type_index_file = type_dir / "index.md" + with open(type_index_file, 'w') as file: + file.write(f"# {helper_type}\n") + file.write(f"## Keywords\n") + for keyword in sorted(keywords.keys()): + file.write(f"- [{keyword}](./{keyword}.md)\n") + + for keyword, docs in keywords.items(): + keyword_file = type_dir / f"{keyword}.md" + with open(keyword_file, 'w') as file: + for doc in docs: + file.write(doc) + file.write("\n---\n") diff --git a/src/engine/test/helper_tests/helpers_description/filter/binary_and.yml b/src/engine/test/helper_tests/helpers_description/filter/binary_and.yml index 16a091e668a..9c2303a2b1c 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/binary_and.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/binary_and.yml @@ -6,7 +6,7 @@ metadata: Transforms the hexadecimal value into an unsigned integer and performs the AND bit by bit with the field hexadecimal transformed to unsigned int. If it is other than 0x0 then the operation evaluates to true. keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/contains.yml b/src/engine/test/helper_tests/helpers_description/filter/contains.yml index 0a3a9f94252..3eabf8bdfd4 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/contains.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/contains.yml @@ -7,7 +7,7 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/exists.yml b/src/engine/test/helper_tests/helpers_description/filter/exists.yml index 843dd74a276..a8c961736cd 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/exists.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/exists.yml @@ -7,7 +7,7 @@ metadata: If it does, the function will evaluate to true, otherwise it will be false. This helper function is used in the check stage. keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/exists_key_in.yml b/src/engine/test/helper_tests/helpers_description/filter/exists_key_in.yml index 1ff312d98eb..4761d3044c1 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/exists_key_in.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/exists_key_in.yml @@ -8,7 +8,7 @@ metadata: If the object contains the key, then the function will evaluate to true, otherwise it will be false. This helper function is typically used in the check stage. keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/int_equal.yml b/src/engine/test/helper_tests/helpers_description/filter/int_equal.yml index cb87abca3e4..a0d20d5551c 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/int_equal.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/int_equal.yml @@ -7,7 +7,8 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. This helper function is typically used in the check stage keywords: - - to define + - integer + - comparison helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/int_greater.yml b/src/engine/test/helper_tests/helpers_description/filter/int_greater.yml index e20761f3147..0f1c0f4f736 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/int_greater.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/int_greater.yml @@ -7,7 +7,8 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. This helper function is typically used in the check stage keywords: - - to define + - integer + - comparison helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/int_less.yml b/src/engine/test/helper_tests/helpers_description/filter/int_less.yml index 8fa895bde81..74693497e55 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/int_less.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/int_less.yml @@ -7,7 +7,8 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. This helper function is typically used in the check stage keywords: - - to define + - integer + - comparison helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/int_less_or_equal.yml b/src/engine/test/helper_tests/helpers_description/filter/int_less_or_equal.yml index ee0f6e2f409..f9d4f2dba5f 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/int_less_or_equal.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/int_less_or_equal.yml @@ -7,7 +7,8 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. This helper function is typically used in the check stage keywords: - - to define + - integer + - comparison helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/int_not_equal.yml b/src/engine/test/helper_tests/helpers_description/filter/int_not_equal.yml index f57440350e1..3742bf2e074 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/int_not_equal.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/int_not_equal.yml @@ -7,7 +7,8 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. This helper function is typically used in the check stage keywords: - - to define + - integer + - comparison helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/ip_cidr_match.yml b/src/engine/test/helper_tests/helpers_description/filter/ip_cidr_match.yml index bf98f2875d4..47ae0982d65 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/ip_cidr_match.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/ip_cidr_match.yml @@ -11,7 +11,7 @@ metadata: where ddd is a decimal number of up to three digits in the range 0 to 255. This helper function is typically used in the check stage keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/is_array.yml b/src/engine/test/helper_tests/helpers_description/filter/is_array.yml index 58696d3d5ee..79df47624ae 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/is_array.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/is_array.yml @@ -7,7 +7,7 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. This helper function is typically used in the check stage keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/is_boolean.yml b/src/engine/test/helper_tests/helpers_description/filter/is_boolean.yml index 2b1bf402817..652735d171a 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/is_boolean.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/is_boolean.yml @@ -7,7 +7,7 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. This helper function is typically used in the check stage keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/is_not_array.yml b/src/engine/test/helper_tests/helpers_description/filter/is_not_array.yml index 8ff4eb21d9d..f6c1bd08db0 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/is_not_array.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/is_not_array.yml @@ -7,7 +7,7 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. This helper function is typically used in the check stage keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/is_not_boolean.yml b/src/engine/test/helper_tests/helpers_description/filter/is_not_boolean.yml index f605e7065cd..5fe2bc9cfe8 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/is_not_boolean.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/is_not_boolean.yml @@ -7,7 +7,7 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. This helper function is typically used in the check stage keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/is_not_object.yml b/src/engine/test/helper_tests/helpers_description/filter/is_not_object.yml index a5a9f36a85b..3de143cb406 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/is_not_object.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/is_not_object.yml @@ -7,7 +7,7 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. This helper function is typically used in the check stage keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/is_not_string.yml b/src/engine/test/helper_tests/helpers_description/filter/is_not_string.yml index 02702bd0bb3..46729c91056 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/is_not_string.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/is_not_string.yml @@ -7,7 +7,7 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. This helper function is typically used in the check stage keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/is_number.yml b/src/engine/test/helper_tests/helpers_description/filter/is_number.yml index b4b1a02605b..7a67178136a 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/is_number.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/is_number.yml @@ -8,7 +8,7 @@ metadata: This helper function is typically used in the check stage keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/is_object.yml b/src/engine/test/helper_tests/helpers_description/filter/is_object.yml index 4dcfb78f791..0169e38c867 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/is_object.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/is_object.yml @@ -8,7 +8,7 @@ metadata: This helper function is typically used in the check stage keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/is_public_ip.yml b/src/engine/test/helper_tests/helpers_description/filter/is_public_ip.yml index 2c528e330a2..5578a0a6c44 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/is_public_ip.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/is_public_ip.yml @@ -17,7 +17,7 @@ metadata: This helper function is typically used in the check stage keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/is_string.yml b/src/engine/test/helper_tests/helpers_description/filter/is_string.yml index a23f02d40f4..06e9515969c 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/is_string.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/is_string.yml @@ -8,7 +8,7 @@ metadata: This helper function is typically used in the check stage keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/kvdb_match.yml b/src/engine/test/helper_tests/helpers_description/filter/kvdb_match.yml index 4d30841c54b..1ad64a69c84 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/kvdb_match.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/kvdb_match.yml @@ -6,7 +6,7 @@ metadata: Checks if a given key exist in the DB named db-name. This helper function is typically used in the check stage. keywords: - - to define + - kvdb helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/kvdb_not_match.yml b/src/engine/test/helper_tests/helpers_description/filter/kvdb_not_match.yml index 04f4b2436d2..cb863c3cbf9 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/kvdb_not_match.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/kvdb_not_match.yml @@ -6,7 +6,7 @@ metadata: Checks if a given key does not exist in the DB named db-name. This helper function is typically used in the check stage. keywords: - - to define + - kvdb helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/match_value.yml b/src/engine/test/helper_tests/helpers_description/filter/match_value.yml index c789741799d..2ebc91656e8 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/match_value.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/match_value.yml @@ -9,7 +9,7 @@ metadata: This helper function is typically used in the check stage. keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/regex_match.yml b/src/engine/test/helper_tests/helpers_description/filter/regex_match.yml index cf8a74a205e..601b3755800 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/regex_match.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/regex_match.yml @@ -10,7 +10,7 @@ metadata: This helper function is typically used in the check stage. keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/starts_with.yml b/src/engine/test/helper_tests/helpers_description/filter/starts_with.yml index 8b5ca7d2d28..9ab4ff7b197 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/starts_with.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/starts_with.yml @@ -7,7 +7,7 @@ metadata: If they're not, the function evaluates to false. In case of error, the function will evaluate to false. keywords: - - to define + - undefined helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/string_equal.yml b/src/engine/test/helper_tests/helpers_description/filter/string_equal.yml index fa2730c6f15..1e31c85cd8d 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/string_equal.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/string_equal.yml @@ -8,7 +8,8 @@ metadata: This helper function is typically used in the check stage keywords: - - to define + - string + - comparison helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/string_greater.yml b/src/engine/test/helper_tests/helpers_description/filter/string_greater.yml index 80c4fedcfb5..3c8820c99f2 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/string_greater.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/string_greater.yml @@ -8,7 +8,8 @@ metadata: This helper function is typically used in the check stage keywords: - - to define + - string + - comparison helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/string_less.yml b/src/engine/test/helper_tests/helpers_description/filter/string_less.yml index 47e97b8783b..e6c65c1ab66 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/string_less.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/string_less.yml @@ -8,7 +8,8 @@ metadata: This helper function is typically used in the check stage keywords: - - to define + - string + - comparison helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/string_less_or_equal.yml b/src/engine/test/helper_tests/helpers_description/filter/string_less_or_equal.yml index eeabea48fb9..f67d22e821f 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/string_less_or_equal.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/string_less_or_equal.yml @@ -8,7 +8,8 @@ metadata: This helper function is typically used in the check stage keywords: - - to define + - string + - comparison helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/filter/string_not_equal.yml b/src/engine/test/helper_tests/helpers_description/filter/string_not_equal.yml index e8318d99f0c..fbb39e58487 100644 --- a/src/engine/test/helper_tests/helpers_description/filter/string_not_equal.yml +++ b/src/engine/test/helper_tests/helpers_description/filter/string_not_equal.yml @@ -8,7 +8,8 @@ metadata: This helper function is typically used in the check stage keywords: - - to define + - string + - comparison helper_type: filter diff --git a/src/engine/test/helper_tests/helpers_description/map/active_response_send.yml b/src/engine/test/helper_tests/helpers_description/map/active_response_send.yml index e5d2a39f130..6a71fc86061 100644 --- a/src/engine/test/helper_tests/helpers_description/map/active_response_send.yml +++ b/src/engine/test/helper_tests/helpers_description/map/active_response_send.yml @@ -8,7 +8,7 @@ metadata: Thre result value doesn`t mean that it checks the correct execution of the Active response. This helper function is typically used in the map stage. keywords: - - to define + - undefined helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/as.yml b/src/engine/test/helper_tests/helpers_description/map/as.yml index 73d1545f5d7..6b15a7ac9ae 100644 --- a/src/engine/test/helper_tests/helpers_description/map/as.yml +++ b/src/engine/test/helper_tests/helpers_description/map/as.yml @@ -9,7 +9,7 @@ metadata: - number: mapping of the 'autonomous_system_number' field of the mmdb entry. - organization.name: mapping of the 'autonomous_system_organization' field of the mmdb entry. keywords: - - to define + - max_min_db helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/concat.yml b/src/engine/test/helper_tests/helpers_description/map/concat.yml index 88e26ae69c3..84007dcf6c6 100644 --- a/src/engine/test/helper_tests/helpers_description/map/concat.yml +++ b/src/engine/test/helper_tests/helpers_description/map/concat.yml @@ -6,7 +6,7 @@ metadata: The function receives two or more operands and concatenates them in the order they are provided. The result of the concatenation is stored in the field `field`. keywords: - - different types + - different_types helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/concat_any.yml b/src/engine/test/helper_tests/helpers_description/map/concat_any.yml index 0e39d65d0a3..bfcf40e0f02 100644 --- a/src/engine/test/helper_tests/helpers_description/map/concat_any.yml +++ b/src/engine/test/helper_tests/helpers_description/map/concat_any.yml @@ -6,7 +6,7 @@ metadata: The function receives two or more operands and concatenates them in the order they are provided. The result of the concatenation is stored in the field `field`. keywords: - - different types + - different_types helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/date_from_epoch.yml b/src/engine/test/helper_tests/helpers_description/map/date_from_epoch.yml index 6d845e6ecf9..30e36eb69ca 100644 --- a/src/engine/test/helper_tests/helpers_description/map/date_from_epoch.yml +++ b/src/engine/test/helper_tests/helpers_description/map/date_from_epoch.yml @@ -7,7 +7,7 @@ metadata: Remember epoch, understood as UNIX epoch, is the seconds passed since january first of 1970, so it will fail on negative values. Floating points numbers will be converted to integers. keywords: - - to define + - undefined helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/decode_base16.yml b/src/engine/test/helper_tests/helpers_description/map/decode_base16.yml index a2c5278761e..a2242544554 100644 --- a/src/engine/test/helper_tests/helpers_description/map/decode_base16.yml +++ b/src/engine/test/helper_tests/helpers_description/map/decode_base16.yml @@ -6,7 +6,7 @@ metadata: The operation transforms a string of hexa digits into an ASCII string. The result of the operation is mapped to “field”. If the “field” already exists, then it will be replaced. In case of errors “field” will not be modified. keywords: - - to define + - undefined helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/downcase.yml b/src/engine/test/helper_tests/helpers_description/map/downcase.yml index 6b50cfd9bf6..21fe921f657 100644 --- a/src/engine/test/helper_tests/helpers_description/map/downcase.yml +++ b/src/engine/test/helper_tests/helpers_description/map/downcase.yml @@ -7,7 +7,7 @@ metadata: The result of the lowercase (+downcase) operation is mapped to “field”. If the field field already exists, then it will be replaced. In case of errors “field” will not be modified. keywords: - - to define + - string helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/geoip.yml b/src/engine/test/helper_tests/helpers_description/map/geoip.yml index 757f3eb40d9..13f27480915 100644 --- a/src/engine/test/helper_tests/helpers_description/map/geoip.yml +++ b/src/engine/test/helper_tests/helpers_description/map/geoip.yml @@ -18,7 +18,7 @@ metadata: - region_iso_code: mapping of the 'subdivisions.0.iso_code' field of the mmdb entry. - region_name: mapping of the 'subdivisions.0.names.en' field of the mmdb entry. keywords: - - to define + - max_min_db helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/hex_to_number.yml b/src/engine/test/helper_tests/helpers_description/map/hex_to_number.yml index a4d39572cbf..80b290115e9 100644 --- a/src/engine/test/helper_tests/helpers_description/map/hex_to_number.yml +++ b/src/engine/test/helper_tests/helpers_description/map/hex_to_number.yml @@ -7,7 +7,7 @@ metadata: The result of the operation is mapped to “field”. If the “field” already exists, then it will be replaced. In case of errors “field” will not be modified. keywords: - - to define + - undefined helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/ip_version.yml b/src/engine/test/helper_tests/helpers_description/map/ip_version.yml index 325c3735bd2..807984988ab 100644 --- a/src/engine/test/helper_tests/helpers_description/map/ip_version.yml +++ b/src/engine/test/helper_tests/helpers_description/map/ip_version.yml @@ -9,7 +9,7 @@ metadata: - IPv4: support address in dotted-decimal format, "ddd.ddd.ddd.ddd" where ddd is a decimal number of up to three digits in the range  0  to  255 - IPv6: support RFC 2373 representation of addresses keywords: - - to define + - ip helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/join.yml b/src/engine/test/helper_tests/helpers_description/map/join.yml index 35f05e7653a..52a02a01cfb 100644 --- a/src/engine/test/helper_tests/helpers_description/map/join.yml +++ b/src/engine/test/helper_tests/helpers_description/map/join.yml @@ -7,7 +7,7 @@ metadata: The result of the string concatenation (join) operation is mapped to “field”. If the “field” already exists, then it will be replaced. In case of errors “field” will not be modified. keywords: - - to define + - undefined helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/regex_extract.yml b/src/engine/test/helper_tests/helpers_description/map/regex_extract.yml index 88fe3f5190c..7cd7c3c5cae 100644 --- a/src/engine/test/helper_tests/helpers_description/map/regex_extract.yml +++ b/src/engine/test/helper_tests/helpers_description/map/regex_extract.yml @@ -11,7 +11,7 @@ metadata: RE2 syntax: https://github.com/google/re2/wiki/Syntax This helper function is used in the map stage keywords: - - to define + - undefined helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/send_upgrade_confirmation.yml b/src/engine/test/helper_tests/helpers_description/map/send_upgrade_confirmation.yml index e37a2734b13..0cf67631961 100644 --- a/src/engine/test/helper_tests/helpers_description/map/send_upgrade_confirmation.yml +++ b/src/engine/test/helper_tests/helpers_description/map/send_upgrade_confirmation.yml @@ -7,7 +7,7 @@ metadata: send it throug the UPGRADE socket. The result of the communication will be return as a boolean value being true when sent ok and false otherwise. This helper function is typically used in the map stage. keywords: - - to define + - undefined helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/sha1.yml b/src/engine/test/helper_tests/helpers_description/map/sha1.yml index 233f959dd3b..b16e9ddec27 100644 --- a/src/engine/test/helper_tests/helpers_description/map/sha1.yml +++ b/src/engine/test/helper_tests/helpers_description/map/sha1.yml @@ -8,7 +8,7 @@ metadata: In case of errors “field” will not be modified. This helper function is typically used in the map stage keywords: - - to define + - undefined helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/system_epoch.yml b/src/engine/test/helper_tests/helpers_description/map/system_epoch.yml index 3193e962f04..28a738982e2 100644 --- a/src/engine/test/helper_tests/helpers_description/map/system_epoch.yml +++ b/src/engine/test/helper_tests/helpers_description/map/system_epoch.yml @@ -6,7 +6,7 @@ metadata: Get unix epoch time in seconds from system clock. The result operation is mapped to “field”. If the “field” already exists, then it will be replaced. keywords: - - to define + - time helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/to_string.yml b/src/engine/test/helper_tests/helpers_description/map/to_string.yml index 1b20f5e3ef2..bedce791384 100644 --- a/src/engine/test/helper_tests/helpers_description/map/to_string.yml +++ b/src/engine/test/helper_tests/helpers_description/map/to_string.yml @@ -6,7 +6,7 @@ metadata: Transforms a number into a string with that number. This helper function is typically used in the map stage keywords: - - to define + - undefined helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/upcase.yml b/src/engine/test/helper_tests/helpers_description/map/upcase.yml index db2f81a2dd9..c4831c12be6 100644 --- a/src/engine/test/helper_tests/helpers_description/map/upcase.yml +++ b/src/engine/test/helper_tests/helpers_description/map/upcase.yml @@ -7,7 +7,7 @@ metadata: The result of the uppercase (upcase) operation is mapped to “field”. If the “field” already exists, then it will be replaced. In case of errors “field” will not be modified. keywords: - - to define + - string helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/wdb_query.yml b/src/engine/test/helper_tests/helpers_description/map/wdb_query.yml index 10f3bfdd650..3fd1b73bd1f 100644 --- a/src/engine/test/helper_tests/helpers_description/map/wdb_query.yml +++ b/src/engine/test/helper_tests/helpers_description/map/wdb_query.yml @@ -8,7 +8,7 @@ metadata: In case of errors target field will not be modified. This helper function is typically used in the map stage keywords: - - to define + - wdb helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/map/wdb_update.yml b/src/engine/test/helper_tests/helpers_description/map/wdb_update.yml index 39f4ff19665..b74c718f87a 100644 --- a/src/engine/test/helper_tests/helpers_description/map/wdb_update.yml +++ b/src/engine/test/helper_tests/helpers_description/map/wdb_update.yml @@ -8,7 +8,7 @@ metadata: If the field field already exists, then it will be replaced. In case of errors target field will not be modified. This helper function is typically used in the map stage keywords: - - to define + - wdb helper_type: map diff --git a/src/engine/test/helper_tests/helpers_description/transformation/array_append.yml b/src/engine/test/helper_tests/helpers_description/transformation/array_append.yml index 9b6f5e2c441..b113a877965 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/array_append.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/array_append.yml @@ -12,7 +12,7 @@ metadata: element to be added. keywords: - - to define + - array helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/array_append_any.yml b/src/engine/test/helper_tests/helpers_description/transformation/array_append_any.yml index 1ccb4ffddd1..5e117cf3e53 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/array_append_any.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/array_append_any.yml @@ -12,7 +12,7 @@ metadata: will always be taken or, failing that, the type of the first element to be added. keywords: - - to define + - array helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/array_append_unique.yml b/src/engine/test/helper_tests/helpers_description/transformation/array_append_unique.yml index 1e3299a2a20..78bb8ac8dc6 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/array_append_unique.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/array_append_unique.yml @@ -10,7 +10,7 @@ metadata: added already exists in the array. keywords: - - to define + - array helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/array_append_unique_any.yml b/src/engine/test/helper_tests/helpers_description/transformation/array_append_unique_any.yml index 9b7cee0adea..18df656e5b5 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/array_append_unique_any.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/array_append_unique_any.yml @@ -10,7 +10,7 @@ metadata: it will be added to the target field. keywords: - - to define + - array helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/delete.yml b/src/engine/test/helper_tests/helpers_description/transformation/delete.yml index 130eea31b43..204cfa2d624 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/delete.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/delete.yml @@ -7,7 +7,7 @@ metadata: This helper function is typically used in the map stage. keywords: - - to define + - delete helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/erase_custom_fields.yml b/src/engine/test/helper_tests/helpers_description/transformation/erase_custom_fields.yml index 8c985449603..f74d813509d 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/erase_custom_fields.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/erase_custom_fields.yml @@ -7,7 +7,7 @@ metadata: Typically used with field = ".", the root element. keywords: - - to define + - delete helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/get_key_in.yml b/src/engine/test/helper_tests/helpers_description/transformation/get_key_in.yml index def0de08920..1caa884ead4 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/get_key_in.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/get_key_in.yml @@ -9,7 +9,7 @@ metadata: This helper function is typically used in the map stage. keywords: - - to define + - undefined helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_decode_bitmask.yml b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_decode_bitmask.yml index c5894ed15cd..cc3aac714e5 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_decode_bitmask.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_decode_bitmask.yml @@ -25,7 +25,7 @@ metadata: If the resulting array is empty, the function fails, and it neither creates nor overwrites the value of field. keywords: - - to define + - kvdb helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_delete.yml b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_delete.yml index 41fdbb9562e..e08f60dfc38 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_delete.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_delete.yml @@ -7,7 +7,7 @@ metadata: If it was able to be removed, then map `true` into the field. This helper function is typically used in the map stage keywords: - - to define + - kvdb helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get.yml b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get.yml index 293cdd44bba..9c0859089f5 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get.yml @@ -6,7 +6,7 @@ metadata: Gets the value of a given key in the DB named db-name and if its successful it stores it in the given field. Key value type can be string, number, object, array or null. This helper function is typically used in the map stage keywords: - - to define + - kvdb helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get_array.yml b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get_array.yml index 75a3706cc37..5107d7fa60e 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get_array.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get_array.yml @@ -7,7 +7,7 @@ metadata: Best effort, if a key is not present in the DB, skip it. keywords: - - to define + - kvdb helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get_merge.yml b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get_merge.yml index c730a039be8..6396e5eade5 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get_merge.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_get_merge.yml @@ -9,7 +9,7 @@ metadata: value type hold by field. This helper function is typically used in the map stage. keywords: - - to define + - kvdb helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_set.yml b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_set.yml index a04054dcddb..dac62a72d7d 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/kvdb_set.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/kvdb_set.yml @@ -8,7 +8,7 @@ metadata: If it was able to insert the value, then map `true` into field, if not, then map `false` into field. Value type can be string, number, object, array or null. This helper function is typically used in the map stage keywords: - - to define + - kvdb helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/merge.yml b/src/engine/test/helper_tests/helpers_description/transformation/merge.yml index ac3111e0172..7f5881e7557 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/merge.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/merge.yml @@ -11,7 +11,7 @@ metadata: and will be not duplicated. This helper function is typically used in the map stage keywords: - - to define + - undefined helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_alphanumeric.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_alphanumeric.yml index 70ee8ea8334..e9dc0d6ebc9 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_alphanumeric.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_alphanumeric.yml @@ -6,7 +6,7 @@ metadata: Checks if an input matches an alphanumeric string, and if so, it evaluates to true and the extracted data contained in a JSON object is stored in the output field; otherwise, it evaluates to false. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_between.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_between.yml index c59c4e2d5fb..b745af2e736 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_between.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_between.yml @@ -7,7 +7,7 @@ metadata: with the `end` delimiter. If so, it extracts the text found between these delimiters and stores this extracted substring in `field` keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_binary.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_binary.yml index b13a73b3eea..5e96eb6b488 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_binary.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_binary.yml @@ -7,7 +7,7 @@ metadata: It checks the string for compliance with the base64 encoding standards, including character set and padding. If the string is a valid base64 encoded string, it stores the same string in `field` without modification. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_bool.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_bool.yml index e53d5412a85..9c19b02cdd0 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_bool.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_bool.yml @@ -6,7 +6,7 @@ metadata: Checks if an input is the “true” or “false” string and store a boolean value in field according to the string value. The operation es key insensitive Fail if other value is store in $inField or not exist. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_byte.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_byte.yml index f55b1e07293..96cfad71d26 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_byte.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_byte.yml @@ -7,7 +7,7 @@ metadata: If the numeric value is within the range of -128 to 127 (inclusive) it truncates the number to fit into a byte data type and stores the result in `field`. The operation is case-sensitive. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_csv.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_csv.yml index e95f73ca297..076482fbad9 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_csv.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_csv.yml @@ -13,7 +13,7 @@ metadata: The “escaping” character is used to escape the “quoting” characters that are intended to be used as literal characters. This helper function is typically used in the map stage. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_double.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_double.yml index e219cefd05b..57b3de6011a 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_double.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_double.yml @@ -8,7 +8,7 @@ metadata: as double-precision floating-point numbers are capable of representing a wide range of decimal numbers with significant precision. keywords: - - to define + - undefined helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_dsv.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_dsv.yml index 22bf1512c35..7808c15a90b 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_dsv.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_dsv.yml @@ -13,7 +13,7 @@ metadata: The “escaping” character is used to escape the “quoting” characters that are intended to be used as literal characters. This helper function is typically used in the map stage. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_file.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_file.yml index a734c2311dc..c22c0bd722e 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_file.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_file.yml @@ -6,7 +6,7 @@ metadata: Checks whether an input contains a valid file path and, if so, it evaluates to true and the extracted data contained in a JSON object is then stored on the field, otherwise it evaluates to false. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_float.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_float.yml index 844ae20a62e..7287c5bfee7 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_float.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_float.yml @@ -6,7 +6,7 @@ metadata: Evaluates if the content of the input field is a string that can be successfully converted into a floating-point number. It converts and stores the floating-point number in `field`, as floating-point numbers inherently support decimals. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_fqdn.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_fqdn.yml index b8f99ba7931..d846ec74196 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_fqdn.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_fqdn.yml @@ -8,7 +8,7 @@ metadata: Checks whether an input contains a valid domain name format and, if so, it evaluates to true and is then stored on the field, otherwise it evaluates to false. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_ip.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_ip.yml index 9ca2f4361ba..edbcab0c362 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_ip.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_ip.yml @@ -10,7 +10,7 @@ metadata: and the correct format for IPv6 (eight groups of four hexadecimal digits separated by colons). If the string is a valid IP address, it stores the same string in `field` without modification. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_json.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_json.yml index afdb92fd6a0..03112d4eb3d 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_json.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_json.yml @@ -9,7 +9,7 @@ metadata: If the validation is successful, the input is transformed into a JSON object which is then assigned to the specified field. If the input is not valid JSON, the parser does not modify the output. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_key_value.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_key_value.yml index 9584dadf5b1..6264590b650 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_key_value.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_key_value.yml @@ -14,7 +14,7 @@ metadata: This helper function is typically used in the map stage. Checks whether an input fits a keys-values list format and, if it does, such pairs of keys and values are stored as new fields of the event. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_quoted.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_quoted.yml index 0a34cc03e0c..5d26602c59f 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_quoted.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_quoted.yml @@ -8,7 +8,7 @@ metadata: Evaluates the content of the input field to extract text that is enclosed in the specified `quoted` character considering any `escape` characters used to include the quotation character within the quoted text. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_uri.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_uri.yml index d09fcd6c44a..663798585db 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_uri.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_uri.yml @@ -8,7 +8,7 @@ metadata: Checks whether an input contains a valid URI format and, if so, it evaluates to true and transforms it to a ECS url object encoded as a JSON string which is then stored on the field, otherwise it evaluates to false. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_useragent.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_useragent.yml index 49589da1fe5..14199100013 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_useragent.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_useragent.yml @@ -10,7 +10,7 @@ metadata: It directly maps this string to `field` without any modification or parsing. This function is particularly useful for logging or analyzing user agent strings in their original format. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/parse_xml.yml b/src/engine/test/helper_tests/helpers_description/transformation/parse_xml.yml index 9fa8d0ad452..18bb5018bce 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/parse_xml.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/parse_xml.yml @@ -7,7 +7,7 @@ metadata: It preserves the structure of the original XML in the default mode and provides a specialized transformation for Windows Event Log XML when the optional "windows" argument is used. keywords: - - to define + - parser helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/rename.yml b/src/engine/test/helper_tests/helpers_description/transformation/rename.yml index fc52068b6fd..71dc1edbdba 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/rename.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/rename.yml @@ -6,7 +6,7 @@ metadata: Moves existing “input_field” to the field name provided (field). Replace if field exist. This helper function is used in the map stage. keywords: - - to define + - undefined helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/replace.yml b/src/engine/test/helper_tests/helpers_description/transformation/replace.yml index 6efefe87529..b52bc92fab4 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/replace.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/replace.yml @@ -7,7 +7,7 @@ metadata: In case of errors “field” will not be modified. This helper function is typically used in the map stage keywords: - - to define + - string helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/sca_decoder.yml b/src/engine/test/helper_tests/helpers_description/transformation/sca_decoder.yml index d7f7a4aaa78..8ded286dbe5 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/sca_decoder.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/sca_decoder.yml @@ -7,7 +7,7 @@ metadata: The operation also updates the WDB. This helper wasn't developed to be used by the external users it will only take care of wdb managing. This helper function is typically used in the map stage. keywords: - - to define + - undefined helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/split.yml b/src/engine/test/helper_tests/helpers_description/transformation/split.yml index 5d4e66b4baa..416abe537b7 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/split.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/split.yml @@ -8,7 +8,7 @@ metadata: If the “field” already exists, then it will be replaced. In case of errors “field” will not be modified. This helper function is typically used in the map stage keywords: - - to define + - string helper_type: transformation diff --git a/src/engine/test/helper_tests/helpers_description/transformation/trim.yml b/src/engine/test/helper_tests/helpers_description/transformation/trim.yml index af455f342dc..c0c52335a6d 100644 --- a/src/engine/test/helper_tests/helpers_description/transformation/trim.yml +++ b/src/engine/test/helper_tests/helpers_description/transformation/trim.yml @@ -7,7 +7,7 @@ metadata: The result of the trim (trim) operation is mapped to “field”. In case of errors “field” will not be modified. This helper function is typically used in the map stage keywords: - - to define + - string helper_type: transformation