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
|
/*
This source file is part of the Swift.org open source project
Copyright (c) 2021-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 XCTest
import Foundation
@testable import SymbolKit
class SymbolKindTests: XCTestCase {
func testKindParsing() throws {
var kind: SymbolGraph.Symbol.KindIdentifier
// Verify basic parsing of old style identifier is working.
XCTAssert(SymbolGraph.Symbol.KindIdentifier.isKnownIdentifier("swift.func"))
kind = SymbolGraph.Symbol.KindIdentifier(identifier: "swift.func")
XCTAssertEqual(kind, .func)
XCTAssertEqual(kind.identifier, "func")
// Verify new language-agnostic type is recognized.
XCTAssert(SymbolGraph.Symbol.KindIdentifier.isKnownIdentifier("func"))
kind = SymbolGraph.Symbol.KindIdentifier(identifier: "func")
XCTAssertEqual(kind, .func)
XCTAssertEqual(kind.identifier, "func")
// Verify a bare language is not recognized.
XCTAssertFalse(SymbolGraph.Symbol.KindIdentifier.isKnownIdentifier("swift"))
kind = SymbolGraph.Symbol.KindIdentifier(identifier: "swift")
XCTAssertEqual(kind.identifier, "swift")
// Verify if nothing is recognized, identifier and name is still there.
XCTAssertFalse(SymbolGraph.Symbol.KindIdentifier.isKnownIdentifier("swift.madeupapi"))
kind = SymbolGraph.Symbol.KindIdentifier(identifier: "swift.madeupapi")
XCTAssertEqual(kind.identifier, "swift.madeupapi")
// Verify a registered, previously unknown identifier is recognized.
let custom = SymbolGraph.Symbol.KindIdentifier(rawValue: "custom")
SymbolGraph.Symbol.KindIdentifier.register(custom)
XCTAssert(SymbolGraph.Symbol.KindIdentifier.isKnownIdentifier("swift.custom"))
kind = SymbolGraph.Symbol.KindIdentifier(identifier: "swift.custom")
XCTAssertEqual(kind, custom)
XCTAssertEqual(kind.identifier, "custom")
// Verify a registered, previously unknown identifier is recognized if
// used in a language-agnostic way.
XCTAssert(SymbolGraph.Symbol.KindIdentifier.isKnownIdentifier("custom"))
kind = SymbolGraph.Symbol.KindIdentifier(identifier: "custom")
XCTAssertEqual(kind, custom)
XCTAssertEqual(kind.identifier, "custom")
// Verify an unknown identifier is parsed correctly if it is
// registered with the decoder.
let otherCustom = SymbolGraph.Symbol.KindIdentifier(rawValue: "other.custom")
let decoder = JSONDecoder()
decoder.register(symbolKinds: otherCustom)
XCTAssertFalse(SymbolGraph.Symbol.KindIdentifier.isKnownIdentifier("swift.other.custom"))
kind = try decoder.decode(SymbolGraph.Symbol.KindIdentifier.self, from: "\"swift.other.custom\"".data(using: .utf8)!)
XCTAssertEqual(kind, otherCustom)
XCTAssertEqual(kind.identifier, "other.custom")
}
func testAllCasesWithCustomIdentifiers() throws {
let registeredOnStaticContext = SymbolGraph.Symbol.KindIdentifier(rawValue: "custom.registeredOnStaticContext")
SymbolGraph.Symbol.KindIdentifier.register(registeredOnStaticContext)
let registeredOnDecoder = SymbolGraph.Symbol.KindIdentifier(rawValue: "custom.registeredOnDecoder")
JSONDecoder().register(symbolKinds: registeredOnDecoder)
XCTAssertTrue(SymbolGraph.Symbol.KindIdentifier.allCases.contains(registeredOnStaticContext))
XCTAssertFalse(SymbolGraph.Symbol.KindIdentifier.allCases.contains(registeredOnDecoder))
}
func testKindDecoding() throws {
var schemaData: Data
var kindJson: String
let jsonDecoder = JSONDecoder()
kindJson = """
{"identifier": "swift.func", "displayName": "Function"}
"""
schemaData = kindJson.data(using: .utf8)!
let kind = try jsonDecoder.decode(SymbolGraph.Symbol.Kind.self, from: schemaData)
XCTAssertNotNil(kind)
XCTAssertEqual(kind.identifier, .func)
XCTAssertEqual(kind.displayName, "Function")
// Verify that the identifier can parse without the "swift." prefix
kindJson = """
"func"
"""
schemaData = kindJson.data(using: .utf8)!
let identifier = try jsonDecoder.decode(SymbolGraph.Symbol.KindIdentifier.self, from: schemaData)
XCTAssertNotNil(identifier)
XCTAssertEqual(identifier, .func)
}
func testIdentifierRetrieval() throws {
var theCase: SymbolGraph.Symbol.KindIdentifier
theCase = .class
XCTAssertEqual(theCase.identifier, "class")
}
func testVariousLanguagePrefixes() throws {
let identifiers = ["func", "swift.func", "objc.func"]
let jsonDecoder = JSONDecoder()
for identifier in identifiers {
let parsed = SymbolGraph.Symbol.KindIdentifier(identifier: identifier)
XCTAssertEqual(parsed, .func)
let kindJson = """
{"identifier": "\(identifier)", "displayName": "Function"}
"""
let schemaData = kindJson.data(using: .utf8)!
let kind = try jsonDecoder.decode(SymbolGraph.Symbol.Kind.self, from: schemaData)
XCTAssertNotNil(kind)
XCTAssertEqual(kind.identifier, .func)
XCTAssertEqual(kind.displayName, "Function")
}
}
/// Make sure that all the cases added to `KindIdentifier` can parse back as themselves
/// when their `identifier` string is given back to the `.init(identifier:)` initializer.
func testKindIdentifierRoundtrip() throws {
for identifier in SymbolGraph.Symbol.KindIdentifier.allCases {
let parsed = SymbolGraph.Symbol.KindIdentifier(identifier: identifier.identifier)
XCTAssertEqual(identifier, parsed)
}
}
}
|
