ClangTidyDiagnosticConsumerTest.cpp

#include"ClangTidy.h"
#include"ClangTidyTest.h"
#include"gtest/gtest.h"

namespaceclang {
namespacetidy {
namespacetest {

namespace {
classTestCheck : publicClangTidyCheck {
public:
TestCheck(StringRef Name, ClangTidyContext *Context)
 : ClangTidyCheck(Name, Context) {
diag("DiagWithNoLoc");
 }
voidregisterMatchers(ast_matchers::MatchFinder *Finder) override {
 Finder->addMatcher(ast_matchers::varDecl().bind("var"), this);
 }
voidcheck(const ast_matchers::MatchFinder::MatchResult &Result) override {
constauto *Var = Result.Nodes.getNodeAs<VarDecl>("var");
// Add diagnostics in the wrong order.
diag(Var->getLocation(), "variable");
diag(Var->getTypeSpecStartLoc(), "type specifier");
 }
};

classHighlightTestCheck : publicClangTidyCheck {
public:
HighlightTestCheck(StringRef Name, ClangTidyContext *Context)
 : ClangTidyCheck(Name, Context) {}
voidregisterMatchers(ast_matchers::MatchFinder *Finder) override {
 Finder->addMatcher(ast_matchers::varDecl().bind("var"), this);
 }
voidcheck(const ast_matchers::MatchFinder::MatchResult &Result) override {
constauto *Var = Result.Nodes.getNodeAs<VarDecl>("var");
diag(Var->getLocation(), "highlight range") << Var->getSourceRange();
 }
};

classInvalidRangeTestCheck : publicClangTidyCheck {
public:
InvalidRangeTestCheck(StringRef Name, ClangTidyContext *Context)
 : ClangTidyCheck(Name, Context) {}
voidregisterMatchers(ast_matchers::MatchFinder *Finder) override {
 Finder->addMatcher(ast_matchers::varDecl().bind("var"), this);
 }
voidcheck(const ast_matchers::MatchFinder::MatchResult &Result) override {
constauto *Var = Result.Nodes.getNodeAs<VarDecl>("var");
 SourceLocation ValidBeginLoc = Var->getBeginLoc();
 SourceLocation ValidEndLoc = Var->getEndLoc();
 SourceLocation InvalidLoc;
ASSERT_TRUE(ValidBeginLoc.isValid());
ASSERT_TRUE(ValidEndLoc.isValid());
ASSERT_TRUE(InvalidLoc.isInvalid());

diag(ValidBeginLoc, "valid->valid")
 << SourceRange(ValidBeginLoc, ValidEndLoc);
diag(ValidBeginLoc, "valid->invalid")
 << SourceRange(ValidBeginLoc, InvalidLoc);
diag(ValidBeginLoc, "invalid->valid")
 << SourceRange(InvalidLoc, ValidEndLoc);
diag(ValidBeginLoc, "invalid->invalid")
 << SourceRange(InvalidLoc, InvalidLoc);
 }
};

} // namespace

TEST(ClangTidyDiagnosticConsumer, SortsErrors) {
 std::vector<ClangTidyError> Errors;
 runCheckOnCode<TestCheck>("int a;", &Errors);
EXPECT_EQ(3ul, Errors.size());
EXPECT_EQ("DiagWithNoLoc", Errors[0].Message.Message);
EXPECT_EQ("type specifier", Errors[1].Message.Message);
EXPECT_EQ("variable", Errors[2].Message.Message);
}

TEST(ClangTidyDiagnosticConsumer, HandlesSourceRangeHighlight) {
 std::vector<ClangTidyError> Errors;
 runCheckOnCode<HighlightTestCheck>("int abc;", &Errors);
EXPECT_EQ(1ul, Errors.size());
EXPECT_EQ("highlight range", Errors[0].Message.Message);

// int abc;
// ____^
// 01234
EXPECT_EQ(4ul, Errors[0].Message.FileOffset);

// int abc
// ~~~~~~~ -> Length 7. (0-length highlights are nonsensical.)
EXPECT_EQ(1ul, Errors[0].Message.Ranges.size());
EXPECT_EQ(0ul, Errors[0].Message.Ranges[0].FileOffset);
EXPECT_EQ(7ul, Errors[0].Message.Ranges[0].Length);
}

TEST(ClangTidyDiagnosticConsumer, InvalidSourceLocationRangesIgnored) {
 std::vector<ClangTidyError> Errors;
 runCheckOnCode<InvalidRangeTestCheck>("int x;", &Errors);
EXPECT_EQ(4ul, Errors.size());

EXPECT_EQ("invalid->invalid", Errors[0].Message.Message);
EXPECT_TRUE(Errors[0].Message.Ranges.empty());

EXPECT_EQ("invalid->valid", Errors[1].Message.Message);
EXPECT_TRUE(Errors[1].Message.Ranges.empty());

EXPECT_EQ("valid->invalid", Errors[2].Message.Message);
EXPECT_TRUE(Errors[2].Message.Ranges.empty());

EXPECT_EQ("valid->valid", Errors[3].Message.Message);
EXPECT_EQ(1ul, Errors[3].Message.Ranges.size());
}

} // namespace test
} // namespace tidy
} // namespace clang