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, WriteFile) {
121   static const char TBDv3File3[] =
122       "--- !tapi-tbd-v3\n"
123       "archs:           [ i386, x86_64 ]\n"
124       "platform:        macosx\n"
125       "install-name:    '/usr/lib/libfoo.dylib'\n"
126       "current-version: 1.2.3\n"
127       "compatibility-version: 0\n"
128       "swift-abi-version: 5\n"
129       "exports:\n"
130       "  - archs:           [ i386 ]\n"
131       "    symbols:         [ _sym1 ]\n"
132       "    weak-def-symbols: [ _sym2 ]\n"
133       "    thread-local-symbols: [ _sym3 ]\n"
134       "  - archs:           [ x86_64 ]\n"
135       "    allowable-clients: [ clientA ]\n"
136       "    re-exports:      [ '/usr/lib/libfoo.dylib' ]\n"
137       "    objc-classes:    [ Class1 ]\n"
138       "    objc-eh-types:   [ Class1 ]\n"
139       "    objc-ivars:      [ Class1._ivar1 ]\n"
140       "...\n";
141 
142   InterfaceFile File;
143   TargetList Targets;
144   for (auto &&arch : AK_i386 | AK_x86_64)
145     Targets.emplace_back(Target(arch, PlatformKind::macOS));
146   File.setPath("libfoo.dylib");
147   File.setInstallName("/usr/lib/libfoo.dylib");
148   File.setFileType(FileType::TBD_V3);
149   File.addTargets(Targets);
150   File.setCurrentVersion(PackedVersion(1, 2, 3));
151   File.setTwoLevelNamespace();
152   File.setApplicationExtensionSafe();
153   File.setSwiftABIVersion(5);
154   File.setObjCConstraint(ObjCConstraintType::Retain_Release);
155   File.addAllowableClient("clientA", Targets[1]);
156   File.addReexportedLibrary("/usr/lib/libfoo.dylib", Targets[1]);
157   File.addSymbol(SymbolKind::GlobalSymbol, "_sym1", {Targets[0]});
158   File.addSymbol(SymbolKind::GlobalSymbol, "_sym2", {Targets[0]},
159                  SymbolFlags::WeakDefined);
160   File.addSymbol(SymbolKind::GlobalSymbol, "_sym3", {Targets[0]},
161                  SymbolFlags::ThreadLocalValue);
162   File.addSymbol(SymbolKind::ObjectiveCClass, "Class1", {Targets[1]});
163   File.addSymbol(SymbolKind::ObjectiveCClassEHType, "Class1", {Targets[1]});
164   File.addSymbol(SymbolKind::ObjectiveCInstanceVariable, "Class1._ivar1",
165                  {Targets[1]});
166 
167   SmallString<4096> Buffer;
168   raw_svector_ostream OS(Buffer);
169   auto Result = TextAPIWriter::writeToStream(OS, File);
170   EXPECT_FALSE(Result);
171   EXPECT_STREQ(TBDv3File3, Buffer.c_str());
172 }
173 
174 TEST(TBDv3, Platform_macOS) {
175   static const char TBDv3PlatformMacOS[] = "--- !tapi-tbd-v3\n"
176                                            "archs: [ x86_64 ]\n"
177                                            "platform: macosx\n"
178                                            "install-name: Test.dylib\n"
179                                            "...\n";
180 
181   auto Result =
182       TextAPIReader::get(MemoryBufferRef(TBDv3PlatformMacOS, "Test.tbd"));
183   EXPECT_TRUE(!!Result);
184   auto Platform = PlatformKind::macOS;
185   auto File = std::move(Result.get());
186   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
187   EXPECT_EQ(File->getPlatforms().size(), 1U);
188   EXPECT_EQ(Platform, *File->getPlatforms().begin());
189 
190   SmallString<4096> Buffer;
191   raw_svector_ostream OS(Buffer);
192   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
193   EXPECT_TRUE(!WriteResult);
194   EXPECT_EQ(stripWhitespace(TBDv3PlatformMacOS),
195             stripWhitespace(Buffer.c_str()));
196 }
197 
198 TEST(TBDv3, Platform_iOS) {
199   static const char TBDv3PlatformiOS[] = "--- !tapi-tbd-v3\n"
200                                          "archs: [ arm64 ]\n"
201                                          "platform: ios\n"
202                                          "install-name: Test.dylib\n"
203                                          "...\n";
204 
205   auto Result =
206       TextAPIReader::get(MemoryBufferRef(TBDv3PlatformiOS, "Test.tbd"));
207   EXPECT_TRUE(!!Result);
208   auto Platform = PlatformKind::iOS;
209   auto File = std::move(Result.get());
210   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
211   EXPECT_EQ(File->getPlatforms().size(), 1U);
212   EXPECT_EQ(Platform, *File->getPlatforms().begin());
213 
214   SmallString<4096> Buffer;
215   raw_svector_ostream OS(Buffer);
216   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
217   EXPECT_TRUE(!WriteResult);
218   EXPECT_EQ(stripWhitespace(TBDv3PlatformiOS), stripWhitespace(Buffer.c_str()));
219 }
220 
221 TEST(TBDv3, Platform_watchOS) {
222   static const char TBDv3watchOS[] = "--- !tapi-tbd-v3\n"
223                                      "archs: [ armv7k ]\n"
224                                      "platform: watchos\n"
225                                      "install-name: Test.dylib\n"
226                                      "...\n";
227 
228   auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3watchOS, "Test.tbd"));
229   EXPECT_TRUE(!!Result);
230   auto Platform = PlatformKind::watchOS;
231   auto File = std::move(Result.get());
232   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
233   EXPECT_EQ(File->getPlatforms().size(), 1U);
234   EXPECT_EQ(Platform, *File->getPlatforms().begin());
235 
236   SmallString<4096> Buffer;
237   raw_svector_ostream OS(Buffer);
238   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
239   EXPECT_TRUE(!WriteResult);
240   EXPECT_EQ(stripWhitespace(TBDv3watchOS), stripWhitespace(Buffer.c_str()));
241 }
242 
243 TEST(TBDv3, Platform_tvOS) {
244   static const char TBDv3PlatformtvOS[] = "--- !tapi-tbd-v3\n"
245                                           "archs: [ arm64 ]\n"
246                                           "platform: tvos\n"
247                                           "install-name: Test.dylib\n"
248                                           "...\n";
249 
250   auto Result =
251       TextAPIReader::get(MemoryBufferRef(TBDv3PlatformtvOS, "Test.tbd"));
252   EXPECT_TRUE(!!Result);
253   auto File = std::move(Result.get());
254   auto Platform = PlatformKind::tvOS;
255   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
256   EXPECT_EQ(File->getPlatforms().size(), 1U);
257   EXPECT_EQ(Platform, *File->getPlatforms().begin());
258 
259   SmallString<4096> Buffer;
260   raw_svector_ostream OS(Buffer);
261   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
262   EXPECT_TRUE(!WriteResult);
263   EXPECT_EQ(stripWhitespace(TBDv3PlatformtvOS),
264             stripWhitespace(Buffer.c_str()));
265 }
266 
267 TEST(TBDv3, Platform_bridgeOS) {
268   static const char TBDv3BridgeOS[] = "--- !tapi-tbd-v3\n"
269                                       "archs: [ armv7k ]\n"
270                                       "platform: bridgeos\n"
271                                       "install-name: Test.dylib\n"
272                                       "...\n";
273 
274   auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3BridgeOS, "Test.tbd"));
275   EXPECT_TRUE(!!Result);
276   auto Platform = PlatformKind::bridgeOS;
277   auto File = std::move(Result.get());
278   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
279   EXPECT_EQ(File->getPlatforms().size(), 1U);
280   EXPECT_EQ(Platform, *File->getPlatforms().begin());
281 
282   SmallString<4096> Buffer;
283   raw_svector_ostream OS(Buffer);
284   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
285   EXPECT_TRUE(!WriteResult);
286   EXPECT_EQ(stripWhitespace(TBDv3BridgeOS), stripWhitespace(Buffer.c_str()));
287 }
288 
289 TEST(TBDv3, Platform_macCatalyst) {
290   static const char TBDv3PlatformiOSmac[] = "--- !tapi-tbd-v3\n"
291                                             "archs: [ armv7k ]\n"
292                                             "platform: iosmac\n"
293                                             "install-name: Test.dylib\n"
294                                             "...\n";
295 
296   auto Result =
297       TextAPIReader::get(MemoryBufferRef(TBDv3PlatformiOSmac, "Test.tbd"));
298   EXPECT_TRUE(!!Result);
299   auto Platform = PlatformKind::macCatalyst;
300   auto File = std::move(Result.get());
301   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
302   EXPECT_EQ(Platform, *File->getPlatforms().begin());
303 
304   SmallString<4096> Buffer;
305   raw_svector_ostream OS(Buffer);
306   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
307   EXPECT_TRUE(!WriteResult);
308   EXPECT_EQ(stripWhitespace(TBDv3PlatformiOSmac),
309             stripWhitespace(Buffer.c_str()));
310 }
311 
312 TEST(TBDv3, Platform_zippered) {
313   static const char TBDv3PlatformZippered[] = "--- !tapi-tbd-v3\n"
314                                               "archs: [ armv7k ]\n"
315                                               "platform: zippered\n"
316                                               "install-name: Test.dylib\n"
317                                               "...\n";
318 
319   auto Result =
320       TextAPIReader::get(MemoryBufferRef(TBDv3PlatformZippered, "Test.tbd"));
321   EXPECT_TRUE(!!Result);
322   auto File = std::move(Result.get());
323   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
324 
325   PlatformSet Platforms;
326   Platforms.insert(PlatformKind::macOS);
327   Platforms.insert(PlatformKind::macCatalyst);
328   EXPECT_EQ(Platforms.size(), File->getPlatforms().size());
329   for (auto Platform : File->getPlatforms())
330 	    EXPECT_EQ(Platforms.count(Platform), 1U);
331 
332   SmallString<4096> Buffer;
333   raw_svector_ostream OS(Buffer);
334   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
335   EXPECT_TRUE(!WriteResult);
336   EXPECT_EQ(stripWhitespace(TBDv3PlatformZippered),
337             stripWhitespace(Buffer.c_str()));
338 }
339 
340 TEST(TBDv3, Platform_iOSSim) {
341   static const char TBDv3PlatformiOSsim[] = "--- !tapi-tbd-v3\n"
342                                             "archs: [ x86_64 ]\n"
343                                             "platform: ios\n"
344                                             "install-name: Test.dylib\n"
345                                             "...\n";
346 
347   auto Result =
348       TextAPIReader::get(MemoryBufferRef(TBDv3PlatformiOSsim, "Test.tbd"));
349   EXPECT_TRUE(!!Result);
350   auto Platform = PlatformKind::iOSSimulator;
351   auto File = std::move(Result.get());
352   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
353   EXPECT_EQ(File->getPlatforms().size(), 1U);
354   EXPECT_EQ(Platform, *File->getPlatforms().begin());
355 
356   SmallString<4096> Buffer;
357   raw_svector_ostream OS(Buffer);
358   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
359   EXPECT_TRUE(!WriteResult);
360   EXPECT_EQ(stripWhitespace(TBDv3PlatformiOSsim),
361             stripWhitespace(Buffer.c_str()));
362 }
363 
364 TEST(TBDv3, Platform_watchOSSim) {
365   static const char TBDv3watchOSsim[] = "--- !tapi-tbd-v3\n"
366                                         "archs: [ x86_64 ]\n"
367                                         "platform: watchos\n"
368                                         "install-name: Test.dylib\n"
369                                         "...\n";
370 
371   auto Result =
372       TextAPIReader::get(MemoryBufferRef(TBDv3watchOSsim, "Test.tbd"));
373   EXPECT_TRUE(!!Result);
374   auto Platform = PlatformKind::watchOSSimulator;
375   auto File = std::move(Result.get());
376   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
377   EXPECT_EQ(File->getPlatforms().size(), 1U);
378   EXPECT_EQ(Platform, *File->getPlatforms().begin());
379 
380   SmallString<4096> Buffer;
381   raw_svector_ostream OS(Buffer);
382   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
383   EXPECT_TRUE(!WriteResult);
384   EXPECT_EQ(stripWhitespace(TBDv3watchOSsim), stripWhitespace(Buffer.c_str()));
385 }
386 
387 TEST(TBDv3, Platform_tvOSSim) {
388   static const char TBDv3PlatformtvOSsim[] = "--- !tapi-tbd-v3\n"
389                                              "archs: [ x86_64 ]\n"
390                                              "platform: tvos\n"
391                                              "install-name: Test.dylib\n"
392                                              "...\n";
393 
394   auto Result =
395       TextAPIReader::get(MemoryBufferRef(TBDv3PlatformtvOSsim, "Test.tbd"));
396   EXPECT_TRUE(!!Result);
397   auto File = std::move(Result.get());
398   auto Platform = PlatformKind::tvOSSimulator;
399   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
400   EXPECT_EQ(File->getPlatforms().size(), 1U);
401   EXPECT_EQ(Platform, *File->getPlatforms().begin());
402 
403   SmallString<4096> Buffer;
404   raw_svector_ostream OS(Buffer);
405   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
406   EXPECT_TRUE(!WriteResult);
407   EXPECT_EQ(stripWhitespace(TBDv3PlatformtvOSsim),
408             stripWhitespace(Buffer.c_str()));
409 }
410 
411 TEST(TBDv3, Swift_1_0) {
412   static const char TBDv3Swift1[] = "--- !tapi-tbd-v3\n"
413                                     "archs: [ arm64 ]\n"
414                                     "platform: ios\n"
415                                     "install-name: Test.dylib\n"
416                                     "swift-abi-version: 1.0\n"
417                                     "...\n";
418 
419   auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift1, "Test.tbd"));
420   EXPECT_TRUE(!!Result);
421   auto File = std::move(Result.get());
422   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
423   EXPECT_EQ(1U, File->getSwiftABIVersion());
424 
425   SmallString<4096> Buffer;
426   raw_svector_ostream OS(Buffer);
427   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
428   EXPECT_TRUE(!WriteResult);
429   EXPECT_EQ(stripWhitespace(TBDv3Swift1), stripWhitespace(Buffer.c_str()));
430 }
431 
432 TEST(TBDv3, Swift_1_1) {
433   static const char TBDv3Swift1Dot[] = "--- !tapi-tbd-v3\n"
434                                        "archs: [ arm64 ]\n"
435                                        "platform: ios\n"
436                                        "install-name: Test.dylib\n"
437                                        "swift-abi-version: 1.1\n"
438                                        "...\n";
439 
440   auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift1Dot, "Test.tbd"));
441   EXPECT_TRUE(!!Result);
442   auto File = std::move(Result.get());
443   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
444   EXPECT_EQ(2U, File->getSwiftABIVersion());
445 
446   SmallString<4096> Buffer;
447   raw_svector_ostream OS(Buffer);
448   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
449   EXPECT_TRUE(!WriteResult);
450   EXPECT_EQ(stripWhitespace(TBDv3Swift1Dot), stripWhitespace(Buffer.c_str()));
451 }
452 
453 TEST(TBDv3, Swift_2_0) {
454   static const char TBDv3Swift2[] = "--- !tapi-tbd-v3\n"
455                                     "archs: [ arm64 ]\n"
456                                     "platform: ios\n"
457                                     "install-name: Test.dylib\n"
458                                     "swift-abi-version: 2.0\n"
459                                     "...\n";
460 
461   auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift2, "Test.tbd"));
462   EXPECT_TRUE(!!Result);
463   auto File = std::move(Result.get());
464   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
465   EXPECT_EQ(3U, File->getSwiftABIVersion());
466 
467   SmallString<4096> Buffer;
468   raw_svector_ostream OS(Buffer);
469   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
470   EXPECT_TRUE(!WriteResult);
471   EXPECT_EQ(stripWhitespace(TBDv3Swift2), stripWhitespace(Buffer.c_str()));
472 }
473 
474 TEST(TBDv3, Swift_3_0) {
475   static const char TBDv3Swift3[] = "--- !tapi-tbd-v3\n"
476                                     "archs: [ arm64 ]\n"
477                                     "platform: ios\n"
478                                     "install-name: Test.dylib\n"
479                                     "swift-abi-version: 3.0\n"
480                                     "...\n";
481 
482   auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift3, "Test.tbd"));
483   EXPECT_TRUE(!!Result);
484   auto File = std::move(Result.get());
485   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
486   EXPECT_EQ(4U, File->getSwiftABIVersion());
487 
488   SmallString<4096> Buffer;
489   raw_svector_ostream OS(Buffer);
490   auto WriteResult = TextAPIWriter::writeToStream(OS, *File);
491   EXPECT_TRUE(!WriteResult);
492   EXPECT_EQ(stripWhitespace(TBDv3Swift3), stripWhitespace(Buffer.c_str()));
493 }
494 
495 TEST(TBDv3, Swift_4_0) {
496   static const char TBDv3Swift4[] = "--- !tapi-tbd-v3\n"
497                                     "archs: [ arm64 ]\n"
498                                     "platform: ios\n"
499                                     "install-name: Test.dylib\n"
500                                     "swift-abi-version: 4.0\n"
501                                     "...\n";
502 
503   auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift4, "Test.tbd"));
504   EXPECT_FALSE(!!Result);
505   auto errorMessage = toString(Result.takeError());
506   EXPECT_EQ("malformed file\nTest.tbd:5:20: error: invalid Swift ABI "
507             "version.\nswift-abi-version: 4.0\n                   ^~~\n",
508             errorMessage);
509 }
510 
511 TEST(TBDv3, Swift_5) {
512   static const char TBDv3Swift5[] = "--- !tapi-tbd-v3\n"
513                                     "archs: [ arm64 ]\n"
514                                     "platform: ios\n"
515                                     "install-name: Test.dylib\n"
516                                     "swift-abi-version: 5\n"
517                                     "...\n";
518 
519   auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift5, "Test.tbd"));
520   EXPECT_TRUE(!!Result);
521   auto File = std::move(Result.get());
522   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
523   EXPECT_EQ(5U, File->getSwiftABIVersion());
524 }
525 
526 TEST(TBDv3, Swift_99) {
527   static const char TBDv3Swift99[] = "--- !tapi-tbd-v3\n"
528                                      "archs: [ arm64 ]\n"
529                                      "platform: ios\n"
530                                      "install-name: Test.dylib\n"
531                                      "swift-abi-version: 99\n"
532                                      "...\n";
533 
534   auto Result = TextAPIReader::get(MemoryBufferRef(TBDv3Swift99, "Test.tbd"));
535   EXPECT_TRUE(!!Result);
536   auto File = std::move(Result.get());
537   EXPECT_EQ(FileType::TBD_V3, File->getFileType());
538   EXPECT_EQ(99U, File->getSwiftABIVersion());
539 }
540 
541 TEST(TBDv3, UnknownArchitecture) {
542   static const char TBDv3FileUnknownArch[] = "--- !tapi-tbd-v3\n"
543                                              "archs: [ foo ]\n"
544                                              "platform: macosx\n"
545                                              "install-name: Test.dylib\n"
546                                              "...\n";
547 
548   auto Result =
549       TextAPIReader::get(MemoryBufferRef(TBDv3FileUnknownArch, "Test.tbd"));
550   EXPECT_TRUE(!!Result);
551 }
552 
553 TEST(TBDv3, UnknownPlatform) {
554   static const char TBDv3FileUnknownPlatform[] = "--- !tapi-tbd-v3\n"
555                                                  "archs: [ i386 ]\n"
556                                                  "platform: newOS\n"
557                                                  "...\n";
558 
559   auto Result =
560       TextAPIReader::get(MemoryBufferRef(TBDv3FileUnknownPlatform, "Test.tbd"));
561   EXPECT_FALSE(!!Result);
562   auto errorMessage = toString(Result.takeError());
563   EXPECT_EQ("malformed file\nTest.tbd:3:11: error: unknown platform\nplatform: "
564             "newOS\n          ^~~~~\n",
565             errorMessage);
566 }
567 
568 TEST(TBDv3, MalformedFile1) {
569   static const char TBDv3FileMalformed1[] = "--- !tapi-tbd-v3\n"
570                                             "archs: [ arm64 ]\n"
571                                             "foobar: \"Unsupported key\"\n"
572                                             "...\n";
573 
574   auto Result =
575       TextAPIReader::get(MemoryBufferRef(TBDv3FileMalformed1, "Test.tbd"));
576   EXPECT_FALSE(!!Result);
577   auto errorMessage = toString(Result.takeError());
578   ASSERT_EQ("malformed file\nTest.tbd:2:1: error: missing required key "
579             "'platform'\narchs: [ arm64 ]\n^\n",
580             errorMessage);
581 }
582 
583 TEST(TBDv3, MalformedFile2) {
584   static const char TBDv3FileMalformed2[] = "--- !tapi-tbd-v3\n"
585                                             "archs: [ arm64 ]\n"
586                                             "platform: ios\n"
587                                             "install-name: Test.dylib\n"
588                                             "foobar: \"Unsupported key\"\n"
589                                             "...\n";
590 
591   auto Result =
592       TextAPIReader::get(MemoryBufferRef(TBDv3FileMalformed2, "Test.tbd"));
593   EXPECT_FALSE(!!Result);
594   auto errorMessage = toString(Result.takeError());
595   ASSERT_EQ(
596       "malformed file\nTest.tbd:5:9: error: unknown key 'foobar'\nfoobar: "
597       "\"Unsupported key\"\n        ^~~~~~~~~~~~~~~~~\n",
598       errorMessage);
599 }
600 
601 } // namespace TBDv3
602