behavex 4.2.3__tar.gz → 4.2.4__tar.gz

{behavex-4.2.3/behavex.egg-info → behavex-4.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: behavex
-Version: 4.2.3
+Version: 4.2.4
 Summary: Agile testing framework on top of Behave (BDD).
 Home-page: https://github.com/hrcorval/behavex
 Author: Hernan Rey
@@ -29,7 +29,7 @@ Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: behave==1.2.6
-Requires-Dist: behavex-images>=3.0.10
+Requires-Dist: behavex-images>=3.2.1
 Requires-Dist: allure-python-commons
 Requires-Dist: jinja2
 Requires-Dist: configobj

{behavex-4.2.3 → behavex-4.2.4}/behavex/arguments.py

@@ -333,7 +333,6 @@ def parse_arguments(args):
         '--formatter-outdir',
         help="Specify the output directory for the custom formatter relative to the output folder",
         metavar='DIR',
-        default='report_artifacts',
         required=False,
     )
 

{behavex-4.2.3 → behavex-4.2.4}/behavex/conf_logging.cfg

@@ -11,12 +11,12 @@ keys=simpleFormatter
 encoding=utf-8-sig
 
 [logger_root]
-level=DEBUG
+level=INFO
 handlers=consoleHandler
 
 [handler_consoleHandler]
 class=StreamHandler
-level=DEBUG
+level=INFO
 encoding=utf-8-sig
 formatter=simpleFormatter
 args=(sys.stdout, )

{behavex-4.2.3 → behavex-4.2.4}/behavex/outputs/formatter_manager.py

@@ -9,16 +9,20 @@ Formatter manager module to handle custom formatters.
 import importlib
 import os
 import sys
-from typing import Optional, Type
+from typing import (Any, Dict, Optional,  # pyright: ignore[reportDeprecated]
+                    Type)
 
 from behavex.conf_mgr import get_env, get_param
 
+# Formatter Constants
+DEFAULT_FORMATTER_DIR = 'report-artifacts'
+
 
 class FormatterManager:
     """Manager class for handling custom formatters in BehaveX."""
 
     @staticmethod
-    def load_formatter(formatter_spec: str) -> Optional[Type]:
+    def load_formatter(formatter_spec: str) -> Optional[Type[Any]]: #pyright: ignore[reportDeprecated]
         """
         Load a formatter class from a module path specification.
 
@@ -64,25 +68,27 @@ class FormatterManager:
             return None
 
     @staticmethod
-    def get_formatter_output_dir() -> str:
+    def get_formatter_output_dir(formatter_spec: str) -> Optional[str]: #pyright: ignore[reportDeprecated]
         """
-        Get the output directory for the custom formatter.
+        Get the preferred output directory from a formatter class.
+
+        Args:
+            formatter_spec: String in format "module_path:FormatterClass"
 
         Returns:
-            Absolute path to the formatter output directory, or None if no custom directory is specified
+            The formatter's preferred output directory, or None if not found
         """
-        base_output = get_env('OUTPUT', 'output')
-        formatter_outdir = get_param('formatter_outdir', '')
-
-        # Return None if no custom formatter output directory is specified
-        # This allows formatters to use their own default directories
-        if not formatter_outdir or formatter_outdir == 'report_artifacts':
-            return None
+        try:
+            formatter_class = FormatterManager.load_formatter(formatter_spec)
+            if formatter_class and hasattr(formatter_class, 'DEFAULT_OUTPUT_DIR'):
+                return formatter_class.DEFAULT_OUTPUT_DIR
+        except Exception as e:
+            print(f"Warning: Could not load formatter {formatter_spec} to get output directory: {str(e)}")
 
-        return os.path.join(base_output, formatter_outdir)
+        return None
 
     @staticmethod
-    def format_results(json_output: dict) -> None:
+    def format_results(json_output: Dict[str, Any]) -> None: #pyright: ignore[reportDeprecated]
         """
         Format test results using the specified custom formatter.
 
