blob: 17528e962bfc9ecfdfdb7ec53c13b7743df166bd [file] [log] [blame]
Eric Liu495b2112016-09-19 17:40:32 +00001//===-- ChangeNamespaceTests.cpp - Change namespace unit tests ---*- C++ -*-===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9
10#include "ChangeNamespace.h"
11#include "unittests/Tooling/RewriterTestContext.h"
12#include "clang/ASTMatchers/ASTMatchFinder.h"
13#include "clang/Basic/FileManager.h"
14#include "clang/Basic/FileSystemOptions.h"
15#include "clang/Basic/VirtualFileSystem.h"
16#include "clang/Format/Format.h"
17#include "clang/Frontend/CompilerInstance.h"
18#include "clang/Frontend/PCHContainerOperations.h"
19#include "clang/Tooling/Refactoring.h"
20#include "clang/Tooling/Tooling.h"
21#include "llvm/ADT/IntrusiveRefCntPtr.h"
22#include "llvm/ADT/StringRef.h"
23#include "llvm/Support/MemoryBuffer.h"
24#include "gtest/gtest.h"
25#include <memory>
26#include <string>
27#include <vector>
28
29namespace clang {
30namespace change_namespace {
31namespace {
32
33class ChangeNamespaceTest : public ::testing::Test {
34public:
35 std::string runChangeNamespaceOnCode(llvm::StringRef Code) {
36 clang::RewriterTestContext Context;
37 clang::FileID ID = Context.createInMemoryFile(FileName, Code);
38
39 std::map<std::string, tooling::Replacements> FileToReplacements;
40 change_namespace::ChangeNamespaceTool NamespaceTool(
41 OldNamespace, NewNamespace, FilePattern, &FileToReplacements);
42 ast_matchers::MatchFinder Finder;
43 NamespaceTool.registerMatchers(&Finder);
44 std::unique_ptr<tooling::FrontendActionFactory> Factory =
45 tooling::newFrontendActionFactory(&Finder);
46 tooling::runToolOnCodeWithArgs(Factory->create(), Code, {"-std=c++11"},
47 FileName);
48 formatAndApplyAllReplacements(FileToReplacements, Context.Rewrite);
49 return format(Context.getRewrittenText(ID));
50 }
51
52 std::string format(llvm::StringRef Code) {
53 tooling::Replacements Replaces = format::reformat(
54 format::getLLVMStyle(), Code, {tooling::Range(0, Code.size())});
55 auto ChangedCode = tooling::applyAllReplacements(Code, Replaces);
56 EXPECT_TRUE(static_cast<bool>(ChangedCode));
57 if (!ChangedCode) {
58 llvm::errs() << llvm::toString(ChangedCode.takeError());
59 return "";
60 }
61 return *ChangedCode;
62 }
63
64protected:
65 std::string FileName = "input.cc";
66 std::string OldNamespace = "na::nb";
67 std::string NewNamespace = "x::y";
68 std::string FilePattern = "input.cc";
69};
70
71TEST_F(ChangeNamespaceTest, NoMatchingNamespace) {
72 std::string Code = "namespace na {\n"
73 "namespace nx {\n"
74 "class A {};\n"
75 "} // namespace nx\n"
76 "} // namespace na\n";
77 std::string Expected = "namespace na {\n"
78 "namespace nx {\n"
79 "class A {};\n"
80 "} // namespace nx\n"
81 "} // namespace na\n";
82 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
83}
84
85TEST_F(ChangeNamespaceTest, SimpleMoveWithoutTypeRefs) {
86 std::string Code = "namespace na {\n"
87 "namespace nb {\n"
88 "class A {};\n"
89 "} // namespace nb\n"
90 "} // namespace na\n";
91 std::string Expected = "\n\n"
92 "namespace x {\n"
93 "namespace y {\n"
94 "class A {};\n"
95 "} // namespace y\n"
96 "} // namespace x\n";
97 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
98}
99
100TEST_F(ChangeNamespaceTest, SimpleMoveIntoAnotherNestedNamespace) {
101 NewNamespace = "na::nc";
102 std::string Code = "namespace na {\n"
103 "namespace nb {\n"
104 "class A {};\n"
105 "} // namespace nb\n"
106 "} // namespace na\n";
107 std::string Expected = "namespace na {\n"
108 "\n"
109 "namespace nc {\n"
110 "class A {};\n"
111 "} // namespace nc\n"
112 "} // namespace na\n";
113 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
114}
115
Eric Liu447164d2016-10-05 15:52:39 +0000116TEST_F(ChangeNamespaceTest, MoveIntoAnotherNestedNamespaceWithRef) {
117 NewNamespace = "na::nc";
118 std::string Code = "namespace na {\n"
119 "class A {};\n"
120 "namespace nb {\n"
121 "class X { A a; };\n"
122 "} // namespace nb\n"
123 "} // namespace na\n";
124 std::string Expected = "namespace na {\n"
125 "class A {};\n"
126 "\n"
127 "namespace nc {\n"
128 "class X { A a; };\n"
129 "} // namespace nc\n"
130 "} // namespace na\n";
131 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
132}
133
Eric Liu495b2112016-09-19 17:40:32 +0000134TEST_F(ChangeNamespaceTest, SimpleMoveNestedNamespace) {
135 NewNamespace = "na::x::y";
136 std::string Code = "namespace na {\n"
137 "class A {};\n"
138 "namespace nb {\n"
139 "class B {};\n"
140 "} // namespace nb\n"
141 "} // namespace na\n";
142 std::string Expected = "namespace na {\n"
143 "class A {};\n"
144 "\n"
145 "namespace x {\n"
146 "namespace y {\n"
147 "class B {};\n"
148 "} // namespace y\n"
149 "} // namespace x\n"
150 "} // namespace na\n";
151 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
152}
153
154TEST_F(ChangeNamespaceTest, SimpleMoveWithTypeRefs) {
155 std::string Code = "namespace na {\n"
156 "class C_A {};\n"
157 "namespace nc {\n"
158 "class C_C {};"
159 "} // namespace nc\n"
160 "namespace nb {\n"
161 "class C_X {\n"
162 "public:\n"
163 " C_A a;\n"
164 " nc::C_C c;\n"
165 "};\n"
166 "class C_Y {\n"
167 " C_X x;\n"
168 "};\n"
169 "} // namespace nb\n"
170 "} // namespace na\n";
171 std::string Expected = "namespace na {\n"
172 "class C_A {};\n"
173 "namespace nc {\n"
174 "class C_C {};"
175 "} // namespace nc\n"
176 "\n"
177 "} // namespace na\n"
178 "namespace x {\n"
179 "namespace y {\n"
180 "class C_X {\n"
181 "public:\n"
182 " na::C_A a;\n"
183 " na::nc::C_C c;\n"
184 "};\n"
185 "class C_Y {\n"
186 " C_X x;\n"
187 "};\n"
188 "} // namespace y\n"
189 "} // namespace x\n";
190 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
191}
192
Eric Liu8393cb02016-10-31 08:28:29 +0000193TEST_F(ChangeNamespaceTest, TypeLocInTemplateSpecialization) {
194 std::string Code = "namespace na {\n"
195 "class A {};\n"
196 "template <typename T>\n"
197 "class B {};\n"
198 "template <typename T1, typename T2>\n"
199 "class Two {};\n"
200 "namespace nc { class C {}; }\n"
201 "} // na\n"
202 "\n"
203 "namespace na {\n"
204 "namespace nb {\n"
205 "void f() {\n"
206 " B<A> b;\n"
207 " B<nc::C> b_c;\n"
208 " Two<A, nc::C> two;\n"
209 "}\n"
210 "} // nb\n"
211 "} // na\n";
212 std::string Expected = "namespace na {\n"
213 "class A {};\n"
214 "template <typename T>\n"
215 "class B {};\n"
216 "template <typename T1, typename T2>\n"
217 "class Two {};\n"
218 "namespace nc { class C {}; }\n"
219 "} // na\n"
220 "\n"
221 "\n"
222 "namespace x {\n"
223 "namespace y {\n"
224 "void f() {\n"
225 " na::B<na::A> b;\n"
226 " na::B<na::nc::C> b_c;\n"
227 " na::Two<na::A, na::nc::C> two;\n"
228 "}\n"
229 "} // namespace y\n"
230 "} // namespace x\n";
231 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
232}
233
Eric Liu495b2112016-09-19 17:40:32 +0000234TEST_F(ChangeNamespaceTest, LeaveForwardDeclarationBehind) {
235 std::string Code = "namespace na {\n"
236 "namespace nb {\n"
237 "class FWD;\n"
238 "class A {\n"
239 " FWD *fwd;\n"
240 "};\n"
241 "} // namespace nb\n"
242 "} // namespace na\n";
243 std::string Expected = "namespace na {\n"
244 "namespace nb {\n"
245 "class FWD;\n"
246 "} // namespace nb\n"
247 "} // namespace na\n"
248 "namespace x {\n"
249 "namespace y {\n"
250 "\n"
251 "class A {\n"
252 " na::nb::FWD *fwd;\n"
253 "};\n"
254 "} // namespace y\n"
255 "} // namespace x\n";
256 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
257}
258
259TEST_F(ChangeNamespaceTest, MoveFunctions) {
260 std::string Code = "namespace na {\n"
261 "class C_A {};\n"
262 "namespace nc {\n"
263 "class C_C {};"
264 "} // namespace nc\n"
265 "namespace nb {\n"
266 "void fwd();\n"
267 "void f(C_A ca, nc::C_C cc) {\n"
268 " C_A ca_1 = ca;\n"
269 "}\n"
270 "} // namespace nb\n"
271 "} // namespace na\n";
272
273 std::string Expected = "namespace na {\n"
274 "class C_A {};\n"
275 "namespace nc {\n"
276 "class C_C {};"
277 "} // namespace nc\n"
278 "\n"
279 "} // namespace na\n"
280 "namespace x {\n"
281 "namespace y {\n"
282 "void fwd();\n"
283 "void f(na::C_A ca, na::nc::C_C cc) {\n"
284 " na::C_A ca_1 = ca;\n"
285 "}\n"
286 "} // namespace y\n"
287 "} // namespace x\n";
288 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
289}
290
Eric Liu912d0392016-09-27 12:54:48 +0000291TEST_F(ChangeNamespaceTest, DoNotCrashWithLambdaAsParameter) {
292 std::string Code =
293 "#include <functional>\n"
294 "void f(std::function<void(int)> func, int param) { func(param); } "
295 "void g() { f([](int x) {}, 1); }";
296
297 std::string Expected =
298 "#include <functional>\n"
299 "void f(std::function<void(int)> func, int param) { func(param); } "
300 "void g() { f([](int x) {}, 1); }";
301 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
302}
303
Eric Liu68765a82016-09-21 15:06:12 +0000304TEST_F(ChangeNamespaceTest, FixUsingShadowDecl) {
Eric Liu912d0392016-09-27 12:54:48 +0000305 std::string Code = "class GLOB {};\n"
306 "using BLOG = GLOB;\n"
307 "namespace na {\n"
Eric Liu68765a82016-09-21 15:06:12 +0000308 "namespace nc {\n"
309 "class SAME {};\n"
310 "}\n"
311 "namespace nd {\n"
312 "class SAME {};\n"
313 "}\n"
314 "namespace nb {\n"
315 "using nc::SAME;\n"
316 "using YO = nc::SAME;\n"
317 "typedef nc::SAME IDENTICAL;\n"
318 "void f(nd::SAME Same) {}\n"
319 "} // namespace nb\n"
320 "} // namespace na\n";
321
Eric Liu912d0392016-09-27 12:54:48 +0000322 std::string Expected = "class GLOB {};\n"
323 "using BLOG = GLOB;\n"
324 "namespace na {\n"
Eric Liu68765a82016-09-21 15:06:12 +0000325 "namespace nc {\n"
326 "class SAME {};\n"
327 "}\n"
328 "namespace nd {\n"
329 "class SAME {};\n"
330 "}\n"
331 "\n"
332 "} // namespace na\n"
333 "namespace x {\n"
334 "namespace y {\n"
335 "using ::na::nc::SAME;\n"
336 "using YO = na::nc::SAME;\n"
337 "typedef na::nc::SAME IDENTICAL;\n"
338 "void f(na::nd::SAME Same) {}\n"
339 "} // namespace y\n"
340 "} // namespace x\n";
341 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
342}
343
Eric Liu912d0392016-09-27 12:54:48 +0000344TEST_F(ChangeNamespaceTest, UsingShadowDeclInFunction) {
345 std::string Code = "namespace glob {\n"
346 "class Glob {};\n"
347 "}\n"
348 "namespace na {\n"
349 "namespace nb {\n"
350 "void f() {\n"
351 " using glob::Glob;\n"
352 " Glob g;\n"
353 "}\n"
354 "} // namespace nb\n"
355 "} // namespace na\n";
356
357 // FIXME: don't add namespace qualifier when there is UsingShadowDecl.
358 std::string Expected = "namespace glob {\n"
359 "class Glob {};\n"
360 "}\n"
361 "\n"
362 "namespace x {\n"
363 "namespace y {\n"
364 "void f() {\n"
365 " using ::glob::Glob;\n"
366 " glob::Glob g;\n"
367 "}\n"
368 "} // namespace y\n"
369 "} // namespace x\n";
370 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
371}
372
373TEST_F(ChangeNamespaceTest, UsingShadowDeclInGlobal) {
374 std::string Code = "namespace glob {\n"
375 "class Glob {};\n"
376 "}\n"
377 "using glob::Glob;\n"
378 "namespace na {\n"
379 "namespace nb {\n"
380 "void f() { Glob g; }\n"
381 "} // namespace nb\n"
382 "} // namespace na\n";
383
384 // FIXME: don't add namespace qualifier when there is UsingShadowDecl.
385 std::string Expected = "namespace glob {\n"
386 "class Glob {};\n"
387 "}\n"
388 "using glob::Glob;\n"
389 "\n"
390 "namespace x {\n"
391 "namespace y {\n"
392 "void f() { glob::Glob g; }\n"
393 "} // namespace y\n"
394 "} // namespace x\n";
395 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
396}
397
398TEST_F(ChangeNamespaceTest, UsingNamespace) {
399 std::string Code = "namespace glob {\n"
400 "class Glob {};\n"
401 "}\n"
402 "using namespace glob;\n"
403 "namespace na {\n"
404 "namespace nb {\n"
405 "void f() { Glob g; }\n"
406 "} // namespace nb\n"
407 "} // namespace na\n";
408
409 // FIXME: don't add namespace qualifier when there is "using namespace" decl.
410 std::string Expected = "namespace glob {\n"
411 "class Glob {};\n"
412 "}\n"
413 "using namespace glob;\n"
414 "\n"
415 "namespace x {\n"
416 "namespace y {\n"
417 "void f() { glob::Glob g; }\n"
418 "} // namespace y\n"
419 "} // namespace x\n";
420 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
421}
422
Eric Liu68765a82016-09-21 15:06:12 +0000423TEST_F(ChangeNamespaceTest, TypeInNestedNameSpecifier) {
424 std::string Code =
425 "namespace na {\n"
426 "class C_A {\n"
427 "public:\n"
428 " class Nested {\n"
429 " public:\n"
430 " static int NestedX;\n"
431 " static void nestedFunc() {}\n"
432 " };\n"
433 "};\n"
434 "namespace nb {\n"
435 "class C_X {\n"
436 " C_A na;\n"
437 " C_A::Nested nested;\n"
438 " void f() {\n"
439 " C_A::Nested::nestedFunc();\n"
440 " int X = C_A::Nested::NestedX;\n"
441 " }\n"
442 "};\n"
443 "} // namespace nb\n"
444 "} // namespace na\n";
445 std::string Expected =
446 "namespace na {\n"
447 "class C_A {\n"
448 "public:\n"
449 " class Nested {\n"
450 " public:\n"
451 " static int NestedX;\n"
452 " static void nestedFunc() {}\n"
453 " };\n"
454 "};\n"
455 "\n"
456 "} // namespace na\n"
457 "namespace x {\n"
458 "namespace y {\n"
459 "class C_X {\n"
460 " na::C_A na;\n"
461 " na::C_A::Nested nested;\n"
462 " void f() {\n"
463 " na::C_A::Nested::nestedFunc();\n"
464 " int X = na::C_A::Nested::NestedX;\n"
465 " }\n"
466 "};\n"
467 "} // namespace y\n"
468 "} // namespace x\n";
469 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
470}
471
Eric Liu12068d82016-09-22 11:54:00 +0000472TEST_F(ChangeNamespaceTest, FixFunctionNameSpecifiers) {
473 std::string Code =
474 "namespace na {\n"
475 "class A {\n"
476 "public:\n"
477 " static void f() {}\n"
478 " static void g();\n"
479 "};\n"
480 "void A::g() {}"
481 "void a_f() {}\n"
482 "static void static_f() {}\n"
483 "namespace nb {\n"
484 "void f() { a_f(); static_f(); A::f(); }\n"
485 "void g() { f(); A::g(); }\n"
486 "} // namespace nb\n"
487 "} // namespace na\n";
488 std::string Expected =
489 "namespace na {\n"
490 "class A {\n"
491 "public:\n"
492 " static void f() {}\n"
493 " static void g();\n"
494 "};\n"
495 "void A::g() {}"
496 "void a_f() {}\n"
497 "static void static_f() {}\n"
498 "\n"
499 "} // namespace na\n"
500 "namespace x {\n"
501 "namespace y {\n"
502 "void f() { na::a_f(); na::static_f(); na::A::f(); }\n"
503 "void g() { f(); na::A::g(); }\n"
504 "} // namespace y\n"
505 "} // namespace x\n";
506 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
507}
508
Eric Liu159f0132016-09-30 04:32:39 +0000509TEST_F(ChangeNamespaceTest, MoveAndFixGlobalVariables) {
510 std::string Code = "namespace na {\n"
511 "int GlobA;\n"
512 "static int GlobAStatic = 0;\n"
513 "namespace nc { int GlobC; }\n"
514 "namespace nb {\n"
515 "int GlobB;\n"
516 "void f() {\n"
517 " int a = GlobA;\n"
518 " int b = GlobAStatic;\n"
519 " int c = nc::GlobC;\n"
520 "}\n"
521 "} // namespace nb\n"
522 "} // namespace na\n";
523
524 std::string Expected = "namespace na {\n"
525 "int GlobA;\n"
526 "static int GlobAStatic = 0;\n"
527 "namespace nc { int GlobC; }\n"
528 "\n"
529 "} // namespace na\n"
530 "namespace x {\n"
531 "namespace y {\n"
532 "int GlobB;\n"
533 "void f() {\n"
534 " int a = na::GlobA;\n"
535 " int b = na::GlobAStatic;\n"
536 " int c = na::nc::GlobC;\n"
537 "}\n"
538 "} // namespace y\n"
539 "} // namespace x\n";
540
541 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
542}
543
544TEST_F(ChangeNamespaceTest, DoNotFixStaticVariableOfClass) {
545 std::string Code = "namespace na {\n"
546 "class A {\n"
547 "public:\n"
548 "static int A1;\n"
549 "static int A2;\n"
550 "}\n"
551 "static int A::A1 = 0;\n"
552 "namespace nb {\n"
553 "void f() { int a = A::A1; int b = A::A2; }"
554 "} // namespace nb\n"
555 "} // namespace na\n";
556
557 std::string Expected = "namespace na {\n"
558 "class A {\n"
559 "public:\n"
560 "static int A1;\n"
561 "static int A2;\n"
562 "}\n"
563 "static int A::A1 = 0;\n"
564 "\n"
565 "} // namespace na\n"
566 "namespace x {\n"
567 "namespace y {\n"
568 "void f() { int a = na::A::A1; int b = na::A::A2; }"
569 "} // namespace y\n"
570 "} // namespace x\n";
571
572 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
573}
574
Haojian Wuef8a6dc2016-10-04 10:35:53 +0000575TEST_F(ChangeNamespaceTest, NoMisplaceAtEOF) {
576 std::string Code = "namespace na {\n"
577 "namespace nb {\n"
578 "class A;\n"
579 "class B {};\n"
580 "}"
581 "}";
582 std::string Expected = "namespace na {\n"
583 "namespace nb {\n"
584 "class A;\n"
585 "}\n"
586 "}\n"
587 "namespace x {\n"
588 "namespace y {\n"
589 "\n"
590 "class B {};\n"
591 "} // namespace y\n"
592 "} // namespace x\n";
593 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
594}
595
Eric Liu73f49fd2016-10-12 12:34:18 +0000596TEST_F(ChangeNamespaceTest, CommentsBeforeMovedClass) {
597 std::string Code = "namespace na {\n"
598 "namespace nb {\n"
599 "\n\n"
600 "// Wild comments.\n"
601 "\n"
602 "// Comments.\n"
603 "// More comments.\n"
604 "class B {\n"
605 " // Private comments.\n"
606 " int a;\n"
607 "};\n"
608 "}\n"
609 "}";
610 std::string Expected = "\n"
611 "\n"
612 "namespace x {\n"
613 "namespace y {\n"
614 "\n\n"
615 "// Wild comments.\n"
616 "\n"
617 "// Comments.\n"
618 "// More comments.\n"
619 "class B {\n"
620 " // Private comments.\n"
621 " int a;\n"
622 "};\n"
623 "} // namespace y\n"
624 "} // namespace x\n";
625 EXPECT_EQ(format(Expected), runChangeNamespaceOnCode(Code));
626}
627
Eric Liu495b2112016-09-19 17:40:32 +0000628} // anonymous namespace
629} // namespace change_namespace
630} // namespace clang