Skip to content

VaporTesting

Core

Vapor VaporMacros beta AsyncKit RoutingKit ConsoleKit ConsoleKitCommands ConsoleKitTerminal ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Database

Fluent FluentKit FluentSQL FluentPostgresDriver FluentMongoDriver FluentMySQLDriver FluentSQLiteDriver SQLKit PostgresKit MySQLKit SQLiteKit PostgresNIO MySQLNIO SQLiteNIO Redis

Queues

Queues QueuesRedisDriver

Push Notifications

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

5.0 (beta)

4.x 5.0 (beta) beta

VaporTesting

Classes
TaskLocalMetricsSystemWrapper
TaskLocalTracingSystemWrapper
Protocols
TestClient
- Instance Properties
- var baseURL: URI?
- var port: Int?
- Instance Methods
- func withOptions<T>(LiveClientOptions, (any TestClient) async throws -> T) async throws -> T
Structures
LiveClientOptions
- Initializers
- init(tls: TLSConfiguration?, configuration: HTTPClient.Configuration?, timeout: Duration)
- Instance Properties
- var configuration: HTTPClient.Configuration?
- var timeout: Duration
- var tls: TLSConfiguration?
LiveTestOptions
- Initializers
- init(hostname: String, port: Int, clientOptions: LiveClientOptions)
- Instance Properties
- var clientOptions: LiveClientOptions
- var hostname: String
- var port: Int
- Type Properties
- static var live: `Self`
- Type Methods
- static func live(hostname: String, port: Int, clientOptions: LiveClientOptions) -> LiveTestOptions
MetricsTaskLocalTrait
- Instance Methods
- func provideScope(for: Testing.Test, testCase: Testing.Test.Case?, performing: @Sendable () async throws -> Void) async throws
TracingTaskLocalTrait
- Instance Methods
- func provideScope(for: Testing.Test, testCase: Testing.Test.Case?, performing: @Sendable () async throws -> Void) async throws
Variables
var metrics: TestMetrics
var tracer: InMemoryTracer
Functions
func expectJSONEquals<T>(String?, T, sourceLocation: SourceLocation)
func withApp<T>(environment: Environment, configuration: ServerConfiguration, configReader: ConfigReader, logger: Logger, services: Application.ServiceConfiguration, configure: ((Application) async throws -> Void)?, (Application) async throws -> T) async throws -> T
Extended Modules
Testing
- Extended Protocols
- Trait
  - Type Methods
  - static func withMetrics(TestMetrics) -> Self
  - static func withTracer(InMemoryTracer) -> Self
Vapor

API Docs
Framework Docs

- API Docs
  
  Reference documentation for Vapor
- Framework Docs
  
  Learn how to use Vapor
Home
Store
Showcase
Team
Blog
GitHub
Theme
- Light
- Dark
- System

You're viewing documentation for a pre-release version. View the latest stable version

Type MethodTesting

withMetrics(_:)

static func withMetrics(_ value: TestMetrics) -> Self

Vapor

Reference documentation for Vapor and its ecosystem.

Community

Team
Join our Discord
Store
Showcase
Supporters

Resources

Blog
Framework Docs
API Docs
Press Kit
Help

API Documentation © 2026 Vapor.

Twitter
Mastodon
Bsky
GitHub