enhacement(#4909): Changes in playbooks dir, setup.py and launchers

deployability/Jenkinsfiles/Launcher.groovy

@@ -1,7 +1,6 @@
-
 String jenkins_reference = params.getOrDefault('JENKINS_REFERENCE', 'enhancement/4751-dtt1-iteration-2-poc')
-String launcher_path = "launchers"
-String task_flow_launcher = "provision.py"
+String launcher_path = "modules/provision"
+String task_flow_launcher = "main.py"
 String workflow = "modules/workflow_engine/examples/dtt1-managers.yaml"
 String schema = "modules/workflow_engine/schema.json"
 

deployability/Jenkinsfiles/Provision.groovy

@@ -1,7 +1,5 @@
-
-
-String provision_path = "${WORKSPACE}/scripts/provision"
-String provision_script = "provision.py"
+String provision_path = "${WORKSPACE}/modules/provision"
+String provision_script = "main.py"
 String inventory = "inventory.yaml"
 String jenkins_reference = params.getOrDefault('JENKINS_REFERENCE', 'enhancement/4665-dtt1-poc')
 

deployability/launchers/allocation.py → deployability/modules/allocation/main.py

@@ -2,7 +2,7 @@
 import os
 import sys
 
-project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '../..'))
 sys.path.append(project_root)
 
 from modules.allocation import Allocator

deployability/modules/generic/ansible.py

@@ -19,7 +19,9 @@ class Inventory(BaseModel):
 class Ansible:
     def __init__(self, ansible_data: dict | Inventory, path: str | Path = None):
         self.path = path
-        self.playbooks_path = Path(__file__).parents[2] / 'playbooks'
+        self.modules_path = Path(__file__).parents[2]
+        self.provision_playbook_path = self.modules_path / 'provision/playbooks'
+        self.testing_playbook_path = self.modules_path / 'testing/playbooks'
         self.ansible_data = Inventory(**dict(ansible_data))
         self.inventory = self.generate_inventory()
         self.logger = Logger(Path(__file__).stem).get_logger()
@@ -32,7 +34,7 @@ def render_playbooks(self, rendering_variables: dict) -> list[str]:
             rendering_variables (dict): Extra variables to render the playbooks.
         """
         tasks = []
-        path_to_render_playbooks = self.playbooks_path / rendering_variables.get("templates_path")
+        path_to_render_playbooks = self.provision_playbook_path / rendering_variables.get("templates_path")
         template_loader = jinja2.FileSystemLoader(searchpath=path_to_render_playbooks)
         template_env = jinja2.Environment(loader=template_loader)
 

deployability/launchers/provision.py → deployability/modules/provision/main.py

@@ -6,7 +6,7 @@
 
 # ---------------- Vars ------------------------
 
-project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '../..'))
 sys.path.append(project_root)
 
 from modules.provision import Provision, models

deployability/modules/setup.py

@@ -0,0 +1,49 @@
+
+# Copyright (C) 2015-2024, Wazuh Inc.
+# Created by Wazuh, Inc. <[email protected]>.
+# This program is free software; you can redistribute it and/or modify it under the terms of GPLv2
+import json
+from setuptools import setup, find_packages
+import os
+
+def get_files_from_directory(directory):
+    paths = []
+    for (path, directories, filenames) in os.walk(directory):
+        for filename in filenames:
+            paths.append(os.path.join('..', path, filename))
+    return paths
+
+def get_version():
+    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)
+    data = json.load(f)
+    version = data['version']
+    return version
+
+scripts_list = [
+                'models=workflow_engine.models:main',
+                'schema_validator=workflow_engine.schema_validator:main',
+                'task=workflow_engine.task:main',
+                'workflow_processor=workflow_engine.workflow_processor:main',
+                'main=workflow_engine.main:main'
+]
+
+package_data_list = get_files_from_directory("workflow_engine")
+
+setup(
+    name='workflow_engine',
+    version=get_version(),
+    description='Wazuh testing utilities to help programmers automate deployment tests',
+    url='https://github.com/wazuh',
+    author='Wazuh',
+    author_email='[email protected]',
+    license='GPLv2',
+    packages=['workflow_engine'],
+    package_dir={'workflow_engine': 'workflow_engine'},
+    package_data={'workflow_engine': package_data_list},
+    entry_points={'console_scripts': scripts_list},
+    include_package_data=True,
+    zip_safe=False
+)

deployability/launchers/test.py → deployability/modules/testing/main.py

@@ -2,7 +2,7 @@
 import sys
 import os
 
-project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '../..'))
 sys.path.append(project_root)
 
 from modules.testing import Tester, InputPayload

deployability/modules/testing/testing.py

@@ -77,7 +77,7 @@ def _run_tests(cls, test_list: list[str], ansible: Ansible, extra_vars: ExtraVar
         """
         for test in test_list:
             rendering_var = {**extra_vars, 'test': test}
-            template = str(ansible.playbooks_path / cls._test_template)
+            template = str(ansible.testing_playbook_path / cls._test_template)
             playbook = ansible.render_playbook(template, rendering_var)
             if not playbook:
                 logger.warning(f"Test {test} not found. Skipped.")
