0a1f91c80c
One of the reasons why AnalyzerOptions is so chaotic is that options can be retrieved from the command line whenever and wherever. This allowed for some options to be forgotten for a looooooong time. Have you ever heard of "region-store-small-struct-limit"? In order to prevent this in the future, I'm proposing to restrict AnalyzerOptions' interface so that only checker options can be retrieved without special getters. I would like to make every option be accessible only through a getter, but checkers from plugins are a thing, so I'll have to figure something out for that. This also forces developers who'd like to add a new option to register it properly in the .def file. This is done by * making the third checker pointer parameter non-optional, and checked by an assert to be non-null. * I added new, but private non-checkers option initializers, meant only for internal use, * Renamed these methods accordingly (mind the consistent name for once with getBooleanOption!): - getOptionAsString -> getCheckerStringOption, - getOptionAsInteger -> getCheckerIntegerOption * The 3 functions meant for initializing data members (with the not very descriptive getBooleanOption, getOptionAsString and getOptionAsUInt names) were renamed to be overloads of the getAndInitOption function name. * All options were in some way retrieved via getCheckerOption. I removed it, and moved the logic to getStringOption and getCheckerStringOption. This did cause some code duplication, but that's the only way I could do it, now that checker and non-checker options are separated. Note that the non-checker version inserts the new option to the ConfigTable with the default value, but the checker version only attempts to find already existing entries. This is how it always worked, but this is clunky and I might end reworking that too, so we can eventually get a ConfigTable that contains the entire configuration of the analyzer. Differential Revision: https://reviews.llvm.org/D53483 llvm-svn: 346113
94 lines
3.6 KiB
C++
94 lines
3.6 KiB
C++
//===- unittest/StaticAnalyzer/AnalyzerOptionsTest.cpp - SA Options test --===//
|
|
//
|
|
// The LLVM Compiler Infrastructure
|
|
//
|
|
// This file is distributed under the University of Illinois Open Source
|
|
// License. See LICENSE.TXT for details.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#include "clang/StaticAnalyzer/Core/AnalyzerOptions.h"
|
|
#include "clang/StaticAnalyzer/Core/Checker.h"
|
|
#include "gtest/gtest.h"
|
|
|
|
namespace clang {
|
|
namespace ento {
|
|
|
|
TEST(StaticAnalyzerOptions, getRegisteredCheckers) {
|
|
auto IsDebugChecker = [](StringRef CheckerName) {
|
|
return CheckerName.startswith("debug");
|
|
};
|
|
auto IsAlphaChecker = [](StringRef CheckerName) {
|
|
return CheckerName.startswith("alpha");
|
|
};
|
|
const auto &AllCheckers =
|
|
AnalyzerOptions::getRegisteredCheckers(/*IncludeExperimental=*/true);
|
|
EXPECT_FALSE(llvm::any_of(AllCheckers, IsDebugChecker));
|
|
EXPECT_TRUE(llvm::any_of(AllCheckers, IsAlphaChecker));
|
|
|
|
const auto &StableCheckers = AnalyzerOptions::getRegisteredCheckers();
|
|
EXPECT_FALSE(llvm::any_of(StableCheckers, IsDebugChecker));
|
|
EXPECT_FALSE(llvm::any_of(StableCheckers, IsAlphaChecker));
|
|
}
|
|
|
|
TEST(StaticAnalyzerOptions, SearchInParentPackageTests) {
|
|
AnalyzerOptions Opts;
|
|
Opts.Config["Outer.Inner.CheckerOne:Option"] = "true";
|
|
Opts.Config["Outer.Inner:Option"] = "false";
|
|
Opts.Config["Outer.Inner:Option2"] = "true";
|
|
Opts.Config["Outer:Option2"] = "false";
|
|
|
|
struct CheckerOneMock : CheckerBase {
|
|
StringRef getTagDescription() const override {
|
|
return "Outer.Inner.CheckerOne";
|
|
}
|
|
};
|
|
struct CheckerTwoMock : CheckerBase {
|
|
StringRef getTagDescription() const override {
|
|
return "Outer.Inner.CheckerTwo";
|
|
}
|
|
};
|
|
|
|
// Checker one has Option specified as true. It should read true regardless of
|
|
// search mode.
|
|
CheckerOneMock CheckerOne;
|
|
EXPECT_TRUE(Opts.getCheckerBooleanOption("Option", false, &CheckerOne));
|
|
// The package option is overridden with a checker option.
|
|
EXPECT_TRUE(Opts.getCheckerBooleanOption("Option", false, &CheckerOne,
|
|
true));
|
|
// The Outer package option is overridden by the Inner package option. No
|
|
// package option is specified.
|
|
EXPECT_TRUE(Opts.getCheckerBooleanOption("Option2", false, &CheckerOne,
|
|
true));
|
|
// No package option is specified and search in packages is turned off. The
|
|
// default value should be returned.
|
|
EXPECT_FALSE(Opts.getCheckerBooleanOption("Option2", false, &CheckerOne));
|
|
EXPECT_TRUE(Opts.getCheckerBooleanOption("Option2", true, &CheckerOne));
|
|
|
|
// Checker true has no option specified. It should get the default value when
|
|
// search in parents turned off and false when search in parents turned on.
|
|
CheckerTwoMock CheckerTwo;
|
|
EXPECT_FALSE(Opts.getCheckerBooleanOption("Option", false, &CheckerTwo));
|
|
EXPECT_TRUE(Opts.getCheckerBooleanOption("Option", true, &CheckerTwo));
|
|
EXPECT_FALSE(Opts.getCheckerBooleanOption("Option", true, &CheckerTwo, true));
|
|
}
|
|
|
|
TEST(StaticAnalyzerOptions, StringOptions) {
|
|
AnalyzerOptions Opts;
|
|
Opts.Config["Outer.Inner.CheckerOne:Option"] = "StringValue";
|
|
|
|
struct CheckerOneMock : CheckerBase {
|
|
StringRef getTagDescription() const override {
|
|
return "Outer.Inner.CheckerOne";
|
|
}
|
|
};
|
|
|
|
CheckerOneMock CheckerOne;
|
|
EXPECT_TRUE("StringValue" ==
|
|
Opts.getCheckerStringOption("Option", "DefaultValue", &CheckerOne));
|
|
EXPECT_TRUE("DefaultValue" ==
|
|
Opts.getCheckerStringOption("Option2", "DefaultValue", &CheckerOne));
|
|
}
|
|
} // end namespace ento
|
|
} // end namespace clang
|