RefactoringTest.cpp 64 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721
  1. //===- unittest/Tooling/RefactoringTest.cpp - Refactoring unit tests ------===//
  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 "clang/Tooling/Refactoring.h"
  9. #include "ReplacementTest.h"
  10. #include "RewriterTestContext.h"
  11. #include "clang/AST/ASTConsumer.h"
  12. #include "clang/AST/ASTContext.h"
  13. #include "clang/AST/DeclCXX.h"
  14. #include "clang/AST/DeclGroup.h"
  15. #include "clang/AST/RecursiveASTVisitor.h"
  16. #include "clang/Basic/Diagnostic.h"
  17. #include "clang/Basic/DiagnosticOptions.h"
  18. #include "clang/Basic/FileManager.h"
  19. #include "clang/Basic/LangOptions.h"
  20. #include "clang/Basic/SourceManager.h"
  21. #include "clang/Format/Format.h"
  22. #include "clang/Frontend/CompilerInstance.h"
  23. #include "clang/Frontend/FrontendAction.h"
  24. #include "clang/Frontend/TextDiagnosticPrinter.h"
  25. #include "clang/Rewrite/Core/Rewriter.h"
  26. #include "clang/Tooling/Refactoring/AtomicChange.h"
  27. #include "clang/Tooling/Tooling.h"
  28. #include "llvm/ADT/SmallString.h"
  29. #include "llvm/Support/VirtualFileSystem.h"
  30. #include "gtest/gtest.h"
  31. namespace clang {
  32. namespace tooling {
  33. TEST_F(ReplacementTest, CanDeleteAllText) {
  34. FileID ID = Context.createInMemoryFile("input.cpp", "text");
  35. SourceLocation Location = Context.getLocation(ID, 1, 1);
  36. Replacement Replace(createReplacement(Location, 4, ""));
  37. EXPECT_TRUE(Replace.apply(Context.Rewrite));
  38. EXPECT_EQ("", Context.getRewrittenText(ID));
  39. }
  40. TEST_F(ReplacementTest, CanDeleteAllTextInTextWithNewlines) {
  41. FileID ID = Context.createInMemoryFile("input.cpp", "line1\nline2\nline3");
  42. SourceLocation Location = Context.getLocation(ID, 1, 1);
  43. Replacement Replace(createReplacement(Location, 17, ""));
  44. EXPECT_TRUE(Replace.apply(Context.Rewrite));
  45. EXPECT_EQ("", Context.getRewrittenText(ID));
  46. }
  47. TEST_F(ReplacementTest, CanAddText) {
  48. FileID ID = Context.createInMemoryFile("input.cpp", "");
  49. SourceLocation Location = Context.getLocation(ID, 1, 1);
  50. Replacement Replace(createReplacement(Location, 0, "result"));
  51. EXPECT_TRUE(Replace.apply(Context.Rewrite));
  52. EXPECT_EQ("result", Context.getRewrittenText(ID));
  53. }
  54. TEST_F(ReplacementTest, CanReplaceTextAtPosition) {
  55. FileID ID = Context.createInMemoryFile("input.cpp",
  56. "line1\nline2\nline3\nline4");
  57. SourceLocation Location = Context.getLocation(ID, 2, 3);
  58. Replacement Replace(createReplacement(Location, 12, "x"));
  59. EXPECT_TRUE(Replace.apply(Context.Rewrite));
  60. EXPECT_EQ("line1\nlixne4", Context.getRewrittenText(ID));
  61. }
  62. TEST_F(ReplacementTest, CanReplaceTextAtPositionMultipleTimes) {
  63. FileID ID = Context.createInMemoryFile("input.cpp",
  64. "line1\nline2\nline3\nline4");
  65. SourceLocation Location1 = Context.getLocation(ID, 2, 3);
  66. Replacement Replace1(createReplacement(Location1, 12, "x\ny\n"));
  67. EXPECT_TRUE(Replace1.apply(Context.Rewrite));
  68. EXPECT_EQ("line1\nlix\ny\nne4", Context.getRewrittenText(ID));
  69. // Since the original source has not been modified, the (4, 4) points to the
  70. // 'e' in the original content.
  71. SourceLocation Location2 = Context.getLocation(ID, 4, 4);
  72. Replacement Replace2(createReplacement(Location2, 1, "f"));
  73. EXPECT_TRUE(Replace2.apply(Context.Rewrite));
  74. EXPECT_EQ("line1\nlix\ny\nnf4", Context.getRewrittenText(ID));
  75. }
  76. TEST_F(ReplacementTest, ApplyFailsForNonExistentLocation) {
  77. Replacement Replace("nonexistent-file.cpp", 0, 1, "");
  78. EXPECT_FALSE(Replace.apply(Context.Rewrite));
  79. }
  80. TEST_F(ReplacementTest, CanRetrivePath) {
  81. Replacement Replace("/path/to/file.cpp", 0, 1, "");
  82. EXPECT_EQ("/path/to/file.cpp", Replace.getFilePath());
  83. }
  84. TEST_F(ReplacementTest, ReturnsInvalidPath) {
  85. Replacement Replace1(Context.Sources, SourceLocation(), 0, "");
  86. EXPECT_TRUE(Replace1.getFilePath().empty());
  87. Replacement Replace2;
  88. EXPECT_TRUE(Replace2.getFilePath().empty());
  89. }
  90. // Checks that an llvm::Error instance contains a ReplacementError with expected
  91. // error code, expected new replacement, and expected existing replacement.
  92. static bool checkReplacementError(llvm::Error &&Error,
  93. replacement_error ExpectedErr,
  94. llvm::Optional<Replacement> ExpectedExisting,
  95. llvm::Optional<Replacement> ExpectedNew) {
  96. if (!Error) {
  97. llvm::errs() << "Error is a success.";
  98. return false;
  99. }
  100. std::string ErrorMessage;
  101. llvm::raw_string_ostream OS(ErrorMessage);
  102. llvm::handleAllErrors(std::move(Error), [&](const ReplacementError &RE) {
  103. llvm::errs() << "Handling error...\n";
  104. if (ExpectedErr != RE.get())
  105. OS << "Unexpected error code: " << int(RE.get()) << "\n";
  106. if (ExpectedExisting != RE.getExistingReplacement()) {
  107. OS << "Expected Existing != Actual Existing.\n";
  108. if (ExpectedExisting.hasValue())
  109. OS << "Expected existing replacement: " << ExpectedExisting->toString()
  110. << "\n";
  111. if (RE.getExistingReplacement().hasValue())
  112. OS << "Actual existing replacement: "
  113. << RE.getExistingReplacement()->toString() << "\n";
  114. }
  115. if (ExpectedNew != RE.getNewReplacement()) {
  116. OS << "Expected New != Actual New.\n";
  117. if (ExpectedNew.hasValue())
  118. OS << "Expected new replacement: " << ExpectedNew->toString() << "\n";
  119. if (RE.getNewReplacement().hasValue())
  120. OS << "Actual new replacement: " << RE.getNewReplacement()->toString()
  121. << "\n";
  122. }
  123. });
  124. OS.flush();
  125. if (ErrorMessage.empty()) return true;
  126. llvm::errs() << ErrorMessage;
  127. return false;
  128. }
  129. TEST_F(ReplacementTest, FailAddReplacements) {
  130. Replacements Replaces;
  131. Replacement Deletion("x.cc", 0, 10, "3");
  132. auto Err = Replaces.add(Deletion);
  133. EXPECT_TRUE(!Err);
  134. llvm::consumeError(std::move(Err));
  135. Replacement OverlappingReplacement("x.cc", 0, 2, "a");
  136. Err = Replaces.add(OverlappingReplacement);
  137. EXPECT_TRUE(checkReplacementError(std::move(Err),
  138. replacement_error::overlap_conflict,
  139. Deletion, OverlappingReplacement));
  140. Replacement ContainedReplacement("x.cc", 2, 2, "a");
  141. Err = Replaces.add(Replacement(ContainedReplacement));
  142. EXPECT_TRUE(checkReplacementError(std::move(Err),
  143. replacement_error::overlap_conflict,
  144. Deletion, ContainedReplacement));
  145. Replacement WrongPathReplacement("y.cc", 20, 2, "");
  146. Err = Replaces.add(WrongPathReplacement);
  147. EXPECT_TRUE(checkReplacementError(std::move(Err),
  148. replacement_error::wrong_file_path,
  149. Deletion, WrongPathReplacement));
  150. EXPECT_EQ(1u, Replaces.size());
  151. EXPECT_EQ(Deletion, *Replaces.begin());
  152. }
  153. TEST_F(ReplacementTest, DeletionInReplacements) {
  154. Replacements Replaces;
  155. Replacement R("x.cc", 0, 10, "3");
  156. auto Err = Replaces.add(R);
  157. EXPECT_TRUE(!Err);
  158. llvm::consumeError(std::move(Err));
  159. Err = Replaces.add(Replacement("x.cc", 0, 2, ""));
  160. EXPECT_TRUE(!Err);
  161. llvm::consumeError(std::move(Err));
  162. Err = Replaces.add(Replacement("x.cc", 2, 2, ""));
  163. EXPECT_TRUE(!Err);
  164. llvm::consumeError(std::move(Err));
  165. EXPECT_EQ(1u, Replaces.size());
  166. EXPECT_EQ(R, *Replaces.begin());
  167. }
  168. TEST_F(ReplacementTest, OverlappingReplacements) {
  169. Replacements Replaces;
  170. auto Err = Replaces.add(Replacement("x.cc", 0, 3, "345"));
  171. EXPECT_TRUE(!Err);
  172. llvm::consumeError(std::move(Err));
  173. Err = Replaces.add(Replacement("x.cc", 2, 3, "543"));
  174. EXPECT_TRUE(!Err);
  175. llvm::consumeError(std::move(Err));
  176. EXPECT_EQ(1u, Replaces.size());
  177. EXPECT_EQ(Replacement("x.cc", 0, 5, "34543"), *Replaces.begin());
  178. Err = Replaces.add(Replacement("x.cc", 2, 1, "5"));
  179. EXPECT_TRUE(!Err);
  180. llvm::consumeError(std::move(Err));
  181. EXPECT_EQ(1u, Replaces.size());
  182. EXPECT_EQ(Replacement("x.cc", 0, 5, "34543"), *Replaces.begin());
  183. }
  184. TEST_F(ReplacementTest, AddAdjacentInsertionAndReplacement) {
  185. Replacements Replaces;
  186. // Test adding an insertion at the offset of an existing replacement.
  187. auto Err = Replaces.add(Replacement("x.cc", 10, 3, "replace"));
  188. EXPECT_TRUE(!Err);
  189. llvm::consumeError(std::move(Err));
  190. Err = Replaces.add(Replacement("x.cc", 10, 0, "insert"));
  191. EXPECT_TRUE(!Err);
  192. llvm::consumeError(std::move(Err));
  193. EXPECT_EQ(Replaces.size(), 2u);
  194. Replaces.clear();
  195. // Test overlap with an existing insertion.
  196. Err = Replaces.add(Replacement("x.cc", 10, 0, "insert"));
  197. EXPECT_TRUE(!Err);
  198. llvm::consumeError(std::move(Err));
  199. Err = Replaces.add(Replacement("x.cc", 10, 3, "replace"));
  200. EXPECT_TRUE(!Err);
  201. llvm::consumeError(std::move(Err));
  202. EXPECT_EQ(Replaces.size(), 2u);
  203. }
  204. TEST_F(ReplacementTest, MergeNewDeletions) {
  205. Replacements Replaces;
  206. Replacement ContainingReplacement("x.cc", 0, 10, "");
  207. auto Err = Replaces.add(ContainingReplacement);
  208. EXPECT_TRUE(!Err);
  209. llvm::consumeError(std::move(Err));
  210. Err = Replaces.add(Replacement("x.cc", 5, 3, ""));
  211. EXPECT_TRUE(!Err);
  212. llvm::consumeError(std::move(Err));
  213. Err = Replaces.add(Replacement("x.cc", 0, 10, ""));
  214. EXPECT_TRUE(!Err);
  215. llvm::consumeError(std::move(Err));
  216. Err = Replaces.add(Replacement("x.cc", 5, 5, ""));
  217. EXPECT_TRUE(!Err);
  218. llvm::consumeError(std::move(Err));
  219. EXPECT_EQ(1u, Replaces.size());
  220. EXPECT_EQ(*Replaces.begin(), ContainingReplacement);
  221. }
  222. TEST_F(ReplacementTest, MergeOverlappingButNotAdjacentReplacement) {
  223. Replacements Replaces;
  224. auto Err = Replaces.add(Replacement("x.cc", 0, 2, ""));
  225. EXPECT_TRUE(!Err);
  226. llvm::consumeError(std::move(Err));
  227. Err = Replaces.add(Replacement("x.cc", 5, 5, ""));
  228. EXPECT_TRUE(!Err);
  229. llvm::consumeError(std::move(Err));
  230. Replacement After = Replacement("x.cc", 10, 5, "");
  231. Err = Replaces.add(After);
  232. EXPECT_TRUE(!Err);
  233. llvm::consumeError(std::move(Err));
  234. Replacement ContainingReplacement("x.cc", 0, 10, "");
  235. Err = Replaces.add(ContainingReplacement);
  236. EXPECT_TRUE(!Err);
  237. llvm::consumeError(std::move(Err));
  238. EXPECT_EQ(2u, Replaces.size());
  239. EXPECT_EQ(*Replaces.begin(), ContainingReplacement);
  240. EXPECT_EQ(*(++Replaces.begin()), After);
  241. }
  242. TEST_F(ReplacementTest, InsertionBeforeMergedDeletions) {
  243. Replacements Replaces;
  244. Replacement Insertion("x.cc", 0, 0, "123");
  245. auto Err = Replaces.add(Insertion);
  246. EXPECT_TRUE(!Err);
  247. llvm::consumeError(std::move(Err));
  248. Err = Replaces.add(Replacement("x.cc", 5, 5, ""));
  249. EXPECT_TRUE(!Err);
  250. llvm::consumeError(std::move(Err));
  251. Replacement Deletion("x.cc", 0, 10, "");
  252. Err = Replaces.add(Deletion);
  253. EXPECT_TRUE(!Err);
  254. llvm::consumeError(std::move(Err));
  255. EXPECT_EQ(2u, Replaces.size());
  256. EXPECT_EQ(*Replaces.begin(), Insertion);
  257. EXPECT_EQ(*(++Replaces.begin()), Deletion);
  258. }
  259. TEST_F(ReplacementTest, MergeOverlappingDeletions) {
  260. Replacements Replaces;
  261. auto Err = Replaces.add(Replacement("x.cc", 0, 2, ""));
  262. EXPECT_TRUE(!Err);
  263. llvm::consumeError(std::move(Err));
  264. Err = Replaces.add(Replacement("x.cc", 0, 5, ""));
  265. EXPECT_TRUE(!Err);
  266. llvm::consumeError(std::move(Err));
  267. EXPECT_EQ(1u, Replaces.size());
  268. EXPECT_EQ(Replacement("x.cc", 0, 5, ""), *Replaces.begin());
  269. Err = Replaces.add(Replacement("x.cc", 1, 5, ""));
  270. EXPECT_TRUE(!Err);
  271. llvm::consumeError(std::move(Err));
  272. EXPECT_EQ(1u, Replaces.size());
  273. EXPECT_EQ(Replacement("x.cc", 0, 6, ""), *Replaces.begin());
  274. }
  275. TEST_F(ReplacementTest, FailedMergeExistingDeletions) {
  276. Replacements Replaces;
  277. Replacement First("x.cc", 0, 2, "");
  278. auto Err = Replaces.add(First);
  279. EXPECT_TRUE(!Err);
  280. llvm::consumeError(std::move(Err));
  281. Replacement Second("x.cc", 5, 5, "");
  282. Err = Replaces.add(Second);
  283. EXPECT_TRUE(!Err);
  284. llvm::consumeError(std::move(Err));
  285. Err = Replaces.add(Replacement("x.cc", 1, 10, ""));
  286. EXPECT_TRUE(!Err);
  287. llvm::consumeError(std::move(Err));
  288. EXPECT_EQ(1u, Replaces.size());
  289. EXPECT_EQ(Replacement("x.cc", 0, 11, ""), *Replaces.begin());
  290. }
  291. TEST_F(ReplacementTest, FailAddRegression) {
  292. Replacements Replaces;
  293. // Create two replacements, where the second one is an insertion of the empty
  294. // string exactly at the end of the first one.
  295. auto Err = Replaces.add(Replacement("x.cc", 0, 10, "1"));
  296. EXPECT_TRUE(!Err);
  297. llvm::consumeError(std::move(Err));
  298. Err = Replaces.add(Replacement("x.cc", 10, 0, ""));
  299. EXPECT_TRUE(!Err);
  300. llvm::consumeError(std::move(Err));
  301. // Make sure we find the overlap with the first entry when inserting a
  302. // replacement that ends exactly at the seam of the existing replacements.
  303. Replacement OverlappingReplacement("x.cc", 5, 5, "fail");
  304. Err = Replaces.add(OverlappingReplacement);
  305. EXPECT_TRUE(checkReplacementError(std::move(Err),
  306. replacement_error::overlap_conflict,
  307. *Replaces.begin(), OverlappingReplacement));
  308. Err = Replaces.add(Replacement("x.cc", 10, 0, ""));
  309. EXPECT_TRUE(!Err);
  310. llvm::consumeError(std::move(Err));
  311. }
  312. TEST_F(ReplacementTest, InsertAtOffsetOfReplacement) {
  313. Replacements Replaces;
  314. auto Err = Replaces.add(Replacement("x.cc", 10, 2, ""));
  315. EXPECT_TRUE(!Err);
  316. llvm::consumeError(std::move(Err));
  317. Err = Replaces.add(Replacement("x.cc", 10, 0, ""));
  318. EXPECT_TRUE(!Err);
  319. llvm::consumeError(std::move(Err));
  320. EXPECT_EQ(Replaces.size(), 2u);
  321. Replaces.clear();
  322. Err = Replaces.add(Replacement("x.cc", 10, 0, ""));
  323. EXPECT_TRUE(!Err);
  324. llvm::consumeError(std::move(Err));
  325. Err = Replaces.add(Replacement("x.cc", 10, 2, ""));
  326. EXPECT_TRUE(!Err);
  327. llvm::consumeError(std::move(Err));
  328. EXPECT_EQ(Replaces.size(), 2u);
  329. }
  330. TEST_F(ReplacementTest, AddInsertAtOtherInsertWhenOderIndependent) {
  331. Replacements Replaces;
  332. auto Err = Replaces.add(Replacement("x.cc", 10, 0, "a"));
  333. EXPECT_TRUE(!Err);
  334. llvm::consumeError(std::move(Err));
  335. Replacement ConflictInsertion("x.cc", 10, 0, "b");
  336. Err = Replaces.add(ConflictInsertion);
  337. EXPECT_TRUE(checkReplacementError(std::move(Err),
  338. replacement_error::insert_conflict,
  339. *Replaces.begin(), ConflictInsertion));
  340. Replaces.clear();
  341. Err = Replaces.add(Replacement("x.cc", 10, 0, "a"));
  342. EXPECT_TRUE(!Err);
  343. llvm::consumeError(std::move(Err));
  344. Err = Replaces.add(Replacement("x.cc", 10, 0, "aa"));
  345. EXPECT_TRUE(!Err);
  346. llvm::consumeError(std::move(Err));
  347. EXPECT_EQ(1u, Replaces.size());
  348. EXPECT_EQ(Replacement("x.cc", 10, 0, "aaa"), *Replaces.begin());
  349. Replaces.clear();
  350. Err = Replaces.add(Replacement("x.cc", 10, 0, ""));
  351. EXPECT_TRUE(!Err);
  352. llvm::consumeError(std::move(Err));
  353. Err = Replaces.add(Replacement("x.cc", 10, 3, ""));
  354. EXPECT_TRUE(!Err);
  355. llvm::consumeError(std::move(Err));
  356. Err = Replaces.add(Replacement("x.cc", 10, 0, ""));
  357. EXPECT_TRUE(!Err);
  358. llvm::consumeError(std::move(Err));
  359. EXPECT_EQ(2u, Replaces.size());
  360. EXPECT_EQ(Replacement("x.cc", 10, 0, ""), *Replaces.begin());
  361. EXPECT_EQ(Replacement("x.cc", 10, 3, ""), *std::next(Replaces.begin()));
  362. }
  363. TEST_F(ReplacementTest, InsertBetweenAdjacentReplacements) {
  364. Replacements Replaces;
  365. auto Err = Replaces.add(Replacement("x.cc", 10, 5, "a"));
  366. EXPECT_TRUE(!Err);
  367. llvm::consumeError(std::move(Err));
  368. Err = Replaces.add(Replacement("x.cc", 8, 2, "a"));
  369. EXPECT_TRUE(!Err);
  370. llvm::consumeError(std::move(Err));
  371. Err = Replaces.add(Replacement("x.cc", 10, 0, "b"));
  372. EXPECT_TRUE(!Err);
  373. llvm::consumeError(std::move(Err));
  374. }
  375. TEST_F(ReplacementTest, CanApplyReplacements) {
  376. FileID ID = Context.createInMemoryFile("input.cpp",
  377. "line1\nline2\nline3\nline4");
  378. Replacements Replaces =
  379. toReplacements({Replacement(Context.Sources,
  380. Context.getLocation(ID, 2, 1), 5, "replaced"),
  381. Replacement(Context.Sources,
  382. Context.getLocation(ID, 3, 1), 5, "other")});
  383. EXPECT_TRUE(applyAllReplacements(Replaces, Context.Rewrite));
  384. EXPECT_EQ("line1\nreplaced\nother\nline4", Context.getRewrittenText(ID));
  385. }
  386. // Verifies that replacement/deletion is applied before insertion at the same
  387. // offset.
  388. TEST_F(ReplacementTest, InsertAndDelete) {
  389. FileID ID = Context.createInMemoryFile("input.cpp",
  390. "line1\nline2\nline3\nline4");
  391. Replacements Replaces = toReplacements(
  392. {Replacement(Context.Sources, Context.getLocation(ID, 2, 1), 6, ""),
  393. Replacement(Context.Sources, Context.getLocation(ID, 2, 1), 0,
  394. "other\n")});
  395. EXPECT_TRUE(applyAllReplacements(Replaces, Context.Rewrite));
  396. EXPECT_EQ("line1\nother\nline3\nline4", Context.getRewrittenText(ID));
  397. }
  398. TEST_F(ReplacementTest, AdjacentReplacements) {
  399. FileID ID = Context.createInMemoryFile("input.cpp",
  400. "ab");
  401. Replacements Replaces = toReplacements(
  402. {Replacement(Context.Sources, Context.getLocation(ID, 1, 1), 1, "x"),
  403. Replacement(Context.Sources, Context.getLocation(ID, 1, 2), 1, "y")});
  404. EXPECT_TRUE(applyAllReplacements(Replaces, Context.Rewrite));
  405. EXPECT_EQ("xy", Context.getRewrittenText(ID));
  406. }
  407. TEST_F(ReplacementTest, AddDuplicateReplacements) {
  408. FileID ID = Context.createInMemoryFile("input.cpp",
  409. "line1\nline2\nline3\nline4");
  410. auto Replaces = toReplacements({Replacement(
  411. Context.Sources, Context.getLocation(ID, 2, 1), 5, "replaced")});
  412. auto Err = Replaces.add(Replacement(
  413. Context.Sources, Context.getLocation(ID, 2, 1), 5, "replaced"));
  414. EXPECT_TRUE(!Err);
  415. llvm::consumeError(std::move(Err));
  416. Err = Replaces.add(Replacement(Context.Sources, Context.getLocation(ID, 2, 1),
  417. 5, "replaced"));
  418. EXPECT_TRUE(!Err);
  419. llvm::consumeError(std::move(Err));
  420. EXPECT_TRUE(applyAllReplacements(Replaces, Context.Rewrite));
  421. EXPECT_EQ("line1\nreplaced\nline3\nline4", Context.getRewrittenText(ID));
  422. }
  423. TEST_F(ReplacementTest, FailOrderDependentReplacements) {
  424. FileID ID = Context.createInMemoryFile("input.cpp",
  425. "line1\nline2\nline3\nline4");
  426. auto Replaces = toReplacements({Replacement(
  427. Context.Sources, Context.getLocation(ID, 2, 1), 5, "other")});
  428. Replacement ConflictReplacement(Context.Sources,
  429. Context.getLocation(ID, 2, 1), 5, "rehto");
  430. auto Err = Replaces.add(ConflictReplacement);
  431. EXPECT_TRUE(checkReplacementError(std::move(Err),
  432. replacement_error::overlap_conflict,
  433. *Replaces.begin(), ConflictReplacement));
  434. EXPECT_TRUE(applyAllReplacements(Replaces, Context.Rewrite));
  435. EXPECT_EQ("line1\nother\nline3\nline4", Context.getRewrittenText(ID));
  436. }
  437. TEST_F(ReplacementTest, InvalidSourceLocationFailsApplyAll) {
  438. Replacements Replaces =
  439. toReplacements({Replacement(Context.Sources, SourceLocation(), 5, "2")});
  440. EXPECT_FALSE(applyAllReplacements(Replaces, Context.Rewrite));
  441. }
  442. TEST_F(ReplacementTest, MultipleFilesReplaceAndFormat) {
  443. // Column limit is 20.
  444. std::string Code1 = "Long *a =\n"
  445. " new Long();\n"
  446. "long x = 1;";
  447. std::string Expected1 = "auto a = new Long();\n"
  448. "long x =\n"
  449. " 12345678901;";
  450. std::string Code2 = "int x = 123;\n"
  451. "int y = 0;";
  452. std::string Expected2 = "int x =\n"
  453. " 1234567890123;\n"
  454. "int y = 10;";
  455. StringRef File1 = "format_1.cpp";
  456. StringRef File2 = "format_2.cpp";
  457. FileID ID1 = Context.createInMemoryFile(File1, Code1);
  458. FileID ID2 = Context.createInMemoryFile(File2, Code2);
  459. // Scrambled the order of replacements.
  460. std::map<std::string, Replacements> FileToReplaces;
  461. FileToReplaces[File1] = toReplacements(
  462. {tooling::Replacement(Context.Sources, Context.getLocation(ID1, 1, 1), 6,
  463. "auto "),
  464. tooling::Replacement(Context.Sources, Context.getLocation(ID1, 3, 10), 1,
  465. "12345678901")});
  466. FileToReplaces[File2] = toReplacements(
  467. {tooling::Replacement(Context.Sources, Context.getLocation(ID2, 1, 12), 0,
  468. "4567890123"),
  469. tooling::Replacement(Context.Sources, Context.getLocation(ID2, 2, 9), 1,
  470. "10")});
  471. EXPECT_TRUE(
  472. formatAndApplyAllReplacements(FileToReplaces, Context.Rewrite,
  473. "{BasedOnStyle: LLVM, ColumnLimit: 20}"));
  474. EXPECT_EQ(Expected1, Context.getRewrittenText(ID1));
  475. EXPECT_EQ(Expected2, Context.getRewrittenText(ID2));
  476. }
  477. TEST(ShiftedCodePositionTest, FindsNewCodePosition) {
  478. Replacements Replaces =
  479. toReplacements({Replacement("", 0, 1, ""), Replacement("", 4, 3, " ")});
  480. // Assume ' int i;' is turned into 'int i;' and cursor is located at '|'.
  481. EXPECT_EQ(0u, Replaces.getShiftedCodePosition(0)); // |int i;
  482. EXPECT_EQ(0u, Replaces.getShiftedCodePosition(1)); // |nt i;
  483. EXPECT_EQ(1u, Replaces.getShiftedCodePosition(2)); // i|t i;
  484. EXPECT_EQ(2u, Replaces.getShiftedCodePosition(3)); // in| i;
  485. EXPECT_EQ(3u, Replaces.getShiftedCodePosition(4)); // int| i;
  486. EXPECT_EQ(3u, Replaces.getShiftedCodePosition(5)); // int | i;
  487. EXPECT_EQ(3u, Replaces.getShiftedCodePosition(6)); // int |i;
  488. EXPECT_EQ(4u, Replaces.getShiftedCodePosition(7)); // int |;
  489. EXPECT_EQ(5u, Replaces.getShiftedCodePosition(8)); // int i|
  490. }
  491. TEST(ShiftedCodePositionTest, FindsNewCodePositionWithInserts) {
  492. Replacements Replaces = toReplacements({Replacement("", 4, 0, "\"\n\"")});
  493. // Assume '"12345678"' is turned into '"1234"\n"5678"'.
  494. EXPECT_EQ(3u, Replaces.getShiftedCodePosition(3)); // "123|5678"
  495. EXPECT_EQ(7u, Replaces.getShiftedCodePosition(4)); // "1234|678"
  496. EXPECT_EQ(8u, Replaces.getShiftedCodePosition(5)); // "12345|78"
  497. }
  498. TEST(ShiftedCodePositionTest, FindsNewCodePositionInReplacedText) {
  499. // Replace the first four characters with "abcd".
  500. auto Replaces = toReplacements({Replacement("", 0, 4, "abcd")});
  501. for (unsigned i = 0; i < 3; ++i)
  502. EXPECT_EQ(i, Replaces.getShiftedCodePosition(i));
  503. }
  504. TEST(ShiftedCodePositionTest, NoReplacementText) {
  505. Replacements Replaces = toReplacements({Replacement("", 0, 42, "")});
  506. EXPECT_EQ(0u, Replaces.getShiftedCodePosition(0));
  507. EXPECT_EQ(0u, Replaces.getShiftedCodePosition(39));
  508. EXPECT_EQ(3u, Replaces.getShiftedCodePosition(45));
  509. EXPECT_EQ(0u, Replaces.getShiftedCodePosition(42));
  510. }
  511. class FlushRewrittenFilesTest : public ::testing::Test {
  512. public:
  513. FlushRewrittenFilesTest() {}
  514. ~FlushRewrittenFilesTest() override {
  515. for (llvm::StringMap<std::string>::iterator I = TemporaryFiles.begin(),
  516. E = TemporaryFiles.end();
  517. I != E; ++I) {
  518. llvm::StringRef Name = I->second;
  519. std::error_code EC = llvm::sys::fs::remove(Name);
  520. (void)EC;
  521. assert(!EC);
  522. }
  523. }
  524. FileID createFile(llvm::StringRef Name, llvm::StringRef Content) {
  525. SmallString<1024> Path;
  526. int FD;
  527. std::error_code EC = llvm::sys::fs::createTemporaryFile(Name, "", FD, Path);
  528. assert(!EC);
  529. (void)EC;
  530. llvm::raw_fd_ostream OutStream(FD, true);
  531. OutStream << Content;
  532. OutStream.close();
  533. auto File = Context.Files.getFile(Path);
  534. assert(File);
  535. StringRef Found =
  536. TemporaryFiles.insert(std::make_pair(Name, Path.str())).first->second;
  537. assert(Found == Path);
  538. (void)Found;
  539. return Context.Sources.createFileID(*File, SourceLocation(),
  540. SrcMgr::C_User);
  541. }
  542. std::string getFileContentFromDisk(llvm::StringRef Name) {
  543. std::string Path = TemporaryFiles.lookup(Name);
  544. assert(!Path.empty());
  545. // We need to read directly from the FileManager without relaying through
  546. // a FileEntry, as otherwise we'd read through an already opened file
  547. // descriptor, which might not see the changes made.
  548. // FIXME: Figure out whether there is a way to get the SourceManger to
  549. // reopen the file.
  550. auto FileBuffer = Context.Files.getBufferForFile(Path);
  551. return (*FileBuffer)->getBuffer();
  552. }
  553. llvm::StringMap<std::string> TemporaryFiles;
  554. RewriterTestContext Context;
  555. };
  556. TEST_F(FlushRewrittenFilesTest, StoresChangesOnDisk) {
  557. FileID ID = createFile("input.cpp", "line1\nline2\nline3\nline4");
  558. Replacements Replaces = toReplacements({Replacement(
  559. Context.Sources, Context.getLocation(ID, 2, 1), 5, "replaced")});
  560. EXPECT_TRUE(applyAllReplacements(Replaces, Context.Rewrite));
  561. EXPECT_FALSE(Context.Rewrite.overwriteChangedFiles());
  562. EXPECT_EQ("line1\nreplaced\nline3\nline4",
  563. getFileContentFromDisk("input.cpp"));
  564. }
  565. namespace {
  566. template <typename T>
  567. class TestVisitor : public clang::RecursiveASTVisitor<T> {
  568. public:
  569. bool runOver(StringRef Code) {
  570. return runToolOnCode(std::make_unique<TestAction>(this), Code);
  571. }
  572. protected:
  573. clang::SourceManager *SM;
  574. clang::ASTContext *Context;
  575. private:
  576. class FindConsumer : public clang::ASTConsumer {
  577. public:
  578. FindConsumer(TestVisitor *Visitor) : Visitor(Visitor) {}
  579. void HandleTranslationUnit(clang::ASTContext &Context) override {
  580. Visitor->TraverseDecl(Context.getTranslationUnitDecl());
  581. }
  582. private:
  583. TestVisitor *Visitor;
  584. };
  585. class TestAction : public clang::ASTFrontendAction {
  586. public:
  587. TestAction(TestVisitor *Visitor) : Visitor(Visitor) {}
  588. std::unique_ptr<clang::ASTConsumer>
  589. CreateASTConsumer(clang::CompilerInstance &compiler,
  590. llvm::StringRef dummy) override {
  591. Visitor->SM = &compiler.getSourceManager();
  592. Visitor->Context = &compiler.getASTContext();
  593. /// TestConsumer will be deleted by the framework calling us.
  594. return std::make_unique<FindConsumer>(Visitor);
  595. }
  596. private:
  597. TestVisitor *Visitor;
  598. };
  599. };
  600. } // end namespace
  601. void expectReplacementAt(const Replacement &Replace,
  602. StringRef File, unsigned Offset, unsigned Length) {
  603. ASSERT_TRUE(Replace.isApplicable());
  604. EXPECT_EQ(File, Replace.getFilePath());
  605. EXPECT_EQ(Offset, Replace.getOffset());
  606. EXPECT_EQ(Length, Replace.getLength());
  607. }
  608. class ClassDeclXVisitor : public TestVisitor<ClassDeclXVisitor> {
  609. public:
  610. bool VisitCXXRecordDecl(CXXRecordDecl *Record) {
  611. if (Record->getName() == "X") {
  612. Replace = Replacement(*SM, Record, "");
  613. }
  614. return true;
  615. }
  616. Replacement Replace;
  617. };
  618. TEST(Replacement, CanBeConstructedFromNode) {
  619. ClassDeclXVisitor ClassDeclX;
  620. EXPECT_TRUE(ClassDeclX.runOver(" class X;"));
  621. expectReplacementAt(ClassDeclX.Replace, "input.cc", 5, 7);
  622. }
  623. TEST(Replacement, ReplacesAtSpellingLocation) {
  624. ClassDeclXVisitor ClassDeclX;
  625. EXPECT_TRUE(ClassDeclX.runOver("#define A(Y) Y\nA(class X);"));
  626. expectReplacementAt(ClassDeclX.Replace, "input.cc", 17, 7);
  627. }
  628. class CallToFVisitor : public TestVisitor<CallToFVisitor> {
  629. public:
  630. bool VisitCallExpr(CallExpr *Call) {
  631. if (Call->getDirectCallee()->getName() == "F") {
  632. Replace = Replacement(*SM, Call, "");
  633. }
  634. return true;
  635. }
  636. Replacement Replace;
  637. };
  638. TEST(Replacement, FunctionCall) {
  639. CallToFVisitor CallToF;
  640. EXPECT_TRUE(CallToF.runOver("void F(); void G() { F(); }"));
  641. expectReplacementAt(CallToF.Replace, "input.cc", 21, 3);
  642. }
  643. TEST(Replacement, TemplatedFunctionCall) {
  644. CallToFVisitor CallToF;
  645. EXPECT_TRUE(CallToF.runOver(
  646. "template <typename T> void F(); void G() { F<int>(); }"));
  647. expectReplacementAt(CallToF.Replace, "input.cc", 43, 8);
  648. }
  649. class NestedNameSpecifierAVisitor
  650. : public TestVisitor<NestedNameSpecifierAVisitor> {
  651. public:
  652. bool TraverseNestedNameSpecifierLoc(NestedNameSpecifierLoc NNSLoc) {
  653. if (NNSLoc.getNestedNameSpecifier()) {
  654. if (const NamespaceDecl* NS = NNSLoc.getNestedNameSpecifier()->getAsNamespace()) {
  655. if (NS->getName() == "a") {
  656. Replace = Replacement(*SM, &NNSLoc, "", Context->getLangOpts());
  657. }
  658. }
  659. }
  660. return TestVisitor<NestedNameSpecifierAVisitor>::TraverseNestedNameSpecifierLoc(
  661. NNSLoc);
  662. }
  663. Replacement Replace;
  664. };
  665. TEST(Replacement, ColonColon) {
  666. NestedNameSpecifierAVisitor VisitNNSA;
  667. EXPECT_TRUE(VisitNNSA.runOver("namespace a { void f() { ::a::f(); } }"));
  668. expectReplacementAt(VisitNNSA.Replace, "input.cc", 25, 5);
  669. }
  670. TEST(Range, overlaps) {
  671. EXPECT_TRUE(Range(10, 10).overlapsWith(Range(0, 11)));
  672. EXPECT_TRUE(Range(0, 11).overlapsWith(Range(10, 10)));
  673. EXPECT_FALSE(Range(10, 10).overlapsWith(Range(0, 10)));
  674. EXPECT_FALSE(Range(0, 10).overlapsWith(Range(10, 10)));
  675. EXPECT_TRUE(Range(0, 10).overlapsWith(Range(2, 6)));
  676. EXPECT_TRUE(Range(2, 6).overlapsWith(Range(0, 10)));
  677. }
  678. TEST(Range, contains) {
  679. EXPECT_TRUE(Range(0, 10).contains(Range(0, 10)));
  680. EXPECT_TRUE(Range(0, 10).contains(Range(2, 6)));
  681. EXPECT_FALSE(Range(2, 6).contains(Range(0, 10)));
  682. EXPECT_FALSE(Range(0, 10).contains(Range(0, 11)));
  683. }
  684. TEST(Range, CalculateRangesOfReplacements) {
  685. // Before: aaaabbbbbbz
  686. // After : bbbbbbzzzzzzoooooooooooooooo
  687. Replacements Replaces = toReplacements(
  688. {Replacement("foo", 0, 4, ""), Replacement("foo", 10, 1, "zzzzzz"),
  689. Replacement("foo", 11, 0, "oooooooooooooooo")});
  690. std::vector<Range> Ranges = Replaces.getAffectedRanges();
  691. EXPECT_EQ(2ul, Ranges.size());
  692. EXPECT_TRUE(Ranges[0].getOffset() == 0);
  693. EXPECT_TRUE(Ranges[0].getLength() == 0);
  694. EXPECT_TRUE(Ranges[1].getOffset() == 6);
  695. EXPECT_TRUE(Ranges[1].getLength() == 22);
  696. }
  697. TEST(Range, CalculateRangesOfInsertionAroundReplacement) {
  698. Replacements Replaces = toReplacements(
  699. {Replacement("foo", 0, 2, ""), Replacement("foo", 0, 0, "ba")});
  700. std::vector<Range> Ranges = Replaces.getAffectedRanges();
  701. EXPECT_EQ(1ul, Ranges.size());
  702. EXPECT_EQ(0u, Ranges[0].getOffset());
  703. EXPECT_EQ(2u, Ranges[0].getLength());
  704. }
  705. TEST(Range, RangesAfterEmptyReplacements) {
  706. std::vector<Range> Ranges = {Range(5, 6), Range(10, 5)};
  707. Replacements Replaces;
  708. std::vector<Range> Expected = {Range(5, 10)};
  709. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  710. }
  711. TEST(Range, RangesAfterReplacements) {
  712. std::vector<Range> Ranges = {Range(5, 2), Range(10, 5)};
  713. Replacements Replaces = toReplacements({Replacement("foo", 0, 2, "1234")});
  714. std::vector<Range> Expected = {Range(0, 4), Range(7, 2), Range(12, 5)};
  715. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  716. }
  717. TEST(Range, RangesBeforeReplacements) {
  718. std::vector<Range> Ranges = {Range(5, 2), Range(10, 5)};
  719. Replacements Replaces = toReplacements({Replacement("foo", 20, 2, "1234")});
  720. std::vector<Range> Expected = {Range(5, 2), Range(10, 5), Range(20, 4)};
  721. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  722. }
  723. TEST(Range, NotAffectedByReplacements) {
  724. std::vector<Range> Ranges = {Range(0, 2), Range(5, 2), Range(10, 5)};
  725. Replacements Replaces = toReplacements({Replacement("foo", 3, 2, "12"),
  726. Replacement("foo", 12, 2, "12"),
  727. Replacement("foo", 20, 5, "")});
  728. std::vector<Range> Expected = {Range(0, 2), Range(3, 4), Range(10, 5),
  729. Range(20, 0)};
  730. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  731. }
  732. TEST(Range, RangesWithNonOverlappingReplacements) {
  733. std::vector<Range> Ranges = {Range(0, 2), Range(5, 2), Range(10, 5)};
  734. Replacements Replaces = toReplacements({Replacement("foo", 3, 1, ""),
  735. Replacement("foo", 6, 1, "123"),
  736. Replacement("foo", 20, 2, "12345")});
  737. std::vector<Range> Expected = {Range(0, 2), Range(3, 0), Range(4, 4),
  738. Range(11, 5), Range(21, 5)};
  739. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  740. }
  741. TEST(Range, RangesWithOverlappingReplacements) {
  742. std::vector<Range> Ranges = {Range(0, 2), Range(5, 2), Range(15, 5),
  743. Range(30, 5)};
  744. Replacements Replaces = toReplacements(
  745. {Replacement("foo", 1, 3, ""), Replacement("foo", 6, 1, "123"),
  746. Replacement("foo", 13, 3, "1"), Replacement("foo", 25, 15, "")});
  747. std::vector<Range> Expected = {Range(0, 1), Range(2, 4), Range(12, 5),
  748. Range(22, 0)};
  749. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  750. }
  751. TEST(Range, MergeIntoOneRange) {
  752. std::vector<Range> Ranges = {Range(0, 2), Range(5, 2), Range(15, 5)};
  753. Replacements Replaces =
  754. toReplacements({Replacement("foo", 1, 15, "1234567890")});
  755. std::vector<Range> Expected = {Range(0, 15)};
  756. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  757. }
  758. TEST(Range, ReplacementsStartingAtRangeOffsets) {
  759. std::vector<Range> Ranges = {Range(0, 2), Range(5, 5), Range(15, 5)};
  760. Replacements Replaces = toReplacements(
  761. {Replacement("foo", 0, 2, "12"), Replacement("foo", 5, 1, "123"),
  762. Replacement("foo", 7, 4, "12345"), Replacement("foo", 15, 10, "12")});
  763. std::vector<Range> Expected = {Range(0, 2), Range(5, 9), Range(18, 2)};
  764. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  765. }
  766. TEST(Range, ReplacementsEndingAtRangeEnds) {
  767. std::vector<Range> Ranges = {Range(0, 2), Range(5, 2), Range(15, 5)};
  768. Replacements Replaces = toReplacements(
  769. {Replacement("foo", 6, 1, "123"), Replacement("foo", 17, 3, "12")});
  770. std::vector<Range> Expected = {Range(0, 2), Range(5, 4), Range(17, 4)};
  771. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  772. }
  773. TEST(Range, AjacentReplacements) {
  774. std::vector<Range> Ranges = {Range(0, 0), Range(15, 5)};
  775. Replacements Replaces = toReplacements(
  776. {Replacement("foo", 1, 2, "123"), Replacement("foo", 12, 3, "1234")});
  777. std::vector<Range> Expected = {Range(0, 0), Range(1, 3), Range(13, 9)};
  778. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  779. }
  780. TEST(Range, MergeRangesAfterReplacements) {
  781. std::vector<Range> Ranges = {Range(8, 0), Range(5, 2), Range(9, 0), Range(0, 1)};
  782. Replacements Replaces = toReplacements({Replacement("foo", 1, 3, ""),
  783. Replacement("foo", 7, 0, "12"),
  784. Replacement("foo", 9, 2, "")});
  785. std::vector<Range> Expected = {Range(0, 1), Range(2, 4), Range(7, 0),
  786. Range(8, 0)};
  787. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  788. }
  789. TEST(Range, ConflictingRangesBeforeReplacements) {
  790. std::vector<Range> Ranges = {Range(8, 3), Range(5, 4), Range(9, 1)};
  791. Replacements Replaces = toReplacements({Replacement("foo", 1, 3, "")});
  792. std::vector<Range> Expected = {Range(1, 0), Range(2, 6)};
  793. EXPECT_EQ(Expected, calculateRangesAfterReplacements(Replaces, Ranges));
  794. }
  795. class MergeReplacementsTest : public ::testing::Test {
  796. protected:
  797. void mergeAndTestRewrite(StringRef Code, StringRef Intermediate,
  798. StringRef Result, const Replacements &First,
  799. const Replacements &Second) {
  800. // These are mainly to verify the test itself and make it easier to read.
  801. auto AfterFirst = applyAllReplacements(Code, First);
  802. EXPECT_TRUE(static_cast<bool>(AfterFirst));
  803. auto InSequenceRewrite = applyAllReplacements(*AfterFirst, Second);
  804. EXPECT_TRUE(static_cast<bool>(InSequenceRewrite));
  805. EXPECT_EQ(Intermediate, *AfterFirst);
  806. EXPECT_EQ(Result, *InSequenceRewrite);
  807. tooling::Replacements Merged = First.merge(Second);
  808. auto MergedRewrite = applyAllReplacements(Code, Merged);
  809. EXPECT_TRUE(static_cast<bool>(MergedRewrite));
  810. EXPECT_EQ(*InSequenceRewrite, *MergedRewrite);
  811. if (*InSequenceRewrite != *MergedRewrite)
  812. for (tooling::Replacement M : Merged)
  813. llvm::errs() << M.getOffset() << " " << M.getLength() << " "
  814. << M.getReplacementText() << "\n";
  815. }
  816. void mergeAndTestRewrite(StringRef Code, const Replacements &First,
  817. const Replacements &Second) {
  818. auto AfterFirst = applyAllReplacements(Code, First);
  819. EXPECT_TRUE(static_cast<bool>(AfterFirst));
  820. auto InSequenceRewrite = applyAllReplacements(*AfterFirst, Second);
  821. tooling::Replacements Merged = First.merge(Second);
  822. auto MergedRewrite = applyAllReplacements(Code, Merged);
  823. EXPECT_TRUE(static_cast<bool>(MergedRewrite));
  824. EXPECT_EQ(*InSequenceRewrite, *MergedRewrite);
  825. if (*InSequenceRewrite != *MergedRewrite)
  826. for (tooling::Replacement M : Merged)
  827. llvm::errs() << M.getOffset() << " " << M.getLength() << " "
  828. << M.getReplacementText() << "\n";
  829. }
  830. };
  831. TEST_F(MergeReplacementsTest, Offsets) {
  832. mergeAndTestRewrite("aaa", "aabab", "cacabab",
  833. toReplacements({{"", 2, 0, "b"}, {"", 3, 0, "b"}}),
  834. toReplacements({{"", 0, 0, "c"}, {"", 1, 0, "c"}}));
  835. mergeAndTestRewrite("aaa", "babaa", "babacac",
  836. toReplacements({{"", 0, 0, "b"}, {"", 1, 0, "b"}}),
  837. toReplacements({{"", 4, 0, "c"}, {"", 5, 0, "c"}}));
  838. mergeAndTestRewrite("aaaa", "aaa", "aac", toReplacements({{"", 1, 1, ""}}),
  839. toReplacements({{"", 2, 1, "c"}}));
  840. mergeAndTestRewrite("aa", "bbabba", "bbabcba",
  841. toReplacements({{"", 0, 0, "bb"}, {"", 1, 0, "bb"}}),
  842. toReplacements({{"", 4, 0, "c"}}));
  843. }
  844. TEST_F(MergeReplacementsTest, Concatenations) {
  845. // Basic concatenations. It is important to merge these into a single
  846. // replacement to ensure the correct order.
  847. {
  848. auto First = toReplacements({{"", 0, 0, "a"}});
  849. auto Second = toReplacements({{"", 1, 0, "b"}});
  850. EXPECT_EQ(toReplacements({{"", 0, 0, "ab"}}), First.merge(Second));
  851. }
  852. {
  853. auto First = toReplacements({{"", 0, 0, "a"}});
  854. auto Second = toReplacements({{"", 0, 0, "b"}});
  855. EXPECT_EQ(toReplacements({{"", 0, 0, "ba"}}), First.merge(Second));
  856. }
  857. mergeAndTestRewrite("", "a", "ab", toReplacements({{"", 0, 0, "a"}}),
  858. toReplacements({{"", 1, 0, "b"}}));
  859. mergeAndTestRewrite("", "a", "ba", toReplacements({{"", 0, 0, "a"}}),
  860. toReplacements({{"", 0, 0, "b"}}));
  861. }
  862. TEST_F(MergeReplacementsTest, NotChangingLengths) {
  863. mergeAndTestRewrite("aaaa", "abba", "acca",
  864. toReplacements({{"", 1, 2, "bb"}}),
  865. toReplacements({{"", 1, 2, "cc"}}));
  866. mergeAndTestRewrite("aaaa", "abba", "abcc",
  867. toReplacements({{"", 1, 2, "bb"}}),
  868. toReplacements({{"", 2, 2, "cc"}}));
  869. mergeAndTestRewrite("aaaa", "abba", "ccba",
  870. toReplacements({{"", 1, 2, "bb"}}),
  871. toReplacements({{"", 0, 2, "cc"}}));
  872. mergeAndTestRewrite("aaaaaa", "abbdda", "abccda",
  873. toReplacements({{"", 1, 2, "bb"}, {"", 3, 2, "dd"}}),
  874. toReplacements({{"", 2, 2, "cc"}}));
  875. }
  876. TEST_F(MergeReplacementsTest, OverlappingRanges) {
  877. mergeAndTestRewrite("aaa", "bbd", "bcbcd",
  878. toReplacements({{"", 0, 1, "bb"}, {"", 1, 2, "d"}}),
  879. toReplacements({{"", 1, 0, "c"}, {"", 2, 0, "c"}}));
  880. mergeAndTestRewrite("aaaa", "aabbaa", "acccca",
  881. toReplacements({{"", 2, 0, "bb"}}),
  882. toReplacements({{"", 1, 4, "cccc"}}));
  883. mergeAndTestRewrite("aaaa", "aababa", "acccca",
  884. toReplacements({{"", 2, 0, "b"}, {"", 3, 0, "b"}}),
  885. toReplacements({{"", 1, 4, "cccc"}}));
  886. mergeAndTestRewrite("aaaaaa", "abbbba", "abba",
  887. toReplacements({{"", 1, 4, "bbbb"}}),
  888. toReplacements({{"", 2, 2, ""}}));
  889. mergeAndTestRewrite("aaaa", "aa", "cc",
  890. toReplacements({{"", 1, 1, ""}, {"", 2, 1, ""}}),
  891. toReplacements({{"", 0, 2, "cc"}}));
  892. mergeAndTestRewrite("aa", "abbba", "abcbcba",
  893. toReplacements({{"", 1, 0, "bbb"}}),
  894. toReplacements({{"", 2, 0, "c"}, {"", 3, 0, "c"}}));
  895. mergeAndTestRewrite(
  896. "aaa", "abbab", "ccdd",
  897. toReplacements({{"", 0, 1, ""}, {"", 2, 0, "bb"}, {"", 3, 0, "b"}}),
  898. toReplacements({{"", 0, 2, "cc"}, {"", 2, 3, "dd"}}));
  899. mergeAndTestRewrite(
  900. "aa", "babbab", "ccdd",
  901. toReplacements({{"", 0, 0, "b"}, {"", 1, 0, "bb"}, {"", 2, 0, "b"}}),
  902. toReplacements({{"", 0, 3, "cc"}, {"", 3, 3, "dd"}}));
  903. }
  904. TEST(DeduplicateByFileTest, PathsWithDots) {
  905. std::map<std::string, Replacements> FileToReplaces;
  906. llvm::IntrusiveRefCntPtr<llvm::vfs::InMemoryFileSystem> VFS(
  907. new llvm::vfs::InMemoryFileSystem());
  908. FileManager FileMgr(FileSystemOptions(), VFS);
  909. #if !defined(_WIN32)
  910. StringRef Path1 = "a/b/.././c.h";
  911. StringRef Path2 = "a/c.h";
  912. #else
  913. StringRef Path1 = "a\\b\\..\\.\\c.h";
  914. StringRef Path2 = "a\\c.h";
  915. #endif
  916. EXPECT_TRUE(VFS->addFile(Path1, 0, llvm::MemoryBuffer::getMemBuffer("")));
  917. EXPECT_TRUE(VFS->addFile(Path2, 0, llvm::MemoryBuffer::getMemBuffer("")));
  918. FileToReplaces[Path1] = Replacements();
  919. FileToReplaces[Path2] = Replacements();
  920. FileToReplaces = groupReplacementsByFile(FileMgr, FileToReplaces);
  921. EXPECT_EQ(1u, FileToReplaces.size());
  922. EXPECT_EQ(Path1, FileToReplaces.begin()->first);
  923. }
  924. TEST(DeduplicateByFileTest, PathWithDotSlash) {
  925. std::map<std::string, Replacements> FileToReplaces;
  926. llvm::IntrusiveRefCntPtr<llvm::vfs::InMemoryFileSystem> VFS(
  927. new llvm::vfs::InMemoryFileSystem());
  928. FileManager FileMgr(FileSystemOptions(), VFS);
  929. #if !defined(_WIN32)
  930. StringRef Path1 = "./a/b/c.h";
  931. StringRef Path2 = "a/b/c.h";
  932. #else
  933. StringRef Path1 = ".\\a\\b\\c.h";
  934. StringRef Path2 = "a\\b\\c.h";
  935. #endif
  936. EXPECT_TRUE(VFS->addFile(Path1, 0, llvm::MemoryBuffer::getMemBuffer("")));
  937. EXPECT_TRUE(VFS->addFile(Path2, 0, llvm::MemoryBuffer::getMemBuffer("")));
  938. FileToReplaces[Path1] = Replacements();
  939. FileToReplaces[Path2] = Replacements();
  940. FileToReplaces = groupReplacementsByFile(FileMgr, FileToReplaces);
  941. EXPECT_EQ(1u, FileToReplaces.size());
  942. EXPECT_EQ(Path1, FileToReplaces.begin()->first);
  943. }
  944. TEST(DeduplicateByFileTest, NonExistingFilePath) {
  945. std::map<std::string, Replacements> FileToReplaces;
  946. llvm::IntrusiveRefCntPtr<llvm::vfs::InMemoryFileSystem> VFS(
  947. new llvm::vfs::InMemoryFileSystem());
  948. FileManager FileMgr(FileSystemOptions(), VFS);
  949. #if !defined(_WIN32)
  950. StringRef Path1 = "./a/b/c.h";
  951. StringRef Path2 = "a/b/c.h";
  952. #else
  953. StringRef Path1 = ".\\a\\b\\c.h";
  954. StringRef Path2 = "a\\b\\c.h";
  955. #endif
  956. FileToReplaces[Path1] = Replacements();
  957. FileToReplaces[Path2] = Replacements();
  958. FileToReplaces = groupReplacementsByFile(FileMgr, FileToReplaces);
  959. EXPECT_TRUE(FileToReplaces.empty());
  960. }
  961. class AtomicChangeTest : public ::testing::Test {
  962. protected:
  963. void SetUp() override {
  964. DefaultFileID = Context.createInMemoryFile("input.cpp", DefaultCode);
  965. DefaultLoc = Context.Sources.getLocForStartOfFile(DefaultFileID)
  966. .getLocWithOffset(20);
  967. assert(DefaultLoc.isValid() && "Default location must be valid.");
  968. }
  969. RewriterTestContext Context;
  970. std::string DefaultCode = std::string(100, 'a');
  971. unsigned DefaultOffset = 20;
  972. SourceLocation DefaultLoc;
  973. FileID DefaultFileID;
  974. };
  975. TEST_F(AtomicChangeTest, AtomicChangeToYAML) {
  976. AtomicChange Change(Context.Sources, DefaultLoc);
  977. llvm::Error Err =
  978. Change.insert(Context.Sources, DefaultLoc, "aa", /*InsertAfter=*/false);
  979. ASSERT_TRUE(!Err);
  980. Err = Change.insert(Context.Sources, DefaultLoc.getLocWithOffset(10), "bb",
  981. /*InsertAfter=*/false);
  982. ASSERT_TRUE(!Err);
  983. Change.addHeader("a.h");
  984. Change.removeHeader("b.h");
  985. std::string YAMLString = Change.toYAMLString();
  986. // NOTE: If this test starts to fail for no obvious reason, check whitespace.
  987. ASSERT_STREQ("---\n"
  988. "Key: 'input.cpp:20'\n"
  989. "FilePath: input.cpp\n"
  990. "Error: ''\n"
  991. "InsertedHeaders:\n"
  992. " - a.h\n"
  993. "RemovedHeaders:\n"
  994. " - b.h\n"
  995. "Replacements:\n"
  996. " - FilePath: input.cpp\n"
  997. " Offset: 20\n"
  998. " Length: 0\n"
  999. " ReplacementText: aa\n"
  1000. " - FilePath: input.cpp\n"
  1001. " Offset: 30\n"
  1002. " Length: 0\n"
  1003. " ReplacementText: bb\n"
  1004. "...\n",
  1005. YAMLString.c_str());
  1006. }
  1007. TEST_F(AtomicChangeTest, YAMLToAtomicChange) {
  1008. std::string YamlContent = "---\n"
  1009. "Key: 'input.cpp:20'\n"
  1010. "FilePath: input.cpp\n"
  1011. "Error: 'ok'\n"
  1012. "InsertedHeaders:\n"
  1013. " - a.h\n"
  1014. "RemovedHeaders:\n"
  1015. " - b.h\n"
  1016. "Replacements:\n"
  1017. " - FilePath: input.cpp\n"
  1018. " Offset: 20\n"
  1019. " Length: 0\n"
  1020. " ReplacementText: aa\n"
  1021. " - FilePath: input.cpp\n"
  1022. " Offset: 30\n"
  1023. " Length: 0\n"
  1024. " ReplacementText: bb\n"
  1025. "...\n";
  1026. AtomicChange ExpectedChange(Context.Sources, DefaultLoc);
  1027. llvm::Error Err = ExpectedChange.insert(Context.Sources, DefaultLoc, "aa",
  1028. /*InsertAfter=*/false);
  1029. ASSERT_TRUE(!Err);
  1030. Err = ExpectedChange.insert(Context.Sources, DefaultLoc.getLocWithOffset(10),
  1031. "bb", /*InsertAfter=*/false);
  1032. ASSERT_TRUE(!Err);
  1033. ExpectedChange.addHeader("a.h");
  1034. ExpectedChange.removeHeader("b.h");
  1035. ExpectedChange.setError("ok");
  1036. AtomicChange ActualChange = AtomicChange::convertFromYAML(YamlContent);
  1037. EXPECT_EQ(ExpectedChange.getKey(), ActualChange.getKey());
  1038. EXPECT_EQ(ExpectedChange.getFilePath(), ActualChange.getFilePath());
  1039. EXPECT_EQ(ExpectedChange.getError(), ActualChange.getError());
  1040. EXPECT_EQ(ExpectedChange.getInsertedHeaders(),
  1041. ActualChange.getInsertedHeaders());
  1042. EXPECT_EQ(ExpectedChange.getRemovedHeaders(),
  1043. ActualChange.getRemovedHeaders());
  1044. EXPECT_EQ(ExpectedChange.getReplacements().size(),
  1045. ActualChange.getReplacements().size());
  1046. EXPECT_EQ(2u, ActualChange.getReplacements().size());
  1047. EXPECT_EQ(*ExpectedChange.getReplacements().begin(),
  1048. *ActualChange.getReplacements().begin());
  1049. EXPECT_EQ(*(++ExpectedChange.getReplacements().begin()),
  1050. *(++ActualChange.getReplacements().begin()));
  1051. }
  1052. TEST_F(AtomicChangeTest, CheckKeyAndKeyFile) {
  1053. AtomicChange Change(Context.Sources, DefaultLoc);
  1054. EXPECT_EQ("input.cpp:20", Change.getKey());
  1055. EXPECT_EQ("input.cpp", Change.getFilePath());
  1056. }
  1057. TEST_F(AtomicChangeTest, Replace) {
  1058. AtomicChange Change(Context.Sources, DefaultLoc);
  1059. llvm::Error Err = Change.replace(Context.Sources, DefaultLoc, 2, "aa");
  1060. ASSERT_TRUE(!Err);
  1061. EXPECT_EQ(Change.getReplacements().size(), 1u);
  1062. EXPECT_EQ(*Change.getReplacements().begin(),
  1063. Replacement(Context.Sources, DefaultLoc, 2, "aa"));
  1064. // Add a new replacement that conflicts with the existing one.
  1065. Err = Change.replace(Context.Sources, DefaultLoc, 3, "ab");
  1066. EXPECT_TRUE((bool)Err);
  1067. llvm::consumeError(std::move(Err));
  1068. EXPECT_EQ(Change.getReplacements().size(), 1u);
  1069. }
  1070. TEST_F(AtomicChangeTest, ReplaceWithRange) {
  1071. AtomicChange Change(Context.Sources, DefaultLoc);
  1072. SourceLocation End = DefaultLoc.getLocWithOffset(20);
  1073. llvm::Error Err = Change.replace(
  1074. Context.Sources, CharSourceRange::getCharRange(DefaultLoc, End), "aa");
  1075. ASSERT_TRUE(!Err);
  1076. EXPECT_EQ(Change.getReplacements().size(), 1u);
  1077. EXPECT_EQ(*Change.getReplacements().begin(),
  1078. Replacement(Context.Sources, DefaultLoc, 20, "aa"));
  1079. }
  1080. TEST_F(AtomicChangeTest, InsertBefore) {
  1081. AtomicChange Change(Context.Sources, DefaultLoc);
  1082. llvm::Error Err = Change.insert(Context.Sources, DefaultLoc, "aa");
  1083. ASSERT_TRUE(!Err);
  1084. EXPECT_EQ(Change.getReplacements().size(), 1u);
  1085. EXPECT_EQ(*Change.getReplacements().begin(),
  1086. Replacement(Context.Sources, DefaultLoc, 0, "aa"));
  1087. Err = Change.insert(Context.Sources, DefaultLoc, "b", /*InsertAfter=*/false);
  1088. ASSERT_TRUE(!Err);
  1089. EXPECT_EQ(Change.getReplacements().size(), 1u);
  1090. EXPECT_EQ(*Change.getReplacements().begin(),
  1091. Replacement(Context.Sources, DefaultLoc, 0, "baa"));
  1092. }
  1093. TEST_F(AtomicChangeTest, InsertAfter) {
  1094. AtomicChange Change(Context.Sources, DefaultLoc);
  1095. llvm::Error Err = Change.insert(Context.Sources, DefaultLoc, "aa");
  1096. ASSERT_TRUE(!Err);
  1097. EXPECT_EQ(Change.getReplacements().size(), 1u);
  1098. EXPECT_EQ(*Change.getReplacements().begin(),
  1099. Replacement(Context.Sources, DefaultLoc, 0, "aa"));
  1100. Err = Change.insert(Context.Sources, DefaultLoc, "b");
  1101. ASSERT_TRUE(!Err);
  1102. EXPECT_EQ(Change.getReplacements().size(), 1u);
  1103. EXPECT_EQ(*Change.getReplacements().begin(),
  1104. Replacement(Context.Sources, DefaultLoc, 0, "aab"));
  1105. }
  1106. TEST_F(AtomicChangeTest, InsertBeforeWithInvalidLocation) {
  1107. AtomicChange Change(Context.Sources, DefaultLoc);
  1108. llvm::Error Err =
  1109. Change.insert(Context.Sources, DefaultLoc, "a", /*InsertAfter=*/false);
  1110. ASSERT_TRUE(!Err);
  1111. // Invalid location.
  1112. Err = Change.insert(Context.Sources, SourceLocation(), "a",
  1113. /*InsertAfter=*/false);
  1114. ASSERT_TRUE((bool)Err);
  1115. EXPECT_TRUE(checkReplacementError(
  1116. std::move(Err), replacement_error::wrong_file_path,
  1117. Replacement(Context.Sources, DefaultLoc, 0, "a"),
  1118. Replacement(Context.Sources, SourceLocation(), 0, "a")));
  1119. }
  1120. TEST_F(AtomicChangeTest, InsertBeforeToWrongFile) {
  1121. AtomicChange Change(Context.Sources, DefaultLoc);
  1122. llvm::Error Err =
  1123. Change.insert(Context.Sources, DefaultLoc, "a", /*InsertAfter=*/false);
  1124. ASSERT_TRUE(!Err);
  1125. // Inserting at a different file.
  1126. FileID NewID = Context.createInMemoryFile("extra.cpp", DefaultCode);
  1127. SourceLocation NewLoc = Context.Sources.getLocForStartOfFile(NewID);
  1128. Err = Change.insert(Context.Sources, NewLoc, "b", /*InsertAfter=*/false);
  1129. ASSERT_TRUE((bool)Err);
  1130. EXPECT_TRUE(
  1131. checkReplacementError(std::move(Err), replacement_error::wrong_file_path,
  1132. Replacement(Context.Sources, DefaultLoc, 0, "a"),
  1133. Replacement(Context.Sources, NewLoc, 0, "b")));
  1134. }
  1135. TEST_F(AtomicChangeTest, InsertAfterWithInvalidLocation) {
  1136. AtomicChange Change(Context.Sources, DefaultLoc);
  1137. llvm::Error Err = Change.insert(Context.Sources, DefaultLoc, "a");
  1138. ASSERT_TRUE(!Err);
  1139. // Invalid location.
  1140. Err = Change.insert(Context.Sources, SourceLocation(), "b");
  1141. ASSERT_TRUE((bool)Err);
  1142. EXPECT_TRUE(checkReplacementError(
  1143. std::move(Err), replacement_error::wrong_file_path,
  1144. Replacement(Context.Sources, DefaultLoc, 0, "a"),
  1145. Replacement(Context.Sources, SourceLocation(), 0, "b")));
  1146. }
  1147. class ApplyAtomicChangesTest : public ::testing::Test {
  1148. protected:
  1149. ApplyAtomicChangesTest() : FilePath("file.cc") {
  1150. Spec.Cleanup = true;
  1151. Spec.Format = ApplyChangesSpec::kAll;
  1152. Spec.Style = format::getLLVMStyle();
  1153. }
  1154. ~ApplyAtomicChangesTest() override {}
  1155. void setInput(llvm::StringRef Input) {
  1156. Code = Input;
  1157. FID = Context.createInMemoryFile(FilePath, Code);
  1158. }
  1159. SourceLocation getLoc(unsigned Offset) const {
  1160. return Context.Sources.getLocForStartOfFile(FID).getLocWithOffset(Offset);
  1161. }
  1162. AtomicChange replacementToAtomicChange(llvm::StringRef Key, unsigned Offset,
  1163. unsigned Length,
  1164. llvm::StringRef Text) {
  1165. AtomicChange Change(FilePath, Key);
  1166. llvm::Error Err =
  1167. Change.replace(Context.Sources, getLoc(Offset), Length, Text);
  1168. EXPECT_FALSE(Err);
  1169. return Change;
  1170. }
  1171. std::string rewrite(bool FailureExpected = false) {
  1172. llvm::Expected<std::string> ChangedCode =
  1173. applyAtomicChanges(FilePath, Code, Changes, Spec);
  1174. EXPECT_EQ(FailureExpected, !ChangedCode);
  1175. if (!ChangedCode) {
  1176. llvm::errs() << "Failed to apply changes: "
  1177. << llvm::toString(ChangedCode.takeError()) << "\n";
  1178. return "";
  1179. }
  1180. return *ChangedCode;
  1181. }
  1182. RewriterTestContext Context;
  1183. FileID FID;
  1184. ApplyChangesSpec Spec;
  1185. std::string Code;
  1186. std::string FilePath;
  1187. llvm::SmallVector<AtomicChange, 8> Changes;
  1188. };
  1189. TEST_F(ApplyAtomicChangesTest, BasicRefactoring) {
  1190. setInput("int a;");
  1191. AtomicChange Change(FilePath, "key1");
  1192. Changes.push_back(replacementToAtomicChange("key1", 4, 1, "b"));
  1193. EXPECT_EQ("int b;", rewrite());
  1194. }
  1195. TEST_F(ApplyAtomicChangesTest, SeveralRefactorings) {
  1196. setInput("int a;\n"
  1197. "int b;");
  1198. Changes.push_back(replacementToAtomicChange("key1", 0, 3, "float"));
  1199. Changes.push_back(replacementToAtomicChange("key2", 4, 1, "f"));
  1200. Changes.push_back(replacementToAtomicChange("key3", 11, 1, "g"));
  1201. Changes.push_back(replacementToAtomicChange("key4", 7, 3, "float"));
  1202. EXPECT_EQ("float f;\n"
  1203. "float g;",
  1204. rewrite());
  1205. }
  1206. TEST_F(ApplyAtomicChangesTest, IgnorePathsInRefactorings) {
  1207. setInput("int a;\n"
  1208. "int b;");
  1209. Changes.push_back(replacementToAtomicChange("key1", 4, 1, "aa"));
  1210. FileID ID = Context.createInMemoryFile("AnotherFile", "12345678912345");
  1211. Changes.emplace_back("AnotherFile", "key2");
  1212. auto Err = Changes.back().replace(
  1213. Context.Sources,
  1214. Context.Sources.getLocForStartOfFile(ID).getLocWithOffset(11), 1, "bb");
  1215. ASSERT_TRUE(!Err);
  1216. EXPECT_EQ("int aa;\n"
  1217. "int bb;",
  1218. rewrite());
  1219. }
  1220. TEST_F(ApplyAtomicChangesTest, AppliesDuplicateInsertions) {
  1221. setInput("int a;");
  1222. Changes.push_back(replacementToAtomicChange("key1", 5, 0, "b"));
  1223. Changes.push_back(replacementToAtomicChange("key2", 5, 0, "b"));
  1224. EXPECT_EQ("int abb;", rewrite());
  1225. }
  1226. TEST_F(ApplyAtomicChangesTest, BailsOnOverlappingRefactorings) {
  1227. setInput("int a;");
  1228. Changes.push_back(replacementToAtomicChange("key1", 0, 5, "float f"));
  1229. Changes.push_back(replacementToAtomicChange("key2", 4, 1, "b"));
  1230. EXPECT_EQ("", rewrite(/*FailureExpected=*/true));
  1231. }
  1232. TEST_F(ApplyAtomicChangesTest, BasicReformatting) {
  1233. setInput("int a;");
  1234. Changes.push_back(replacementToAtomicChange("key1", 5, 1, "b"));
  1235. EXPECT_EQ("int b;", rewrite());
  1236. }
  1237. TEST_F(ApplyAtomicChangesTest, OnlyFormatWhenViolateColumnLimits) {
  1238. Spec.Format = ApplyChangesSpec::kViolations;
  1239. Spec.Style.ColumnLimit = 8;
  1240. setInput("int a;\n"
  1241. "int a;\n"
  1242. "int aaaaaaaa;\n");
  1243. Changes.push_back(replacementToAtomicChange("key1", 5, 1, "x"));
  1244. Changes.push_back(replacementToAtomicChange("key2", 15, 1, "x"));
  1245. Changes.push_back(replacementToAtomicChange("key3", 23, 8, "xx"));
  1246. EXPECT_EQ("int x;\n"
  1247. "int x;\n"
  1248. "int xx;\n",
  1249. rewrite());
  1250. }
  1251. TEST_F(ApplyAtomicChangesTest, LastLineViolateColumnLimits) {
  1252. Spec.Format = ApplyChangesSpec::kViolations;
  1253. Spec.Style.ColumnLimit = 8;
  1254. setInput("int a;\n"
  1255. "int a;");
  1256. Changes.push_back(replacementToAtomicChange("key1", 0, 1, "i"));
  1257. Changes.push_back(replacementToAtomicChange("key2", 15, 2, "y;"));
  1258. EXPECT_EQ("int a;\n"
  1259. "int y;",
  1260. rewrite());
  1261. }
  1262. TEST_F(ApplyAtomicChangesTest, LastLineWithNewlineViolateColumnLimits) {
  1263. Spec.Format = ApplyChangesSpec::kViolations;
  1264. Spec.Style.ColumnLimit = 8;
  1265. setInput("int a;\n"
  1266. "int a;\n");
  1267. Changes.push_back(replacementToAtomicChange("key1", 0, 1, "i"));
  1268. Changes.push_back(replacementToAtomicChange("key2", 14, 3, "y;\n"));
  1269. EXPECT_EQ("int a;\n"
  1270. "int y;\n",
  1271. rewrite());
  1272. }
  1273. TEST_F(ApplyAtomicChangesTest, Longer) {
  1274. setInput("int a;");
  1275. Changes.push_back(replacementToAtomicChange("key1", 5, 1, "bbb"));
  1276. EXPECT_EQ("int bbb;", rewrite());
  1277. }
  1278. TEST_F(ApplyAtomicChangesTest, Shorter) {
  1279. setInput("int aaa;");
  1280. Changes.push_back(replacementToAtomicChange("key1", 5, 3, "b"));
  1281. EXPECT_EQ("int b;", rewrite());
  1282. }
  1283. TEST_F(ApplyAtomicChangesTest, OnlyFormatChangedLines) {
  1284. setInput("int aaa;\n"
  1285. "int a = b;\n"
  1286. "int bbb;");
  1287. Changes.push_back(replacementToAtomicChange("key1", 14, 1, "b"));
  1288. EXPECT_EQ("int aaa;\n"
  1289. "int b = b;\n"
  1290. "int bbb;",
  1291. rewrite());
  1292. }
  1293. TEST_F(ApplyAtomicChangesTest, DisableFormatting) {
  1294. Spec.Format = ApplyChangesSpec::kNone;
  1295. setInput("int aaa;\n"
  1296. "int a = b;\n"
  1297. "int bbb;");
  1298. Changes.push_back(replacementToAtomicChange("key1", 14, 1, "b"));
  1299. EXPECT_EQ("int aaa;\n"
  1300. "int b = b;\n"
  1301. "int bbb;",
  1302. rewrite());
  1303. }
  1304. TEST_F(ApplyAtomicChangesTest, AdaptsToLocalPointerStyle) {
  1305. setInput("int *aaa;\n"
  1306. "int *bbb;");
  1307. Changes.push_back(replacementToAtomicChange("key1", 0, 0, "int* ccc;\n"));
  1308. EXPECT_EQ("int *ccc;\n"
  1309. "int *aaa;\n"
  1310. "int *bbb;",
  1311. rewrite());
  1312. }
  1313. TEST_F(ApplyAtomicChangesTest, AcceptsSurroundingFormatting) {
  1314. setInput(" int aaa;\n"
  1315. " int a = b;\n"
  1316. " int bbb;");
  1317. Changes.push_back(replacementToAtomicChange("key1", 20, 1, "b"));
  1318. EXPECT_EQ(" int aaa;\n"
  1319. " int b = b;\n"
  1320. " int bbb;",
  1321. rewrite());
  1322. }
  1323. TEST_F(ApplyAtomicChangesTest, BailsOutOnConflictingChanges) {
  1324. setInput("int c;\n"
  1325. "int f;");
  1326. // Insertions at the same offset are only allowed in the same AtomicChange.
  1327. Changes.push_back(replacementToAtomicChange("key1", 0, 0, "int a;\n"));
  1328. Changes.push_back(replacementToAtomicChange("key2", 0, 0, "int b;\n"));
  1329. EXPECT_EQ("", rewrite(/*FailureExpected=*/true));
  1330. }
  1331. TEST_F(ApplyAtomicChangesTest, InsertsNewIncludesInRightOrder) {
  1332. setInput("int a;");
  1333. Changes.emplace_back(FilePath, "key1");
  1334. Changes.back().addHeader("b");
  1335. Changes.back().addHeader("c");
  1336. Changes.emplace_back(FilePath, "key2");
  1337. Changes.back().addHeader("a");
  1338. EXPECT_EQ("#include \"a\"\n"
  1339. "#include \"b\"\n"
  1340. "#include \"c\"\n"
  1341. "int a;",
  1342. rewrite());
  1343. }
  1344. TEST_F(ApplyAtomicChangesTest, RemoveAndSortIncludes) {
  1345. setInput("#include \"a\"\n"
  1346. "#include \"b\"\n"
  1347. "#include \"c\"\n"
  1348. "\n"
  1349. "int a;");
  1350. Changes.emplace_back(FilePath, "key1");
  1351. Changes.back().removeHeader("b");
  1352. EXPECT_EQ("#include \"a\"\n"
  1353. "#include \"c\"\n"
  1354. "\n"
  1355. "int a;",
  1356. rewrite());
  1357. }
  1358. TEST_F(ApplyAtomicChangesTest, InsertsSystemIncludes) {
  1359. setInput("#include <asys>\n"
  1360. "#include <csys>\n"
  1361. "\n"
  1362. "#include \"a\"\n"
  1363. "#include \"c\"\n");
  1364. Changes.emplace_back(FilePath, "key1");
  1365. Changes.back().addHeader("<asys>"); // Already exists.
  1366. Changes.back().addHeader("<b>");
  1367. Changes.back().addHeader("<d>");
  1368. Changes.back().addHeader("\"b-already-escaped\"");
  1369. EXPECT_EQ("#include <asys>\n"
  1370. "#include <b>\n"
  1371. "#include <csys>\n"
  1372. "#include <d>\n"
  1373. "\n"
  1374. "#include \"a\"\n"
  1375. "#include \"b-already-escaped\"\n"
  1376. "#include \"c\"\n",
  1377. rewrite());
  1378. }
  1379. TEST_F(ApplyAtomicChangesTest, RemoveSystemIncludes) {
  1380. setInput("#include <a>\n"
  1381. "#include <b>\n"
  1382. "\n"
  1383. "#include \"c\""
  1384. "\n"
  1385. "int a;");
  1386. Changes.emplace_back(FilePath, "key1");
  1387. Changes.back().removeHeader("<a>");
  1388. EXPECT_EQ("#include <b>\n"
  1389. "\n"
  1390. "#include \"c\""
  1391. "\n"
  1392. "int a;",
  1393. rewrite());
  1394. }
  1395. TEST_F(ApplyAtomicChangesTest,
  1396. DoNotFormatFollowingLinesIfSeparatedWithNewline) {
  1397. setInput("#ifndef __H__\n"
  1398. "#define __H__\n"
  1399. "#include \"b\"\n"
  1400. "\n"
  1401. "int a;\n"
  1402. "int a;\n"
  1403. "int a;\n"
  1404. "#endif // __H__\n");
  1405. Changes.push_back(replacementToAtomicChange("key1",
  1406. llvm::StringRef("#ifndef __H__\n"
  1407. "#define __H__\n"
  1408. "\n"
  1409. "#include \"b\"\n"
  1410. "int a;\n"
  1411. "int ")
  1412. .size(),
  1413. 1, "b"));
  1414. Changes.back().addHeader("a");
  1415. EXPECT_EQ("#ifndef __H__\n"
  1416. "#define __H__\n"
  1417. "#include \"a\"\n"
  1418. "#include \"b\"\n"
  1419. "\n"
  1420. "int a;\n"
  1421. "int b;\n"
  1422. "int a;\n"
  1423. "#endif // __H__\n",
  1424. rewrite());
  1425. }
  1426. TEST_F(ApplyAtomicChangesTest, FormatsCorrectLineWhenHeaderIsRemoved) {
  1427. setInput("#include \"a\"\n"
  1428. "\n"
  1429. "int a;\n"
  1430. "int a;\n"
  1431. "int a;");
  1432. Changes.push_back(replacementToAtomicChange("key1", 27, 1, "b"));
  1433. Changes.back().removeHeader("a");
  1434. EXPECT_EQ("\n"
  1435. "int a;\n"
  1436. "int b;\n"
  1437. "int a;",
  1438. rewrite());
  1439. }
  1440. TEST_F(ApplyAtomicChangesTest, CleansUpCtorInitializers) {
  1441. setInput("A::A() : a(), b() {}\n"
  1442. "A::A() : a(), b() {}\n"
  1443. "A::A() : a(), b() {}\n"
  1444. "A::A() : a()/**/, b() {}\n"
  1445. "A::A() : a() ,// \n"
  1446. " /**/ b() {}");
  1447. Changes.emplace_back(FilePath, "key1");
  1448. auto Err = Changes.back().replace(Context.Sources, getLoc(9), 3, "");
  1449. ASSERT_TRUE(!Err);
  1450. Err = Changes.back().replace(Context.Sources, getLoc(35), 3, "");
  1451. ASSERT_TRUE(!Err);
  1452. Err = Changes.back().replace(Context.Sources, getLoc(51), 3, "");
  1453. ASSERT_TRUE(!Err);
  1454. Err = Changes.back().replace(Context.Sources, getLoc(56), 3, "");
  1455. ASSERT_TRUE(!Err);
  1456. Err = Changes.back().replace(Context.Sources, getLoc(72), 3, "");
  1457. ASSERT_TRUE(!Err);
  1458. Err = Changes.back().replace(Context.Sources, getLoc(97), 3, "");
  1459. ASSERT_TRUE(!Err);
  1460. Err = Changes.back().replace(Context.Sources, getLoc(118), 3, "");
  1461. ASSERT_TRUE(!Err);
  1462. EXPECT_EQ("A::A() : b() {}\n"
  1463. "A::A() : a() {}\n"
  1464. "A::A() {}\n"
  1465. "A::A() : b() {}\n"
  1466. "A::A() {}",
  1467. rewrite());
  1468. }
  1469. TEST_F(ApplyAtomicChangesTest, CleansUpParameterLists) {
  1470. setInput("void f(int i, float f, string s);\n"
  1471. "f(1, 2.0f, \"a\");\n"
  1472. "g(1, 1);");
  1473. Changes.emplace_back(FilePath, "key1");
  1474. auto Err = Changes.back().replace(Context.Sources, getLoc(7), 5, "");
  1475. ASSERT_TRUE(!Err);
  1476. Err = Changes.back().replace(Context.Sources, getLoc(23), 8, "");
  1477. ASSERT_TRUE(!Err);
  1478. Err = Changes.back().replace(Context.Sources, getLoc(36), 1, "");
  1479. ASSERT_TRUE(!Err);
  1480. Err = Changes.back().replace(Context.Sources, getLoc(45), 3, "");
  1481. ASSERT_TRUE(!Err);
  1482. Err = Changes.back().replace(Context.Sources, getLoc(53), 1, "");
  1483. ASSERT_TRUE(!Err);
  1484. Err = Changes.back().replace(Context.Sources, getLoc(56), 1, "");
  1485. ASSERT_TRUE(!Err);
  1486. EXPECT_EQ("void f(float f);\n"
  1487. "f(2.0f);\n"
  1488. "g();",
  1489. rewrite());
  1490. }
  1491. TEST_F(ApplyAtomicChangesTest, DisableCleanup) {
  1492. Spec.Cleanup = false;
  1493. setInput("void f(int i, float f, string s);\n"
  1494. "f(1, 2.0f, \"a\");\n"
  1495. "g(1, 1);");
  1496. Changes.emplace_back(FilePath, "key1");
  1497. auto Err = Changes.back().replace(Context.Sources, getLoc(7), 5, "");
  1498. ASSERT_TRUE(!Err);
  1499. Err = Changes.back().replace(Context.Sources, getLoc(23), 8, "");
  1500. ASSERT_TRUE(!Err);
  1501. Err = Changes.back().replace(Context.Sources, getLoc(36), 1, "");
  1502. ASSERT_TRUE(!Err);
  1503. Err = Changes.back().replace(Context.Sources, getLoc(45), 3, "");
  1504. ASSERT_TRUE(!Err);
  1505. Err = Changes.back().replace(Context.Sources, getLoc(53), 1, "");
  1506. ASSERT_TRUE(!Err);
  1507. Err = Changes.back().replace(Context.Sources, getLoc(56), 1, "");
  1508. ASSERT_TRUE(!Err);
  1509. EXPECT_EQ("void f(, float f, );\n"
  1510. "f(, 2.0f, );\n"
  1511. "g(, );",
  1512. rewrite());
  1513. }
  1514. TEST_F(ApplyAtomicChangesTest, EverythingDeleted) {
  1515. setInput("int a;");
  1516. Changes.push_back(replacementToAtomicChange("key1", 0, 6, ""));
  1517. EXPECT_EQ("", rewrite());
  1518. }
  1519. TEST_F(ApplyAtomicChangesTest, DoesNotDeleteInserts) {
  1520. setInput("int a;\n"
  1521. "int b;");
  1522. Changes.emplace_back(FilePath, "key1");
  1523. auto Err = Changes.back().replace(Context.Sources, getLoc(4), 1, "");
  1524. ASSERT_TRUE(!Err);
  1525. Err = Changes.back().replace(Context.Sources, getLoc(4), 0, "b");
  1526. ASSERT_TRUE(!Err);
  1527. Err = Changes.back().replace(Context.Sources, getLoc(11), 0, "a");
  1528. ASSERT_TRUE(!Err);
  1529. Err = Changes.back().replace(Context.Sources, getLoc(11), 1, "");
  1530. ASSERT_TRUE(!Err);
  1531. EXPECT_EQ("int b;\n"
  1532. "int a;",
  1533. rewrite());
  1534. }
  1535. } // end namespace tooling
  1536. } // end namespace clang