Rocstar Namespace Reference

Namespaces
	Rocin
	TestFixture
	Namespace for storing simple test utility fixtures.

Classes
class	TestingObject
	Project-specific testing object. More...
class	TestComLine
	ComLineObject for Rocstar testing command-line interface. More...

Typedefs
typedef IRAD::Util::TestResults	TestResults
	Project-specific test results type. More...
typedef IRAD::Comm::CommunicatorObject	CommType
	Convenience typedef for CommunicatorObject. More...

Functions
int	ParallelTest (int argc, char *argv[])
	Drives the Rocstar::TestObject. More...
int	Test (int argc, char *argv[])
	Drives the Rocstar::TestObject. More...

Typedef Documentation

typedef IRAD::Comm::CommunicatorObject CommType

Convenience typedef for CommunicatorObject.

Definition at line 20 of file ParallelTestRocstar.C.

typedef IRAD::Util::TestResults TestResults

Project-specific test results type.

Test results types can be custom implemented by the project developer. The requirement is that they produce the proper test results output when used with outstreams.

Definition at line 41 of file RocstarTest.H.

Function Documentation

int Rocstar::ParallelTest	(	int	argc,
		char *	argv[]
	)

Drives the Rocstar::TestObject.

Parameters

argc	number of string command line tokens
argv	string command line tokens

Returns

0 if successful, 1 otherwise

Drives the Rocstar::TestObject, which should encapsulate all the tests for the Rocstar namespace (and thus the project).

Command line documentation:

      rocstar_test [-h] [-v [level] -o <filename> -l <filename> -n <TestName> ] 

      -h,--help
         Print out long version of help and exit.

      -v,--verblevel [level]
         Set the verbosity level. (default = 0)

      -o,--output <filename>
         Set the output file to <filename>. (default = stdout)

      -l,--list <filename>
         Set the list file name to <filename>. (no default). The list file should be a text file with one test name per line.

      -n,--name <TestName>
         Run test by name. (no default)

Definition at line 50 of file ParallelTestRocstar.C.

References TestComLine::Initialize(), rank, and test().

