[clang-rename] Introduce an unittest skeleton for clang-rename.

[hokein]

Summary

This will make references rename tests easier.

[hokein]

Add missing license.

[ioeric]

lg

unittests/clang-rename/ClangRenameTests.cpp

92

I'd put EXPECT_EQ in test cases so that it would be easier to see which case fails. Maybe pull out a function for wrapping Expected and EXPECT_EQ on the formatted result and format(Actual)?

[hokein]

unittests/clang-rename/ClangRenameTests.cpp

92

I don't see a strong benefit of it. As our test cases are generated by INSTANTIATE_TEST_CASE_P, pulling out this function doesn't make the failure output much clearer; this will also save us some keystrokes. I'd keep it at the moment.

unittests/CMakeLists.txt

 add_custom_target(ExtraToolsUnitTests)
 set_target_properties(ExtraToolsUnitTests PROPERTIES FOLDER "Extra Tools Unit Tests")
 
 function(add_extra_unittest test_dirname)
   add_unittest(ExtraToolsUnitTests ${test_dirname} ${ARGN})
 endfunction()
 
 add_subdirectory(change-namespace)
 add_subdirectory(clang-apply-replacements)
 add_subdirectory(clang-move)
 add_subdirectory(clang-query)
 add_subdirectory(clang-tidy)
+add_subdirectory(clang-rename)
 add_subdirectory(include-fixer)

unittests/clang-rename/CMakeLists.txt

+set(LLVM_LINK_COMPONENTS
+  support
+  )
+
+get_filename_component(CLANG_RENAME_SOURCE_DIR
+  ${CMAKE_CURRENT_SOURCE_DIR}/../../clang-rename REALPATH)
+include_directories(
+  ${CLANG_RENAME_SOURCE_DIR}
+  )
+
+# We'd like clang/unittests/Tooling/RewriterTestContext.h in the test.
+include_directories(${CLANG_SOURCE_DIR})
+
+add_extra_unittest(ClangRenameTests
+  ClangRenameTests.cpp
+  )
+
+target_link_libraries(ClangRenameTests
+  clangAST
+  clangASTMatchers
+  clangBasic
+  clangFormat
+  clangFrontend
+  clangRename
+  clangRewrite
+  clangTooling
+  clangToolingCore
+  )

unittests/clang-rename/ClangRenameTests.cpp

