Nektar::TestData Class Reference

The TestData class is responsible for parsing a test XML file and storing the data. More...

#include <TestData.h>

Public Member Functions
	TestData (const fs::path &pFilename, po::variables_map &pVm)
	TestData constructor. More...
	TestData (const TestData &pSrc)
const std::string &	GetDescription () const
	Returns the description of a test. More...
const Command &	GetCommand (unsigned int pId) const
unsigned int	GetNumCommands () const
std::string	GetMetricType (unsigned int pId) const
	Returns the type of metric to be collected for a given metric ID. More...
unsigned int	GetNumMetrics () const
	Returns the number of metrics to be collected for the test. More...
TiXmlElement *	GetMetric (unsigned int pId)
	Returns a pointer to the TiXmlElement object representing the metric for a given metric ID. More...
unsigned int	GetMetricId (unsigned int pId)
	Returns the ID of the metric for a given metric ID. More...
DependentFile	GetDependentFile (unsigned int pId) const
unsigned int	GetNumDependentFiles () const
	Returns the number of dependent files required for the test. More...
unsigned int	GetNumRuns () const
	Returns the number of runs to be performed for the test. More...
void	SaveFile ()

Private Member Functions
void	Parse (TiXmlDocument *pDoc)
	Parse the test file and populate member variables for the test. More...
Command	ParseCommand (TiXmlElement *pElmt) const

Private Attributes
po::variables_map	m_cmdoptions
std::string	m_description
std::vector< Command >	m_commands
TiXmlDocument *	m_doc
std::vector< TiXmlElement * >	m_metrics
std::vector< DependentFile >	m_files
unsigned int	m_runs
	The number of times to run the test. More...

Detailed Description

The TestData class is responsible for parsing a test XML file and storing the data.

Definition at line 78 of file TestData.h.

Constructor & Destructor Documentation

TestData() [1/2]

Nektar::TestData::TestData	(	const fs::path &	pFilename,
		po::variables_map &	pVm
	)

TestData constructor.

The class is constructed with the path to the test XML file and a po::variables_map object containing the command-line options passed to the program.

Parameters

pFilename
pVm

Definition at line 58 of file TestData.cpp.

    : m_cmdoptions(pVm)
{
    // Process test file format.
    m_doc = new TiXmlDocument(pFilename.string().c_str());
 
    bool loadOkay = m_doc->LoadFile();
 
    ASSERTL0(loadOkay,
             "Failed to load test definition file: " + pFilename.string() +
                 "\n" + string(m_doc->ErrorDesc()));
 
    Parse(m_doc);
}

References ASSERTL0, m_doc, and Parse().

TestData() [2/2]

Nektar::TestData::TestData

(

const TestData &

pSrc

)

Definition at line 73 of file TestData.cpp.

{
    boost::ignore_unused(pSrc);
}

Member Function Documentation

GetCommand()

const Command & Nektar::TestData::GetCommand

(

unsigned int

pId

)

const

Definition at line 84 of file TestData.cpp.

{
    ASSERTL0(pId < m_commands.size(),
             "Command ID '" + std::to_string(pId) + "' not found");
    return m_commands[pId];
}

References ASSERTL0, and m_commands.

Referenced by main().

GetDependentFile()

DependentFile Nektar::TestData::GetDependentFile

(

unsigned int

pId

)

const

Definition at line 131 of file TestData.cpp.

{
    ASSERTL0(pId < m_files.size(), "File index out of range.");
    return m_files[pId];
}

References ASSERTL0, and m_files.

Referenced by main().

GetDescription()

const std::string & Nektar::TestData::GetDescription

(

)

const

Returns the description of a test.

Definition at line 79 of file TestData.cpp.

{
    return m_description;
}

References m_description.

GetMetric()

TiXmlElement * Nektar::TestData::GetMetric

(

unsigned int

pId

)

Returns a pointer to the TiXmlElement object representing the metric for a given metric ID.

Definition at line 116 of file TestData.cpp.

{
    ASSERTL0(pId < m_metrics.size(), "Metric index out of range.");
    return m_metrics[pId];
}

References ASSERTL0, and m_metrics.

Referenced by main().

GetMetricId()

unsigned int Nektar::TestData::GetMetricId

(

unsigned int

pId

)

Returns the ID of the metric for a given metric ID.

Definition at line 123 of file TestData.cpp.

