Add Workflow module to Wazuh-qa repository #4990
Conversation
fcaffieri
requested review from
rauldpm,
QU3B1M,
pro-akim and
davidjiglesias
deployability/modules/workflow_engine/examples/dtt1-agents-poc.yaml
Outdated
Show resolved
Hide resolved
deployability/modules/setup.py
Outdated
| script_path = os.path.dirname(__file__) | ||
| rel_path = "../version.json" | ||
| abs_file_path = os.path.join(script_path, rel_path) | ||
| f = open(abs_file_path) |
There was a problem hiding this comment.
Always use a with statement to open files, ensuring an appropriate context handling
| from setuptools import setup, find_packages | ||
| import os | ||
|
|
||
| def get_files_from_directory(directory): |
There was a problem hiding this comment.
This may lead to including unwanted files (like temporary or binary files) in the distribution package. It's generally better to specify only the types of files we need explicitly.
deployability/modules/setup.py
Outdated
| paths = [] | ||
| for (path, directories, filenames) in os.walk(directory): | ||
| for filename in filenames: | ||
| paths.append(os.path.join('..', path, filename)) |
There was a problem hiding this comment.
We are assuming the package's structure relative to where the setup script is run, which can vary and not work as expected while packaging. We need to consider using a more predictable method to specify package data instead of ../
deployability/modules/setup.py
Outdated
|
|
||
| def get_version(): | ||
| script_path = os.path.dirname(__file__) | ||
| rel_path = "../version.json" |
There was a problem hiding this comment.
We always need to add appropriate exception handling, if the version.json file doesn't exist or contains invalid JSON it will lead to a runtime error without proper handling.
|
|
||
| class ThreadIDFilter(logging.Filter): | ||
| """ | ||
| A filter that uppercases the name of the log record. |
There was a problem hiding this comment.
This seems wrong based on the function below
| """ | ||
| A filter that uppercases the name of the log record. | ||
| """ | ||
| def filter(self, record: str) -> bool: |
There was a problem hiding this comment.
The str type hint is incorrect, it should be logging.LogRecord
| bool: True if the record should be logged, False otherwise. | ||
| """ | ||
| record.thread_id = threading.get_native_id() | ||
| return record |
There was a problem hiding this comment.
This is not returning a bool but the record itself
|
|
||
| def _load_config() -> None: | ||
| """ | ||
| Loads the logging configuration from 'config.yaml' file. |
There was a problem hiding this comment.
Add error handling around the file reading and YAML parsing process. If the config.yaml file is missing, corrupt, or contains invalid YAML, the application should handle this gracefully, possibly falling back to a default logging configuration.
| @@ -0,0 +1,3 @@ | |||
| # Copyright (C) 2015, Wazuh Inc. | |||
There was a problem hiding this comment.
What is this empty file?
There was a problem hiding this comment.
This file is not used for the Workflow, it is dragged in case it is required at some point, but at the moment it is not necessary and was eliminated in 39e5f11.
davidjiglesias
deleted the
4989-dtt1-iteration-3-workflow-engine-module-release-workflow-module
branch
Description
The objective of the PR is to incorporate the DTT Workflow module into the QA repository.
Related to: #4905
Testing performed
All test in: #4910