@@ -95,7 +95,7 @@ def _setup(cls, ansible: Ansible, remote_working_dir: str = '/tmp') -> None:
         """
         extra_vars = {'local_path': str(Path(__file__).parent / 'tests'),
                       'working_dir': remote_working_dir}
-        playbook = str(ansible.playbooks_path / cls._setup_playbook)
+        playbook = str(ansible.testing_playbook_path / cls._setup_playbook)
         ansible.run_playbook(playbook, extra_vars)
 
     @classmethod
@@ -108,5 +108,5 @@ def _cleanup(cls, ansible: Ansible, remote_working_dir: str = '/tmp') -> None:
             remote_working_dir (str): The remote working directory.
         """
         extra_vars = {'working_dir': remote_working_dir}
-        playbook = str(ansible.playbooks_path / cls._cleanup_playbook)
+        playbook = str(ansible.testing_playbook_path / cls._cleanup_playbook)
         ansible.run_playbook(playbook, extra_vars)

deployability/modules/workflow_engine.egg-info/PKG-INFO

@@ -0,0 +1,8 @@
+Metadata-Version: 2.1
+Name: workflow_engine
+Version: 1.0
+Summary: Wazuh testing utilities to help programmers automate deployment tests
+Home-page: https://github.com/wazuh
+Author: Wazuh
+Author-email: [email protected]
+License: GPLv2

deployability/modules/workflow_engine.egg-info/SOURCES.txt

@@ -0,0 +1,29 @@
+setup.py
+workflow_engine/README.md
+workflow_engine/__init__.py
+workflow_engine/main.py
+workflow_engine/models.py
+workflow_engine/schema_validator.py
+workflow_engine/task.py
+workflow_engine/workflow_processor.py
+workflow_engine.egg-info/PKG-INFO
+workflow_engine.egg-info/SOURCES.txt
+workflow_engine.egg-info/dependency_links.txt
+workflow_engine.egg-info/entry_points.txt
+workflow_engine.egg-info/not-zip-safe
+workflow_engine.egg-info/top_level.txt
+workflow_engine/__pycache__/__init__.cpython-310.pyc
+workflow_engine/__pycache__/models.cpython-310.pyc
+workflow_engine/__pycache__/schema_validator.cpython-310.pyc
+workflow_engine/__pycache__/task.cpython-310.pyc
+workflow_engine/__pycache__/utils.cpython-310.pyc
+workflow_engine/__pycache__/workflow_processor.cpython-310.pyc
+workflow_engine/examples/dtt1-agents-poc.yaml
+workflow_engine/examples/dtt1-agents.yaml
+workflow_engine/examples/dtt1-managers.yaml
+workflow_engine/logging/__init__.py
+workflow_engine/logging/config.yaml
+workflow_engine/logging/filter.py
+workflow_engine/logging/logger.py
+workflow_engine/logging/__pycache__/__init__.cpython-310.pyc
+workflow_engine/schemas/schema_v1.json

deployability/modules/workflow_engine.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

deployability/modules/workflow_engine.egg-info/entry_points.txt

@@ -0,0 +1,7 @@
+[console_scripts]
+main = workflow_engine.main:main
+models = workflow_engine.models:main
+schema_validator = workflow_engine.schema_validator:main
+task = workflow_engine.task:main
+utils = workflow_engine.utils:main
+workflow_processor = workflow_engine.workflow_processor:main

deployability/modules/workflow_engine.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

deployability/modules/workflow_engine.egg-info/top_level.txt

@@ -0,0 +1 @@
+workflow_engine

deployability/modules/workflow_engine/__init__.py

@@ -1 +1 @@
-from .workflow_processor import WorkflowProcessor
+#from .workflow_processor import WorkflowProcessor

deployability/launchers/workflow_engine.py → deployability/modules/workflow_engine/main.py

@@ -6,11 +6,11 @@
 import sys
 import argparse
 
-project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '../..'))
 sys.path.append(project_root)
 
-from modules.workflow_engine.workflow_processor import WorkflowProcessor
-from modules.workflow_engine.models import InputPayload
+from workflow_engine.workflow_processor import WorkflowProcessor
+from workflow_engine.models import InputPayload
 
 
 def parse_arguments() -> argparse.Namespace:

deployability/modules/workflow_engine/schema_validator.py

@@ -5,7 +5,7 @@
 from pathlib import Path
 from ruamel.yaml import YAML
 
-from .logging.logger import logger
+from workflow_engine.logging.logger import logger
 
 
 class SchemaValidator:

deployability/modules/workflow_engine/task.py

@@ -7,7 +7,7 @@
 import time
 
 from abc import ABC, abstractmethod
-from .logging.logger import logger
+from workflow_engine.logging.logger import logger
 
 
 class Task(ABC):

deployability/modules/workflow_engine/workflow_processor.py

@@ -11,9 +11,9 @@
 from pathlib import Path 
 from itertools import product
 
-from .logging.logger import logger
-from .schema_validator import SchemaValidator
-from .task import Task, TASKS_HANDLERS
+from workflow_engine.logging.logger import logger
+from workflow_engine.schema_validator import SchemaValidator
+from workflow_engine.task import Task, TASKS_HANDLERS
 
 
 class WorkflowFile:

deployability/version.json

@@ -0,0 +1,4 @@
+{
+    "version": "1.0",
+    "revision": "1"
+}