import { IAutoBeTypeScriptCompileResult } from "../compiler/IAutoBeTypeScriptCompileResult";
import { AutoBeTestFunction } from "../histories";
import { AutoBeCompleteEventBase } from "./base/AutoBeCompleteEventBase";

/**
 * Event fired when the Test agent completes the e2e test code generation
 * process for all API endpoints and scenarios.
 *
 * This event represents the successful completion of comprehensive test suite
 * creation that validates both technical functionality and business rule
 * implementation across all API operations. The Test agent's completion ensures
 * that every API endpoint has multiple use case scenarios implemented as test
 * programs that provide thorough coverage of the application functionality.
 *
 * The completion of test generation creates a robust validation framework that
 * ensures the generated APIs work correctly under realistic operational
 * conditions and properly implement all business requirements established in
 * the analysis phase.
 *
 * @author Samchon
 */
export interface AutoBeTestCompleteEvent extends AutoBeCompleteEventBase<"testComplete"> {
  /**
   * Generated e2e test files as key-value pairs representing the complete test
   * suite.
   *
   * Contains the final set of TypeScript test files with each key representing
   * the file path and each value containing the actual test code. Each test
   * file includes standalone functions that implement specific use case
   * scenarios for API endpoints, providing comprehensive end-to-end testing
   * coverage that validates both technical functionality and business logic
   * implementation.
   *
   * The test files are designed to work under realistic operational conditions,
   * ensuring that the generated APIs not only compile and execute correctly but
   * also properly implement the business requirements and handle edge cases
   * appropriately. These tests serve as both validation tools and documentation
   * of expected system behavior.
   */
  functions: AutoBeTestFunction[];

  /**
   * Results of compiling the generated e2e test TypeScript files through the
   * TypeScript compiler.
   *
   * Contains the {@link IAutoBeTypeScriptCompileResult} from processing the
   * generated test files through the TypeScript compilation pipeline. This
   * compilation result validates test code syntax, type safety, framework
   * integration, and dependency resolution to ensure that all generated test
   * scenarios are syntactically correct and ready for execution.
   *
   * Through the Test agent's internal compiler feedback process, this result is
   * typically successful as the agent iteratively refines the generated code
   * based on compilation diagnostics. However, in rare cases where the compiler
   * feedback iteration limit is exceeded, the result may indicate failure
   * despite the agent's correction attempts. Such failure occurrences are
   * extremely infrequent due to the sophisticated feedback mechanisms built
   * into the Test agent's code generation process.
   *
   * Successful compilation indicates that the generated test suite is
   * production-ready and can be executed immediately to validate the
   * corresponding API implementations without any syntax or integration
   * issues.
   */
  compiled: IAutoBeTypeScriptCompileResult;
}