{
    ASSERTL0(pId < m_metrics.size(), "Metric index out of range.");
    const char *id = m_metrics[pId]->Attribute("id");
    ASSERTL0(id, "No ID found for metric!");
    return boost::lexical_cast<unsigned int>(id);
}

References ASSERTL0, and m_metrics.

Referenced by main().

GetMetricType()

std::string Nektar::TestData::GetMetricType

(

unsigned int

pId

)

const

Returns the type of metric to be collected for a given metric ID.

Definition at line 97 of file TestData.cpp.

{
    ASSERTL0(pId < m_metrics.size(), "Metric ID out of range.");
 
    // read the property name
    ASSERTL0(m_metrics[pId]->Attribute("type"),
             "Missing 'type' attribute in metric " +
                 boost::lexical_cast<string>(pId) + ").");
    return boost::to_upper_copy(string(m_metrics[pId]->Attribute("type")));
}

References ASSERTL0, and m_metrics.

Referenced by main().

GetNumCommands()

unsigned int Nektar::TestData::GetNumCommands

(

)

const

Definition at line 91 of file TestData.cpp.

{
    return m_commands.size();
}

References m_commands.

Referenced by main().

GetNumDependentFiles()

unsigned int Nektar::TestData::GetNumDependentFiles

(

)

const

Returns the number of dependent files required for the test.

Definition at line 138 of file TestData.cpp.

{
    return m_files.size();
}

References m_files.

Referenced by main().

GetNumMetrics()

unsigned int Nektar::TestData::GetNumMetrics

(

)

const

Returns the number of metrics to be collected for the test.

Definition at line 109 of file TestData.cpp.

{
    return m_metrics.size();
}

References m_metrics.

Referenced by main().

GetNumRuns()

unsigned int Nektar::TestData::GetNumRuns

(

)

const

Returns the number of runs to be performed for the test.

Definition at line 144 of file TestData.cpp.

{
    return m_runs;
}

References m_runs.

Referenced by main().

Parse()

void Nektar::TestData::Parse ( TiXmlDocument *  pDoc )

private

Parse the test file and populate member variables for the test.

Definition at line 216 of file TestData.cpp.

{
    TiXmlHandle handle(pDoc);
    TiXmlElement *testElement, *tmp, *metrics, *files;
    testElement = handle.FirstChildElement("test").Element();
    ASSERTL0(testElement, "Cannot find 'test' root element.");
 
    // Find the desired number of test runs
    unsigned int runs = 1;
    testElement->QueryUnsignedAttribute("runs", &runs);
    ASSERTL0(runs > 0, "Number of runs must be greater than zero.");
    m_runs = runs;
 
    // Find description tag.
    tmp = testElement->FirstChildElement("description");
    ASSERTL0(tmp, "Cannot find 'description' for test.");
    m_description = string(tmp->GetText());
 
    // Find command(s) to run.
    if (m_cmdoptions.count("executable"))
    {
        m_commands.push_back(ParseCommand(testElement));
        m_commands.back().m_executable =
            fs::path(m_cmdoptions["executable"].as<std::string>());
    }
    else if (testElement->FirstChildElement("executable"))
    {
        m_commands.push_back(ParseCommand(testElement));
    }
    else if ((tmp = testElement->FirstChildElement("segment")))
    {
        ASSERTL0(m_cmdoptions.count("executable") == 0,
                 "Test files defining more than one command in segment "
                 "blocks cannot use --executable.");
 
        while (tmp)
        {
            m_commands.push_back(ParseCommand(tmp));
            tmp = tmp->NextSiblingElement("segment");
        }
 
        for (int i = 1; i < m_commands.size(); ++i)
        {
            ASSERTL0(m_commands[i].m_commandType == m_commands[0].m_commandType,
                     "All segment commands should be of the same type.");
        }
    }
 
    ASSERTL0(m_commands.size() > 0,
             "No executable / command segments specified for test.");
 
    // Extract metric tags
    metrics = testElement->FirstChildElement("metrics");
    ASSERTL0(metrics, "No metrics defined for test.");
 
    tmp = metrics->FirstChildElement("metric");
    while (tmp)
    {
        m_metrics.push_back(tmp);
        tmp = tmp->NextSiblingElement("metric");
    }
 
    // Extract list of dependent files
    files = testElement->FirstChildElement("files");
    if (files)
    {
        tmp = files->FirstChildElement("file");
        while (tmp)
        {
            DependentFile f;
            f.m_filename = string(tmp->GetText());
            if (tmp->Attribute("description"))
            {
                f.m_description = string(tmp->Attribute("description"));
            }
            m_files.push_back(f);
            tmp = tmp->NextSiblingElement("file");
        }
    }
}

