Enum TestAppError

pub enum TestAppError {
    IoError(Error),
    ClientError(ApiClientError),
    JsonError(Error),
    YamlError {
        error: String,
    },
    UnhealthyServer {
        timeout: Duration,
    },
    ServerError(Box<dyn Error + Send + Sync + 'static>),
}

Error types for test client operations.

TestAppError represents all possible errors that can occur during test client operations, from server startup to OpenAPI generation. It provides detailed error information to help diagnose test failures.

Error Categories

• I/O Errors: File operations, network binding issues
• Client Errors: ApiClient configuration and request errors
• Serialization Errors: JSON/YAML parsing and generation errors
• Server Health Errors: Server startup and health check failures

All variants implement standard error traits and provide detailed context for debugging.

Variants

IoError(Error)

I/O operation failed.

This includes file operations (creating directories, writing files) and network operations (binding to ports, socket operations).

ClientError(ApiClientError)

ApiClient configuration or operation failed.

This wraps errors from the underlying ApiClient, including configuration errors, request failures, and response parsing issues.

JsonError(Error)

JSON serialization or deserialization failed.

This occurs when generating OpenAPI specifications in JSON format or when processing JSON request/response data.

YamlError

YAML serialization failed.

This occurs specifically when generating OpenAPI specifications in YAML format. Contains the detailed error message.

Fields

error: String

Detailed error message from the YAML serializer.

UnhealthyServer

Server failed to become healthy within the timeout period.

This indicates that the test server either failed to start properly or did not respond to health checks within the configured timeout.

Troubleshooting

• Check server logs for startup errors
• Verify health check implementation
• Increase timeout if server startup is slow
• Ensure no port conflicts with other services

Fields

timeout: Duration

The timeout duration that was exceeded.

ServerError(Box<dyn Error + Send + Sync + 'static>)

Server operation failed.

This wraps errors from the TestServer implementation, including launch failures and health check errors.

Trait Implementations

impl Debug for TestAppError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for TestAppError

fn fmt(&self, __derive_more_f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for TestAppError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<ApiClientError> for TestAppError

fn from(value: ApiClientError) -> Self

Converts to this type from the input type.

impl From<Box<dyn Error + Send + Sync>> for TestAppError

fn from(value: Box<dyn Error + Send + Sync + 'static>) -> Self

Converts to this type from the input type.

impl From<Error> for TestAppError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<Error> for TestAppError

fn from(value: Error) -> Self

Converts to this type from the input type.

impl From<String> for TestAppError

fn from(value: String) -> Self

Converts to this type from the input type.