TestUtils Namespace Reference

Various common utils for unit tests. More...

Functions
std::vector< double >	binCenters (const QCPGraph *graph)
	Returns vector representing bin centers on QCPgraph. More...
std::vector< double >	binErrors (const QCPGraph *graph)
	Returns vector representing bin errors of QCPGraph. More...
std::vector< double >	binValues (const QCPGraph *graph)
	Returns vector representing y-values on QCPgraph. More...
template<typename T >
void	clean_items (T &items)
	Deletes items in the container and cleans container afterwards. More...
template<typename T >
auto	create_pointers (const std::vector< std::unique_ptr< T >> &vec)
	Creates vector of pointers from vector of unique_ptr. More...
template<typename B , typename D >
auto	create_row (int ncolumns)
	Creates vector of unique_ptr of given type. More...
std::string	CreateEmptyFile (const std::string &dirname, const std::string &fileName)
	Helper function to create empty file in a given directory (directory should exist). More...
std::string	CreateTestDirectory (const std::string &test_sub_dir)
	Creates test directory in main test folder and returns full path. More...
std::string	CreateTestFile (const std::string &dirname, const std::string &fileName)
	Helper function to create test file in a given directory (directory should exist). More...
template<typename G , typename T >
std::vector< double >	get_values (const G *graph, T operand)
	Returns vector representing bin centers/values on QCPGraph. More...
template<typename T >
T *	GetPlottable (QCustomPlot *custom_plot)
	Finds and returns specific plottable in QCustomPlot canvas. More...
QString	JsonToString (const QJsonObject &object)
QJsonDocument	LoadJson (const std::string &fileName)
QString	ModelToJsonString (ModelView::SessionModel &model)
	Returns string representing serialized json content of the model. More...
void	SaveJson (const QJsonArray &object, const std::string &fileName)
void	SaveJson (const QJsonObject &object, const std::string &fileName)
std::string	TestDirectoryPath (const std::string &test_sub_dir)
	Returns full path to the main test folder in CMAKE_BINARY_DIR. More...
std::string	TestFileName (const std::string &test_sub_dir, const std::string &file_name)
	Returns full path to the file in test directory. More...
std::string	TestOutputDir ()
	Returns full path to the main test folder, as defined by CMake at compile time. More...
template<typename T , typename... Args>
std::vector< T >	toVector (Args &&... args)
	Creates vector of T from argument list. Used in EXPECT_EQ macros for convenience. More...

Detailed Description

Various common utils for unit tests.

Function Documentation

binCenters()

std::vector< double > TestUtils::binCenters

(

const QCPGraph *

graph

)

Returns vector representing bin centers on QCPgraph.

Definition at line 18 of file customplot_test_utils.cpp.

{
    return get_values(graph, [](auto x) { return x.key; });
}

References get_values().

Referenced by TEST_F().

Here is the call graph for this function:

binErrors()

std::vector< double > TestUtils::binErrors

(

const QCPGraph *

graph

)

Returns vector representing bin errors of QCPGraph.

Definition at line 28 of file customplot_test_utils.cpp.

{
    std::vector<double> result;
    if (auto errorBars = GetPlottable<QCPErrorBars>(graph->parentPlot()); errorBars) {
        auto container = errorBars->data();
        std::transform(container->begin(), container->end(), std::back_inserter(result),
                       [](auto x) { return x.errorPlus; });
    };
    return result;
}

Referenced by TEST_F().

binValues()

std::vector< double > TestUtils::binValues

(

const QCPGraph *

graph

)

Returns vector representing y-values on QCPgraph.

Definition at line 23 of file customplot_test_utils.cpp.

{
    return get_values(graph, [](auto x) { return x.value; });
}

References get_values().

Referenced by TEST_F().

Here is the call graph for this function:

clean_items()

template<typename T >

void TestUtils::clean_items

(

T &

items

)

Deletes items in the container and cleans container afterwards.

Definition at line 71 of file test_utils.h.

{
    for (auto item : items)
        delete item;
    items.clear();
}

create_pointers()

template<typename T >

auto TestUtils::create_pointers

(

const std::vector< std::unique_ptr< T >> &

vec

)

Creates vector of pointers from vector of unique_ptr.

Definition at line 90 of file test_utils.h.

{
    std::vector<T*> result;
    std::transform(vec.begin(), vec.end(), std::back_inserter(result),
                   [](auto& x) { return x.get(); });
    return result;
}

Referenced by ViewItemTest::test_data(), and ViewModelBaseTest::test_data().

create_row()

template<typename B , typename D >

auto TestUtils::create_row

(

int

ncolumns

)

Creates vector of unique_ptr of given type.

Definition at line 80 of file test_utils.h.

{
    std::vector<std::unique_ptr<B>> result;
    for (int i = 0; i < ncolumns; ++i)
        result.emplace_back(std::make_unique<D>());
    return result;
}

CreateEmptyFile()

std::string TestUtils::CreateEmptyFile	(	const std::string &	dirname,
		const std::string &	fileName
	)

Helper function to create empty file in a given directory (directory should exist).

Returns full path of the file.

Definition at line 107 of file test_utils.cpp.

{
    std::string filename = dirname.empty() ? fileName : dirname + "/" + fileName;
 
    QFile file(QString::fromStdString(filename));
    if (!file.open(QIODevice::WriteOnly | QIODevice::Text))
        throw std::runtime_error("TestFileUtils::createTestFile() -> Error. "
                                 "Can't create file");
    return filename;
}

References FileSystemUtils::filename().

Referenced by TEST_F().

Here is the call graph for this function:

