1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2022 Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See https://swift.org/LICENSE.txt for license information
See https://swift.org/CONTRIBUTORS.txt for Swift project authors
*/
import Foundation
import SymbolKit
import XCTest
/// Tests symbol graph creation as would be done by clients of SymbolKit.
///
/// `SymbolKit` is intentionally imported in this file without `@testable` to verify
/// that the public API is sufficient for clients.
class SymbolGraphCreationTests: XCTestCase {
func testCreateAndEncodeSymbolGraph() throws {
let symbolGraph = SymbolGraph(
metadata: .init(
formatVersion: .init(
major: 0,
minor: 5,
patch: 0
),
generator: "org.swift.SymbolKitTests"
),
module: .init(
name: "Games",
platform: .init(
architecture: nil,
vendor: nil,
operatingSystem: .init(
name: "MyOS",
minimumVersion: .init(major: 1, minor: 2, patch: 3)
),
environment: nil
)
),
symbols: [
SymbolGraph.Symbol(
identifier: .init(
precise: "c:objc(cs)PlayingCard",
interfaceLanguage: "swift"
),
names: .init(
title: "PlayingCard",
navigator: [
.init(
kind: .identifier,
spelling: "PlayingCard",
preciseIdentifier: nil
),
],
subHeading: [
.init(
kind: .keyword,
spelling: "class",
preciseIdentifier: nil
),
.init(
kind: .text,
spelling: " ",
preciseIdentifier: nil
),
.init(
kind: .identifier,
spelling: "PlayingCard",
preciseIdentifier: nil
)
],
prose: "Playing Card"
),
pathComponents: ["PlayingCard"],
docComment: .init(
[
.init(
text: "test",
range: .init(
start: .init(
line: 0,
character: 0
),
end: .init(
line: 0,
character: 5
)
)
)
]
),
accessLevel: .init(rawValue: "open"),
kind: .init(
parsedIdentifier: .class,
displayName: "Class"
),
mixins: [
SymbolGraph.Symbol.DeclarationFragments.mixinKey : SymbolGraph.Symbol.DeclarationFragments(
declarationFragments: [
.init(
kind: .keyword,
spelling: "class",
preciseIdentifier: nil
),
.init(
kind: .text,
spelling: " ",
preciseIdentifier: nil
),
.init(
kind: .identifier,
spelling: "PlayingCard",
preciseIdentifier: nil
)
]
),
SymbolGraph.Symbol.Location.mixinKey : SymbolGraph.Symbol.Location(
uri: "/path/to/PlayingCard.swift",
position: .init(line: 0, character: 0)
),
]
)
],
relationships: [
.init(
source: "c:objc(cs)PlayingCard",
target: "c:objc(cs)Deck",
kind: .memberOf,
targetFallback: nil
)
]
)
let sortedJSONEncoder = JSONEncoder()
sortedJSONEncoder.outputFormatting = [.prettyPrinted, .sortedKeys]
let encodedSymbolGraph = try sortedJSONEncoder.encode(symbolGraph)
let encodedSymbolGraphString = String(data: encodedSymbolGraph, encoding: .utf8)
let decodedSymbolGraph = try JSONDecoder().decode(SymbolGraph.self, from: encodedSymbolGraph)
// The SymbolGraph model is not `Equatable` so we re-encode to a string to compare the
// equality.
let reEncodedSymbolGraph = try sortedJSONEncoder.encode(decodedSymbolGraph)
let reEncodedSymbolGraphString = String(data: reEncodedSymbolGraph, encoding: .utf8)
XCTAssertEqual(
encodedSymbolGraphString,
reEncodedSymbolGraphString,
"Round-trip SymbolGraph encoding failed."
)
}
}
|