+#include "RenamingAction.h"
+#include "USRFindingAction.h"
+#include "unittests/Tooling/RewriterTestContext.h"
+#include "clang/ASTMatchers/ASTMatchFinder.h"
+#include "clang/Basic/FileManager.h"
+#include "clang/Basic/FileSystemOptions.h"
+#include "clang/Basic/VirtualFileSystem.h"
+#include "clang/Format/Format.h"
+#include "clang/Frontend/CompilerInstance.h"
+#include "clang/Frontend/PCHContainerOperations.h"
+#include "clang/Tooling/Refactoring.h"
+#include "clang/Tooling/Tooling.h"
+#include "llvm/ADT/IntrusiveRefCntPtr.h"
+#include "llvm/ADT/StringRef.h"
+#include "llvm/Support/Format.h"
+#include "llvm/Support/MemoryBuffer.h"
+#include "gtest/gtest.h"
+#include <memory>
+#include <string>
+#include <vector>
+
+namespace clang {
+namespace clang_rename {
+namespace {
+
+struct Case {
+  std::string Before;
+  std::string After;
+};
+
+class ClangRenameTest : public testing::Test,
+                        public testing::WithParamInterface<Case> {
+protected:
+  void AppendToHeader(StringRef Code) {
+    HeaderContent += Code.str();
+  }
+
+  std::string runClangRenameOnCode(llvm::StringRef Code,
+                                   llvm::StringRef OldName,
+                                   llvm::StringRef NewName) {
+    std::string NewCode;
+    llvm::raw_string_ostream(NewCode) << llvm::format(
+        "#include \"%s\"\n%s", HeaderName.c_str(), Code.str().c_str());
+    tooling::FileContentMappings FileContents = {{HeaderName, HeaderContent},
+                                                 {CCName, NewCode}};
+    clang::RewriterTestContext Context;
+    Context.createInMemoryFile(HeaderName, HeaderContent);
+    clang::FileID InputFileID = Context.createInMemoryFile(CCName, NewCode);
+
+    rename::USRFindingAction FindingAction({}, {OldName});
+    std::unique_ptr<tooling::FrontendActionFactory> USRFindingActionFactory =
+        tooling::newFrontendActionFactory(&FindingAction);
+
+    if (!tooling::runToolOnCodeWithArgs(
+            USRFindingActionFactory->create(), NewCode, {"-std=c++11"}, CCName,
+            "clang-rename", std::make_shared<PCHContainerOperations>(),
+            FileContents))
+      return "";
+
+    const std::vector<std::vector<std::string>> &USRList =
+        FindingAction.getUSRList();
+    const std::vector<std::string> &PrevNames = FindingAction.getUSRSpellings();
+    std::vector<std::string> NewNames = {NewName};
+    std::map<std::string, tooling::Replacements> FileToReplacements;
+    rename::RenamingAction RenameAction(NewNames, PrevNames, USRList,
+                                        FileToReplacements);
+    auto RenameActionFactory = tooling::newFrontendActionFactory(&RenameAction);
+    if (!tooling::runToolOnCodeWithArgs(
+            RenameActionFactory->create(), NewCode, {"-std=c++11"}, CCName,
+            "clang-rename", std::make_shared<PCHContainerOperations>(),
+            FileContents))
+      return "";
+
+    formatAndApplyAllReplacements(FileToReplacements, Context.Rewrite, "llvm");
+    return Context.getRewrittenText(InputFileID);
+  }
+
+  void CompareSnippets(StringRef Expected, StringRef Actual) {
+    std::string ExpectedCode;
+    llvm::raw_string_ostream(ExpectedCode) << llvm::format(
+        "#include \"%s\"\n%s", HeaderName.c_str(), Expected.str().c_str());
+    EXPECT_EQ(format(ExpectedCode), format(Actual));
+  }
+
+  std::string format(llvm::StringRef Code) {
+    tooling::Replacements Replaces = format::reformat(
+        format::getLLVMStyle(), Code, {tooling::Range(0, Code.size())});
+    auto ChangedCode = tooling::applyAllReplacements(Code, Replaces);
+    EXPECT_TRUE(static_cast<bool>(ChangedCode));
+    if (!ChangedCode) {
+      llvm::errs() << llvm::toString(ChangedCode.takeError());
+      return "";
+    }
+    return *ChangedCode;
+  }
+
+  std::string HeaderContent;
+  std::string HeaderName = "header.h";
+  std::string CCName = "input.cc";
+};
+
+class RenameClassTest : public ClangRenameTest {
+ public:
+  RenameClassTest() {
+    AppendToHeader("\nclass Foo {};\n");
+  }
+};
+
+INSTANTIATE_TEST_CASE_P(
+    RenameTests, RenameClassTest,
+    testing::ValuesIn(std::vector<Case>({
+      {"Foo f;", "Bar f;"},
+      {"void f(Foo f) {}", "void f(Bar f) {}"},
+      {"void f(Foo *f) {}", "void f(Bar *f) {}"},
+      {"Foo f() { return Foo(); }", "Bar f() { return Bar(); }"},
+    })));
+
+TEST_P(RenameClassTest, RenameClasses) {
+  auto Param = GetParam();
+  std::string OldName = "Foo";
+  std::string NewName = "Bar";
+  std::string Actual = runClangRenameOnCode(Param.Before, OldName, NewName);
+  CompareSnippets(Param.After, Actual);
+}
+
+class RenameFunctionTest : public ClangRenameTest {};
+
+INSTANTIATE_TEST_CASE_P(
+    RenameTests, RenameFunctionTest,
+    testing::ValuesIn(std::vector<Case>({
+      {"void func1() {}", "void func2() {}"},
+    })));
+
+TEST_P(RenameFunctionTest, RenameFunctions) {
+  auto Param = GetParam();
+  std::string OldName = "func1";
+  std::string NewName = "func2";
+  std::string Actual = runClangRenameOnCode(Param.Before, OldName, NewName);
+  CompareSnippets(Param.After, Actual);
+}
+
+} // anonymous namespace
+} // namespace clang_rename
+} // namesdpace clang