Skip to content

testrunner: use structs with designated initialization to pass options #4975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 4, 2023
Merged

testrunner: use structs with designated initialization to pass options #4975

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
faaedbc
testrunner: added designated initialization helper
firewave Apr 17, 2023
baccbc6
testrunner: use structs with `dinit` to pass options
firewave Apr 17, 2023
ab88131
work around GCC 4.8 compiler errors with objects used in `dinit()`
firewave Jul 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions test/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ if (BUILD_TESTS)
target_compile_definitions(testrunner PRIVATE CPPCHECKLIB_IMPORT SIMPLECPP_IMPORT)
target_link_libraries(testrunner cppcheck-core)
endif()
if (CMAKE_CXX_COMPILER_ID MATCHES "Clang")
# $ is used in dinit() dessignated initialization helper
target_compile_options_safe(testrunner -Wno-dollar-in-identifier-extension)
endif()

if (NOT CMAKE_DISABLE_PRECOMPILE_HEADERS)
target_precompile_headers(testrunner PRIVATE precompiled.h)
Expand Down
27 changes: 27 additions & 0 deletions test/helpers.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,31 @@ class PreprocessorHelper
static std::string getcode(Preprocessor &preprocessor, const std::string &filedata, const std::string &cfg, const std::string &filename, Suppressions *inlineSuppression = nullptr);
};

/* designated initialization helper
Usage:
struct S
{
int i;
};

const auto s = dinit(S,
$.i = 1
);
*/
#define dinit(T, ...) \
([&] { T ${}; __VA_ARGS__; return $; }())

#if (defined(__GNUC__) && (__GNUC__ >= 5)) || defined(__clang__)
// work around Clang compilation error
// error: default member initializer for 'y' needed within definition of enclosing class 'X' outside of member functions
// work around GCC compilation error
// error: default member initializer for ‘x::y::z’ required before the end of its enclosing class
// see https://stackoverflow.com/questions/53408962
#define DINIT_NOEXCEPT noexcept
#else
// work around GCC 4.8 compilation error
// error: function 'x()' defaulted on its first declaration with an exception-specification that differs from the implicit declaration 'x()'
#define DINIT_NOEXCEPT
#endif

#endif // helpersH
27 changes: 17 additions & 10 deletions test/testprocessexecutor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,33 +46,41 @@ class TestProcessExecutor : public TestFixture {
return "process";
}

struct CheckOptions
{
CheckOptions() DINIT_NOEXCEPT = default;
SHOWTIME_MODES showtime = SHOWTIME_MODES::SHOWTIME_NONE;
const char* plistOutput = nullptr;
std::vector<std::string> filesList;
};

/**
* Execute check using n jobs for y files which are have
* identical data, given within data.
*/
void check(unsigned int jobs, int files, int result, const std::string &data, SHOWTIME_MODES showtime = SHOWTIME_MODES::SHOWTIME_NONE, const char* const plistOutput = nullptr, const std::vector<std::string>& filesList = {}) {
void check(unsigned int jobs, int files, int result, const std::string &data, const CheckOptions &opt = {}) {
errout.str("");
output.str("");

std::map<std::string, std::size_t> filemap;
if (filesList.empty()) {
if (opt.filesList.empty()) {
for (int i = 1; i <= files; ++i) {
std::ostringstream oss;
oss << fprefix() << "_" << i << ".cpp";
filemap[oss.str()] = data.size();
}
}
else {
for (const auto& f : filesList)
for (const auto& f : opt.filesList)
{
filemap[f] = data.size();
}
}

settings.jobs = jobs;
settings.showtime = showtime;
if (plistOutput)
settings.plistOutput = plistOutput;
settings.showtime = opt.showtime;
if (opt.plistOutput)
settings.plistOutput = opt.plistOutput;
// TODO: test with settings.project.fileSettings;
ProcessExecutor executor(filemap, settings, *this);
std::vector<std::unique_ptr<ScopedFile>> scopedfiles;
Expand Down Expand Up @@ -127,7 +135,7 @@ class TestProcessExecutor : public TestFixture {
"{\n"
" char *a = malloc(10);\n"
" return 0;\n"
"}", SHOWTIME_MODES::SHOWTIME_SUMMARY);
"}", dinit(CheckOptions, $.showtime = SHOWTIME_MODES::SHOWTIME_SUMMARY));
}

void many_threads_plist() {
Expand All @@ -139,7 +147,7 @@ class TestProcessExecutor : public TestFixture {
"{\n"
" char *a = malloc(10);\n"
" return 0;\n"
"}", SHOWTIME_MODES::SHOWTIME_NONE, plistOutput);
"}", dinit(CheckOptions, $.plistOutput = plistOutput));
}

