|
| 1 | +# Copyright (c) Microsoft Corporation. |
| 2 | +# Licensed under the MIT license. |
| 3 | + |
| 4 | +from __future__ import annotations |
| 5 | + |
| 6 | +import logging |
| 7 | +from abc import ABC |
| 8 | +from dataclasses import dataclass |
| 9 | +from typing import Optional, TypeVar |
| 10 | + |
| 11 | +from pyrit.common.logger import logger |
| 12 | +from pyrit.executor.core.strategy import ( |
| 13 | + Strategy, |
| 14 | + StrategyContext, |
| 15 | + StrategyEvent, |
| 16 | + StrategyEventData, |
| 17 | + StrategyEventHandler, |
| 18 | +) |
| 19 | +from pyrit.models import StrategyResult |
| 20 | + |
| 21 | +WorkflowContextT = TypeVar("WorkflowContextT", bound="WorkflowContext") |
| 22 | +WorkflowResultT = TypeVar("WorkflowResultT", bound="WorkflowResult") |
| 23 | + |
| 24 | + |
| 25 | +@dataclass |
| 26 | +class WorkflowContext(StrategyContext, ABC): |
| 27 | + """Base class for all workflow contexts""" |
| 28 | + |
| 29 | + pass |
| 30 | + |
| 31 | + |
| 32 | +@dataclass |
| 33 | +class WorkflowResult(StrategyResult, ABC): |
| 34 | + """Base class for all workflow results""" |
| 35 | + |
| 36 | + pass |
| 37 | + |
| 38 | + |
| 39 | +class _DefaultWorkflowEventHandler(StrategyEventHandler[WorkflowContextT, WorkflowResultT]): |
| 40 | + """ |
| 41 | + Default event handler for workflow strategies. |
| 42 | + Handles events during the execution of a workflow strategy. |
| 43 | + """ |
| 44 | + |
| 45 | + def __init__(self, logger: logging.Logger = logger): |
| 46 | + """ |
| 47 | + Initialize the default event handler with a logger. |
| 48 | +
|
| 49 | + Args: |
| 50 | + logger (logging.Logger): Logger instance for logging events. |
| 51 | + """ |
| 52 | + self._logger = logger |
| 53 | + self._events = { |
| 54 | + StrategyEvent.ON_PRE_VALIDATE: self._on_pre_validate, |
| 55 | + StrategyEvent.ON_POST_VALIDATE: self._on_post_validate, |
| 56 | + StrategyEvent.ON_PRE_SETUP: self._on_pre_setup, |
| 57 | + StrategyEvent.ON_POST_SETUP: self._on_post_setup, |
| 58 | + StrategyEvent.ON_PRE_EXECUTE: self._on_pre_execute, |
| 59 | + StrategyEvent.ON_POST_EXECUTE: self._on_post_execute, |
| 60 | + StrategyEvent.ON_PRE_TEARDOWN: self._on_pre_teardown, |
| 61 | + StrategyEvent.ON_POST_TEARDOWN: self._on_post_teardown, |
| 62 | + StrategyEvent.ON_ERROR: self._on_error, |
| 63 | + } |
| 64 | + |
| 65 | + async def on_event(self, event_data: StrategyEventData[WorkflowContextT, WorkflowResultT]) -> None: |
| 66 | + """ |
| 67 | + Handle an event during the workflow strategy execution. |
| 68 | +
|
| 69 | + Args: |
| 70 | + event_data: The event data containing context and result. |
| 71 | + """ |
| 72 | + if event_data.event in self._events: |
| 73 | + handler = self._events[event_data.event] |
| 74 | + await handler(event_data) |
| 75 | + |
| 76 | + async def _on_pre_validate(self, event_data: StrategyEventData[WorkflowContextT, WorkflowResultT]) -> None: |
| 77 | + self._logger.debug(f"Starting validation for workflow {event_data.strategy_name}") |
| 78 | + |
| 79 | + async def _on_post_validate(self, event_data: StrategyEventData[WorkflowContextT, WorkflowResultT]) -> None: |
| 80 | + self._logger.debug(f"Validation completed for workflow {event_data.strategy_name}") |
| 81 | + |
| 82 | + async def _on_pre_setup(self, event_data: StrategyEventData[WorkflowContextT, WorkflowResultT]) -> None: |
| 83 | + self._logger.debug(f"Starting setup for workflow {event_data.strategy_name}") |
| 84 | + |
| 85 | + async def _on_post_setup(self, event_data: StrategyEventData[WorkflowContextT, WorkflowResultT]) -> None: |
| 86 | + self._logger.debug(f"Setup completed for workflow {event_data.strategy_name}") |
| 87 | + |
| 88 | + async def _on_pre_execute(self, event_data: StrategyEventData[WorkflowContextT, WorkflowResultT]) -> None: |
| 89 | + self._logger.info(f"Starting execution of workflow {event_data.strategy_name}") |
| 90 | + |
| 91 | + async def _on_post_execute(self, event_data: StrategyEventData[WorkflowContextT, WorkflowResultT]) -> None: |
| 92 | + self._logger.info(f"Workflow {event_data.strategy_name} completed.") |
| 93 | + |
| 94 | + async def _on_pre_teardown(self, event_data: StrategyEventData[WorkflowContextT, WorkflowResultT]) -> None: |
| 95 | + self._logger.debug(f"Starting teardown for workflow {event_data.strategy_name}") |
| 96 | + |
| 97 | + async def _on_post_teardown(self, event_data: StrategyEventData[WorkflowContextT, WorkflowResultT]) -> None: |
| 98 | + self._logger.debug(f"Teardown completed for workflow {event_data.strategy_name}") |
| 99 | + |
| 100 | + async def _on_error(self, event_data: StrategyEventData[WorkflowContextT, WorkflowResultT]) -> None: |
| 101 | + self._logger.error( |
| 102 | + f"Error in workflow {event_data.strategy_name}: {event_data.error}", exc_info=event_data.error |
| 103 | + ) |
| 104 | + |
| 105 | + |
| 106 | +class WorkflowStrategy(Strategy[WorkflowContextT, WorkflowResultT], ABC): |
| 107 | + """ |
| 108 | + Abstract base class for workflow strategies. |
| 109 | + Defines the interface for executing workflows and handling results. |
| 110 | + """ |
| 111 | + |
| 112 | + def __init__( |
| 113 | + self, |
| 114 | + *, |
| 115 | + context_type: type[WorkflowContextT], |
| 116 | + logger: logging.Logger = logger, |
| 117 | + event_handler: Optional[StrategyEventHandler[WorkflowContextT, WorkflowResultT]] = None, |
| 118 | + ): |
| 119 | + """ |
| 120 | + Initialize the workflow strategy with a specific context type and logger. |
| 121 | +
|
| 122 | + Args: |
| 123 | + context_type: The type of context this strategy operates on. |
| 124 | + logger: Logger instance for logging events. |
| 125 | + event_handler: Optional custom event handler for workflow events. |
| 126 | + """ |
| 127 | + default_handler = _DefaultWorkflowEventHandler[WorkflowContextT, WorkflowResultT](logger=logger) |
| 128 | + super().__init__( |
| 129 | + context_type=context_type, |
| 130 | + event_handler=event_handler or default_handler, |
| 131 | + logger=logger, |
| 132 | + ) |
0 commit comments