/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2009 University of Washington
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#include "ns3/test.h"
#include <iostream>
#include <fstream>
#include <string>
using namespace ns3;
//
// Run one of the test suites. Returns an integer with the boolean sense of
// "an error has occurred." That is, 0 == false -> no error; 1 == true -> an
// error occurred.
//
int
main (int argc, char *argv[])
{
bool doVerbose = false;
bool doList = false;
bool doHelp = false;
bool doSuite = false;
bool doKinds = false;
bool haveBasedir = false;
bool haveOutfile = false;
bool haveType = false;
std::string suiteName;
std::string basedir;
std::string outfileName;
std::string typeName;
for (int i = 1; i < argc; ++i)
{
std::string arg(argv[i]);
if (arg.find ("--basedir=") != std::string::npos)
{
basedir = arg.substr (arg.find_first_of ("=") + 1, 9999);
haveBasedir = true;
}
if (arg.find ("--constrain=") != std::string::npos)
{
typeName = arg.substr (arg.find_first_of ("=") + 1, 9999);
haveType = true;
}
if (arg.compare ("--help") == 0)
{
doHelp = true;
}
if (arg.compare ("--kinds") == 0)
{
doKinds = true;
}
if (arg.compare ("--list") == 0)
{
doList = true;
}
if (arg.find ("--out=") != std::string::npos)
{
outfileName = arg.substr (arg.find_first_of ("=") + 1, 9999);
haveOutfile = true;
}
if (arg.find ("--suite=") != std::string::npos)
{
suiteName = arg.substr (arg.find_first_of ("=") + 1, 9999);
doSuite = true;
}
if (arg.compare ("--verbose") == 0)
{
doVerbose = true;
}
}
//
// A help request trumps everything else. If we have one, just print the help
// and leave.
//
if (doHelp)
{
std::cout << " --basedir=dir: Set the base directory (where to find src) to \"dir\"" << std::endl;
std::cout << " --constrain=test-type: Constrain checks to test suites of type \"test-type\"" << std::endl;
std::cout << " --help: Print this message" << std::endl;
std::cout << " --kinds: List all of the available kinds of tests" << std::endl;
std::cout << " --list: List all of the test suites (optionally constrained by test-type)" << std::endl;
std::cout << " --out=file-name: Set the test status output file to \"file-name\"" << std::endl;
std::cout << " --suite=suite-name: Run the test suite named \"suite-name\"" << std::endl;
std::cout << " --verbose: Turn on messages in the run test suites" << std::endl;
return false;
}
//
// A kinds request trumps everything remaining. If we are asked, just
// print the list of types and leave.
//
if (doKinds)
{
//
// Coming up with a string to represent a test type is completely up to
// us here. We just define the types as being a string composed of the
// enum defined in test.h converted to lower case.
//
std::cout << " bvt: Build Verification Tests (to see if build completed successfully)" << std::endl;
std::cout << " unit: Unit Tests (within modules to check basic functionality)" << std::endl;
std::cout << " system: System Tests (spans modules to check integration of modules)" << std::endl;
std::cout << " example: Examples (to see if example programs run successfully)" << std::endl;
std::cout << " performance: Performance Tests (check to see if the system is as fast as expected)" << std::endl;
return false;
}
//
// A list request is the first functional request. It trumps running the
// actual tests. If we get a list request, we don't run anything, we just
// do the requested list which may or may not be qualified by a typename.
//
if (doList)
{
for (uint32_t i = 0; i < TestRunner::GetNTestSuites (); ++i)
{
TestSuite *suite = TestRunner::GetTestSuite (i);
//
// Filter the tests listed by type if requested.
//
if (haveType)
{
TestSuite::TestType type = suite->GetTestType ();
if (typeName == "bvt" && type != TestSuite::BVT)
{
continue;
}
if (typeName == "unit" && type != TestSuite::UNIT)
{
continue;
}
if (typeName == "system" && type != TestSuite::SYSTEM)
{
continue;
}
if (typeName == "example" && type != TestSuite::EXAMPLE)
{
continue;
}
if (typeName == "performance" && type != TestSuite::PERFORMANCE)
{
continue;
}
}
//
// This creates a list of test suite names that can be used by the
// high level test manager to get a list of all tests. It will then
// typically launch individual tests in parallel, calling back here
// with a specific "suite=" to run.
//
std::cout << suite->GetName () << std::endl;
}
return false;
}
//
// If we haven't been asked to run a test suite, we are just going to happily
// try and run everything. Test suites are possibly going to need to figure
// out where there source directory is, and to do that they will need to know
// where the base directory of the distribution is (the directory in which
// "src" is found). We could try and run without it, but when it is needed,
// the test will fail with an assertion. So to be safe, we require a basedir
// to proceed.
//
if (haveBasedir == false)
{
std::cout << "Must specify a base directory to run tests (use --basedir option)" << std::endl;
return true;
}
//
// If given an output file, we just append the output of each test suite
// we're asked to run to the end of that file. We need to append since the
// higher level test runner may be just running a number of tests back to
// back. We leave it up to that code to decide how to deal with possible
// parallel operation -- we just append to a file here. If no output file
// is specified, we don't do any output and just return the sense of error
// given by the test.
//
std::ofstream *pofs = 0;
std::ofstream ofs;
if (!outfileName.empty ())
{
ofs.open (outfileName.c_str (), std::fstream::out | std::fstream::app);
pofs = &ofs;
}
//
// If we have a specified test suite to run, then we only run that suite.
// The default case is to "run everything. We don't expect this to be done
// much since typically higher level code will be running suites in parallel
// but we'll do it if asked.
//
bool result = false;
for (uint32_t i = 0; i < TestRunner::GetNTestSuites (); ++i)
{
TestSuite *testSuite = TestRunner::GetTestSuite (i);
if (doSuite == false || (doSuite == true && suiteName == testSuite->GetName ()))
{
testSuite->SetBaseDir (basedir);
testSuite->SetStream (pofs);
testSuite->SetVerbose (doVerbose);
result |= testSuite->Run ();
}
}
ofs.close();
return result;
}