[clang-tidy] Make clang-format and include-order-check coherent

[kadircet]

Summary

LLVM style puts both gtest and gmock to the end of the include list.
But llvm-include-order-check was only moving gtest headers to the end, resulting
in a false tidy-warning.

[kadircet]

• Add gmock header

[njames93]

Thanks for fixing this, been bugging me for a while.

clang-tools-extra/test/clang-tidy/checkers/llvm-include-order.cpp

1

Would it be wise to specify a format style here to ensure they align. Better yet 2 run lines, one that runs clang-tidy with no format, the other specifies a format.

[kadircet]

clang-tools-extra/test/clang-tidy/checkers/llvm-include-order.cpp

1

ah sorry, i missed this comment :/ i am not sure how the formatting vs. generated edits interact. is it enough to have --format-style=LLVM and ensure the run lines produce the same ordering?

[njames93]

clang-tools-extra/test/clang-tidy/checkers/llvm-include-order.cpp

1

Just noticed they still don't seem to sync up, but thats because llvm-include-order doesn't move the first include in a file. Could argue that's a bug and instead should use a heuristic based on the translation unit name and header name.

clang-tools-extra/clang-tidy/llvm/IncludeOrderCheck.cpp

if (IsMainModule)
     return 0;
 
   // LLVM and clang headers are in the penultimate position.
   if (Filename.startswith("llvm/") || Filename.startswith("llvm-c/") ||
       Filename.startswith("clang/") || Filename.startswith("clang-c/"))
     return 2;
 
   // System headers are sorted to the end.
-  if (IsAngled || Filename.startswith("gtest/"))
+  if (IsAngled || Filename.startswith("gtest/") ||
+      Filename.startswith("gmock/"))
     return 3;
 
   // Other headers are inserted between the main module header and LLVM headers.
   return 1;
 }
 
 void IncludeOrderPPCallbacks::InclusionDirective(
     SourceLocation HashLoc, const Token &IncludeTok, StringRef FileName,

clang-tools-extra/test/clang-tidy/checkers/llvm-include-order.cpp

 // RUN: %check_clang_tidy %s llvm-include-order %t -- -- -isystem %S/Inputs/Headers
 
 // CHECK-MESSAGES: [[@LINE+2]]:1: warning: #includes are not sorted properly
 #include "j.h"
 #include "gtest/foo.h"
+#include "gmock/foo.h"
 #include "i.h"
 #include <s.h>
 #include "llvm/a.h"
 #include "clang/b.h"
 #include "clang-c/c.h" // hi
 #include "llvm-c/d.h" // -c
 
 // CHECK-FIXES: #include "j.h"
 // CHECK-FIXES-NEXT: #include "i.h"
 // CHECK-FIXES-NEXT: #include "clang-c/c.h" // hi
 // CHECK-FIXES-NEXT: #include "clang/b.h"
 // CHECK-FIXES-NEXT: #include "llvm-c/d.h" // -c
 // CHECK-FIXES-NEXT: #include "llvm/a.h"
+// CHECK-FIXES-NEXT: #include "gmock/foo.h"
 // CHECK-FIXES-NEXT: #include "gtest/foo.h"
 // CHECK-FIXES-NEXT: #include <s.h>
 
 #include "b.h"
 #ifdef FOO
 #include "a.h"
 #endif