rasa-pro 3.9.18__py3-none-any.whl → 3.10.16__py3-none-any.whl

rasa/e2e_test/e2e_test_schema.yml

@@ -25,6 +25,97 @@ mapping:
               regex;(^[a-zA-Z_]+[a-zA-Z0-9_]*$):
                 type: any
 
+  stub_custom_actions:
+    type: map
+    mapping:
+      regex;(^[a-zA-Z_]+([a-zA-Z0-9_]*::?)*[a-zA-Z0-9_]*$):
+        type: map
+        mapping:
+          events:
+            type: seq
+            sequence:
+              - type: map
+                matching: any
+                mapping:
+                  event:
+                    type: "str"
+                    enum: ["user", "bot", "slot", "session_started", "action", "reset_slots", "restart", "reminder", "cancel_reminder", "pause", "resume", "followup", "export", "undo", "rewind", "entities", "active_loop", "agent", "loop_interrupted", "action_execution_rejected"]
+                  timestamp:
+                    type: float
+                  metadata:
+                    type: map
+                    mapping:
+                      regex;(^[a-zA-Z_]+[a-zA-Z0-9_]*$):
+                        type: any
+                  text:
+                    type: "str"
+                  parse_data:
+                    type: map
+                    mapping:
+                        regex;(^[a-zA-Z_]+[a-zA-Z0-9_]*$):
+                            type: any
+                  input_channel:
+                    type: "str"
+                  data:
+                    type: map
+                    mapping:
+                      regex;(^[a-zA-Z_]+[a-zA-Z0-9_]*$):
+                        type: any
+                  name:
+                    type: "str"
+                  value:
+                    type: any
+                  entities:
+                    type: any
+                  intent:
+                    type: "str"
+                  kill_on_user_message:
+                    type: bool
+                  date_time:
+                    type: "str"
+                  policy:
+                    type: "str"
+                  confidence:
+                    type: float
+                  is_interrupted:
+                    type: bool
+
+          responses:
+            type: seq
+            sequence:
+              - type: map
+                matching: any
+                mapping:
+                  text:
+                    type: "str"
+                  buttons:
+                    type: "seq"
+                    sequence:
+                      - type: map
+                        mapping:
+                          payload:
+                            type: "str"
+                          title:
+                            type: "str"
+                  response:
+                    type: "str"
+                  image:
+                    type: "str"
+                  attachment:
+                    type: "str"
+                  elements:
+                    type: "seq"
+                    sequence:
+                      - type: map
+                        mapping:
+                          regex;(^[a-zA-Z_]+[a-zA-Z0-9_]*$):
+                            type: any
+                  custom:
+                    type: map
+                    mapping:
+                      regex;(^[a-zA-Z_]+[a-zA-Z0-9_]*$):
+                        type: any
+
   test_cases:
     type: "seq"
     sequence:
@@ -53,6 +144,11 @@ mapping:
                   metadata:
                     type: "str"
                     pattern: ^[a-zA-Z_]+[a-zA-Z0-9_]*$
+                  assertion_order_enabled:
+                    type: bool
+                  assertions:
+                    # see e2e_test/assertions.yml
+                    include: assertions
               - type: map
                 mapping:
                   utter:

rasa/e2e_test/pykwalify_extensions.py

@@ -0,0 +1,39 @@
+"""This module regroups custom validation functions, and it is
+loaded as an extension of the pykwalify library:
+
+https://pykwalify.readthedocs.io/en/latest/extensions.html#extensions
+"""
+
+from typing import Any, Dict, List, Union
+
+from pykwalify.errors import SchemaError
+
+BOT_UTTERED_KEY = "bot_uttered"
+BUTTONS_KEY = "buttons"
+
+
+def require_assertion_keys(
+    assertions: List[Dict[str, Any]], _: Dict, __: str
+) -> Union[SchemaError, bool]:
+    """Validates that certain assertion keys are not mapped to empty values."""
+    for assertion in assertions:
+        if not isinstance(assertion, dict):
+            # this is handled by other validation rules
+            continue
+
+        bot_uttered_dict = assertion.get(BOT_UTTERED_KEY)
+        if BOT_UTTERED_KEY in assertion and isinstance(bot_uttered_dict, dict):
+            if not bot_uttered_dict:
+                return SchemaError(
+                    f"The '{BOT_UTTERED_KEY}' assertion is an empty dictionary."
+                )
+
+            if BUTTONS_KEY in bot_uttered_dict and not bot_uttered_dict.get(
+                BUTTONS_KEY
+            ):
+                return SchemaError(
+                    f"The '{BUTTONS_KEY}' key in the '{BOT_UTTERED_KEY}' assertion "
+                    f"is mapped to a null value or empty list."
+                )
+
+    return True

