AutoBE
    Preparing search index...

    Interface AutoBeTestOperationFunction

    Test writing function content structure for individual test scenario files.

    This interface represents the structured content generated by the test write agent when creating comprehensive E2E test files. Each instance encapsulates the complete lifecycle of a test file creation, from initial scenario planning through code drafting, review, and final polished implementation.

    The test write function content enables systematic development of validation suites that ensure generated applications function correctly under realistic operational conditions. By capturing scenario descriptions, implementation code, and iterative refinements, this structure supports both immediate test file generation and long-term quality assurance practices.

    Michael

    interface AutoBeTestOperationFunction {
        content: string;
        domain: string;
        location: string;
        name: string;
        scenario: Omit<AutoBeTestScenario, "functionName">;
        type: "operation";
    }

    Hierarchy

    • AutoBeTestFunctionBase<"operation">
      • AutoBeTestOperationFunction
    Index

    Properties

    content: string

    The complete source code content of the test function. Contains the full implementation including function signature and body.

    domain: string

    Functional domain category for test classification and organization.

    Primary business or API resource domain that this test validates, used for logical grouping and file structure organization. Common domains include core business entities like "user", "order", "payment", "inventory", or "notification" that represent major functional areas of the application.

    The domain classification helps developers quickly locate relevant tests and understand the scope of validation coverage across different business areas.

    location: string

    The file system location where this test function will be written. Should be an absolute or relative path to the target test file.

    name: string

    The name identifier of the function. Used to reference the function within the test suite.

    scenario: Omit<AutoBeTestScenario, "functionName">

    Detailed metadata describing the test scenario and its characteristics.

    Provides comprehensive information about what this test file covers, including the specific API endpoints being tested, the business scenarios being validated, expected outcomes, and any special conditions or prerequisites. This metadata helps developers understand the test's purpose and scope without having to analyze the AST structure or generated code.

    The scenario information is crucial for test maintenance, coverage analysis, and ensuring that all business requirements are adequately tested across the test suite. It serves as high-level documentation that complements both the structured AST representation and the generated executable TypeScript code.

    type: "operation"

    Discriminator field that identifies the specific type of test function. Used for discriminated union pattern to distinguish between different test function types.