From 9eb8c92b526b13491565585b0d33159d624bf811 Mon Sep 17 00:00:00 2001
From: Alexander Kornienko <alexfh@google.com>
Date: Tue, 8 Apr 2014 12:27:49 +0000
Subject: [PATCH] Output clang-tidy errors in a consistent order.

Summary: Sort errors by path, file offset and message.

Reviewers: djasper, klimek

Reviewed By: djasper

CC: cfe-commits

Differential Revision: http://reviews.llvm.org/D3314

llvm-svn: 205759
---
 .../ClangTidyDiagnosticConsumer.cpp           |  7 ++--
 .../unittests/clang-tidy/CMakeLists.txt       |  1 +
 .../ClangTidyDiagnosticConsumerTest.cpp       | 33 +++++++++++++++++++
 .../unittests/clang-tidy/ClangTidyTest.h      | 10 ++++--
 4 files changed, 46 insertions(+), 5 deletions(-)
 create mode 100644 clang-tools-extra/unittests/clang-tidy/ClangTidyDiagnosticConsumerTest.cpp

diff --git a/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.cpp b/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.cpp
index 0d1180dacbe4..44d35d974752 100644
--- a/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.cpp
+++ b/clang-tools-extra/clang-tidy/ClangTidyDiagnosticConsumer.cpp
@@ -239,10 +239,11 @@ void ClangTidyDiagnosticConsumer::finish() {
   finalizeLastError();
   std::set<const ClangTidyError*, LessClangTidyError> UniqueErrors;
   for (const ClangTidyError &Error : Errors) {
-    if (Context.getChecksFilter().isCheckEnabled(Error.CheckName) &&
-        UniqueErrors.insert(&Error).second)
-      Context.storeError(Error);
+    if (Context.getChecksFilter().isCheckEnabled(Error.CheckName))
+      UniqueErrors.insert(&Error);
   }
+  for (const ClangTidyError *Error : UniqueErrors)
+    Context.storeError(*Error);
   Errors.clear();
 }
 
diff --git a/clang-tools-extra/unittests/clang-tidy/CMakeLists.txt b/clang-tools-extra/unittests/clang-tidy/CMakeLists.txt
index 5d29b0f9e8f0..fc1217d6a365 100644
--- a/clang-tools-extra/unittests/clang-tidy/CMakeLists.txt
+++ b/clang-tools-extra/unittests/clang-tidy/CMakeLists.txt
@@ -7,6 +7,7 @@ get_filename_component(CLANG_LINT_SOURCE_DIR
 include_directories(${CLANG_LINT_SOURCE_DIR})
 
 add_extra_unittest(ClangTidyTests
+  ClangTidyDiagnosticConsumerTest.cpp
   LLVMModuleTest.cpp
   GoogleModuleTest.cpp
   MiscModuleTest.cpp)
diff --git a/clang-tools-extra/unittests/clang-tidy/ClangTidyDiagnosticConsumerTest.cpp b/clang-tools-extra/unittests/clang-tidy/ClangTidyDiagnosticConsumerTest.cpp
new file mode 100644
index 000000000000..08255a62ef90
--- /dev/null
+++ b/clang-tools-extra/unittests/clang-tidy/ClangTidyDiagnosticConsumerTest.cpp
@@ -0,0 +1,33 @@
+#include "ClangTidy.h"
+#include "ClangTidyTest.h"
+#include "gtest/gtest.h"
+
+namespace clang {
+namespace tidy {
+namespace test {
+
+class TestCheck : public ClangTidyCheck {
+public:
+  void registerMatchers(ast_matchers::MatchFinder *Finder) override {
+    Finder->addMatcher(ast_matchers::varDecl().bind("var"), this);
+  }
+  void check(const ast_matchers::MatchFinder::MatchResult &Result) override {
+    const VarDecl *Var = Result.Nodes.getNodeAs<VarDecl>("var");
+    // Add diagnostics in the wrong order.
+    diag(Var->getLocation(), "variable");
+    diag(Var->getTypeSpecStartLoc(), "type specifier");
+  }
+};
+
+TEST(ClangTidyDiagnosticConsumer, SortsErrors) {
+  SmallVector<ClangTidyError, 8> Errors;
+  runCheckOnCode<TestCheck>("int a;", Errors);
+  EXPECT_EQ(2ul, Errors.size());
+  // FIXME: Remove " []" once the check name is removed from the message text.
+  EXPECT_EQ("type specifier []", Errors[0].Message.Message);
+  EXPECT_EQ("variable []", Errors[1].Message.Message);
+}
+
+} // namespace test
+} // namespace tidy
+} // namespace clang
diff --git a/clang-tools-extra/unittests/clang-tidy/ClangTidyTest.h b/clang-tools-extra/unittests/clang-tidy/ClangTidyTest.h
index 06d5c720eeb5..8b3d9c6a6bf7 100644
--- a/clang-tools-extra/unittests/clang-tidy/ClangTidyTest.h
+++ b/clang-tools-extra/unittests/clang-tidy/ClangTidyTest.h
@@ -39,9 +39,10 @@ private:
   ClangTidyContext *Context;
 };
 
-template <typename T> std::string runCheckOnCode(StringRef Code) {
+template <typename T>
+std::string runCheckOnCode(StringRef Code,
+                           SmallVectorImpl<ClangTidyError> &Errors) {
   T Check;
-  SmallVector<ClangTidyError, 16> Errors;
   ClangTidyContext Context(&Errors, ".*", "");
   ClangTidyDiagnosticConsumer DiagConsumer(Context);
   Check.setContext(&Context);
@@ -65,6 +66,11 @@ template <typename T> std::string runCheckOnCode(StringRef Code) {
   return tooling::applyAllReplacements(Code, Fixes);
 }
 
+template <typename T> std::string runCheckOnCode(StringRef Code) {
+  SmallVector<ClangTidyError, 16> Errors;
+  return runCheckOnCode<T>(Code, Errors);
+}
+
 } // namespace test
 } // namespace tidy
 } // namespace clang