[clang-doc] Add unit tests for merging

[juliehockett]

Summary

This is part of a move to convert clang-doc's tests to a more maintainable unit test framework, with a smaller number of integration tests to maintain and more granular failure feedback.

[jakehehrlich]

clang-tools-extra/unittests/clang-doc/MergeTest.cpp

222

Use {} not () on both SmallString and Location (and any other constructors)

clang-tools-extra/unittests/clang-doc/CMakeLists.txt

 set(LLVM_LINK_COMPONENTS
   support
   BitReader
   BitWriter
   )
 
 get_filename_component(CLANG_DOC_SOURCE_DIR
   ${CMAKE_CURRENT_SOURCE_DIR}/../../clang-doc REALPATH)
 include_directories(
   ${CLANG_DOC_SOURCE_DIR}
   )
 
 add_extra_unittest(ClangDocTests
   BitcodeTest.cpp
   ClangDocTest.cpp
+  MergeTest.cpp
   SerializeTest.cpp
   )
 
 target_link_libraries(ClangDocTests
   PRIVATE
   clangAST
   clangASTMatchers
   clangBasic
   clangDoc
   clangFormat
   clangFrontend
   clangRewrite
   clangTooling
   clangToolingCore
   )

clang-tools-extra/unittests/clang-doc/MergeTest.cpp

