mirror of
https://github.com/apple/swift-log
synced 2026-11-22 03:40:39 +00:00
Migrating `swift-log` from XCTest to Swift Testing ### Motivation Swift Testing is a modern alternative to XCTest. Swift Server Ecosystem packages should serve as reference implementations for modern Swift features and best practices. ### Modifications - 1-to-1 migration of test suites, tests, and assertions to Swift Testing syntax with XCTest import removed - XCTest references removed from documentation - `.trace` log level added to relevant tests - `GlobalLoggerTest` suite serialized to handle global `LoggingSystem` access (XCTest runs tests serially by default; Swift Testing runs in parallel, so serializing this suite avoids requiring `swift test --no-parallel` across all CI and development environments) ### Result Successfully executes 52 tests with `swift test --disable-xctest`.
158 lines
4.4 KiB
Swift
158 lines
4.4 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the Swift Logging API open source project
|
|
//
|
|
// Copyright (c) 2018-2019 Apple Inc. and the Swift Logging API project authors
|
|
// Licensed under Apache License v2.0
|
|
//
|
|
// See LICENSE.txt for license information
|
|
// See CONTRIBUTORS.txt for the list of Swift Logging API project authors
|
|
//
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import Testing
|
|
|
|
@testable import Logging
|
|
|
|
#if canImport(Darwin)
|
|
import Darwin
|
|
#elseif os(Windows)
|
|
import WinSDK
|
|
#elseif canImport(Android)
|
|
import Android
|
|
#else
|
|
import Glibc
|
|
#endif
|
|
|
|
struct MetadataProviderTest {
|
|
@Test func logHandlerThatDidNotImplementProvidersButSomeoneAttemptsToSetOneOnIt() {
|
|
#if DEBUG
|
|
// we only emit these warnings in debug mode
|
|
let logging = TestLogging()
|
|
var handler = LogHandlerThatDidNotImplementMetadataProviders(testLogging: logging)
|
|
|
|
handler.metadataProvider = .simpleTestProvider
|
|
|
|
logging.history.assertExist(
|
|
level: .warning,
|
|
message:
|
|
"Attempted to set metadataProvider on LogHandlerThatDidNotImplementMetadataProviders that did not implement support for them. Please contact the log handler maintainer to implement metadata provider support.",
|
|
source: "Logging"
|
|
)
|
|
|
|
let countBefore = logging.history.entries.count
|
|
handler.metadataProvider = .simpleTestProvider
|
|
#expect(countBefore == logging.history.entries.count, "Should only log the warning once")
|
|
#endif
|
|
}
|
|
|
|
@Test func logHandlerThatDidImplementProvidersButSomeoneAttemptsToSetOneOnIt() {
|
|
#if DEBUG
|
|
// we only emit these warnings in debug mode
|
|
let logging = TestLogging()
|
|
var handler = LogHandlerThatDidImplementMetadataProviders(testLogging: logging)
|
|
|
|
handler.metadataProvider = .simpleTestProvider
|
|
|
|
logging.history.assertNotExist(
|
|
level: .warning,
|
|
message:
|
|
"Attempted to set metadataProvider on LogHandlerThatDidImplementMetadataProviders that did not implement support for them. Please contact the log handler maintainer to implement metadata provider support.",
|
|
source: "Logging"
|
|
)
|
|
#endif
|
|
}
|
|
}
|
|
|
|
extension Logger.MetadataProvider {
|
|
static var simpleTestProvider: Logger.MetadataProvider {
|
|
Logger.MetadataProvider {
|
|
["test": "provided"]
|
|
}
|
|
}
|
|
}
|
|
|
|
public struct LogHandlerThatDidNotImplementMetadataProviders: LogHandler {
|
|
let testLogging: TestLogging
|
|
init(testLogging: TestLogging) {
|
|
self.testLogging = testLogging
|
|
}
|
|
|
|
public subscript(metadataKey _: String) -> Logging.Logger.Metadata.Value? {
|
|
get {
|
|
nil
|
|
}
|
|
set(newValue) {
|
|
// ignore
|
|
}
|
|
}
|
|
|
|
public var metadata: Logging.Logger.Metadata = [:]
|
|
|
|
public var logLevel: Logging.Logger.Level = .trace
|
|
|
|
public func log(
|
|
level: Logger.Level,
|
|
message: Logger.Message,
|
|
metadata: Logger.Metadata?,
|
|
source: String,
|
|
file: String,
|
|
function: String,
|
|
line: UInt
|
|
) {
|
|
self.testLogging.make(label: "fake").log(
|
|
level: level,
|
|
message: message,
|
|
metadata: metadata,
|
|
source: source,
|
|
file: file,
|
|
function: function,
|
|
line: line
|
|
)
|
|
}
|
|
}
|
|
|
|
public struct LogHandlerThatDidImplementMetadataProviders: LogHandler {
|
|
let testLogging: TestLogging
|
|
init(testLogging: TestLogging) {
|
|
self.testLogging = testLogging
|
|
}
|
|
|
|
public subscript(metadataKey _: String) -> Logging.Logger.Metadata.Value? {
|
|
get {
|
|
nil
|
|
}
|
|
set(newValue) {
|
|
// ignore
|
|
}
|
|
}
|
|
|
|
public var metadata: Logging.Logger.Metadata = [:]
|
|
|
|
public var logLevel: Logging.Logger.Level = .trace
|
|
|
|
public var metadataProvider: Logger.MetadataProvider?
|
|
|
|
public func log(
|
|
level: Logger.Level,
|
|
message: Logger.Message,
|
|
metadata: Logger.Metadata?,
|
|
source: String,
|
|
file: String,
|
|
function: String,
|
|
line: UInt
|
|
) {
|
|
self.testLogging.make(label: "fake").log(
|
|
level: level,
|
|
message: message,
|
|
metadata: metadata,
|
|
source: source,
|
|
file: file,
|
|
function: function,
|
|
line: line
|
|
)
|
|
}
|
|
}
|