References ASSERTL0, m_cmdoptions, m_commands, Nektar::DependentFile::m_description, m_description, Nektar::DependentFile::m_filename, m_files, m_metrics, m_runs, and ParseCommand().

Referenced by TestData().

ParseCommand()

Command Nektar::TestData::ParseCommand ( TiXmlElement *  pElmt ) const

private

Definition at line 149 of file TestData.cpp.

{
    Command cmd;
    TiXmlElement *tmp;
 
    cmd.m_pythonTest = false;
 
    std::string commandType = "none";
    if (elmt->Attribute("type"))
    {
        commandType = elmt->Attribute("type");
 
        if (commandType == "none")
        {
            cmd.m_commandType = eNone;
        }
        else if (commandType == "parallel")
        {
            cmd.m_commandType = eParallel;
        }
        else if (commandType == "sequential")
        {
            cmd.m_commandType = eSequential;
        }
    }
 
    // Parse executable tag. Do not enforce a check because this might be
    // overridden on the command line.
    if (elmt->FirstChildElement("executable"))
    {
        tmp              = elmt->FirstChildElement("executable");
        cmd.m_executable = fs::path(tmp->GetText());
        // Test to see if this test requires Python
        std::string needsPython;
        tmp->QueryStringAttribute("python", &needsPython);
        cmd.m_pythonTest = needsPython == "true";
 
#if defined(RELWITHDEBINFO)
        cmd.m_executable += cmd.m_pythonTest ? "" : "-rg";
#elif !defined(NDEBUG)
        cmd.m_executable += cmd.m_pythonTest ? "" : "-g";
#endif
    }
 
    // Find associated parameters.
    tmp = elmt->FirstChildElement("parameters");
    ASSERTL0(tmp, "Cannot find 'parameters' for test.");
    if (tmp->GetText())
    {
        cmd.m_parameters = string(tmp->GetText());
    }
 
    // Find parallel processes tah.
    tmp = elmt->FirstChildElement("processes");
    if (tmp)
    {
        cmd.m_processes = atoi(tmp->GetText());
    }
    else
    {
        cmd.m_processes = 1;
    }
 
    return cmd;
}

References ASSERTL0, Nektar::eNone, Nektar::eParallel, Nektar::eSequential, Nektar::Command::m_commandType, Nektar::Command::m_executable, Nektar::Command::m_parameters, Nektar::Command::m_processes, and Nektar::Command::m_pythonTest.

Referenced by Parse().

SaveFile()

void Nektar::TestData::SaveFile

(

)

Definition at line 297 of file TestData.cpp.

{
    m_doc->SaveFile();
}

References m_doc.

Referenced by main().

Member Data Documentation

m_cmdoptions

po::variables_map Nektar::TestData::m_cmdoptions

private

Definition at line 101 of file TestData.h.

Referenced by Parse().

m_commands

std::vector<Command> Nektar::TestData::m_commands

private

Definition at line 103 of file TestData.h.

Referenced by GetCommand(), GetNumCommands(), and Parse().

m_description

std::string Nektar::TestData::m_description

private

Definition at line 102 of file TestData.h.

Referenced by GetDescription(), and Parse().

m_doc

TiXmlDocument* Nektar::TestData::m_doc

private

Definition at line 104 of file TestData.h.

Referenced by SaveFile(), and TestData().

m_files

std::vector<DependentFile> Nektar::TestData::m_files

private

Definition at line 106 of file TestData.h.

Referenced by GetDependentFile(), GetNumDependentFiles(), and Parse().

m_metrics

std::vector<TiXmlElement *> Nektar::TestData::m_metrics

private

Definition at line 105 of file TestData.h.

Referenced by GetMetric(), GetMetricId(), GetMetricType(), GetNumMetrics(), and Parse().

m_runs

unsigned int Nektar::TestData::m_runs

private

The number of times to run the test.

Definition at line 108 of file TestData.h.

Referenced by GetNumRuns(), and Parse().