test-read-common.h File Reference

This file declares the common functionality for tests in CTF and DWARF readers, it declares abstractions for `act` test stage. More...

#include <string>
#include "abg-ir.h"
#include "abg-corpus.h"
#include "abg-workers.h"
#include "abg-writer.h"
#include "test-utils.h"
#include "abg-tools-utils.h"

Include dependency graph for test-read-common.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	InOutSpec
	This is an aggregate that specifies where a test shall get its input from, and where it shall write its output to. More...
struct	options
	An abstraction for valid test options. More...
struct	test_task
	The task that performs the tests. More...

Namespaces
namespace	abigail
	Toplevel namespace for libabigail.

Typedefs
typedef test_task *(*	create_new_test) (const InOutSpec *s, string &a_out_abi_base, string &a_in_elf_base, string &a_in_abi_base)
	A convenience typedef for a callback to create_new_test instances.
typedef shared_ptr< test_task >	test_task_sptr

Functions
void	display_usage (const string &prog_name, ostream &out)
	Write the usage message to out stream object.
bool	parse_command_line (int argc, char *argv[], options &opts)
	Parse and process test options.
bool	run_tests (const size_t num_tests, const InOutSpec *specs, const options &opts, create_new_test new_test)
	The main entry point to execute the testsuite.

Detailed Description

This file declares the common functionality for tests in CTF and DWARF readers, it declares abstractions for `act` test stage.

Definition in file test-read-common.h.

Typedef Documentation

create_new_test

typedef test_task *(* create_new_test) (const InOutSpec *s, string &a_out_abi_base, string &a_in_elf_base, string &a_in_abi_base)

A convenience typedef for a callback to create_new_test instances.

Definition at line 172 of file test-read-common.h.

test_task_sptr

typedef shared_ptr<test_task> test_task_sptr

Definition at line 145 of file test-read-common.h.

Function Documentation

display_usage()

void display_usage	(	const string &	prog_name,
		ostream &	out )

Write the usage message to out stream object.

Parameters

prog_name	the program name.
out	the stream object to which want to write.

Definition at line 152 of file test-read-common.cc.

parse_command_line()

bool parse_command_line	(	int	argc,
		char *	argv[],
		options &	opts )

Parse and process test options.

Parameters

argc	the arguments number.
argv	the pointer to the arguments.
opts	the valid options to be processed/parsed.

Returns

true if options was processed/parsed successfully. It returns false when help is requested or an invalid option is supplied.

Definition at line 173 of file test-read-common.cc.

run_tests()

bool run_tests	(	const size_t	num_tests,
		const InOutSpec *	specs,
		const options &	opts,
		create_new_test	new_test )

The main entry point to execute the testsuite.

Parameters

num_tests	the number of tests to be executed.
specs	the abigail::tests::read_common::InOutSpec tests container.
opts	the test execution abigail::tests::read_common::options.
new_test	the create_new_test callback function to create a new test task object.

Returns

true if `all` tests were performed successfully. Otherwise false is returned.

Definition at line 208 of file test-read-common.cc.