rasa/e2e_test/stub_custom_action.py

@@ -0,0 +1,70 @@
+from dataclasses import dataclass
+from typing import Any, Dict, List, Text, Optional
+
+from rasa.e2e_test.constants import (
+    KEY_STUB_CUSTOM_ACTIONS,
+    STUB_CUSTOM_ACTION_NAME_SEPARATOR,
+    TEST_CASE_NAME,
+    TEST_FILE_NAME,
+)
+from rasa.utils.endpoints import EndpointConfig
+
+
+@dataclass
+class StubCustomAction:
+    """Class for storing the stub response of the custom action."""
+
+    action_name: str
+    events: List[Dict[Text, Any]]
+    responses: List[Dict[Text, Any]]
+
+    @staticmethod
+    def from_dict(action_name: str, stub_data: Dict[Text, Any]) -> "StubCustomAction":
+        """Creates a stub custom action from a dictionary.
+
+        Example:
+            >>> StubCustomAction.from_dict(
+            >>>        {"action_name": {"events": [], "responses": []}}
+            >>>    )
+            StubCustomAction(name="action_name", events=[], responses=[])
+
+        Args:
+            action_name (str): Name of the custom action.
+            stub_data (Dict[Text, Any]): Stub custom action response.
+        """
+        return StubCustomAction(
+            action_name=action_name,
+            events=[event for event in stub_data.get("events", [])],
+            responses=[response for response in stub_data.get("responses", [])],
+        )
+
+    def as_dict(self) -> Dict[Text, Any]:
+        """Returns the metadata as a dictionary."""
+        return {"events": self.events, "responses": self.responses}
+
+
+def get_stub_custom_action_key(prefix: str, action_name: str) -> str:
+    """Returns the key used to store the StubCustomAction object"""
+    return f"{prefix}{STUB_CUSTOM_ACTION_NAME_SEPARATOR}{action_name}"
+
+
+def get_stub_custom_action(
+    action_endpoint: EndpointConfig, action_name: str
+) -> Optional["StubCustomAction"]:
+    """Returns the StubCustomAction object"""
+    test_case_name = action_endpoint.kwargs.get(TEST_CASE_NAME)
+    stub_custom_action_test_key = get_stub_custom_action_key(
+        test_case_name, action_name
+    )
+
+    test_file_name = action_endpoint.kwargs.get(TEST_FILE_NAME)
+    stub_custom_action_file_key = get_stub_custom_action_key(
+        test_file_name, action_name
+    )
+    stub_custom_actions = action_endpoint.kwargs.get(KEY_STUB_CUSTOM_ACTIONS, {})
+
+    stub = stub_custom_actions.get(
+        stub_custom_action_test_key
+    ) or stub_custom_actions.get(stub_custom_action_file_key)
+
+    return stub

rasa/e2e_test/utils/e2e_yaml_utils.py

@@ -0,0 +1,55 @@
+from datetime import datetime
+from pathlib import Path
+from typing import Any
+
+import ruamel
+import structlog
+
+from rasa.e2e_test.constants import KEY_TEST_CASES
+
+structlogger = structlog.get_logger()
+
+DEFAULT_E2E_OUTPUT_TESTS_DIRECTORY = "e2e_tests"
+
+
+class E2ETestYAMLWriter:
+    def __init__(
+        self,
+        output_path: str = DEFAULT_E2E_OUTPUT_TESTS_DIRECTORY,
+        **kwargs: Any,
+    ) -> None:
+        """Initializes the E2ETestYAMLWriter with necessary parameters.
+
+        Args:
+            output (str): Directory to save the generated tests.
+        """
+        self.output_path = output_path
+
+    def write_to_file(self, tests: str) -> None:
+        """Writes the provided test cases to a YAML file
+        in the specified output directory.
+
+        Args:
+            tests (str): string containing the generated test cases.
+        """
+        if not tests.strip():
+            structlogger.info("e2e_test_generator.no_tests_provided")
+            return
+
+        output_dir = Path(self.output_path)
+        timestamp = datetime.now().strftime("%Y%m%d_%H%M%S")
+        output_file = output_dir / f"e2e_tests_{timestamp}.yml"
+
+        if not output_dir.exists():
+            output_dir.mkdir(parents=True, exist_ok=True)
+
+        yaml_data = ruamel.yaml.safe_load(tests)
+
+        test_cases_yaml = {KEY_TEST_CASES: yaml_data}
+        with open(output_file, "w") as outfile:
+            yaml = ruamel.yaml.YAML()
+            yaml.dump(test_cases_yaml, outfile)
+
+        structlogger.info(
+            "e2e_test_generator.tests_written_to_yaml", output_file=output_file
+        )