void no_errors_more_files() {
Expand Down Expand Up @@ -184,7 +192,6 @@ class TestProcessExecutor : public TestFixture {
"}");
}


void markup() {
const Settings settingsOld = settings;
settings.library.mMarkupExtensions.emplace(".cp1");
Expand All @@ -201,7 +208,7 @@ class TestProcessExecutor : public TestFixture {
" char *a = malloc(10);\n"
" return 0;\n"
"}",
SHOWTIME_MODES::SHOWTIME_NONE, nullptr, files);
dinit(CheckOptions, $.filesList = files));
// TODO: order of "Checking" and "checked" is affected by thread
/*TODO_ASSERT_EQUALS("Checking " + fprefix() + "_2.cpp ...\n"
"1/4 files checked 25% done\n"
Expand Down
26 changes: 17 additions & 9 deletions test/testsingleexecutor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,13 +61,21 @@ class TestSingleExecutorBase : public TestFixture {
return std::to_string(i);
}

void check(int files, int result, const std::string &data, SHOWTIME_MODES showtime = SHOWTIME_MODES::SHOWTIME_NONE, const char* const plistOutput = nullptr, const std::vector<std::string>& filesList = {}) {
struct CheckOptions
{
CheckOptions() DINIT_NOEXCEPT = default;
SHOWTIME_MODES showtime = SHOWTIME_MODES::SHOWTIME_NONE;
const char* plistOutput = nullptr;
std::vector<std::string> filesList;
};

void check(int files, int result, const std::string &data, const CheckOptions &opt = {}) {
errout.str("");
output.str("");
settings.project.fileSettings.clear();

std::map<std::string, std::size_t> filemap;
if (filesList.empty()) {
if (opt.filesList.empty()) {
for (int i = 1; i <= files; ++i) {
const std::string s = fprefix() + "_" + zpad3(i) + ".cpp";
filemap[s] = data.size();
Expand All @@ -79,7 +87,7 @@ class TestSingleExecutorBase : public TestFixture {
}
}
else {
for (const auto& f : filesList)
for (const auto& f : opt.filesList)
{
filemap[f] = data.size();
if (useFS) {
Expand All @@ -90,9 +98,9 @@ class TestSingleExecutorBase : public TestFixture {
}
}

settings.showtime = showtime;
if (plistOutput)
settings.plistOutput = plistOutput;
settings.showtime = opt.showtime;
if (opt.plistOutput)
settings.plistOutput = opt.plistOutput;
// NOLINTNEXTLINE(performance-unnecessary-value-param)
CppCheck cppcheck(*this, true, [](std::string,std::vector<std::string>,std::string,std::string&){
return false;
Expand Down Expand Up @@ -152,7 +160,7 @@ class TestSingleExecutorBase : public TestFixture {
"{\n"
" char *a = malloc(10);\n"
" return 0;\n"
"}", SHOWTIME_MODES::SHOWTIME_SUMMARY);
"}", dinit(CheckOptions, $.showtime = SHOWTIME_MODES::SHOWTIME_SUMMARY));
}

void many_files_plist() {
Expand All @@ -164,7 +172,7 @@ class TestSingleExecutorBase : public TestFixture {
"{\n"
" char *a = malloc(10);\n"
" return 0;\n"
"}", SHOWTIME_MODES::SHOWTIME_NONE, plistOutput);
"}", dinit(CheckOptions, $.plistOutput = plistOutput));
}

void no_errors_more_files() {
Expand Down Expand Up @@ -225,7 +233,7 @@ class TestSingleExecutorBase : public TestFixture {
" char *a = malloc(10);\n"
" return 0;\n"
"}",
SHOWTIME_MODES::SHOWTIME_NONE, nullptr, files);
dinit(CheckOptions, $.filesList = files));
// TODO: filter out the "files checked" messages
ASSERT_EQUALS("Checking " + fprefix() + "_2.cpp ...\n"
"1/4 files checked 25% done\n"
Expand Down
26 changes: 17 additions & 9 deletions test/testthreadexecutor.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,34 +46,42 @@ class TestThreadExecutor : public TestFixture {
return "thread";
}

struct CheckOptions
{
CheckOptions() DINIT_NOEXCEPT = default;
SHOWTIME_MODES showtime = SHOWTIME_MODES::SHOWTIME_NONE;
const char* plistOutput = nullptr;
std::vector<std::string> filesList;
};

/**
* Execute check using n jobs for y files which are have
* identical data, given within data.
*/
void check(unsigned int jobs, int files, int result, const std::string &data, SHOWTIME_MODES showtime = SHOWTIME_MODES::SHOWTIME_NONE, const char* const plistOutput = nullptr, const std::vector<std::string>& filesList = {}) {
void check(unsigned int jobs, int files, int result, const std::string &data, const CheckOptions &opt = {}) {
errout.str("");
output.str("");

std::map<std::string, std::size_t> filemap;
if (filesList.empty()) {
if (opt.filesList.empty()) {
for (int i = 1; i <= files; ++i) {
std::ostringstream oss;
oss << fprefix() << "_" << i << ".cpp";
filemap[oss.str()] = data.size();
}
}
else {
for (const auto& f : filesList)
for (const auto& f : opt.filesList)
{
filemap[f] = data.size();
}
}

Settings settings1 = settings;
settings1.jobs = jobs;
settings1.showtime = showtime;
if (plistOutput)
settings1.plistOutput = plistOutput;
settings1.showtime = opt.showtime;
if (opt.plistOutput)
settings1.plistOutput = opt.plistOutput;
// TODO: test with settings.project.fileSettings;
ThreadExecutor executor(filemap, settings1, *this);
std::vector<std::unique_ptr<ScopedFile>> scopedfiles;
Expand Down Expand Up @@ -126,7 +134,7 @@ class TestThreadExecutor : public TestFixture {
"{\n"
" char *a = malloc(10);\n"
" return 0;\n"
"}", SHOWTIME_MODES::SHOWTIME_SUMMARY);
"}", dinit(CheckOptions, $.showtime = SHOWTIME_MODES::SHOWTIME_SUMMARY));
}

void many_threads_plist() {
Expand All @@ -138,7 +146,7 @@ class TestThreadExecutor : public TestFixture {
"{\n"
" char *a = malloc(10);\n"
" return 0;\n"
"}", SHOWTIME_MODES::SHOWTIME_NONE, plistOutput);
"}", dinit(CheckOptions, $.plistOutput = plistOutput));
}

void no_errors_more_files() {
Expand Down Expand Up @@ -199,7 +207,7 @@ class TestThreadExecutor : public TestFixture {
" char *a = malloc(10);\n"
" return 0;\n"
"}",
SHOWTIME_MODES::SHOWTIME_NONE, nullptr, files);
dinit(CheckOptions, $.filesList = files));
// TODO: order of "Checking" and "checked" is affected by thread
/*TODO_ASSERT_EQUALS("Checking " + fprefix() + "_2.cpp ...\n"
"1/4 files checked 25% done\n"
Expand Down