+//===-- clang-doc/MergeTest.cpp -------------------------------------------===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+#include "ClangDocTest.h"
+#include "Representation.h"
+#include "gtest/gtest.h"
+
+namespace clang {
+namespace doc {
+
+TEST(MergeTest, mergeNamespaceInfos) {
+  NamespaceInfo One;
+  One.Name = "Namespace";
+  One.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  One.ChildNamespaces.emplace_back(NonEmptySID, "ChildNamespace",
+                                   InfoType::IT_namespace);
+  One.ChildRecords.emplace_back(NonEmptySID, "ChildStruct",
+                                InfoType::IT_record);
+  One.ChildFunctions.emplace_back();
+  One.ChildFunctions.back().Name = "OneFunction";
+  One.ChildFunctions.back().USR = NonEmptySID;
+  One.ChildEnums.emplace_back();
+  One.ChildEnums.back().Name = "OneEnum";
+  One.ChildEnums.back().USR = NonEmptySID;
+
+  NamespaceInfo Two;
+  Two.Name = "Namespace";
+  Two.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  Two.ChildNamespaces.emplace_back(EmptySID, "OtherChildNamespace",
+                                   InfoType::IT_namespace);
+  Two.ChildRecords.emplace_back(EmptySID, "OtherChildStruct",
+                                InfoType::IT_record);
+  Two.ChildFunctions.emplace_back();
+  Two.ChildFunctions.back().Name = "TwoFunction";
+  Two.ChildEnums.emplace_back();
+  Two.ChildEnums.back().Name = "TwoEnum";
+
+  std::vector<std::unique_ptr<Info>> Infos;
+  Infos.emplace_back(llvm::make_unique<NamespaceInfo>(std::move(One)));
+  Infos.emplace_back(llvm::make_unique<NamespaceInfo>(std::move(Two)));
+
+  auto Expected = llvm::make_unique<NamespaceInfo>();
+  Expected->Name = "Namespace";
+  Expected->Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  Expected->ChildNamespaces.emplace_back(NonEmptySID, "ChildNamespace",
+                                         InfoType::IT_namespace);
+  Expected->ChildRecords.emplace_back(NonEmptySID, "ChildStruct",
+                                      InfoType::IT_record);
+  Expected->ChildNamespaces.emplace_back(EmptySID, "OtherChildNamespace",
+                                         InfoType::IT_namespace);
+  Expected->ChildRecords.emplace_back(EmptySID, "OtherChildStruct",
+                                      InfoType::IT_record);
+  Expected->ChildFunctions.emplace_back();
+  Expected->ChildFunctions.back().Name = "OneFunction";
+  Expected->ChildFunctions.back().USR = NonEmptySID;
+  Expected->ChildFunctions.emplace_back();
+  Expected->ChildFunctions.back().Name = "TwoFunction";
+  Expected->ChildEnums.emplace_back();
+  Expected->ChildEnums.back().Name = "OneEnum";
+  Expected->ChildEnums.back().USR = NonEmptySID;
+  Expected->ChildEnums.emplace_back();
+  Expected->ChildEnums.back().Name = "TwoEnum";
+
+  auto Actual = mergeInfos(Infos);
+  assert(Actual);
+  CheckNamespaceInfo(InfoAsNamespace(Expected.get()),
+                     InfoAsNamespace(Actual.get().get()));
+}
+
+TEST(MergeTest, mergeRecordInfos) {
+  RecordInfo One;
+  One.Name = "r";
+  One.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  One.DefLoc = Location(10, llvm::SmallString<16>("test.cpp"));
+
+  One.Members.emplace_back("int", "X", AccessSpecifier::AS_private);
+  One.TagType = TagTypeKind::TTK_Class;
+  One.Parents.emplace_back(EmptySID, "F", InfoType::IT_record);
+  One.VirtualParents.emplace_back(EmptySID, "G", InfoType::IT_record);
+
+  One.ChildRecords.emplace_back(NonEmptySID, "ChildStruct",
+                                InfoType::IT_record);
+  One.ChildFunctions.emplace_back();
+  One.ChildFunctions.back().Name = "OneFunction";
+  One.ChildFunctions.back().USR = NonEmptySID;
+  One.ChildEnums.emplace_back();
+  One.ChildEnums.back().Name = "OneEnum";
+  One.ChildEnums.back().USR = NonEmptySID;
+
+  RecordInfo Two;
+  Two.Name = "r";
+  Two.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  Two.Loc.emplace_back(12, llvm::SmallString<16>("test.cpp"));
+
+  Two.TagType = TagTypeKind::TTK_Class;
+
+  Two.ChildRecords.emplace_back(EmptySID, "OtherChildStruct",
+                                InfoType::IT_record);
+  Two.ChildFunctions.emplace_back();
+  Two.ChildFunctions.back().Name = "TwoFunction";
+  Two.ChildEnums.emplace_back();
+  Two.ChildEnums.back().Name = "TwoEnum";
+
+  std::vector<std::unique_ptr<Info>> Infos;
+  Infos.emplace_back(llvm::make_unique<RecordInfo>(std::move(One)));
+  Infos.emplace_back(llvm::make_unique<RecordInfo>(std::move(Two)));
+
+  auto Expected = llvm::make_unique<RecordInfo>();
+  Expected->Name = "r";
+  Expected->Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  Expected->DefLoc = Location(10, llvm::SmallString<16>("test.cpp"));
+  Expected->Loc.emplace_back(12, llvm::SmallString<16>("test.cpp"));
+
+  Expected->Members.emplace_back("int", "X", AccessSpecifier::AS_private);
+  Expected->TagType = TagTypeKind::TTK_Class;
+  Expected->Parents.emplace_back(EmptySID, "F", InfoType::IT_record);
+  Expected->VirtualParents.emplace_back(EmptySID, "G", InfoType::IT_record);
+
+  Expected->ChildRecords.emplace_back(NonEmptySID, "ChildStruct",
+                                      InfoType::IT_record);
+  Expected->ChildRecords.emplace_back(EmptySID, "OtherChildStruct",
+                                      InfoType::IT_record);
+  Expected->ChildFunctions.emplace_back();
+  Expected->ChildFunctions.back().Name = "OneFunction";
+  Expected->ChildFunctions.back().USR = NonEmptySID;
+  Expected->ChildFunctions.emplace_back();
+  Expected->ChildFunctions.back().Name = "TwoFunction";
+  Expected->ChildEnums.emplace_back();
+  Expected->ChildEnums.back().Name = "OneEnum";
+  Expected->ChildEnums.back().USR = NonEmptySID;
+  Expected->ChildEnums.emplace_back();
+  Expected->ChildEnums.back().Name = "TwoEnum";
+
+  auto Actual = mergeInfos(Infos);
+  assert(Actual);
+  CheckRecordInfo(InfoAsRecord(Expected.get()),
+                  InfoAsRecord(Actual.get().get()));
+}
+
+TEST(MergeTest, mergeFunctionInfos) {
+  FunctionInfo One;
+  One.Name = "f";
+  One.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  One.DefLoc = Location(10, llvm::SmallString<16>("test.cpp"));
+  One.Loc.emplace_back(12, llvm::SmallString<16>("test.cpp"));
+
+  One.IsMethod = true;
+  One.Parent = Reference(EmptySID, "Parent", InfoType::IT_namespace);
+
+  FunctionInfo Two;
+  Two.Name = "f";
+  Two.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  Two.Loc.emplace_back(20, llvm::SmallString<16>("test.cpp"));
+
+  Two.ReturnType = TypeInfo(EmptySID, "void", InfoType::IT_default);
+  Two.Params.emplace_back("int", "P");
+
+  std::vector<std::unique_ptr<Info>> Infos;
+  Infos.emplace_back(llvm::make_unique<FunctionInfo>(std::move(One)));
+  Infos.emplace_back(llvm::make_unique<FunctionInfo>(std::move(Two)));
+
+  auto Expected = llvm::make_unique<FunctionInfo>();
+  Expected->Name = "f";
+  Expected->Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  Expected->DefLoc = Location(10, llvm::SmallString<16>("test.cpp"));
+  Expected->Loc.emplace_back(12, llvm::SmallString<16>("test.cpp"));
+  Expected->Loc.emplace_back(20, llvm::SmallString<16>("test.cpp"));
+
+  Expected->ReturnType = TypeInfo(EmptySID, "void", InfoType::IT_default);
+  Expected->Params.emplace_back("int", "P");
+  Expected->IsMethod = true;
+  Expected->Parent = Reference(EmptySID, "Parent", InfoType::IT_namespace);
+
+  auto Actual = mergeInfos(Infos);
+  assert(Actual);
+  CheckFunctionInfo(InfoAsFunction(Expected.get()),
+                    InfoAsFunction(Actual.get().get()));
+}
+
+TEST(MergeTest, mergeEnumInfos) {
+  EnumInfo One;
+  One.Name = "e";
+  One.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  One.DefLoc = Location(10, llvm::SmallString<16>("test.cpp"));
+  One.Loc.emplace_back(12, llvm::SmallString<16>("test.cpp"));
+
+  One.Scoped = true;
+
+  EnumInfo Two;
+  Two.Name = "e";
+  Two.Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  Two.Loc.emplace_back(20, llvm::SmallString<16>("test.cpp"));
+
+  Two.Members.emplace_back("X");
+  Two.Members.emplace_back("Y");
+
+  std::vector<std::unique_ptr<Info>> Infos;
+  Infos.emplace_back(llvm::make_unique<EnumInfo>(std::move(One)));
+  Infos.emplace_back(llvm::make_unique<EnumInfo>(std::move(Two)));
+
+  auto Expected = llvm::make_unique<EnumInfo>();
+  Expected->Name = "e";
+  Expected->Namespace.emplace_back(EmptySID, "A", InfoType::IT_namespace);
+
+  Expected->DefLoc = Location(10, llvm::SmallString<16>("test.cpp"));
+  Expected->Loc.emplace_back(12, llvm::SmallString<16>("test.cpp"));
+  Expected->Loc.emplace_back(20, llvm::SmallString<16>("test.cpp"));
+
+  Expected->Members.emplace_back("X");
+  Expected->Members.emplace_back("Y");
+  Expected->Scoped = true;
+
+  auto Actual = mergeInfos(Infos);
+  assert(Actual);
+  CheckEnumInfo(InfoAsEnum(Expected.get()), InfoAsEnum(Actual.get().get()));
+}
+
+} // namespace doc
+} // namespace clang