Referenced by main().

  {
    
    // The default verbosity is 0
    int verblevel = 0;

    // This sets everything up with MPI
    Rocstar::CommType communicator(&argc,&argv);
    int rank  = communicator.Rank();
    int nproc = communicator.Size();
    bool do_stdout = !rank;

    // This line creates the Rocstar::TestComLine object and passes in 
    // the command line arguments as a (const char **).
    TestComLine comline((const char **)(argv));
    // The call to comline.Initialize() reads the command line arguments
    // from the array passed in the previous line.
    comline.Initialize();
    
    
    // The ProcessOptions() call does detailed examination of the command
    // line arguments to check for user errors or other problems. This call
    // will return non-zero if there were errors on the commandline.
    int clerr = comline.ProcessOptions();
    // Check if the user just wanted to get the help and exit
    if(!comline.GetOption("help").empty()){
      // Print out the "long usage" (i.e. help) message to stdout
      if(do_stdout){
        std::cout << comline.LongUsage() << std::endl;
        if(verblevel > 1)
          std::cout << "Rocstar::ParallelTest: Exiting test function (success)" 
                    << std::endl;
      }
      communicator.SetExit(1);
    }
    if(communicator.Check())
      return(0);
    if(clerr){
      if(do_stdout){
        std::cout << comline.ErrorReport() << std::endl
                  << std::endl << comline.ShortUsage() << std::endl;
        if(verblevel > 2)
          std::cout << "Rocstar::ParallelTest: Exiting test function (fail)" << std::endl;
      }
      communicator.SetExit(1);
    }
    if(communicator.Check())
      return(1);

    // These outstreams allow the output to file to be set up and separated
    // from the stdout.
    std::ofstream Ouf;
    std::ostream *Out = NULL;
    if(do_stdout)
      Out = &std::cout;

    // The next few lines populate some strings based on the 
    // users input from the commandline.
    std::string OutFileName(comline.GetOption("output"));
    std::string TestName(comline.GetOption("name"));
    std::string ListName(comline.GetOption("list"));
    std::string sverb(comline.GetOption("verblevel"));
    
    // The following block parses and sets the verbosity level
    if(!sverb.empty()){
      verblevel = 1;
      if(sverb != ".true."){
        std::istringstream Istr(sverb);
        Istr >> verblevel;
        if(verblevel < 0)
          verblevel = 1;
      }
    }
    
    // This block sets up the output file if the user specified one
    if(!OutFileName.empty()){
      if(Out){
        Ouf.open(OutFileName.c_str());
        if(!Ouf){
          std::cout << "Rocstar::ParallelTest> Error: Could not open output file, " 
                    <<  OutFileName << " for test output. Exiting (fail)." << std::endl;
          communicator.SetExit(1);
        }
        Out = &Ouf;
      }
      if(communicator.Check())
        return(1);
    }
    
    if(verblevel > 1 && Out)
      *Out << "Rocstar::ParallelTest: Entering test function" << std::endl;
    
    // Make an instance of the Rocstar testing object, Rocstar::ParallelTestingObject
    Rocstar::ParallelTestingObject<Rocstar::CommType,Rocstar::TestResults> test(communicator);
    // Make an instance of the Rocstar results object, Rocstar::TestResults
    Rocstar::TestResults results;
    
    // If the user specified a name, then run only the named test
    if(!TestName.empty()){
      // This call runs a test by name
      test.RunTest(TestName,results);
    }
    // Otherwise, if the user specified a list, then read the list and
    // run the listed tests.
    else if(!ListName.empty()){
      std::ifstream ListInf;
      ListInf.open(ListName.c_str());
      if(!ListInf){
        if(Out)
          *Out << "Rocstar::ParallelTest> Error: Could not open list of tests in file " 
               << ListName << ". Exiting (fail)." << std::endl;
        communicator.SetExit(1);
      }
      if(communicator.Check())
        return(1);
      std::string testname;
      while(std::getline(ListInf,testname))
        test.RunTest(testname,results);
      ListInf.close();
    }
    else {
      // This call runs all the tests for the Rocstar namespace.
      test.Process(results);
    }
    if(Out)
      *Out << results << std::endl;
    
    if(Out && Ouf)
      Ouf.close();

    if((verblevel > 1) && Out)
      *Out << "Rocstar::ParallelTest: Exiting test function (success)" << std::endl;
    
    return(0);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

int Rocstar::Test	(	int	argc,
		char *	argv[]
	)

Drives the Rocstar::TestObject.

Parameters

argc	number of string command line tokens
argv	string command line tokens

Returns

0 if successful, 1 otherwise

Drives the Rocstar::TestObject, which should encapsulate all the tests for the Rocstar namespace (and thus the project).

Command line documentation:

      rocstar_test [-h] [-v [level] -o <filename> -l <filename> -n <TestName> ] 

      -h,--help
         Print out long version of help and exit.

      -v,--verblevel [level]
         Set the verbosity level. (default = 0)

      -o,--output <filename>
         Set the output file to <filename>. (default = stdout)

      -l,--list <filename>
         Set the list file name to <filename>. (no default). The list file should be a text file with one test name per line.

      -n,--name <TestName>
         Run test by name. (no default)

Definition at line 45 of file TestRocstar.C.

References TestComLine::Initialize(), TestingObject< ResultsType >::Process(), TestingObject< ResultsType >::RunTest(), and test().

Referenced by main().

  {
    
    // The default verbosity is 0
    int verblevel = 0;

    // This line creates the Rocstar::TestComLine object and passes in 
    // the command line arguments as a (const char **).
    TestComLine comline((const char **)(argv));
    // The call to comline.Initialize() reads the command line arguments
    // from the array passed in the previous line.
    comline.Initialize();
    // The ProcessOptions() call does detailed examination of the command
    // line arguments to check for user errors or other problems. This call
    // will return non-zero if there were errors on the commandline.
    int clerr = comline.ProcessOptions();
    // Check if the user just wanted to get the help and exit
    if(!comline.GetOption("help").empty()){
      // Print out the "long usage" (i.e. help) message to stdout
      std::cout << comline.LongUsage() << std::endl;
      if(verblevel > 2)
        std::cout << "Rocstar::Test: Exiting test function (success)" << std::endl;
      return(0);
    }
    if(clerr){
      std::cout << comline.ErrorReport() << std::endl
                << std::endl << comline.ShortUsage() << std::endl;
      if(verblevel > 2)
        std::cout << "Rocstar::Test: Exiting test function (fail)" << std::endl;
      return(1);
    }
    // These outstreams allow the output to file to be set up and separated
    // from the stdout.
    std::ofstream Ouf;
    std::ostream *Out = &std::cout;

    // The next few lines populate some strings based on the 
    // users input from the commandline.
    std::string OutFileName(comline.GetOption("output"));
    std::string TestName(comline.GetOption("name"));
    std::string ListName(comline.GetOption("list"));
    std::string sverb(comline.GetOption("verblevel"));
    
    // The following block parses and sets the verbosity level
    if(!sverb.empty()){
      verblevel = 1;
      if(sverb != ".true."){
        std::istringstream Istr(sverb);
        Istr >> verblevel;
        if(verblevel < 0)
          verblevel = 1;
      }
    }
    
    // This block sets up the output file if the user specified one
    if(!OutFileName.empty()){
      Ouf.open(OutFileName.c_str());
      if(!Ouf){
        std::cout << "Rocstar::Test> Error: Could not open output file, " 
                  <<  OutFileName << " for test output. Exiting (fail)." << std::endl;
        return(1);
      }
      Out = &Ouf;
    }
    
    if(verblevel > 2)
      std::cout << "Rocstar::Test: Entering test function" << std::endl;
    
    // Make an instance of the Rocstar testing object, Rocstar::TestingObject
    Rocstar::TestingObject<Rocstar::TestResults> test;
    // Make an instance of the Rocstar results object, Rocstar::TestResults
    Rocstar::TestResults results;
    
    // If the user specified a name, then run only the named test
    if(!TestName.empty()){
      // This call runs a test by name
      test.RunTest(TestName,results);
    }
    // Otherwise, if the user specified a list, then read the list and
    // run the listed tests.
    else if(!ListName.empty()){
      std::ifstream ListInf;
      ListInf.open(ListName.c_str());
      if(!ListInf){
        std::cout << "Rocstar::Test> Error: Could not open list of tests in file " 
                  << ListName << ". Exiting (fail)." << std::endl;
        return(1);
      }
      std::string testname;
      while(std::getline(ListInf,testname))
        test.RunTest(testname,results);
      ListInf.close();
    }
    else {
      // This call runs all the tests for the Rocstar namespace.
      test.Process(results);
    }
    *Out << results << std::endl;
    
    if(Ouf)
      Ouf.close();

    if(verblevel > 2)
      *Out << "Rocstar::Test: Exiting test function (success)" << std::endl;
    
    return(0);
  }

Here is the call graph for this function:

Here is the caller graph for this function: