llvm-capstone/clang-tools-extra/unittests/clang-tidy/ClangTidyDiagnosticConsumerTest.cpp
Balazs Benics 0540485436 [libtooling][clang-tidy] Fix crashing on rendering invalid SourceRanges
Invalid SourceRanges can occur generally if the code does not compile,
thus we expect clang error diagnostics.
Unlike `clang`, `clang-tidy` did not swallow invalid source ranges, but
tried to highlight them, and blow various assertions.

The following two examples produce invalid source ranges, but this is
not a complete list:

  void test(x); // error: unknown type name 'x'
  struct Foo {
    member; // error: C++ requires a type specifier for all declarations
  };

Thanks @whisperity helping me fix this.

Reviewed-By: xazax.hun

Differential Revision: https://reviews.llvm.org/D114254
2021-11-29 09:56:43 +01:00

117 lines
3.9 KiB
C++

#include "ClangTidy.h"
#include "ClangTidyTest.h"
#include "gtest/gtest.h"
namespace clang {
namespace tidy {
namespace test {
namespace {
class TestCheck : public ClangTidyCheck {
public:
TestCheck(StringRef Name, ClangTidyContext *Context)
: ClangTidyCheck(Name, Context) {
diag("DiagWithNoLoc");
}
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 auto *Var = Result.Nodes.getNodeAs<VarDecl>("var");
// Add diagnostics in the wrong order.
diag(Var->getLocation(), "variable");
diag(Var->getTypeSpecStartLoc(), "type specifier");
}
};
class HighlightTestCheck : public ClangTidyCheck {
public:
HighlightTestCheck(StringRef Name, ClangTidyContext *Context)
: ClangTidyCheck(Name, Context) {}
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 auto *Var = Result.Nodes.getNodeAs<VarDecl>("var");
diag(Var->getLocation(), "highlight range") << Var->getSourceRange();
}
};
class InvalidRangeTestCheck : public ClangTidyCheck {
public:
InvalidRangeTestCheck(StringRef Name, ClangTidyContext *Context)
: ClangTidyCheck(Name, Context) {}
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 auto *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