CreateTestDirectory()

std::string TestUtils::CreateTestDirectory

(

const std::string &

test_sub_dir

)

Creates test directory in main test folder and returns full path.

If directory exists, will do nothing.

Definition at line 40 of file test_utils.cpp.

{
    std::string result = TestDirectoryPath(test_sub_dir);
    Utils::create_directory(result);
    return result;
}

References ModelView::Utils::create_directory(), and TestDirectoryPath().

Referenced by FolderBasedTest::FolderBasedTest().

Here is the call graph for this function:

CreateTestFile()

std::string TestUtils::CreateTestFile	(	const std::string &	dirname,
		const std::string &	fileName
	)

Helper function to create test file in a given directory (directory should exist).

Returns full path of the file.

Definition at line 91 of file test_utils.cpp.

{
    std::string filename = dirname.empty() ? fileName : dirname + "/" + fileName;
 
    QFile file(QString::fromStdString(filename));
    if (!file.open(QIODevice::WriteOnly | QIODevice::Text))
        throw std::runtime_error("TestFileUtils::createTestFile() -> Error. "
                                 "Can't create file");
 
    QTextStream out(&file);
    out << "Test file " << 42 << "\n";
    file.close();
 
    return filename;
}

References FileSystemUtils::filename().

Referenced by TEST_F().

Here is the call graph for this function:

get_values()

template<typename G , typename T >

std::vector<double> TestUtils::get_values	(	const G *	graph,
		T	operand
	)

Returns vector representing bin centers/values on QCPGraph.

Definition at line 28 of file customplot_test_utils.h.

{
    std::vector<double> result;
    auto graph_data = *graph->data();
    std::transform(std::begin(graph_data), std::end(graph_data), std::back_inserter(result),
                   [operand](const auto& point) { return operand(point); });
    return result;
}

Referenced by binCenters(), and binValues().

GetPlottable()

template<typename T >

T* TestUtils::GetPlottable

(

QCustomPlot *

custom_plot

)

Finds and returns specific plottable in QCustomPlot canvas.

Definition at line 47 of file customplot_test_utils.h.

{
    for (int i = 0; i < custom_plot->plottableCount(); ++i) {
        if (auto plottable = dynamic_cast<T*>(custom_plot->plottable()); plottable)
            return plottable;
    }
    return nullptr;
}

JsonToString()

QString TestUtils::JsonToString

(

const QJsonObject &

object

)

Definition at line 70 of file test_utils.cpp.

{
    QJsonDocument document(object);
    return QString(document.toJson(QJsonDocument::Compact));
}

Referenced by TEST_F().

LoadJson()

QJsonDocument TestUtils::LoadJson

(

const std::string &

fileName

)

Definition at line 81 of file test_utils.cpp.

{
    QFile jsonFile(QString::fromStdString(fileName));
 
    if (!jsonFile.open(QIODevice::ReadOnly))
        throw std::runtime_error("TestUtils::LoadJson() -> Can't read file");
 
    return QJsonDocument().fromJson(jsonFile.readAll());
}

Referenced by TEST_F().

ModelToJsonString()

QString TestUtils::ModelToJsonString

(

ModelView::SessionModel &

model

)

Returns string representing serialized json content of the model.

Definition at line 76 of file test_utils.cpp.

{
    return QString::fromStdString(JsonUtils::ModelToJsonString(model));
}

References ModelView::JsonUtils::ModelToJsonString().

Here is the call graph for this function:

SaveJson() [1/2]

void TestUtils::SaveJson	(	const QJsonArray &	object,
		const std::string &	fileName
	)

Definition at line 64 of file test_utils.cpp.

{
    QJsonDocument document(object);
    SaveDocument(document, fileName);
}

SaveJson() [2/2]

void TestUtils::SaveJson	(	const QJsonObject &	object,
		const std::string &	fileName
	)

Definition at line 58 of file test_utils.cpp.

{
    QJsonDocument document(object);
    SaveDocument(document, fileName);
}

Referenced by TEST_F().

TestDirectoryPath()

std::string TestUtils::TestDirectoryPath

(

const std::string &

test_sub_dir

)

Returns full path to the main test folder in CMAKE_BINARY_DIR.

Definition at line 47 of file test_utils.cpp.

{
    return TestOutputDir() + std::string("/") + test_sub_dir;
}

References TestOutputDir().

Referenced by CreateTestDirectory(), TestFileName(), and FolderBasedTest::testPath().

Here is the call graph for this function:

TestFileName()

std::string TestUtils::TestFileName	(	const std::string &	test_sub_dir,
		const std::string &	file_name
	)

Returns full path to the file in test directory.

Definition at line 52 of file test_utils.cpp.

{
 
    return TestDirectoryPath(test_sub_dir) + std::string("/") + file_name;
}

References TestDirectoryPath().

Referenced by TEST_F().

Here is the call graph for this function:

TestOutputDir()

std::string TestUtils::TestOutputDir

(

)

Returns full path to the main test folder, as defined by CMake at compile time.

Shoud point to CMAKE_BINARY_DIR/test_output

Definition at line 35 of file test_utils.cpp.

{
    return TestConfig::TestOutputDir(); // defined in auto-generated testconfig.h
}

Referenced by TEST_F(), and TestDirectoryPath().

toVector()

template<typename T , typename... Args>

std::vector<T> TestUtils::toVector

(

Args &&...

args

)

Creates vector of T from argument list. Used in EXPECT_EQ macros for convenience.

Definition at line 100 of file test_utils.h.

{
    std::vector<T> v;
    (v.push_back(T(args)), ...);
    return v;
}