122 lines
3.6 KiB
Swift
122 lines
3.6 KiB
Swift
//
|
|
// Trace.swift
|
|
// Buildkite
|
|
//
|
|
// Created by Aaron Sky on 6/5/22.
|
|
// Copyright © 2022 Aaron Sky. All rights reserved.
|
|
//
|
|
|
|
import Foundation
|
|
|
|
#if canImport(FoundationNetworking)
|
|
import FoundationNetworking
|
|
#endif
|
|
|
|
public struct Trace: Codable, Equatable, Hashable, Identifiable, Sendable {
|
|
/// a unique identifier for this test result
|
|
public var id: UUID
|
|
/// a group or topic for the test
|
|
///
|
|
/// - `Student.isEnrolled()`
|
|
public var scope: String?
|
|
/// a name or description for the test
|
|
///
|
|
/// - `Manager.isEnrolled()`
|
|
/// - `returns_boolean`
|
|
public var name: String?
|
|
/// a unique identifier for the test. If your test runner supports it, use the identifier needed to rerun this test
|
|
///
|
|
/// - `Manager.isEnrolled#returns_boolean`
|
|
public var identifier: String?
|
|
/// the file and line number where the test originates, separated by a colon (:)
|
|
///
|
|
/// - `./tests/Manager/isEnrolled.js:32`
|
|
public var location: String?
|
|
/// the file where the test originates
|
|
///
|
|
/// - `./tests/Manager/isEnrolled.js`
|
|
public var fileName: String?
|
|
/// the outcome of the test, e.g. `"passed"`, `"failed"`, `"skipped"`, or `"unknown"``
|
|
public var result: String?
|
|
/// if applicable, a short summary of why the test failed
|
|
///
|
|
/// - `Expected Boolean, got Object`
|
|
public var failureReason: String?
|
|
/// History object
|
|
public var history: Span
|
|
|
|
public init(
|
|
id: UUID,
|
|
scope: String? = nil,
|
|
name: String? = nil,
|
|
identifier: String? = nil,
|
|
location: String? = nil,
|
|
fileName: String? = nil,
|
|
result: String? = nil,
|
|
failureReason: String? = nil,
|
|
history: Trace.Span
|
|
) {
|
|
self.id = id
|
|
self.scope = scope
|
|
self.name = name
|
|
self.identifier = identifier
|
|
self.location = location
|
|
self.fileName = fileName
|
|
self.result = result
|
|
self.failureReason = failureReason
|
|
self.history = history
|
|
}
|
|
|
|
public struct Span: Codable, Equatable, Hashable, Sendable {
|
|
/// A section category for this span, e.g. `"http"`, `"sql"`, `"sleep"`, or `"annotation"`
|
|
public var section: String
|
|
/// A monotonically increasing number
|
|
public var startAt: TimeInterval?
|
|
/// A monotonically increasing number
|
|
public var endAt: TimeInterval?
|
|
/// How long the span took to run
|
|
public var duration: TimeInterval?
|
|
/// Any information related to this span
|
|
public var detail: [String: String] = [:]
|
|
/// array of span objects
|
|
public var children: [Span] = []
|
|
|
|
public init(
|
|
section: String,
|
|
startAt: TimeInterval? = nil,
|
|
endAt: TimeInterval? = nil,
|
|
duration: TimeInterval? = nil,
|
|
detail: [String: String] = [:],
|
|
children: [Trace.Span] = []
|
|
) {
|
|
self.section = section
|
|
self.startAt = startAt
|
|
self.endAt = endAt
|
|
self.duration = duration
|
|
self.detail = detail
|
|
self.children = children
|
|
}
|
|
|
|
private enum CodingKeys: String, CodingKey {
|
|
case section
|
|
case startAt = "start_at"
|
|
case endAt = "end_at"
|
|
case duration
|
|
case detail
|
|
case children
|
|
}
|
|
}
|
|
|
|
private enum CodingKeys: String, CodingKey {
|
|
case id
|
|
case scope
|
|
case name
|
|
case identifier
|
|
case location
|
|
case fileName = "file_name"
|
|
case result
|
|
case failureReason = "failure_reason"
|
|
case history
|
|
}
|
|
}
|