@@ -97,20 +103,17 @@ class FormatterManager:
         if not formatter_class:
             return
 
-        output_dir = FormatterManager.get_formatter_output_dir()
-
-        # Create the output directory only if a custom one is specified
-        if output_dir:
-            os.makedirs(output_dir, exist_ok=True)
+        # The formatter will handle its own output directory setup
+        # No need to create directories here since formatters manage their own paths
 
         try:
             formatter = formatter_class()
             # Check if the formatter has the expected method
-            if not hasattr(formatter, 'parse_json_to_allure'):
-                print(f"Formatter {formatter_class.__name__} does not implement required method 'parse_json_to_allure'")
+            if not hasattr(formatter, 'launch_json_formatter'):
+                print(f"Formatter {formatter_class.__name__} does not implement required method 'launch_json_formatter'")
                 return
 
-            formatter.parse_json_to_allure(json_output)
+            formatter.launch_json_formatter(json_output)
         except Exception as e:
             print(f"Error running formatter {formatter_spec}: {str(e)}")
             import traceback

{behavex-4.2.3 → behavex-4.2.4}/behavex/outputs/formatters/allure_behavex_formatter.py

@@ -31,7 +31,6 @@ import os
 import re
 import sys
 import uuid
-from datetime import datetime
 from pathlib import Path
 
 from allure_commons.model2 import (Attachment, Parameter, TestResult,
@@ -40,13 +39,15 @@ from allure_commons.types import AttachmentType
 from allure_commons.utils import now
 
 from behavex.conf_mgr import get_env, get_param
-from behavex.outputs.formatter_manager import FormatterManager
 from behavex.outputs.report_utils import get_string_hash
 
 
 class AllureBehaveXFormatter:
     """Allure formatter for BehaveX test results."""
 
+    # Default output directory for this formatter
+    DEFAULT_OUTPUT_DIR = 'allure-results'
+
     def _get_step_line_from_image(self, filename):
         """Extract step line number from image filename.
 
@@ -243,7 +244,11 @@ class AllureBehaveXFormatter:
             TestResult: The updated test case with evidence attachments
         """
 
-        evidence_dir = os.path.join(get_env('logs', 'output/allure-results'), str(scenario_hash), 'evidence')
+        logs_dir = get_env('logs')
+        if logs_dir is None:
+            # Handle standalone script execution case
+            logs_dir = os.path.join(os.path.dirname(output_dir), 'outputs', 'logs')
+        evidence_dir = os.path.join(logs_dir, str(scenario_hash), 'evidence')
 
         if not os.path.exists(evidence_dir):
             return test_case
@@ -297,19 +302,20 @@ class AllureBehaveXFormatter:
 
         return test_case
 
-    def parse_json_to_allure(self, json_data):
+    def launch_json_formatter(self, json_data):
         """
-        Parses the JSON report data and converts it into Allure-compatible results.
+        Generic method to launch the formatter and process JSON test results.
 
         Args:
             json_data (dict): Dictionary containing the test results data.
         """
-        # Get the formatter output directory from FormatterManager
-        formatter_output_dir = FormatterManager.get_formatter_output_dir()
+        # Use the LOGS environment variable which is set consistently by the runner
+        # This ensures evidence, logs, and allure results are all in the same location
+        output_dir = get_env('logs')
 
-        # If a custom output directory is specified, use it.
-        # Otherwise, default to 'output/allure-results'.
-        output_dir = formatter_output_dir or os.path.join(get_env('OUTPUT', 'output'), 'allure-results')
+        # Fallback if LOGS is not set (for standalone script execution)
+        if not output_dir:
+            output_dir = os.path.join(get_env('OUTPUT') or 'output', self.DEFAULT_OUTPUT_DIR)
 
         os.makedirs(output_dir, exist_ok=True)
 
@@ -487,7 +493,11 @@ class AllureBehaveXFormatter:
                 # Process scenario logs as attachment
                 if get_param('formatter_attach_logs'):
                     scenario_hash = scenario.get('identifier_hash', get_string_hash(f"{str(feature['filename'])}-{str(scenario['line'])}"))
-                    log_path = os.path.join(get_env('logs', 'output/allure-results'), str(scenario_hash), 'scenario.log')
+                    logs_dir_for_log = get_env('logs')
+                    if logs_dir_for_log is None:
+                        # Handle standalone script execution case
+                        logs_dir_for_log = os.path.join(os.path.dirname(output_dir), 'outputs', 'logs')
+                    log_path = os.path.join(logs_dir_for_log, str(scenario_hash), 'scenario.log')
                     if os.path.exists(log_path):
                         # Use relative path for the source if possible to avoid duplication
                         rel_path = os.path.relpath(log_path, output_dir) if output_dir in log_path else log_path
@@ -637,7 +647,6 @@ class AllureBehaveXFormatter:
             with open(os.path.join(output_dir, "environment-categories.json"), "w") as f:
                 json.dump(env_categories, f, indent=2)
 
-
 def main():
     parser = argparse.ArgumentParser(description='Parse BehaveX report.json into Allure format')
     parser.add_argument('--report-path',
@@ -651,7 +660,7 @@ def main():
 
     try:
         with open(args.report_path) as f:
-            formatter.parse_json_to_allure(json.load(f))
+            formatter.launch_json_formatter(json.load(f))
     except FileNotFoundError:
         print(f"Error: Could not find report file at {args.report_path}")
         sys.exit(1)

{behavex-4.2.3 → behavex-4.2.4}/behavex/runner.py

@@ -43,6 +43,8 @@ from behavex.environment import extend_behave_hooks
 from behavex.execution_singleton import ExecutionSingleton
 from behavex.global_vars import global_vars
 from behavex.outputs import report_xml
+from behavex.outputs.formatter_manager import (DEFAULT_FORMATTER_DIR,
+                                               FormatterManager)
 from behavex.outputs.report_json import generate_execution_info
 from behavex.outputs.report_utils import (get_overall_status,
                                           match_for_execution,
@@ -1085,8 +1087,25 @@ def _set_env_variables(args):
     if get_param('name'):
         set_env_variable('NAME', args.name)
     if get_param('formatter'):
-        formatter_outdir = get_param('formatter_outdir')
-        set_env_variable('LOGS', os.path.join(get_env('output'), formatter_outdir))
+        formatter_outdir = get_param('formatter_outdir', '')
+        formatter_spec = get_param('formatter')
+
+        # If no formatter output directory is specified, use the default
+        if not formatter_outdir:
+            formatter_outdir = DEFAULT_FORMATTER_DIR
+
+        # Special handling for custom formatters with default settings
+        if formatter_outdir == DEFAULT_FORMATTER_DIR and formatter_spec:
+            # Try to dynamically get the formatter's preferred output directory
+            custom_formatter_dir = FormatterManager.get_formatter_output_dir(formatter_spec)
+            if custom_formatter_dir:
+                # Use the formatter's preferred directory to maintain consistency
+                set_env_variable('LOGS', os.path.join(get_env('output'), custom_formatter_dir))
+            else:
+                # Fallback to default formatter directory
+                set_env_variable('LOGS', os.path.join(get_env('output'), formatter_outdir))
+        else:
+            set_env_variable('LOGS', os.path.join(get_env('output'), formatter_outdir))
     else:
         set_env_variable('LOGS', os.path.join(get_env('output'), 'outputs', 'logs'))
     for arg in BEHAVEX_ARGS[4:]:

{behavex-4.2.3 → behavex-4.2.4}/behavex/utils.py

@@ -79,7 +79,7 @@ def get_logging_level():
         log_level = get_param('logging_level')
     else:
         log_level = LOGGING_CFG['logger_root']['level']
-        log_level = LOGGING_LEVELS.get(log_level.lower(), logging.DEBUG)
+        log_level = LOGGING_LEVELS.get(log_level.lower(), logging.INFO)
     return log_level
 
 

{behavex-4.2.3 → behavex-4.2.4/behavex.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: behavex
-Version: 4.2.3
+Version: 4.2.4
 Summary: Agile testing framework on top of Behave (BDD).
 Home-page: https://github.com/hrcorval/behavex
 Author: Hernan Rey
@@ -29,7 +29,7 @@ Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: behave==1.2.6
-Requires-Dist: behavex-images>=3.0.10
+Requires-Dist: behavex-images>=3.2.1
 Requires-Dist: allure-python-commons
 Requires-Dist: jinja2
 Requires-Dist: configobj

{behavex-4.2.3 → behavex-4.2.4}/behavex.egg-info/requires.txt

@@ -1,5 +1,5 @@
 behave==1.2.6
-behavex-images>=3.0.10
+behavex-images>=3.2.1
 allure-python-commons
 jinja2
 configobj

{behavex-4.2.3 → behavex-4.2.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "behavex"
-version = "4.2.3"
+version = "4.2.4"
 description = "Agile testing framework on top of Behave (BDD)."
 readme = "README.md"
 license = { text = "MIT" }
@@ -14,7 +14,7 @@ authors = [
 requires-python = ">=3.5"
 dependencies = [
     "behave==1.2.6",
-    "behavex-images>=3.0.10",
+    "behavex-images>=3.2.1",
     "allure-python-commons",
     "jinja2",
     "configobj",

{behavex-4.2.3 → behavex-4.2.4}/setup.py

@@ -6,7 +6,7 @@ with open('README.md', 'r') as fh:
 
 setup(
     name='behavex',
-    version='4.2.3',
+    version='4.2.4',
     license="MIT",
     platforms=['any'],
     python_requires='>=3.5',
@@ -25,7 +25,7 @@ setup(
     },
     install_requires=[
         'behave==1.2.6',
-        'behavex-images>=3.2.0',
+        'behavex-images>=3.2.1',
         'allure-python-commons',
         'jinja2',
         'configobj',

behavex-4.2.4/tests/features/environment.py

@@ -0,0 +1,13 @@
+
+def before_all(context):
+    # Configure behavex-images to always attach images to reports
+    try:
+        from behavex_images import image_attachments
+        from behavex_images.image_attachments import AttachmentsCondition
+        image_attachments.set_attachments_condition(context, AttachmentsCondition.ALWAYS)
+    except ImportError:
+        pass  # behavex-images not available
+
+
+def before_scenario(context, scenario):
+    context.progress_bar = False

behavex-4.2.4/tests/features/secondary_features/environment.py

@@ -0,0 +1,16 @@
+
+def before_all(context):
+    # Configure behavex-images to always attach images to reports
+    try:
+        from behavex_images import image_attachments
+        from behavex_images.image_attachments import AttachmentsCondition
+        image_attachments.set_attachments_condition(context, AttachmentsCondition.ALWAYS)
+    except ImportError:
+        pass  # behavex-images not available
+
+
+def after_scenario(context, scenario):
+    if hasattr(context, 'new_scenario_name'):
+        scenario.name = context.new_scenario_name
+    if hasattr(context, 'new_feature_name'):
+        scenario.feature.name = context.new_feature_name

{behavex-4.2.3 → behavex-4.2.4}/tests/features/secondary_features/steps/generic_secondary_steps.py

@@ -1,7 +1,19 @@
 import logging
+import os
 
 from behave import given, then, when
 
+# Get paths
+root_project_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', '..', '..'))
+test_images_path = os.path.join(root_project_path, 'tests', 'test_images')
+
+# Import behavex-images functionality
+try:
+    from behavex_images import image_attachments
+    behavex_images_available = True
+except ImportError:
+    behavex_images_available = False
+
 
 @given('a failing condition')
 def step_impl(context):
@@ -56,3 +68,30 @@ def step_impl(context, feature_or_scenario, suffix):
         logging.info('I rename the scenario from \n"{}" \nto \n"{}"'.format(context.scenario.name, context.new_scenario_name))
     else:
         raise ValueError('Invalid element, it should be "feature" or "scenario"')
+
+
+@given('I take a screenshot using test image {image_number}')
+def step_take_screenshot_using_test_image(context, image_number):
+    """Attach a test image file using behavex-images"""
+    if not behavex_images_available:
+        logging.warning("behavex-images not available, skipping image attachment")
+        return
+
+    image_path = os.path.join(test_images_path, f'test_image_{image_number}.png')
+    if os.path.exists(image_path):
+        image_attachments.attach_image_file(context, image_path)
+        logging.info(f"Attached test image: {image_path}")
+    else:
+        raise FileNotFoundError(f"Test image not found: {image_path}")
+
+
+@when('I validate image attachments')
+def step_validate_image_attachments(context):
+    """Simple validation step for image attachments"""
+    logging.info("Validating image attachments")
+
+
+@then('I should see attached images in the output')
+def step_verify_attached_images_in_output(context):
+    """Verify that images were attached"""
+    logging.info("Images were attached to the test output")

{behavex-4.2.3 → behavex-4.2.4}/tests/features/steps/execution_steps.py

@@ -8,6 +8,15 @@ from behave import given, then, when
 
 root_project_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..', '..', '..'))
 tests_features_path = os.path.join(root_project_path, 'tests', 'features')
+test_images_path = os.path.join(root_project_path, 'tests', 'test_images')
+
+# Import behavex-images functionality
+try:
+    from behavex_images import image_attachments
+    behavex_images_available = True
+except ImportError:
+    behavex_images_available = False
+    logging.warning("behavex-images not available, image attachment tests will be skipped")
 
 
 @given('The progress bar is enabled')
@@ -118,6 +127,7 @@ def run_command_with_scheme_processes_and_tags(context, scenario_name=None, argu
         tags_array = []
     else:
         tags_array = get_tags_arguments(tags)
+    feature_path_2 = None
     if feature_name:
         if feature_name_2:
             feature_path = os.path.join(tests_features_path, 'secondary_features', feature_name)
@@ -294,6 +304,110 @@ def get_total_scenarios_in_junit_reports(context, consider_skipped_scenarios=Tru
     return total_scenarios_in_junit_reports
 
 
+@given('I take a screenshot using test image {image_number}')
+def step_take_screenshot_using_test_image(context, image_number):
+    """Attach a test image file using behavex-images"""
+    if not behavex_images_available:
+        logging.warning("behavex-images not available, skipping image attachment")
+        return
+
+    # Import here to avoid issues if behavex-images is not available
+    from behavex_images import image_attachments
+
+    image_path = os.path.join(test_images_path, f'test_image_{image_number}.png')
+    if os.path.exists(image_path):
+        image_attachments.attach_image_file(context, image_path)
+        logging.info(f"Attached test image: {image_path}")
+    else:
+        raise FileNotFoundError(f"Test image not found: {image_path}")
+
+
+@when('I run the behavex command with image attachments')
+def step_run_behavex_with_image_attachments(context):
+    """Run behavex with HTML formatter and image attachments enabled"""
+    context.output_path = os.path.join('output', 'output_{}'.format(get_random_number(6)))
+    execution_args = [
+        'behavex',
+        os.path.join(tests_features_path, 'secondary_features', 'simple_image_tests.feature'),
+        '-o', context.output_path,
+        '-t', '@IMAGE_ATTACHMENT',
+        '-t', '@HTML_REPORT'
+    ]
+    execute_command(context, execution_args)
+
+
+@when('I run the behavex command with allure formatter and image attachments')
+def step_run_behavex_with_allure_and_image_attachments(context):
+    """Run behavex with Allure formatter and image attachments enabled"""
+    context.output_path = os.path.join('output', 'output_{}'.format(get_random_number(6)))
+    execution_args = [
+        'behavex',
+        os.path.join(tests_features_path, 'secondary_features', 'simple_image_tests.feature'),
+        '-o', context.output_path,
+        '--formatter=behavex.outputs.formatters.allure_behavex_formatter:AllureBehaveXFormatter',
+        '-t', '@IMAGE_ATTACHMENT',
+        '-t', '@ALLURE_FORMATTER'
+    ]
+    execute_command(context, execution_args)
+
+
+@then('I should see the HTML report contains screenshots')
+def step_verify_html_report_contains_screenshots(context):
+    """Verify that the HTML report contains attached screenshots"""
+    html_report_path = os.path.join(context.output_path, 'report.html')
+    if os.path.exists(html_report_path):
+        with open(html_report_path, 'r', encoding='utf-8') as f:
+            html_content = f.read()
+            # Look for image references in the HTML
+            assert 'test_image_' in html_content, "Screenshots not found in HTML report"
+            logging.info("Screenshots found in HTML report")
+    else:
+        raise FileNotFoundError(f"HTML report not found: {html_report_path}")
+
+
+@then('I should see the HTML report contains the image gallery icon')
+def step_verify_html_report_contains_gallery_icon(context):
+    """Verify that the HTML report contains the image gallery icon"""
+    html_report_path = os.path.join(context.output_path, 'report.html')
+    if os.path.exists(html_report_path):
+        with open(html_report_path, 'r', encoding='utf-8') as f:
+            html_content = f.read()
+            # Look for the specific gallery icon HTML element
+            gallery_icon = '<span class="glyphicon glyphicon-picture">'
+            assert gallery_icon in html_content, "Image gallery icon not found in HTML report"
+            logging.info("Image gallery icon found in HTML report")
+    else:
+        raise FileNotFoundError(f"HTML report not found: {html_report_path}")
+
+
+@then('I should see that images are stored in the allure formatter output directory')
+def step_verify_images_in_allure_output(context):
+    """Verify that images are stored in the Allure formatter output directory"""
+    allure_results_path = os.path.join(context.output_path, 'allure-results')
+    if os.path.exists(allure_results_path):
+        # Look for image attachments in allure results
+        allure_files = os.listdir(allure_results_path)
+        image_files = [f for f in allure_files if f.endswith('.png') or f.endswith('.jpg') or f.endswith('.jpeg')]
+        assert len(image_files) > 0, "No image files found in Allure output directory"
+        logging.info(f"Found {len(image_files)} image files in Allure output directory")
+
+        # Also check for attachment references in JSON files
+        json_files = [f for f in allure_files if f.endswith('.json')]
+        found_attachment_reference = False
+        for json_file in json_files:
+            json_path = os.path.join(allure_results_path, json_file)
+            with open(json_path, 'r', encoding='utf-8') as f:
+                json_content = f.read()
+                if 'attachments' in json_content and 'image' in json_content:
+                    found_attachment_reference = True
+                    break
+
+        assert found_attachment_reference, "No image attachment references found in Allure JSON files"
+        logging.info("Image attachment references found in Allure JSON files")
+    else:
+        raise FileNotFoundError(f"Allure results directory not found: {allure_results_path}")
+
+
 def execute_command(context, execution_args, print_output=True):
     if "progress_bar" in context and context.progress_bar:
         execution_args.insert(2, '--show-progress-bar')

behavex-4.2.3/tests/features/environment.py

@@ -1,3 +0,0 @@
-
-def before_scenario(context, scenario):
-    context.progress_bar = False

behavex-4.2.3/tests/features/secondary_features/environment.py

@@ -1,6 +0,0 @@
-
-def after_scenario(context, scenario):
-    if hasattr(context, 'new_scenario_name'):
-        scenario.name = context.new_scenario_name
-    if hasattr(context, 'new_feature_name'):
-        scenario.feature.name = context.new_feature_name