Formatter Integration

class AllureFormatter:
    def __init__(self, stream_opener, config):
        """
        Initialize the Allure formatter.
        
        Parameters:
        - stream_opener: Behave's stream opener for output handling
        - config: Behave configuration object containing test settings
        """
    
    def uri(self, uri):
        """
        Process feature file URI when starting a new feature file.
        
        Parameters:
        - uri (str): Path to the feature file being processed
        """
    
    def feature(self, feature):
        """
        Process feature object and wrap scenarios for Allure integration.
        
        Parameters:
        - feature: Behave feature object containing scenarios and metadata
        """
    
    def step(self, step):
        """
        Schedule a step for execution tracking.
        
        Parameters:
        - step: Behave step object with keyword, name, and optional table/text
        """
    
    def match(self, match):
        """
        Process step match with step definition.
        
        Parameters:
        - match: Behave match object linking step to its implementation
        """
    
    def result(self, result):
        """
        Process step execution result.
        
        Parameters:
        - result: Behave result object with status, duration, and exception info
        """
    
    def eof(self):
        """
        Handle end of feature file processing.
        """
    
    def close(self):
        """
        Clean up formatter resources and unregister plugins.
        """
    
    def close_stream(self):
        """
        Stop the test session and finalize reporting.
        """

# Basic usage - generate reports in 'allure_results' directory
behave -f allure_behave.formatter:AllureFormatter -o allure_results ./features

# With specific output directory
behave -f allure_behave.formatter:AllureFormatter -o /path/to/results ./features

# Combined with other formatters (e.g., pretty for console output)
behave -f pretty -f allure_behave.formatter:AllureFormatter -o allure_results ./features

# With behave configuration options
behave -f allure_behave.formatter:AllureFormatter -o results \
       -D AllureFormatter.issue_pattern=https://jira.example.com/browse/{} \
       -D AllureFormatter.link_pattern=https://docs.example.com/{} \
       ./features

# Generate static HTML report
allure generate allure_results -o allure_report --clean

# Serve report on local web server
allure serve allure_results

# Open generated report
allure open allure_report

# Issue link pattern - converts @issue.ABC-123 tags to clickable links
behave -f allure_behave.formatter:AllureFormatter -o results \
       -D AllureFormatter.issue_pattern=https://jira.company.com/browse/{}

# Custom link pattern - converts @link.DOC-456 tags to documentation links  
behave -f allure_behave.formatter:AllureFormatter -o results \
       -D AllureFormatter.link_pattern=https://docs.company.com/{}

# Hide tests excluded by test plan
behave -f allure_behave.formatter:AllureFormatter -o results \
       -D AllureFormatter.hide_excluded=true

pipeline {
    agent any
    stages {
        stage('Test') {
            steps {
                sh 'behave -f allure_behave.formatter:AllureFormatter -o allure_results ./features'
            }
            post {
                always {
                    allure includeProperties: false, 
                           jdk: '', 
                           results: [[path: 'allure_results']]
                }
            }
        }
    }
}