1 //===-- TextStubV3Tests.cpp - TBD V3 File Test ----------------------------===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===-----------------------------------------------------------------------===/ 8 #include "TextStubHelpers.h" 9 #include "llvm/TextAPI/MachO/InterfaceFile.h" 10 #include "llvm/TextAPI/MachO/TextAPIReader.h" 11 #include "llvm/TextAPI/MachO/TextAPIWriter.h" 12 #include "gtest/gtest.h" 13 #include <string> 14 #include <vector> 15 16 using namespace llvm; 17 using namespace llvm::MachO; 18 19 static ExportedSymbol TBDv3Symbols[] = { 20 {SymbolKind::GlobalSymbol, "$ld$hide$os9.0$_sym1", false, false}, 21 {SymbolKind::GlobalSymbol, "_sym1", false, false}, 22 {SymbolKind::GlobalSymbol, "_sym2", false, false}, 23 {SymbolKind::GlobalSymbol, "_sym3", false, false}, 24 {SymbolKind::GlobalSymbol, "_sym4", false, false}, 25 {SymbolKind::GlobalSymbol, "_sym5", false, false}, 26 {SymbolKind::GlobalSymbol, "_tlv1", false, true}, 27 {SymbolKind::GlobalSymbol, "_tlv3", false, true}, 28 {SymbolKind::GlobalSymbol, "_weak1", true, false}, 29 {SymbolKind::GlobalSymbol, "_weak2", true, false}, 30 {SymbolKind::GlobalSymbol, "_weak3", true, false}, 31 {SymbolKind::ObjectiveCClass, "class1", false, false}, 32 {SymbolKind::ObjectiveCClass, "class2", false, false}, 33 {SymbolKind::ObjectiveCClass, "class3", false, false}, 34 {SymbolKind::ObjectiveCClassEHType, "class1", false, false}, 35 {SymbolKind::ObjectiveCInstanceVariable, "class1._ivar1", false, false}, 36 {SymbolKind::ObjectiveCInstanceVariable, "class1._ivar2", false, false}, 37 {SymbolKind::ObjectiveCInstanceVariable, "class1._ivar3", false, false}, 38 }; 39 40 namespace TBDv3 { 41 42 TEST(TBDv3, ReadFile) { 43 static const char TBDv3File1[] = 44 "--- !tapi-tbd-v3\n" 45 "archs: [ armv7, arm64 ]\n" 46 "uuids: [ 'armv7: 00000000-0000-0000-0000-000000000000',\n" 47 " 'arm64: 11111111-1111-1111-1111-111111111111']\n" 48 "platform: ios\n" 49 "flags: [ installapi ]\n" 50 "install-name: Test.dylib\n" 51 "current-version: 2.3.4\n" 52 "compatibility-version: 1.0\n" 53 "swift-abi-version: 1.1\n" 54 "parent-umbrella: Umbrella.dylib\n" 55 "exports:\n" 56 " - archs: [ armv7, arm64 ]\n" 57 " allowable-clients: [ clientA ]\n" 58 " re-exports: [ /usr/lib/libfoo.dylib ]\n" 59 " symbols: [ _sym1, _sym2, _sym3, _sym4, $ld$hide$os9.0$_sym1 ]\n" 60 " objc-classes: [ class1, class2 ]\n" 61 " objc-eh-types: [ class1 ]\n" 62 " objc-ivars: [ class1._ivar1, class1._ivar2 ]\n" 63 " weak-def-symbols: [ _weak1, _weak2 ]\n" 64 " thread-local-symbols: [ _tlv1, _tlv3 ]\n" 65 " - archs: [ armv7 ]\n" 66 " symbols: [ _sym5 ]\n" 67 " objc-classes: [ class3 ]\n" 68 " objc-ivars: [ class1._ivar3 ]\n" 69 " weak-def-symbols: [ _weak3 ]\n" 70 " thread-local-symbols: [ _tlv3 ]\n" 71 "...\n"; 72 73 auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3File1, "Test.tbd")); 74 EXPECT_TRUE(!!Result); 75 auto File = std::move(Result.get()); 76 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 77 auto Archs = AK_armv7 | AK_arm64; 78 auto Platform = PlatformKind::iOS; 79 TargetList Targets; 80 for (auto &&arch : Archs) 81 Targets.emplace_back(Target(arch, Platform)); 82 EXPECT_EQ(Archs, File->getArchitectures()); 83 UUIDs Uuids = {{Target(AK_armv7, PlatformKind::unknown), 84 "00000000-0000-0000-0000-000000000000"}, 85 {Target(AK_arm64, PlatformKind::unknown), 86 "11111111-1111-1111-1111-111111111111"}}; 87 EXPECT_EQ(Uuids, File->uuids()); 88 EXPECT_EQ(File->getPlatforms().size(), 1U); 89 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 90 EXPECT_EQ(std::string("Test.dylib"), File->getInstallName()); 91 EXPECT_EQ(PackedVersion(2, 3, 4), File->getCurrentVersion()); 92 EXPECT_EQ(PackedVersion(1, 0, 0), File->getCompatibilityVersion()); 93 EXPECT_EQ(2U, File->getSwiftABIVersion()); 94 EXPECT_EQ(ObjCConstraintType::Retain_Release, File->getObjCConstraint()); 95 EXPECT_TRUE(File->isTwoLevelNamespace()); 96 EXPECT_TRUE(File->isApplicationExtensionSafe()); 97 EXPECT_TRUE(File->isInstallAPI()); 98 InterfaceFileRef client("clientA", Targets); 99 InterfaceFileRef reexport("/usr/lib/libfoo.dylib", Targets); 100 EXPECT_EQ(1U, File->allowableClients().size()); 101 EXPECT_EQ(client, File->allowableClients().front()); 102 EXPECT_EQ(1U, File->reexportedLibraries().size()); 103 EXPECT_EQ(reexport, File->reexportedLibraries().front()); 104 105 ExportedSymbolSeq Exports; 106 for (const auto *Sym : File->symbols()) { 107 EXPECT_FALSE(Sym->isWeakReferenced()); 108 EXPECT_FALSE(Sym->isUndefined()); 109 Exports.emplace_back( 110 ExportedSymbol{Sym->getKind(), std::string(Sym->getName()), 111 Sym->isWeakDefined(), Sym->isThreadLocalValue()}); 112 } 113 llvm::sort(Exports.begin(), Exports.end()); 114 115 EXPECT_EQ(sizeof(TBDv3Symbols) / sizeof(ExportedSymbol), Exports.size()); 116 EXPECT_TRUE( 117 std::equal(Exports.begin(), Exports.end(), std::begin(TBDv3Symbols))); 118 } 119 120 TEST(TBDv3, ReadMultipleDocuments) { 121 static const char TBDv3Inlines[] = 122 "--- !tapi-tbd-v3\n" 123 "archs: [ armv7, arm64 ]\n" 124 "uuids: [ 'armv7: 00000000-0000-0000-0000-000000000000',\n" 125 " 'arm64: 11111111-1111-1111-1111-111111111111']\n" 126 "platform: ios\n" 127 "install-name: Test.dylib\n" 128 "current-version: 2.3.4\n" 129 "compatibility-version: 1.0\n" 130 "swift-abi-version: 1.1\n" 131 "parent-umbrella: Umbrella.dylib\n" 132 "exports:\n" 133 " - archs: [ armv7, arm64 ]\n" 134 " allowable-clients: [ clientA ]\n" 135 " re-exports: [ /usr/lib/libfoo.dylib,\n" 136 " TestInline.dylib ]\n" 137 " symbols: [ _sym1, _sym2, _sym3, _sym4, $ld$hide$os9.0$_sym1 ]\n" 138 " objc-classes: [ class1, class2 ]\n" 139 " objc-eh-types: [ class1 ]\n" 140 " objc-ivars: [ class1._ivar1, class1._ivar2 ]\n" 141 " weak-def-symbols: [ _weak1, _weak2 ]\n" 142 " thread-local-symbols: [ _tlv1, _tlv3 ]\n" 143 " - archs: [ armv7 ]\n" 144 " symbols: [ _sym5 ]\n" 145 " objc-classes: [ class3 ]\n" 146 " objc-ivars: [ class1._ivar3 ]\n" 147 " weak-def-symbols: [ _weak3 ]\n" 148 " thread-local-symbols: [ _tlv3 ]\n" 149 "--- !tapi-tbd-v3\n" 150 "archs: [ armv7, arm64 ]\n" 151 "uuids: [ 'armv7: 00000000-0000-0000-0000-000000000000',\n" 152 " 'arm64: 11111111-1111-1111-1111-111111111111']\n" 153 "platform: ios\n" 154 "install-name: TestInline.dylib\n" 155 "swift-abi-version: 1.1\n" 156 "exports:\n" 157 " - archs: [ armv7, arm64 ]\n" 158 " symbols: [ _sym5, _sym6 ]\n" 159 "...\n"; 160 161 auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Inlines, "Test.tbd")); 162 EXPECT_TRUE(!!Result); 163 auto File = std::move(Result.get()); 164 EXPECT_EQ(File->documents().size(), 1U); 165 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 166 auto Archs = AK_armv7 | AK_arm64; 167 auto Platform = PlatformKind::iOS; 168 TargetList Targets; 169 for (auto &&arch : Archs) 170 Targets.emplace_back(Target(arch, Platform)); 171 EXPECT_EQ(Archs, File->getArchitectures()); 172 UUIDs Uuids = {{Target(AK_armv7, PlatformKind::unknown), 173 "00000000-0000-0000-0000-000000000000"}, 174 {Target(AK_arm64, PlatformKind::unknown), 175 "11111111-1111-1111-1111-111111111111"}}; 176 EXPECT_EQ(Uuids, File->uuids()); 177 EXPECT_EQ(File->getPlatforms().size(), 1U); 178 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 179 EXPECT_EQ(std::string("Test.dylib"), File->getInstallName()); 180 EXPECT_EQ(PackedVersion(2, 3, 4), File->getCurrentVersion()); 181 EXPECT_EQ(PackedVersion(1, 0, 0), File->getCompatibilityVersion()); 182 EXPECT_EQ(2U, File->getSwiftABIVersion()); 183 EXPECT_EQ(ObjCConstraintType::Retain_Release, File->getObjCConstraint()); 184 EXPECT_TRUE(File->isTwoLevelNamespace()); 185 EXPECT_TRUE(File->isApplicationExtensionSafe()); 186 EXPECT_FALSE(File->isInstallAPI()); 187 InterfaceFileRef Client("clientA", Targets); 188 const std::vector<InterfaceFileRef> Reexports = { 189 InterfaceFileRef("/usr/lib/libfoo.dylib", Targets), 190 InterfaceFileRef("TestInline.dylib", Targets)}; 191 EXPECT_EQ(1U, File->allowableClients().size()); 192 EXPECT_EQ(Client, File->allowableClients().front()); 193 EXPECT_EQ(2U, File->reexportedLibraries().size()); 194 EXPECT_EQ(Reexports, File->reexportedLibraries()); 195 196 ExportedSymbolSeq Exports; 197 for (const auto *Sym : File->symbols()) { 198 EXPECT_FALSE(Sym->isWeakReferenced()); 199 EXPECT_FALSE(Sym->isUndefined()); 200 Exports.emplace_back(ExportedSymbol{Sym->getKind(), Sym->getName().str(), 201 Sym->isWeakDefined(), 202 Sym->isThreadLocalValue()}); 203 } 204 llvm::sort(Exports.begin(), Exports.end()); 205 206 EXPECT_EQ(sizeof(TBDv3Symbols) / sizeof(ExportedSymbol), Exports.size()); 207 EXPECT_TRUE( 208 std::equal(Exports.begin(), Exports.end(), std::begin(TBDv3Symbols))); 209 210 // Check Second Document 211 Exports.clear(); 212 auto Document = File->documents().front(); 213 EXPECT_EQ(FileType::TBD_V3, Document->getFileType()); 214 EXPECT_EQ(Archs, Document->getArchitectures()); 215 EXPECT_EQ(Uuids, Document->uuids()); 216 EXPECT_EQ(Platform, *Document->getPlatforms().begin()); 217 EXPECT_EQ(std::string("TestInline.dylib"), Document->getInstallName()); 218 EXPECT_EQ(PackedVersion(1, 0, 0), Document->getCurrentVersion()); 219 EXPECT_EQ(PackedVersion(1, 0, 0), Document->getCompatibilityVersion()); 220 EXPECT_EQ(2U, Document->getSwiftABIVersion()); 221 222 for (const auto *Sym : Document->symbols()) { 223 EXPECT_FALSE(Sym->isWeakReferenced()); 224 EXPECT_FALSE(Sym->isUndefined()); 225 Exports.emplace_back(ExportedSymbol{Sym->getKind(), Sym->getName().str(), 226 Sym->isWeakDefined(), 227 Sym->isThreadLocalValue()}); 228 } 229 llvm::sort(Exports.begin(), Exports.end()); 230 231 ExportedSymbolSeq DocumentSymbols{ 232 {SymbolKind::GlobalSymbol, "_sym5", false, false}, 233 {SymbolKind::GlobalSymbol, "_sym6", false, false}, 234 }; 235 236 EXPECT_EQ(DocumentSymbols.size(), Exports.size()); 237 EXPECT_TRUE( 238 std::equal(Exports.begin(), Exports.end(), DocumentSymbols.begin())); 239 } 240 241 TEST(TBDv3, WriteFile) { 242 static const char TBDv3File3[] = 243 "--- !tapi-tbd-v3\n" 244 "archs: [ i386, x86_64 ]\n" 245 "platform: macosx\n" 246 "install-name: '/usr/lib/libfoo.dylib'\n" 247 "current-version: 1.2.3\n" 248 "compatibility-version: 0\n" 249 "swift-abi-version: 5\n" 250 "exports:\n" 251 " - archs: [ i386 ]\n" 252 " symbols: [ _sym1 ]\n" 253 " weak-def-symbols: [ _sym2 ]\n" 254 " thread-local-symbols: [ _sym3 ]\n" 255 " - archs: [ x86_64 ]\n" 256 " allowable-clients: [ clientA ]\n" 257 " re-exports: [ '/usr/lib/libfoo.dylib' ]\n" 258 " objc-classes: [ Class1 ]\n" 259 " objc-eh-types: [ Class1 ]\n" 260 " objc-ivars: [ Class1._ivar1 ]\n" 261 "...\n"; 262 263 InterfaceFile File; 264 TargetList Targets; 265 for (auto &&arch : AK_i386 | AK_x86_64) 266 Targets.emplace_back(Target(arch, PlatformKind::macOS)); 267 File.setPath("libfoo.dylib"); 268 File.setInstallName("/usr/lib/libfoo.dylib"); 269 File.setFileType(FileType::TBD_V3); 270 File.addTargets(Targets); 271 File.setCurrentVersion(PackedVersion(1, 2, 3)); 272 File.setTwoLevelNamespace(); 273 File.setApplicationExtensionSafe(); 274 File.setSwiftABIVersion(5); 275 File.setObjCConstraint(ObjCConstraintType::Retain_Release); 276 File.addAllowableClient("clientA", Targets[1]); 277 File.addReexportedLibrary("/usr/lib/libfoo.dylib", Targets[1]); 278 File.addSymbol(SymbolKind::GlobalSymbol, "_sym1", {Targets[0]}); 279 File.addSymbol(SymbolKind::GlobalSymbol, "_sym2", {Targets[0]}, 280 SymbolFlags::WeakDefined); 281 File.addSymbol(SymbolKind::GlobalSymbol, "_sym3", {Targets[0]}, 282 SymbolFlags::ThreadLocalValue); 283 File.addSymbol(SymbolKind::ObjectiveCClass, "Class1", {Targets[1]}); 284 File.addSymbol(SymbolKind::ObjectiveCClassEHType, "Class1", {Targets[1]}); 285 File.addSymbol(SymbolKind::ObjectiveCInstanceVariable, "Class1._ivar1", 286 {Targets[1]}); 287 288 SmallString<4096> Buffer; 289 raw_svector_ostream OS(Buffer); 290 auto Result = TextAPIWriter::writeToStream(OS, File); 291 EXPECT_FALSE(Result); 292 EXPECT_STREQ(TBDv3File3, Buffer.c_str()); 293 } 294 295 TEST(TBDv3, WriteMultipleDocuments) { 296 static const char TBDv3Inlines[] = 297 "--- !tapi-tbd-v3\n" 298 "archs: [ i386, x86_64 ]\n" 299 "platform: zippered\n" 300 "install-name: '/usr/lib/libfoo.dylib'\n" 301 "current-version: 1.2.3\n" 302 "compatibility-version: 0\n" 303 "swift-abi-version: 5\n" 304 "exports:\n" 305 " - archs: [ x86_64 ]\n" 306 " allowable-clients: [ clientA ]\n" 307 " re-exports: [ '/usr/lib/libbar.dylib' ]\n" 308 " - archs: [ i386, x86_64 ]\n" 309 " symbols: [ _sym1 ]\n" 310 " objc-classes: [ Class1 ]\n" 311 " objc-eh-types: [ Class1 ]\n" 312 " objc-ivars: [ Class1._ivar1 ]\n" 313 " weak-def-symbols: [ _sym2 ]\n" 314 " thread-local-symbols: [ _symA ]\n" 315 "--- !tapi-tbd-v3\n" 316 "archs: [ i386 ]\n" 317 "platform: macosx\n" 318 "install-name: '/usr/lib/libbar.dylib'\n" 319 "current-version: 0\n" 320 "compatibility-version: 0\n" 321 "swift-abi-version: 5\n" 322 "objc-constraint: none\n" 323 "exports:\n" 324 " - archs: [ i386 ]\n" 325 " symbols: [ _sym3, _sym4 ]\n" 326 "...\n"; 327 328 InterfaceFile File; 329 TargetList Targets; 330 for (auto &&arch : AK_i386 | AK_x86_64) { 331 Targets.emplace_back(Target(arch, PlatformKind::macOS)); 332 Targets.emplace_back(Target(arch, PlatformKind::macCatalyst)); 333 } 334 File.addTargets(Targets); 335 File.setPath("libfoo.dylib"); 336 File.setInstallName("/usr/lib/libfoo.dylib"); 337 File.setFileType(FileType::TBD_V3); 338 File.setCurrentVersion(PackedVersion(1, 2, 3)); 339 File.setTwoLevelNamespace(); 340 File.setApplicationExtensionSafe(); 341 File.setSwiftABIVersion(5); 342 File.setObjCConstraint(ObjCConstraintType::Retain_Release); 343 File.addAllowableClient("clientA", Targets[2]); 344 File.addReexportedLibrary("/usr/lib/libbar.dylib", Targets[2]); 345 File.addSymbol(SymbolKind::GlobalSymbol, "_sym1", Targets); 346 File.addSymbol(SymbolKind::GlobalSymbol, "_sym2", Targets, 347 SymbolFlags::WeakDefined); 348 File.addSymbol(SymbolKind::GlobalSymbol, "_symA", Targets, 349 SymbolFlags::ThreadLocalValue); 350 File.addSymbol(SymbolKind::ObjectiveCClass, "Class1", Targets); 351 File.addSymbol(SymbolKind::ObjectiveCClassEHType, "Class1", Targets); 352 File.addSymbol(SymbolKind::ObjectiveCInstanceVariable, "Class1._ivar1", 353 Targets); 354 355 // Inline document 356 InterfaceFile Document; 357 Targets = {Target(AK_i386, PlatformKind::macOS)}; 358 Document.addTargets(Targets); 359 Document.setPath("libbar.dylib"); 360 Document.setInstallName("/usr/lib/libbar.dylib"); 361 Document.setFileType(FileType::TBD_V3); 362 Document.setTwoLevelNamespace(); 363 Document.setApplicationExtensionSafe(); 364 Document.setSwiftABIVersion(5); 365 Document.addSymbol(SymbolKind::GlobalSymbol, "_sym3", Targets); 366 Document.addSymbol(SymbolKind::GlobalSymbol, "_sym4", Targets); 367 File.addDocument(std::make_shared<InterfaceFile>(std::move(Document))); 368 369 SmallString<4096> Buffer; 370 raw_svector_ostream OS(Buffer); 371 auto Result = TextAPIWriter::writeToStream(OS, File); 372 EXPECT_FALSE(Result); 373 EXPECT_STREQ(TBDv3Inlines, Buffer.c_str()); 374 } 375 376 TEST(TBDv3, Platform_macOS) { 377 static const char TBDv3PlatformMacOS[] = "--- !tapi-tbd-v3\n" 378 "archs: [ x86_64 ]\n" 379 "platform: macosx\n" 380 "install-name: Test.dylib\n" 381 "...\n"; 382 383 auto Result = 384 TextAPIReader::get(MemoryBufferRef(TBDv3PlatformMacOS, "Test.tbd")); 385 EXPECT_TRUE(!!Result); 386 auto Platform = PlatformKind::macOS; 387 auto File = std::move(Result.get()); 388 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 389 EXPECT_EQ(File->getPlatforms().size(), 1U); 390 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 391 392 SmallString<4096> Buffer; 393 raw_svector_ostream OS(Buffer); 394 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 395 EXPECT_TRUE(!WriteResult); 396 EXPECT_EQ(stripWhitespace(TBDv3PlatformMacOS), 397 stripWhitespace(Buffer.c_str())); 398 } 399 400 TEST(TBDv3, Platform_iOS) { 401 static const char TBDv3PlatformiOS[] = "--- !tapi-tbd-v3\n" 402 "archs: [ arm64 ]\n" 403 "platform: ios\n" 404 "install-name: Test.dylib\n" 405 "...\n"; 406 407 auto Result = 408 TextAPIReader::get(MemoryBufferRef(TBDv3PlatformiOS, "Test.tbd")); 409 EXPECT_TRUE(!!Result); 410 auto Platform = PlatformKind::iOS; 411 auto File = std::move(Result.get()); 412 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 413 EXPECT_EQ(File->getPlatforms().size(), 1U); 414 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 415 416 SmallString<4096> Buffer; 417 raw_svector_ostream OS(Buffer); 418 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 419 EXPECT_TRUE(!WriteResult); 420 EXPECT_EQ(stripWhitespace(TBDv3PlatformiOS), stripWhitespace(Buffer.c_str())); 421 } 422 423 TEST(TBDv3, Platform_watchOS) { 424 static const char TBDv3watchOS[] = "--- !tapi-tbd-v3\n" 425 "archs: [ armv7k ]\n" 426 "platform: watchos\n" 427 "install-name: Test.dylib\n" 428 "...\n"; 429 430 auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3watchOS, "Test.tbd")); 431 EXPECT_TRUE(!!Result); 432 auto Platform = PlatformKind::watchOS; 433 auto File = std::move(Result.get()); 434 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 435 EXPECT_EQ(File->getPlatforms().size(), 1U); 436 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 437 438 SmallString<4096> Buffer; 439 raw_svector_ostream OS(Buffer); 440 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 441 EXPECT_TRUE(!WriteResult); 442 EXPECT_EQ(stripWhitespace(TBDv3watchOS), stripWhitespace(Buffer.c_str())); 443 } 444 445 TEST(TBDv3, Platform_tvOS) { 446 static const char TBDv3PlatformtvOS[] = "--- !tapi-tbd-v3\n" 447 "archs: [ arm64 ]\n" 448 "platform: tvos\n" 449 "install-name: Test.dylib\n" 450 "...\n"; 451 452 auto Result = 453 TextAPIReader::get(MemoryBufferRef(TBDv3PlatformtvOS, "Test.tbd")); 454 EXPECT_TRUE(!!Result); 455 auto File = std::move(Result.get()); 456 auto Platform = PlatformKind::tvOS; 457 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 458 EXPECT_EQ(File->getPlatforms().size(), 1U); 459 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 460 461 SmallString<4096> Buffer; 462 raw_svector_ostream OS(Buffer); 463 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 464 EXPECT_TRUE(!WriteResult); 465 EXPECT_EQ(stripWhitespace(TBDv3PlatformtvOS), 466 stripWhitespace(Buffer.c_str())); 467 } 468 469 TEST(TBDv3, Platform_bridgeOS) { 470 static const char TBDv3BridgeOS[] = "--- !tapi-tbd-v3\n" 471 "archs: [ armv7k ]\n" 472 "platform: bridgeos\n" 473 "install-name: Test.dylib\n" 474 "...\n"; 475 476 auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3BridgeOS, "Test.tbd")); 477 EXPECT_TRUE(!!Result); 478 auto Platform = PlatformKind::bridgeOS; 479 auto File = std::move(Result.get()); 480 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 481 EXPECT_EQ(File->getPlatforms().size(), 1U); 482 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 483 484 SmallString<4096> Buffer; 485 raw_svector_ostream OS(Buffer); 486 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 487 EXPECT_TRUE(!WriteResult); 488 EXPECT_EQ(stripWhitespace(TBDv3BridgeOS), stripWhitespace(Buffer.c_str())); 489 } 490 491 TEST(TBDv3, Platform_macCatalyst) { 492 static const char TBDv3PlatformiOSmac[] = "--- !tapi-tbd-v3\n" 493 "archs: [ armv7k ]\n" 494 "platform: iosmac\n" 495 "install-name: Test.dylib\n" 496 "...\n"; 497 498 auto Result = 499 TextAPIReader::get(MemoryBufferRef(TBDv3PlatformiOSmac, "Test.tbd")); 500 EXPECT_TRUE(!!Result); 501 auto Platform = PlatformKind::macCatalyst; 502 auto File = std::move(Result.get()); 503 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 504 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 505 506 SmallString<4096> Buffer; 507 raw_svector_ostream OS(Buffer); 508 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 509 EXPECT_TRUE(!WriteResult); 510 EXPECT_EQ(stripWhitespace(TBDv3PlatformiOSmac), 511 stripWhitespace(Buffer.c_str())); 512 } 513 514 TEST(TBDv3, Platform_zippered) { 515 static const char TBDv3PlatformZippered[] = "--- !tapi-tbd-v3\n" 516 "archs: [ armv7k ]\n" 517 "platform: zippered\n" 518 "install-name: Test.dylib\n" 519 "...\n"; 520 521 auto Result = 522 TextAPIReader::get(MemoryBufferRef(TBDv3PlatformZippered, "Test.tbd")); 523 EXPECT_TRUE(!!Result); 524 auto File = std::move(Result.get()); 525 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 526 527 PlatformSet Platforms; 528 Platforms.insert(PlatformKind::macOS); 529 Platforms.insert(PlatformKind::macCatalyst); 530 EXPECT_EQ(Platforms.size(), File->getPlatforms().size()); 531 for (auto Platform : File->getPlatforms()) 532 EXPECT_EQ(Platforms.count(Platform), 1U); 533 534 SmallString<4096> Buffer; 535 raw_svector_ostream OS(Buffer); 536 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 537 EXPECT_TRUE(!WriteResult); 538 EXPECT_EQ(stripWhitespace(TBDv3PlatformZippered), 539 stripWhitespace(Buffer.c_str())); 540 } 541 542 TEST(TBDv3, Platform_iOSSim) { 543 static const char TBDv3PlatformiOSsim[] = "--- !tapi-tbd-v3\n" 544 "archs: [ x86_64 ]\n" 545 "platform: ios\n" 546 "install-name: Test.dylib\n" 547 "...\n"; 548 549 auto Result = 550 TextAPIReader::get(MemoryBufferRef(TBDv3PlatformiOSsim, "Test.tbd")); 551 EXPECT_TRUE(!!Result); 552 auto Platform = PlatformKind::iOSSimulator; 553 auto File = std::move(Result.get()); 554 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 555 EXPECT_EQ(File->getPlatforms().size(), 1U); 556 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 557 558 SmallString<4096> Buffer; 559 raw_svector_ostream OS(Buffer); 560 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 561 EXPECT_TRUE(!WriteResult); 562 EXPECT_EQ(stripWhitespace(TBDv3PlatformiOSsim), 563 stripWhitespace(Buffer.c_str())); 564 } 565 566 TEST(TBDv3, Platform_watchOSSim) { 567 static const char TBDv3watchOSsim[] = "--- !tapi-tbd-v3\n" 568 "archs: [ x86_64 ]\n" 569 "platform: watchos\n" 570 "install-name: Test.dylib\n" 571 "...\n"; 572 573 auto Result = 574 TextAPIReader::get(MemoryBufferRef(TBDv3watchOSsim, "Test.tbd")); 575 EXPECT_TRUE(!!Result); 576 auto Platform = PlatformKind::watchOSSimulator; 577 auto File = std::move(Result.get()); 578 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 579 EXPECT_EQ(File->getPlatforms().size(), 1U); 580 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 581 582 SmallString<4096> Buffer; 583 raw_svector_ostream OS(Buffer); 584 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 585 EXPECT_TRUE(!WriteResult); 586 EXPECT_EQ(stripWhitespace(TBDv3watchOSsim), stripWhitespace(Buffer.c_str())); 587 } 588 589 TEST(TBDv3, Platform_tvOSSim) { 590 static const char TBDv3PlatformtvOSsim[] = "--- !tapi-tbd-v3\n" 591 "archs: [ x86_64 ]\n" 592 "platform: tvos\n" 593 "install-name: Test.dylib\n" 594 "...\n"; 595 596 auto Result = 597 TextAPIReader::get(MemoryBufferRef(TBDv3PlatformtvOSsim, "Test.tbd")); 598 EXPECT_TRUE(!!Result); 599 auto File = std::move(Result.get()); 600 auto Platform = PlatformKind::tvOSSimulator; 601 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 602 EXPECT_EQ(File->getPlatforms().size(), 1U); 603 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 604 605 SmallString<4096> Buffer; 606 raw_svector_ostream OS(Buffer); 607 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 608 EXPECT_TRUE(!WriteResult); 609 EXPECT_EQ(stripWhitespace(TBDv3PlatformtvOSsim), 610 stripWhitespace(Buffer.c_str())); 611 } 612 613 TEST(TBDv3, Arch_arm64e) { 614 static const char TBDv3ArchArm64e[] = "--- !tapi-tbd-v3\n" 615 "archs: [ arm64, arm64e ]\n" 616 "platform: ios\n" 617 "install-name: Test.dylib\n" 618 "...\n"; 619 620 auto Result = 621 TextAPIReader::get(MemoryBufferRef(TBDv3ArchArm64e, "Test.tbd")); 622 EXPECT_TRUE(!!Result); 623 auto File = std::move(Result.get()); 624 auto Platform = PlatformKind::iOS; 625 auto Archs = AK_arm64 | AK_arm64e; 626 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 627 EXPECT_EQ(File->getPlatforms().size(), 1U); 628 EXPECT_EQ(Platform, *File->getPlatforms().begin()); 629 EXPECT_EQ(Archs, File->getArchitectures()); 630 631 SmallString<4096> Buffer; 632 raw_svector_ostream OS(Buffer); 633 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 634 EXPECT_TRUE(!WriteResult); 635 EXPECT_EQ(stripWhitespace(TBDv3ArchArm64e), stripWhitespace(Buffer.c_str())); 636 } 637 638 TEST(TBDv3, Swift_1_0) { 639 static const char TBDv3Swift1[] = "--- !tapi-tbd-v3\n" 640 "archs: [ arm64 ]\n" 641 "platform: ios\n" 642 "install-name: Test.dylib\n" 643 "swift-abi-version: 1.0\n" 644 "...\n"; 645 646 auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift1, "Test.tbd")); 647 EXPECT_TRUE(!!Result); 648 auto File = std::move(Result.get()); 649 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 650 EXPECT_EQ(1U, File->getSwiftABIVersion()); 651 652 SmallString<4096> Buffer; 653 raw_svector_ostream OS(Buffer); 654 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 655 EXPECT_TRUE(!WriteResult); 656 EXPECT_EQ(stripWhitespace(TBDv3Swift1), stripWhitespace(Buffer.c_str())); 657 } 658 659 TEST(TBDv3, Swift_1_1) { 660 static const char TBDv3Swift1Dot[] = "--- !tapi-tbd-v3\n" 661 "archs: [ arm64 ]\n" 662 "platform: ios\n" 663 "install-name: Test.dylib\n" 664 "swift-abi-version: 1.1\n" 665 "...\n"; 666 667 auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift1Dot, "Test.tbd")); 668 EXPECT_TRUE(!!Result); 669 auto File = std::move(Result.get()); 670 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 671 EXPECT_EQ(2U, File->getSwiftABIVersion()); 672 673 SmallString<4096> Buffer; 674 raw_svector_ostream OS(Buffer); 675 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 676 EXPECT_TRUE(!WriteResult); 677 EXPECT_EQ(stripWhitespace(TBDv3Swift1Dot), stripWhitespace(Buffer.c_str())); 678 } 679 680 TEST(TBDv3, Swift_2_0) { 681 static const char TBDv3Swift2[] = "--- !tapi-tbd-v3\n" 682 "archs: [ arm64 ]\n" 683 "platform: ios\n" 684 "install-name: Test.dylib\n" 685 "swift-abi-version: 2.0\n" 686 "...\n"; 687 688 auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift2, "Test.tbd")); 689 EXPECT_TRUE(!!Result); 690 auto File = std::move(Result.get()); 691 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 692 EXPECT_EQ(3U, File->getSwiftABIVersion()); 693 694 SmallString<4096> Buffer; 695 raw_svector_ostream OS(Buffer); 696 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 697 EXPECT_TRUE(!WriteResult); 698 EXPECT_EQ(stripWhitespace(TBDv3Swift2), stripWhitespace(Buffer.c_str())); 699 } 700 701 TEST(TBDv3, Swift_3_0) { 702 static const char TBDv3Swift3[] = "--- !tapi-tbd-v3\n" 703 "archs: [ arm64 ]\n" 704 "platform: ios\n" 705 "install-name: Test.dylib\n" 706 "swift-abi-version: 3.0\n" 707 "...\n"; 708 709 auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift3, "Test.tbd")); 710 EXPECT_TRUE(!!Result); 711 auto File = std::move(Result.get()); 712 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 713 EXPECT_EQ(4U, File->getSwiftABIVersion()); 714 715 SmallString<4096> Buffer; 716 raw_svector_ostream OS(Buffer); 717 auto WriteResult = TextAPIWriter::writeToStream(OS, *File); 718 EXPECT_TRUE(!WriteResult); 719 EXPECT_EQ(stripWhitespace(TBDv3Swift3), stripWhitespace(Buffer.c_str())); 720 } 721 722 TEST(TBDv3, Swift_4_0) { 723 static const char TBDv3Swift4[] = "--- !tapi-tbd-v3\n" 724 "archs: [ arm64 ]\n" 725 "platform: ios\n" 726 "install-name: Test.dylib\n" 727 "swift-abi-version: 4.0\n" 728 "...\n"; 729 730 auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift4, "Test.tbd")); 731 EXPECT_FALSE(!!Result); 732 auto errorMessage = toString(Result.takeError()); 733 EXPECT_EQ("malformed file\nTest.tbd:5:20: error: invalid Swift ABI " 734 "version.\nswift-abi-version: 4.0\n ^~~\n", 735 errorMessage); 736 } 737 738 TEST(TBDv3, Swift_5) { 739 static const char TBDv3Swift5[] = "--- !tapi-tbd-v3\n" 740 "archs: [ arm64 ]\n" 741 "platform: ios\n" 742 "install-name: Test.dylib\n" 743 "swift-abi-version: 5\n" 744 "...\n"; 745 746 auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift5, "Test.tbd")); 747 EXPECT_TRUE(!!Result); 748 auto File = std::move(Result.get()); 749 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 750 EXPECT_EQ(5U, File->getSwiftABIVersion()); 751 } 752 753 TEST(TBDv3, Swift_99) { 754 static const char TBDv3Swift99[] = "--- !tapi-tbd-v3\n" 755 "archs: [ arm64 ]\n" 756 "platform: ios\n" 757 "install-name: Test.dylib\n" 758 "swift-abi-version: 99\n" 759 "...\n"; 760 761 auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift99, "Test.tbd")); 762 EXPECT_TRUE(!!Result); 763 auto File = std::move(Result.get()); 764 EXPECT_EQ(FileType::TBD_V3, File->getFileType()); 765 EXPECT_EQ(99U, File->getSwiftABIVersion()); 766 } 767 768 TEST(TBDv3, UnknownArchitecture) { 769 static const char TBDv3FileUnknownArch[] = "--- !tapi-tbd-v3\n" 770 "archs: [ foo ]\n" 771 "platform: macosx\n" 772 "install-name: Test.dylib\n" 773 "...\n"; 774 775 auto Result = 776 TextAPIReader::get(MemoryBufferRef(TBDv3FileUnknownArch, "Test.tbd")); 777 EXPECT_TRUE(!!Result); 778 } 779 780 TEST(TBDv3, UnknownPlatform) { 781 static const char TBDv3FileUnknownPlatform[] = "--- !tapi-tbd-v3\n" 782 "archs: [ i386 ]\n" 783 "platform: newOS\n" 784 "...\n"; 785 786 auto Result = 787 TextAPIReader::get(MemoryBufferRef(TBDv3FileUnknownPlatform, "Test.tbd")); 788 EXPECT_FALSE(!!Result); 789 auto errorMessage = toString(Result.takeError()); 790 EXPECT_EQ("malformed file\nTest.tbd:3:11: error: unknown platform\nplatform: " 791 "newOS\n ^~~~~\n", 792 errorMessage); 793 } 794 795 TEST(TBDv3, MalformedFile1) { 796 static const char TBDv3FileMalformed1[] = "--- !tapi-tbd-v3\n" 797 "archs: [ arm64 ]\n" 798 "foobar: \"Unsupported key\"\n" 799 "...\n"; 800 801 auto Result = 802 TextAPIReader::get(MemoryBufferRef(TBDv3FileMalformed1, "Test.tbd")); 803 EXPECT_FALSE(!!Result); 804 auto errorMessage = toString(Result.takeError()); 805 ASSERT_EQ("malformed file\nTest.tbd:2:1: error: missing required key " 806 "'platform'\narchs: [ arm64 ]\n^\n", 807 errorMessage); 808 } 809 810 TEST(TBDv3, MalformedFile2) { 811 static const char TBDv3FileMalformed2[] = "--- !tapi-tbd-v3\n" 812 "archs: [ arm64 ]\n" 813 "platform: ios\n" 814 "install-name: Test.dylib\n" 815 "foobar: \"Unsupported key\"\n" 816 "...\n"; 817 818 auto Result = 819 TextAPIReader::get(MemoryBufferRef(TBDv3FileMalformed2, "Test.tbd")); 820 EXPECT_FALSE(!!Result); 821 auto errorMessage = toString(Result.takeError()); 822 ASSERT_EQ( 823 "malformed file\nTest.tbd:5:9: error: unknown key 'foobar'\nfoobar: " 824 "\"Unsupported key\"\n ^~~~~~~~~~~~~~~~~\n", 825 errorMessage); 826 } 827 828 } // namespace TBDv3 829